Skip to content

Commit b4306e5

Browse files
committed
Update README.md
1 parent 80e5bbe commit b4306e5

File tree

1 file changed

+35
-5
lines changed

1 file changed

+35
-5
lines changed

README.md

+35-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Falcon-CrowdStrike-SIEM-Connector
22

3-
To use this image properly first create a `.env` file in the root directory of this repository with the following contents:
3+
This container has all the necessary components to run the Falcon CrowdStrike connector deb package. \
4+
There are two ways to use this container.
5+
6+
## Using an .env file
7+
To use this image with a configuration file, fill the `.env` file in the root directory of this repository with the following contents:
48

59
```
610
CLIENT_ID=<YOUR_CLIENT_ID>
@@ -18,21 +22,47 @@ Make sure to check out the documentation just in case any of these values change
1822

1923
The `CLIENT_ID` and `CLIENT_SECRET` can be produced by visiting `/api-clients-and-keys` UI.
2024

21-
## Building
25+
### Building
2226

2327
```bash
2428
~$ docker build . -t <name>:<tag>
2529
```
2630

27-
## Running
31+
### Running
2832

2933
```bash
3034
~$ docker run <name>:<tag>
3135
```
3236

33-
## Debugging
37+
### Debugging
38+
39+
Make sure you have a running container first (the container doesn't stop running as it is polling logs).
40+
```bash
41+
~$ docker exec -it <container_name> bash
42+
```
43+
44+
## Using arguments
45+
To use this image with run-time arguments, skip the file and add them during run-time.
46+
47+
### Building
48+
49+
```bash
50+
~$ docker build . -t <name>:<tag>
51+
```
52+
53+
### Running
54+
55+
```bash
56+
~$ docker run \
57+
-e CLIENT_ID=<CLIENT_ID> \
58+
-e CLIENT_SECRET=<CLIENT_SECRET> \
59+
-e API_BASE_URL=<API_BASE_URL> \
60+
<name>:<tag>
61+
```
62+
63+
### Debugging
3464

35-
Make sure you have a running container first.
65+
Make sure you have a running container first (the container doesn't stop running as it is polling logs).
3666
```bash
3767
~$ docker exec -it <container_name> bash
3868
```

0 commit comments

Comments
 (0)