diff --git a/README.md b/README.md index a207491..52fb6f8 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,15 @@ Configure fail2ban ================== This is a helper role with tasks and files missing from `Oefenweb.fail2ban`. + +### How to make use of this role + +- Copy your filter and jail files to the corresponding directories of this role. +- Set path variables at `host_vars`. + +### Variables + +| Variable | Description | +|--|--| +| `fail2ban_filterd_path` | Path to directory containing filters to copy (note the trailing slash) | +| `fail2ban_jaild_path` | Path to directory containing jails to copy (note the trailing slash) |