Go to file
Yaroslav Halchenko 09dd317b20 Merge commit '0.8.6-90-g08564bd' into debian-devel
* commit '0.8.6-90-g08564bd':
  ENH: fail2ban-testcases -- custom logging format to ease debugging, non-0 exit code in case of failure
  ENH: Filter's testcases -- rename, del + list again --- a bit unstable, might still fail from time to time
  BF: pyinotify -- monitor the parent directory for IN_CREATE + process freshly added file (Closes gh-44)
  ENH: first working unittest for checking polling and inotify backends
  RF/BF: just use pyinotify.ThreadedNotifier thread in filterpyinotify
  RF: filter.py -- single readline in a loop
  ENH: FilterPoll -- adjusted some msgs + allowed to operate without jail (for testing)
  Minor additional comment to DEVELOP
  ENH: extended test LogfileMonitor
  ENH: add more verbosity levels to be controlled while running unittests
  Added few tests of FileFilter.  yet to place them into a Jail-ed execution test
  DOC: distilling some of server "design" into DEVELOP notes for common good
  ENH: minor, just  trailing spaces/tabs + reformated a string
  ENH: added a basic test for FilterPoll for detection of modifications
  clarified that the are existing test cases and the 'coming soon' is about creating new ones.
  Added beginnings of documentation for developers
  BF: usedns=no was not working at all
  RF: filtertestcase.py to put common testing into a helping subroutine
  ENH: be able to control verbosity from cmdline for fail2ban-testcases
2012-07-19 14:06:14 -04:00
client ENH: Add usedns parameter for the jails 2012-01-12 23:23:41 -05:00
common ENH: Add usedns parameter for the jails 2012-01-12 23:23:41 -05:00
config DOC: Adjusted header for config/*.conf to mention .local and way to comment 2012-06-04 22:41:28 -04:00
debian Adjusted url to "local DOS" issue now described in the manual 2012-07-14 11:12:54 -04:00
doc DOC: a bit extended and reordered run-rootless.txt 2012-01-07 21:08:34 -05:00
files Fix Gentoo initd script (drop extra_commands) 2012-04-21 22:24:51 -04:00
man FIX: direct users to issues on github instead of bothering cyril 2012-01-07 19:03:11 -05:00
server BF: pyinotify -- monitor the parent directory for IN_CREATE + process freshly added file (Closes gh-44) 2012-07-19 13:28:48 -04:00
testcases ENH: Filter's testcases -- rename, del + list again --- a bit unstable, might still fail from time to time 2012-07-19 13:30:01 -04:00
.gitignore added rudimentary .gitignore 2011-11-18 11:50:49 -05:00
.project - Added Eclipse project file 2006-10-17 21:24:27 +00:00
.pydevproject - Removed Python 2.4. Minimum required version is now Python 2.3. 2007-12-16 21:38:04 +00:00
.pylintrc ENH: added a .pylintrc to help with consistent appearance and catch obvious problems 2011-10-04 10:55:16 -04:00
COPYING - Added ISO 8601 date/time format. 2008-05-18 19:53:18 +00:00
ChangeLog Changelog and version changes for 0.8.6 2011-11-28 22:46:04 -05:00
DEVELOP Minor additional comment to DEVELOP 2012-07-19 01:04:05 -04:00
MANIFEST Added pyinotify backend 2011-12-30 00:18:52 -05:00
README Added pyinotify requirements to README 2012-01-08 14:27:00 -05:00
THANKS DOC: moved THANKS into a THANKS file for better visibility, concise README 2011-10-03 15:21:35 -04:00
TODO minor comment into TODO 2012-01-26 23:43:47 -05:00
fail2ban-client Update Free Software Foundation's address 2011-12-30 12:41:46 -05:00
fail2ban-regex BF: fail2ban-regex -- adding forgotten char for -v 2012-02-18 20:12:23 -05:00
fail2ban-server Update Free Software Foundation's address 2011-12-30 12:41:46 -05:00
fail2ban-testcases ENH: fail2ban-testcases -- custom logging format to ease debugging, non-0 exit code in case of failure 2012-07-19 13:30:55 -04:00
kill-server - Initial commit of the new development release 0.7 2006-06-26 20:05:00 +00:00
setup.cfg - Now Fail2ban goes in /usr/share/fail2ban instead of /usr/lib/fail2ban. This is more compliant with FHS. Thanks to Axel Thimm and Yaroslav Halchenko 2007-01-04 12:58:21 +00:00
setup.py Update Free Software Foundation's address 2011-12-30 12:41:46 -05:00

README

                         __      _ _ ___ _               
                        / _|__ _(_) |_  ) |__  __ _ _ _  
                       |  _/ _` | | |/ /| '_ \/ _` | ' \ 
                       |_| \__,_|_|_/___|_.__/\__,_|_||_|

================================================================================
Fail2Ban (version 0.8.6)                                              2011/11/28
================================================================================

Fail2Ban scans log files like /var/log/pwdfail and bans IP that makes too many
password failures. It updates firewall rules to reject the IP address. These
rules can be defined by the user. Fail2Ban can read multiple log files such as
sshd or Apache web server ones.

This README is a quick introduction to Fail2ban. More documentation, FAQ, HOWTOs
are available on the project website: http://www.fail2ban.org

Installation:
-------------

Required:
   >=python-2.3 (http://www.python.org)

Optional:
   pyinotify:
      >=linux-2.6.13
      >=python-2.4
      >=pyinotify-0.8.3 (https://github.com/seb-m/pyinotify)
   Gamin:
      >=gamin-0.0.21 (http://www.gnome.org/~veillard/gamin)

To install, just do:

> tar xvfj fail2ban-0.8.6.tar.bz2
> cd fail2ban-0.8.6
> python setup.py install

This will install Fail2Ban into /usr/share/fail2ban. The executable scripts are
placed into /usr/bin.

It is possible that Fail2ban is already packaged for your distribution. In this
case, you should use it.

Fail2Ban should be correctly installed now. Just type:

> fail2ban-client -h

to see if everything is alright. You should always use fail2ban-client and never
call fail2ban-server directly.

Configuration:
--------------

You can configure Fail2ban using the files in /etc/fail2ban. It is possible to
configure the server using commands sent to it by fail2ban-client. The available
commands are described in the man page of fail2ban-client. Please refer to it or
to the website: http://www.fail2ban.org

Contact:
--------

Website: http://www.fail2ban.org

You need some new features, you found bugs: visit
https://github.com/fail2ban/fail2ban/issues
and if your issue is not yet known -- file a bug report.

If you would like to troubleshoot or discuss: join the mailing list
https://lists.sourceforge.net/lists/listinfo/fail2ban-users

If you just appreciate this program: send kudos to the original
author: Cyril Jaquier: <cyril.jaquier@fail2ban.org>


Thanks:
-------

See THANKS file.

License:
--------

Fail2Ban is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

Fail2Ban is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
Fail2Ban; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
Suite 330, Boston, MA  02111-1307  USA