Skip to content

Readme updates #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlosmmatos merged 2 commits into from
Apr 24, 2025
Merged

Readme updates #429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
963f4a8
doc: add linux migrate to main readme
carlosmmatos Apr 24, 2025
07dafd5
docs: added TOCs for consistency
carlosmmatos Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
|:-|:-|
Expand Down
9 changes: 9 additions & 0 deletions bash/containers/falcon-container-sensor-pull/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
17 changes: 13 additions & 4 deletions powershell/install/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -108,7 +117,7 @@ Enable verbose logging
#>
```

***Examples***:
### Usage

To download the script:

Expand All @@ -122,7 +131,7 @@ Basic example that will install the sensor with the provided provisioning token
.\falcon_windows_install.ps1 -FalconClientId <string> -FalconClientSecret <string> -ProvToken <string>
```

### 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.
Expand Down Expand Up @@ -170,7 +179,7 @@ Enable verbose logging
#>
```

***Examples***:
### Usage

To download the script:

Expand Down
8 changes: 8 additions & 0 deletions powershell/migrate/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading