diff --git a/README.md b/README.md index b2d92ec4..e5ad09e9 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,12 @@ The scripts in this repository are organized into the following categories: |:-|:-| | [Containers](bash/containers) | Shell scripts for working with the CrowdStrike Falcon Container Sensor Images | | [Install](bash/install) | Shell scripts for installing/uninstalling the CrowdStrike Falcon Sensor for Linux | +| [Migrate](bash/migrate) | Shell script to migrate Falcon sensor from one CID to another for Linux | | PowerShell | Description | |:-|:-| | [Install](powershell/install) | PowerShell scripts for installing/uninstalling the CrowdStrike Falcon Sensor for Windows | -| [Migrate](powershell/migrate) | PowerShell script for host migration between Falcon cloud tenants | +| [Migrate](powershell/migrate) | PowerShell script to migrate Falcon sensor from one CID to another for Windows | | SystemD | Description | |:-|:-| diff --git a/bash/containers/falcon-container-sensor-pull/README.md b/bash/containers/falcon-container-sensor-pull/README.md index 38be3423..002648ea 100644 --- a/bash/containers/falcon-container-sensor-pull/README.md +++ b/bash/containers/falcon-container-sensor-pull/README.md @@ -6,6 +6,15 @@ A bash script for managing CrowdStrike Falcon container images. Pull from the of Please refer to the [Deprecation](DEPRECATION.md) document for more information pertaining to deprecated features and upcoming changes in version 2.0.0. +## Table of Contents + +- [Table of Contents](#table-of-contents) +- [Multi-Architecture Support :rocket:](#multi-architecture-support-rocket) +- [Security recommendations](#security-recommendations) +- [Prerequisites](#prerequisites) +- [Auto-Discovery of Falcon Cloud Region](#auto-discovery-of-falcon-cloud-region) +- [Usage](#usage) + ## Multi-Architecture Support :rocket: The Falcon Container Sensor Pull script now supports multi-arch images. However, there are some limitations to be aware of: diff --git a/powershell/install/README.md b/powershell/install/README.md index 9c4de65b..6590409b 100644 --- a/powershell/install/README.md +++ b/powershell/install/README.md @@ -2,6 +2,15 @@ Powershell scripts to install/uninstall Falcon Sensor through the Falcon APIs on a Windows endpoint. +## Table of Contents + +- [Falcon API Permissions](#falcon-api-permissions) +- [Auto-Discovery of Falcon Cloud Region](#auto-discovery-of-falcon-cloud-region) +- [Configuration](#configuration) +- [Install Sensor](#install-sensor) +- [Uninstall Sensor](#uninstall-sensor) +- [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. @@ -51,7 +60,7 @@ You can also specify a Falcon access token if doing a batch install across multi > > The script will output the access token to the console. -### Install +## Install Sensor Uses the CrowdStrike Falcon APIs to check the sensor version assigned to a ***Windows Sensor Update policy***, downloads that version, then installs it on the local machine. By default, once complete, the script @@ -108,7 +117,7 @@ Enable verbose logging #> ``` -***Examples***: +### Usage To download the script: @@ -122,7 +131,7 @@ Basic example that will install the sensor with the provided provisioning token .\falcon_windows_install.ps1 -FalconClientId -FalconClientSecret -ProvToken ``` -### Uninstall +## Uninstall Sensor Uninstalls the CrowdStrike Falcon Sensor for Windows. By default, once complete, the script deletes itself and the downloaded uninstaller package (if necessary). The individual steps and any related error messages are logged to `'Windows\Temp\csfalcon_uninstall.log'` unless otherwise specified. @@ -170,7 +179,7 @@ Enable verbose logging #> ``` -***Examples***: +### Usage To download the script: diff --git a/powershell/migrate/README.md b/powershell/migrate/README.md index 2e22c764..b0ea2702 100644 --- a/powershell/migrate/README.md +++ b/powershell/migrate/README.md @@ -4,6 +4,14 @@ A versatile PowerShell script for host migration between Falcon cloud tenants, s > Can also be used to migrate a sensor from one CID to another within the same cloud. +## Table of Contents + +- [Requirements](#requirements) +- [Auto-Discovery of Falcon Cloud Region](#auto-discovery-of-falcon-cloud-region) +- [What Does It Do?](#what-does-it-do) +- [Usage](#usage) +- [Troubleshooting](#troubleshooting) + ## Requirements - PowerShell 3.0 or higher