diff --git a/README.md b/README.md index a8f1712..21b1596 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # Falcon-CrowdStrike-SIEM-Connector -To use this image properly first create a `.env` file in the root directory of this repository with the following contents: +This container has all the necessary components to run the Falcon CrowdStrike connector deb package. \ +There are two ways to use this container. + +## Using an .env file +To use this image with a configuration file, fill the `.env` file in the root directory of this repository with the following contents: ``` CLIENT_ID= @@ -18,21 +22,47 @@ Make sure to check out the documentation just in case any of these values change The `CLIENT_ID` and `CLIENT_SECRET` can be produced by visiting `/api-clients-and-keys` UI. -## Building +### Building ```bash ~$ docker build . -t : ``` -## Running +### Running ```bash ~$ docker run : ``` -## Debugging +### Debugging + +Make sure you have a running container first (the container doesn't stop running as it is polling logs). +```bash +~$ docker exec -it bash +``` + +## Using arguments +To use this image with run-time arguments, skip the file and add them during run-time. + +### Building + +```bash +~$ docker build . -t : +``` + +### Running + +```bash +~$ docker run \ + -e CLIENT_ID= \ + -e CLIENT_SECRET= \ + -e API_BASE_URL= \ + : +``` + +### Debugging -Make sure you have a running container first. +Make sure you have a running container first (the container doesn't stop running as it is polling logs). ```bash ~$ docker exec -it bash ```