Difference between revisions of "HOWTO Seek Help"
From Fail2ban
Jump to navigationJump to searchYarikoptic (talk | contribs) (initial HOWTO for people to follow) |
Yarikoptic (talk | contribs) (accent more on steps and providing details) |
||
| Line 7: | Line 7: | ||
Recommended steps to troubleshoot problems | Recommended steps to troubleshoot problems | ||
| − | # 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 submit a new comment or even a pull request to address 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''': | ||
| Line 16: | Line 16: | ||
## ''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) | ## ''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) | ||
| − | # '''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 bug''' -- '''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 the 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 the above 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 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 ;-)] | ||
Revision as of 17:40, 27 September 2012
There are 3 channels to find help/support for Fail2Ban. Depending on the level/urgency you might like to use:
- IRC: #fail2ban channel on Freenode network
- Mailing list: https://lists.sourceforge.net/lists/listinfo/fail2ban-users
- Issues tracker: https://github.com/fail2ban/fail2ban/issues
Recommended steps to troubleshoot problems
- 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 submit a new comment or even a pull request to address the problem
- Collect information needed to be shared for effective troubleshooting
- Fail2Ban version
- if your fail2ban is outdated:
- try testing a new release -- the issue might have already being fixed in development
- if you can't test for some reason -- read the ChangeLog if no similar issues have been fixed in recent releases
- if your fail2ban is outdated:
- 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)
- Fail2Ban version
- If you encountered a bug -- submit a new issue to Issue tracker and provide collected above information
- If you just need help with your setup -- report to IRC or the mailing list, once again with the above information
Without providing adequate details you are unlikely to be helped, since noone has a mind reading machine, although some Fail2ban authors are working on it ;-)
