summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/fail2ban/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/fail2ban/README.md')
-rw-r--r--collectors/python.d.plugin/fail2ban/README.md22
1 files changed, 18 insertions, 4 deletions
diff --git a/collectors/python.d.plugin/fail2ban/README.md b/collectors/python.d.plugin/fail2ban/README.md
index 1ab0f6f63..c1ad994a5 100644
--- a/collectors/python.d.plugin/fail2ban/README.md
+++ b/collectors/python.d.plugin/fail2ban/README.md
@@ -1,14 +1,28 @@
-# fail2ban
+<!--
+title: "Fail2ban monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/fail2ban/README.md
+sidebar_label: "Fail2ban"
+-->
-Module monitor fail2ban log file to show all bans for all active jails
+# Fail2ban monitoring with Netdata
-**Requirements:**
+Monitors the fail2ban log file to show all bans for all active jails.
+
+## Requirements
- fail2ban.log file MUST BE readable by Netdata (A good idea is to add **create 0640 root netdata** to fail2ban conf at logrotate.d)
It produces one chart with multiple lines (one line per jail)
-## configuration
+## Configuration
+
+Edit the `python.d/fail2ban.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/fail2ban.conf
+```
Sample: