From a3a1bf6b521ca1119f275b3384eb508d1b405ae5 Mon Sep 17 00:00:00 2001 From: Carlos Matos Date: Fri, 20 Dec 2024 08:38:15 -0500 Subject: [PATCH] docs: update readme with toc and new version info --- README.md | 54 +++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 39 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7626a4a..913e311 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![CrowdStrike](https://raw.githubusercontent.com/CrowdStrike/falcon-integration-gateway/main/docs/assets/cs-logo.png) -# falcon-integration-gateway [![Python Lint](https://github.com/CrowdStrike/falcon-integration-gateway/actions/workflows/linting.yml/badge.svg)](https://github.com/CrowdStrike/falcon-integration-gateway/actions/workflows/linting.yml) [![Container Build on Quay](https://quay.io/repository/crowdstrike/falcon-integration-gateway/status "Docker Repository on Quay")](https://quay.io/repository/crowdstrike/falcon-integration-gateway) +# falcon-integration-gateway [![Python Lint](https://github.com/CrowdStrike/falcon-integration-gateway/actions/workflows/linting.yml/badge.svg)](https://github.com/CrowdStrike/falcon-integration-gateway/actions/workflows/linting.yml) [![Container Build on Quay](https://quay.io/repository/crowdstrike/falcon-integration-gateway/status "Docker Repository on Quay")](https://quay.io/repository/crowdstrike/falcon-integration-gateway) ![PyPI](https://img.shields.io/pypi/v/falcon-integration-gateway) Falcon Integration Gateway (FIG) forwards threat detection findings and audit events from the CrowdStrike Falcon platform to the [backend](fig/backends) of your choice. @@ -8,6 +8,26 @@ Detection findings and audit events generated by CrowdStrike Falcon platform inf This project facilitates the export of the individual detections and audit events from CrowdStrike Falcon to third-party security dashboards (so called backends). The export is useful in cases where security operation team workflows are tied to given third-party solution to get early real-time heads-up about malicious activities or unusual user activities detected by CrowdStrike Falcon platform. +## Table of Contents + +- [Python Compatibility](#python-compatibility) +- [API Scopes](#api-scopes) +- [Authentication](#authentication) + - [Direct Configuration](#direct-configuration) + - [Environment Variables](#environment-variables) + - [Credential Store](#credential-store) +- [Configuration](#configuration) +- [Deployment](#deployment) + - [Backends w/ Available Deployment Guide(s)](#backends-w-available-deployment-guides) + - [Alternative Deployment Options](#alternative-deployment-options) + - [Installation to Kubernetes using the helm chart](#installation-to-kubernetes-using-the-helm-chart) + - [With Docker/Podman](#with-dockerpodman) + - [From the Python Package Index (PyPI)](#from-the-python-package-index-pypi) + - [From Git Repository](#from-git-repository) +- [Developers Guide](#developers-guide) +- [Statement of Support](#statement-of-support) + + ## Python Compatibility > [!IMPORTANT] @@ -94,7 +114,9 @@ secrets_manager_client_secret_key = client_secret_key_name Please refer to the [config.ini](./config/config.ini) file for more details on the available options along with their respective environment variables. -## Backends w/ Available Deployment Guide(s) +## Deployment + +### Backends w/ Available Deployment Guide(s) | Backend | Description | Deployment Guide(s) | General Guide(s) | |:--------|:------------|:--------------------|:-------------------| @@ -106,15 +128,15 @@ Please refer to the [config.ini](./config/config.ini) file for more details on t | Workspace ONE | Pushes events to VMware Workspace ONE Intelligence | *Coming Soon* | [Workspace ONE backend](fig/backends/workspaceone) | | Generic | Displays events to STDOUT (useful for dev/debugging) | N/A | [Generic Backend](fig/backends/generic) | -## Alternative Deployment Options +### Alternative Deployment Options > :exclamation: Prior to any deployment, ensure you refer to the [configuration options](./config/config.ini) available to the application :exclamation: -### Installation to Kubernetes using the helm chart +#### Installation to Kubernetes using the helm chart Please refer to the [FIG helm chart documentation](https://github.com/CrowdStrike/falcon-helm/tree/main/helm-charts/falcon-integration-gateway) for detailed instructions on deploying the FIG via helm chart for your respective backend(s). -### With Docker/Podman +#### With Docker/Podman To install as a container: @@ -142,12 +164,14 @@ To install as a container: docker logs ``` -### From the Python Package Index (PyPI) +#### From the Python Package Index (PyPI) -> [!IMPORTANT] -> Falcon Integration Gateway (FIG) versions below 3.2.1 on PyPI are broken and will not install correctly. Please ensure you install version 3.2.1 or higher from PyPI. +Falcon Integration Gateway (FIG) is available on the [Python Package Index](https://pypi.org/project/falcon-integration-gateway/). + +> [!WARNING] +> Falcon Integration Gateway (FIG) versions below 3.2.2 on PyPI are broken and will not install correctly. Please ensure you install version 3.2.2 or higher from PyPI. -1. Install the package using pip: +1. Install the package: ```bash python3 -m pip install falcon-integration-gateway @@ -178,15 +202,15 @@ To install as a container: python3 -m fig ``` -#### Updating the FIG from PyPI +##### Updating the FIG from PyPI To update the FIG package from PyPI, run: ```bash -python3 -m pip install --upgrade falcon-integration-gateway +python3 -m pip install falcon-integration-gateway --upgrade ``` -### From Git Repository +#### From Git Repository > [!NOTE] > This method requires Python 3.7 or higher and a python package manager such as `pip` to be installed on your system. @@ -212,11 +236,11 @@ python3 -m pip install --upgrade falcon-integration-gateway python3 -m fig ``` -#### Updating the FIG from the Git Repository +##### Updating the FIG from the Git Repository Depending on which configuration method you are using, follow the steps below to update the FIG from the Git repository. -##### config.ini +###### config.ini If you have made any changes to the `config.ini` file, you can update the FIG by following these steps: @@ -242,7 +266,7 @@ python3 -m fig This method ensures that your configuration settings are preserved while updating the FIG to the latest version. -#### Environment Variables (only) +##### Environment Variables (only) If you are only using environment variables to configure the FIG, you can update the FIG by following these steps: