Adding configuration documentation and the config file in the gitignore
This commit is contained in:
parent
e634636768
commit
7c5b2b714a
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -2,3 +2,4 @@ styx-poc
|
||||||
*.json
|
*.json
|
||||||
*.txt
|
*.txt
|
||||||
styx
|
styx
|
||||||
|
config.yml
|
||||||
|
|
19
README.md
19
README.md
|
@ -8,6 +8,25 @@ go build
|
||||||
./styx
|
./styx
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Example configuration:
|
||||||
|
```
|
||||||
|
// config.yml
|
||||||
|
shodan:
|
||||||
|
key: REQUIRED
|
||||||
|
|
||||||
|
// do not forget to set up kafka and create the topic
|
||||||
|
kafka:
|
||||||
|
protocol: tcp
|
||||||
|
host: localhost
|
||||||
|
port: 9092
|
||||||
|
topic: styx
|
||||||
|
partition: 0
|
||||||
|
|
||||||
|
balboa:
|
||||||
|
url: REQUIRED
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
## Datastructure
|
## Datastructure
|
||||||
|
|
||||||
### Meta
|
### Meta
|
||||||
|
|
Loading…
Reference in a new issue