Adding configuration documentation and the config file in the gitignore

This commit is contained in:
Christopher Talib 2020-02-10 14:40:33 +01:00
parent e634636768
commit 7c5b2b714a
2 changed files with 20 additions and 0 deletions

1
.gitignore vendored
View file

@ -2,3 +2,4 @@ styx-poc
*.json
*.txt
styx
config.yml

View file

@ -8,6 +8,25 @@ go build
./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
### Meta