Difference between revisions of "HOWTO Seek Help"

From Fail2ban
Jump to: navigation, search
m
Line 7: Line 7:
 
Recommended steps to troubleshoot problems  
 
Recommended steps to troubleshoot problems  
  
# 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'''
+
# 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'''
 
# '''Verify''' that issue you are experiencing is not already reported on the [https://github.com/fail2ban/fail2ban/issues issue tracker]
 
# '''Verify''' that issue you are experiencing is not already reported on the [https://github.com/fail2ban/fail2ban/issues issue tracker]
## '''if known''' - on the corresponding issue page you might find existing workarounds, or a pull-request to try, or submit a new comment or even a pull request to address the problem
+
#: '''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
 
# '''Collect information''' needed to be shared for effective troubleshooting
 
# '''Collect information''' needed to be shared for effective troubleshooting
 
## ''Fail2Ban version''
 
## ''Fail2Ban version''
### '''if your fail2ban is outdated''':
+
##: '''If your fail2ban is outdated:''':
#### try testing a new release -- the issue might have already being fixed in development
+
##:# try testing a new release -- the issue might have already being fixed in development
#### if you can't test for some reason -- read the [https://github.com/fail2ban/fail2ban/blob/master/ChangeLog ChangeLog] if no similar issues have been fixed in recent releases
+
##:# if you can't test for some reason -- read the [https://github.com/fail2ban/fail2ban/blob/master/ChangeLog ChangeLog] if no similar issues have been fixed in recent releases
 
## ''Your OS'' (with its release version) and either you are using stock fail2ban or the one provided by the distribution through a package manager
 
## ''Your OS'' (with its release version) and either you are using stock fail2ban or the one provided by the distribution through a package manager
 
## ''Your configuration'' (/etc/fail2ban), in particular any customizations you have done
 
## ''Your configuration'' (/etc/fail2ban), in particular any customizations you have done
## ''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)
+
## ''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)
 
## ''Relevant lines'' from monitored log files in question -- '''as an attachment''', to avoid line-wrapping which complicates testing
 
## ''Relevant lines'' from monitored log files in question -- '''as an attachment''', to avoid line-wrapping which complicates testing
# '''If you encountered a bug''' -- '''submit''' a new issue to [https://github.com/fail2ban/fail2ban/issues Issue tracker] and '''provide collected above information'''
+
# '''If you encountered a new bug:'''
# '''If you just need help with your setup''' -- '''report''' to IRC or the [https://lists.sourceforge.net/lists/listinfo/fail2ban-users mailing list], once again '''with the above information'''
+
#: '''submit''' a new issue to [https://github.com/fail2ban/fail2ban/issues Issue tracker] and '''provide collected above information'''
 +
# '''If you just need help with your setup:'''
 +
#: '''report''' to IRC or the [https://lists.sourceforge.net/lists/listinfo/fail2ban-users mailing list], once again '''with above requested information'''
  
Without providing adequate details you are unlikely to be helped, since noone has a mind reading machine, although some Fail2ban authors [http://www.pymvpa.org/ are working on it ;-)]
+
'''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 [http://www.pymvpa.org/ are working on it ;-)]

Revision as of 21:31, 24 October 2012

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. Your OS (with its release version) and either you are using stock fail2ban or the one provided by the distribution through a package manager
    3. Your configuration (/etc/fail2ban), in particular any customizations you have done
    4. 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)
    5. 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 ;-)