Skip to content

Commit

Permalink
docs: update readme to better reflect changes
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosmmatos committed Aug 17, 2024
1 parent 9a59856 commit 0a644a9
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions bash/install/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Falcon Linux Bash Installation Scripts

> [!IMPORTANT]
> **Non-Breaking Change:**
>
> API Scope addition: ***Installation Tokens***
>
> This scope allows the installation script to retrieve the provisioning token from the API if it is required.
> For more information, see [Falcon API Permissions](#falcon-api-permissions).
Bash script to install Falcon Sensor through the Falcon APIs on a Linux endpoint. By default,
this script will install, register the sensor, and start the service. If you would like to simply
install the sensor without any additional configurations, configure the `FALCON_INSTALL_ONLY`
Expand All @@ -26,16 +34,23 @@ To check your version of cURL, run the following command: `curl --version`
- [Examples](#examples-1)
- [Troubleshooting](#troubleshooting)


## Falcon API Permissions

API clients are granted one or more API scopes. Scopes allow access to specific CrowdStrike APIs and describe the actions that an API client can perform.

Ensure the following API scopes are enabled:

- **Sensor Download** [read]
- **Installation Tokens** [read]
- (optional) **Sensor update policies** [read]
> Use this scope when configuring the `FALCON_SENSOR_UPDATE_POLICY_NAME` environment variable.
- (optional) **Hosts** [write]
> Use this scope when configuring the `FALCON_REMOVE_HOST` environment variable for the uninstall script.
> [!IMPORTANT]
> Installation/provisioning tokens prevent unauthorized hosts from being accidentally or maliciously added to your customer ID (CID).
> Its best practice to keep these tokens secure which is why the script will attempt to retrieve the token from the API if
> they are required in your environment.
## Configuration

Expand Down Expand Up @@ -119,6 +134,8 @@ Other Options
- FALCON_PROVISIONING_TOKEN (default: unset)
The provisioning token to use for installing the sensor.
If the provisioning token is unset, the script will attempt to retrieve it from
the API using your authentication credentials and CID requirements.
- FALCON_SENSOR_UPDATE_POLICY_NAME (default: unset)
The name of the sensor update policy to use for installing the sensor.
Expand Down Expand Up @@ -270,13 +287,13 @@ Other Options:
### Usage
#### To download and run the script directly
To download and run the script directly
```bash
curl -L https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.5.4/bash/install/falcon-linux-uninstall.sh | bash
```
#### Alternatively, download the script and run it locally
Alternatively, download the script and run it locally
```bash
curl -O https://raw.githubusercontent.com/crowdstrike/falcon-scripts/v1.5.4/bash/install/falcon-linux-uninstall.sh
Expand Down

0 comments on commit 0a644a9

Please sign in to comment.