Skip to content

Commit c9f7be5

Browse files
authored
Merge pull request #12 from bitflipp/documentation
Documentation
2 parents 04fc740 + 631038f commit c9f7be5

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
# gerberos
22

33
gerberos scans sources for lines matching regular expressions and containing IPv4 or IPv6 addresses and performs actions on those addresses.
4-
Possible sources are (not necessarily existant) non-directory files and systemd journals.
5-
Addresses can be logged or added to ipsets or nftables that gerberos will manage autonomously.
4+
Possible sources are (not necessarily existant) non-directory files, systemd journals, kernel messages, and standard outputs of arbitrary processes.
5+
Addresses can be logged or added to ipsets or nft rulesets that gerberos will manage autonomously.
66

77
Minimal additional logic is applied. This is to adhere to the [Unix philosophy](https://en.wikipedia.org/wiki/Unix_philosophy), but impacts gerberos' out-of-the-box usefulness for specific use cases when compared to tools like [fail2ban](https://github.com/fail2ban/fail2ban).
88

99
## Requirements
1010

11-
- Go 1.18 (development only)
12-
- GNU Make 4.3 (development only, optional)
13-
- pgrep (system test only, optional)
14-
1511
### ipset backend
1612

1713
- ipset 6.34
@@ -21,6 +17,12 @@ Minimal additional logic is applied. This is to adhere to the [Unix philosophy](
2117

2218
- nftables v0.9.3 (tested on Ubuntu 20.04)
2319

20+
### Development only
21+
22+
- Go 1.18
23+
- GNU Make 4.3 (optional)
24+
- pgrep (system tests only, optional)
25+
2426
## Build
2527

2628
`make build`

0 commit comments

Comments
 (0)