From 03fb068df241ea1c51db85ce4d56677f708b0317 Mon Sep 17 00:00:00 2001 From: Asif Bacchus Date: Tue, 21 May 2019 05:40:02 -0600 Subject: [PATCH] Update page '3. Convenience script' --- 3.-Convenience-script.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 3.-Convenience-script.md diff --git a/3.-Convenience-script.md b/3.-Convenience-script.md new file mode 100644 index 0000000..ae57c82 --- /dev/null +++ b/3.-Convenience-script.md @@ -0,0 +1,36 @@ +# Convenience script +Whether you're uncomfortable typing commands at the prompt, new to Fail2Ban or just want something quick and easy, I've included a script to copy the template files to the right place in a default installation for you. You can also specify a custom directory if your F2B configuration files are in a non-default location. The script backups all files that it changes so you can easily undo changes. + +## Running the script + +**The script must be run as ROOT**. Otherwise, execution is dead simple. If you are running a default installation of F2B (i.e. your configuration files are in */etc/fail2ban*) simply run the script, answer 'yes' when prompted and you're done. + +```bash +# logged in as root +./f2b-config.sh + +# using SUDO +sudo ./f2b-config.sh +``` + +If you have a custom intallation of F2B and your configuration files are stored somewhere else, simply provide the path as a parameter: +*NOTE: The trailing slash doesn't matter, the script will strip it* + +```bash +./f2b-config.sh /path/to/f2b-config/ + +# example: f2b config stored in opt/fail2ban +./f2b-config.sh /opt/fail2ban/ +``` + +## What the script does + +The script simply copies the configuration files in this repo into your F2B configuration directory and provides instructions on restarting F2B to apply the changes. Using this wiki, you can customize the config files and then restart F2B to apply your changes. The script backs up any existing *.local* and *.conf* files as *.original* files in same location. + +## Reverting changes + +If you want to undo the changes made by the script, simply find the changed files and copy the *.original* file over the corresponding *.local* or *.conf* file. For example, undo the changes to *jail.local*: + +```bash +cp /etc/fail2ban/jail.local.original /etc/fail2ban/jail.local +```