Go to file
Yaroslav Halchenko 5c9a9b1129 Merge remote-tracking branch 'github_kwirk_fail2ban/upstream#24' into _tent/conf_d
Merge is done with -X ours -- since I have implemented more generic handling
for config files, including now the ones under .d/ subdirectories.

* github_kwirk_fail2ban/upstream#24:
  Fix up for warning/error for inaccessible config files
  Warn if config file present but unreadable
2013-02-17 17:05:30 -05:00
client NF: allow customization configuration under corresponding .d directories (Closes gh-114) 2013-02-17 17:03:23 -05:00
common RF: move exceptions used by both client and server into common/exceptions.py 2013-01-28 09:46:50 -05:00
config BF: remove path from grep call in sendmail-whois-lines.conf Closes: gh-118 2013-02-12 08:48:05 -05:00
doc DOC: a bit extended and reordered run-rootless.txt 2012-01-07 21:08:34 -05:00
files Replace "|" with "_" in ipmasq-ZZZzzz|fail2ban.rul (Closes gh-66) 2012-07-18 10:29:59 -04:00
man FIX: direct users to issues on github instead of bothering cyril 2012-01-07 19:03:11 -05:00
server BF: return str(host) to avoid spurious characters in the logs (Close gh-113) 2013-02-01 16:24:04 -05:00
testcases NF: allow customization configuration under corresponding .d directories (Closes gh-114) 2013-02-17 17:03:23 -05:00
.gitignore ignore build directory and compiled python bits 2012-12-12 21:43:27 +11: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
.travis.yml ENH: trying to go native travis-ci python way to take advantage of virtualenv's with older pythons 2012-11-06 22:05:41 -05:00
COPYING - Added ISO 8601 date/time format. 2008-05-18 19:53:18 +00:00
ChangeLog Getting ready for 0.8.8 release (changelog, version boost) 2012-12-05 22:51:29 -05:00
DEVELOP DOC: minor "fixes" in DEVELOP 2012-11-05 21:12:03 -05:00
MANIFEST Added pyinotify backend 2011-12-30 00:18:52 -05:00
README Getting ready for 0.8.8 release (changelog, version boost) 2012-12-05 22:51:29 -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 BF: do not rely on scripts being under /usr -- might differ eg on Fedora -- rely on import of common.version (Closes gh-112) 2013-01-28 09:54:12 -05:00
fail2ban-regex BF: do not rely on scripts being under /usr -- might differ eg on Fedora -- rely on import of common.version (Closes gh-112) 2013-01-28 09:54:12 -05:00
fail2ban-server BF: do not rely on scripts being under /usr -- might differ eg on Fedora -- rely on import of common.version (Closes gh-112) 2013-01-28 09:54:12 -05:00
fail2ban-testcases NF: allow customization configuration under corresponding .d directories (Closes gh-114) 2013-02-17 17:03:23 -05:00
fail2ban-testcases-all ENH: fail2ban-testcases-all -- pass cmdline options to fail2ban-testcases 2012-11-07 11:34:20 -05: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 just trailing spaces in setup.py 2013-02-11 16:17:52 -05:00

README

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

================================================================================
Fail2Ban (version 0.8.8)                                              2012/07/31
================================================================================

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.8.tar.bz2
> cd fail2ban-0.8.8
> 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>) or the mailing list
https://lists.sourceforge.net/lists/listinfo/fail2ban-users


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