Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tsigouris007 committed Feb 7, 2024
1 parent 80e5bbe commit b4306e5
Showing 1 changed file with 35 additions and 5 deletions.
40 changes: 35 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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=<YOUR_CLIENT_ID>
Expand All @@ -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 <name>:<tag>
```

## Running
### Running

```bash
~$ docker run <name>:<tag>
```

## 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 <container_name> 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 <name>:<tag>
```

### Running

```bash
~$ docker run \
-e CLIENT_ID=<CLIENT_ID> \
-e CLIENT_SECRET=<CLIENT_SECRET> \
-e API_BASE_URL=<API_BASE_URL> \
<name>:<tag>
```

### 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 <container_name> bash
```
Expand Down

0 comments on commit b4306e5

Please sign in to comment.