HOWTO Seek Help

From Fail2ban
Revision as of 13:37, 8 April 2015 by Yarikoptic (Talk | contribs) (added a note to share output from tests)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

There are 3 channels to find help/support for Fail2Ban. Depending on the level/urgency you might like to use:

Recommended steps to troubleshoot problems

  1. If you are troubleshooting if a failregex is correct
    check it with fail2ban-regex against the logfile in question and share its output if you end up reporting
  2. Verify that issue you are experiencing is not already reported on the issue tracker
    If known:
    on the corresponding issue page you might find existing workarounds, or a pull-request to try, or to submit a new comment or even a pull request to fix the problem
  3. Collect information needed to be shared for effective troubleshooting
    1. Fail2Ban version
      If your fail2ban is outdated::
      1. try testing a new release -- the issue might have already being fixed in development
      2. if you can't test for some reason -- read the ChangeLog if no similar issues have been fixed in recent releases
    2. Tests: run fail2ban-testcases and paste output (with failures) - may be it would already hint you how your system is special
    3. Your OS (with its release version) and either you are using stock fail2ban or the one provided by the distribution through a package manager
    4. Your configuration (/etc/fail2ban), in particular any customizations you have done
    5. Relevant parts of /var/log/fail2ban.log file, preferably obtained while running fail2ban with loglevel = 4
      (set it in [Definition] section of /etc/fail2ban/fail2ban.conf or /etc/fail2ban/fail2ban.local).
      Send lengthy output (or with long lines) as an attachment (see next one)
    6. Relevant lines from monitored log files in question -- as an attachment, to avoid line-wrapping which complicates testing
  4. If you encountered a new bug:
    submit a new issue to Issue tracker and provide collected above information
  5. If you just need help with your setup:
    report to IRC or the mailing list, once again with above requested information

Without providing adequate details it is likely for you to not get any help, since noone has a mind reading machine, although some Fail2ban authors are working on it ;-)