From 4fc5d2aaa006a9e46ce30f53606feb4c5449722b Mon Sep 17 00:00:00 2001 From: Thomas Chevalier Date: Thu, 12 May 2022 09:47:23 +0200 Subject: [PATCH] Update readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 126e120..9023555 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,11 @@ This script fetches a list of bogons from team cymru (see https://team-cymru.com/community-services/bogon-reference/) and updates the corresponding sets in the firewall. The bogon list is downloaded then compared to the current list stored on the disk (got from the previous run). If the two list differ the corresponding nftables set is flushed then filled with the new list. This operation is atomic. + +## Installation + +This script need root privileges. The included systemd service files assume that a group "nftables" exists and has the right to execute the command `nft` without password. + +The default working directory is `/var/cache/updateBogons/` and is automatically created if it does not exist. + +