Browse Source

+ docs/install.md

master
Alex 'AdUser' Z 8 years ago
parent
commit
41cad5aee3
  1. 4
      README.md
  2. 44
      docs/install.md

4
README.md

@ -10,6 +10,10 @@ Features:
* minimum dependencies (req: libc, libdl; optional: pcre, redis) * minimum dependencies (req: libc, libdl; optional: pcre, redis)
* pluggable sources / filters / backends (you may write custom one) * pluggable sources / filters / backends (you may write custom one)
Docs:
* docs/install.md -- generic installation instructions
Similar software: Similar software:
* [fail2ban](http://www.fail2ban.org) * [fail2ban](http://www.fail2ban.org)

44
docs/install.md

@ -0,0 +1,44 @@
Build process is quite simple:
cmake <OPTIONS> .
make
Actual list of configurable options for first line can be found at top of `CMakeLists.txt`.
It looks like this:
option(SYMBOL "Option description" DEFAULT_VALUE)
Option can be redefined with `-DSYMBOL=ON` or `-DSYMBOL=OFF` on cmake command line.
Other noticeable options are:
* `CMAKE_BUILD_TYPE` (Debug, Release or unset) -- sets compiler optimization level and debugging info. Set to "Release" for production code.
* `CMAKE_C_COMPILER` -- allows specify another compiler
* `CMAKE_INSTALL_PREFIX` -- set root of install dir ($DESTDIR also will be prefixed if set).
After building you may type `sudo make install` to install compiled binaries and other files.
Default install layout is:
/etc/f2b <- configs location
/etc/f2b/conf-available <- all available config parts
/etc/f2b/conf-enabled <- enabled config parts
/usr/bin <- non-root binaries
/usr/sbin <- root binaries
/usr/lib <- loadable modules
/usr/share/f2b <- patterns collection
After install you need additional steps before configuring f2b.
cd /etc/f2b
# make symlink to patterns collection
ln -s /usr/share/f2b/filters filters
# enable some config parts
# you need at least one backend, filter and source
cd /etc/f2b/conf-enabled
ln -s ../conf-available/05-source-files.conf ./
ls -n ../conf-available/10-backend-exec-ipset.conf ./
ln -s ../conf-available/15-filter-preg.conf ./
# make config part for local settings
touch 99-local.conf
Now you may proceed for configuration and first launch.
Loading…
Cancel
Save