Commit b4306e5 1 parent 80e5bbe commit b4306e5 Copy full SHA for b4306e5
File tree 1 file changed +35
-5
lines changed
1 file changed +35
-5
lines changed Original file line number Diff line number Diff line change 1
1
# Falcon-CrowdStrike-SIEM-Connector
2
2
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:
4
8
5
9
```
6
10
CLIENT_ID=<YOUR_CLIENT_ID>
@@ -18,21 +22,47 @@ Make sure to check out the documentation just in case any of these values change
18
22
19
23
The ` CLIENT_ID ` and ` CLIENT_SECRET ` can be produced by visiting ` /api-clients-and-keys ` UI.
20
24
21
- ## Building
25
+ ### Building
22
26
23
27
``` bash
24
28
~ $ docker build . -t < name> :< tag>
25
29
```
26
30
27
- ## Running
31
+ ### Running
28
32
29
33
``` bash
30
34
~ $ docker run < name> :< tag>
31
35
```
32
36
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
34
64
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) .
36
66
``` bash
37
67
~ $ docker exec -it < container_name> bash
38
68
```
You can’t perform that action at this time.
0 commit comments