=========================
Installation instructions
=========================

Prerequisites
=============

Prerequisites of autogen.sh script:

 * automake1.7 to execute cleanly autogen.sh:
   http://www.gnu.org/software/automake/

Prerequisites of NuFW compilation:

 * GNU libtool:
   http://www.gnu.org/software/libtool/
 * GNU make:
   http://www.gnu.org/software/make/
 * libpam-dev for system authentication module

Prerequisites of NuFW compilation and runtime:

 * glib 2.4+:
   http://www.gtk.org/
 * libipq (in iptables-dev on debian) or libnetfilter_queue
   (optionally libnetfilter_conntrack):
   http://www.netfilter.org/
 * libldap for the provided auth server
 * libsasl2 (Cyrus)
 * libgnutls:
   http://www.gnu.org/software/gnutls/
 * libgcrypt (and libgpg-error):
   http://ftp.gnupg.org/gcrypt/libgcrypt/ and
   http://ftp.gnupg.org/gcrypt/libgpg-error/

Prerequisites of NuFW runtime:

 * Linux kernel 2.6, a kernel superior to 2.6.18 is a good choice: http://www.kernel.org/

Prerequisites of nuauth_command program:

 * Python 2.4+: http://www.python.org/. On Mandriva, install
   libpython2.4-devel to get /usr/lib/python2.4/config/Makefile
 * IPy python library:
   http://software.inl.fr/trac/trac.cgi/wiki/IPy

Name of FreeBSD packages (incomplete list):

 * autotools
 * libtool
 * glib20
 * libgcrypt
 * gnutls
 * cyrus-sasl2


Kernel
======

It is recommanded to use a recent kernel to benefit of all latest feature.
A kernel superior to 2.6.18 is a good choice.

The patch dump-connection-mark.diff (in patches/) can be applied to the kernel
to increase performances when doing session logging.


Compilation
===========

To compile, use the standard ::

  ./autogen.sh
  ./configure
  make
  make install

If it is a first installation, think to copy the configuration file as it ::

  make install-conf

or run ::

  cp ./conf/nuauth.conf /usr/local/etc/nuauth.conf

Else look for changes between your current conf file and the new one.

Next, you will have to run (as root) nufw.
nufw -h will give you a usage message.

You will also have to launch nuauth, the authorisation server.
nuauth -h will give you a usage message.

To use nufw you will have to run a client for each user.
nutcpc and pam_nufw are provided in NuFW archive.

You will find more informations on: http://www.nufw.org


SQL Logging
===========

If you use SQL Logging and SSO features, you may wish to increase performance
of SQL queries by putting closed connections in a different SQL table by using or a script
(cron task ?) or a trigger.


