Update README

This commit is contained in:
ppom 2023-04-11 13:14:46 +02:00
parent 27b058202d
commit a9400b7cd3
2 changed files with 10 additions and 12 deletions

View File

@ -66,18 +66,13 @@ WorkingDirectory=/var/lib/reaction
``` ```
See [reaction.service](./reaction.service) and [reaction.yml](./reaction.yml) for the fully commented examples. See [reaction.service](./reaction.service) and [reaction.yml](./reaction.yml) for the fully commented examples.
## documentation ### database
### configuration reference
`cmd`: note that if program is not in environment's `PATH`, the full path to the command should be given.
`/etc/systemd/system/reaction.service` (again, commented)
```systemd
```
### implicit configuration
the working directory of `reaction` will be used to create and read from the embedded [lmdb](https://www.symas.com/lmdb) database. the working directory of `reaction` will be used to create and read from the embedded [lmdb](https://www.symas.com/lmdb) database.
if you don't know where to start it, `/var/lib/reaction` should be a sane choice. if you don't know where to start it, `/var/lib/reaction` should be a sane choice.
### compilation
```shell
$ go build .
```

View File

@ -1,4 +1,5 @@
--- ---
# TODO heavily comment this file
definitions: definitions:
- &iptablesban [ "iptables" "-w" "-I" "reaction" "1" "-s" "<ip>" "-j" "block" ] - &iptablesban [ "iptables" "-w" "-I" "reaction" "1" "-s" "<ip>" "-j" "block" ]
- &iptablesunban [ "iptables" "-w" "-D" "reaction" "1" "-s" "<ip>" "-j" "block" ] - &iptablesunban [ "iptables" "-w" "-D" "reaction" "1" "-s" "<ip>" "-j" "block" ]
@ -8,6 +9,8 @@ patterns:
streams: streams:
ssh: ssh:
# note that if the command is not in environment's `PATH`
# its full path must be given.
cmd: [ "journalctl" "-fu" "sshd.service" ] cmd: [ "journalctl" "-fu" "sshd.service" ]
filters: filters:
failedlogin: failedlogin: