From a9400b7cd3b58f2e6885dceebeab5223c4ab504f Mon Sep 17 00:00:00 2001 From: ppom <> Date: Tue, 11 Apr 2023 13:14:46 +0200 Subject: [PATCH] Update README --- README.md | 19 +++++++------------ reaction.yml | 3 +++ 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index db77d4c..2cb6f62 100644 --- a/README.md +++ b/README.md @@ -66,18 +66,13 @@ WorkingDirectory=/var/lib/reaction ``` See [reaction.service](./reaction.service) and [reaction.yml](./reaction.yml) for the fully commented examples. -## documentation - -### 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 +### 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. + +### compilation + +```shell +$ go build . +``` diff --git a/reaction.yml b/reaction.yml index a1d9979..754c557 100644 --- a/reaction.yml +++ b/reaction.yml @@ -1,4 +1,5 @@ --- +# TODO heavily comment this file definitions: - &iptablesban [ "iptables" "-w" "-I" "reaction" "1" "-s" "" "-j" "block" ] - &iptablesunban [ "iptables" "-w" "-D" "reaction" "1" "-s" "" "-j" "block" ] @@ -8,6 +9,8 @@ patterns: streams: ssh: + # note that if the command is not in environment's `PATH` + # its full path must be given. cmd: [ "journalctl" "-fu" "sshd.service" ] filters: failedlogin: