#
# $Id: INSTALL,v 1.1 1999/09/15 14:06:22 wiegand Exp $
#

This file describes how to install the FTP-Proxy.
FTP-Proxy is part of the SuSE Proxy-Suite.

If you are planning to install this software from the source
archive, you can simply execute the following steps:

  cd <proxy-suite-top-dir>
  ./configure [options, see below]
  make
  cd ftp-proxy
  su
  make install

The options in the 'configure' command above are the standard
options for a GNU AutoConf based installation, plus the following
package specific ones:

  --prefix=PREFIX         install architecture-independent files in PREFIX
                          [/usr/local/proxy-suite]
  --exec-prefix=EPREFIX   install architecture-dependent files in EPREFIX
                          [same as prefix]
  --sbindir=DIR           system admin executables in DIR [EPREFIX/sbin]
                          --> where 'ftp-proxy' will be installed
  --mandir=DIR            man documentation in DIR [PREFIX/man]
                          --> where man pages will be installed
  --sysconfdir=DIR        read-only single-machine data in DIR [PREFIX/etc]
                          --> where 'ftp-proxy.conf' will be installed

  --enable-debug          allow generation of debugging output
  --enable-warnings       enable -W and -Wall if using gcc
  --enable-proc-mods      Enable (Linux) /proc diagnostic modules
  --enable-so-linger      Enable setting SO_LINGER socket option
  --enable-rfc1579        Enable RFC 1579 (FW-FTP) extensions
  --enable-rfc2428        Enable RFC 2428 (FTP for IPv6) extensions
  --with-regex[=PATH]     Use regular expressions for path names
  --with-libwrap[=PATH]   Compile in libwrap (TCP Wrapper) support
  --with-libldap[=PATH]   Compile in LDAP support

It is recommended to compile the program without debug for production
environments, but debugging is anyway only used when switched on with
the '-v <level>' command line switch.

The next step is to edit the configuration file. Please refer to the
sample file, it is well documented. You may also want to consult the
two manual pages ftp-proxy(8) and ftp-proxy.conf(5) for further
information.

Last but not least there is an overview of all implemented syslog(3)
message formats and tags, plus a White Paper with a more in depth
discussion of the concepts and ideas behind the FTP-Proxy.

To use the FTP-Proxy, you should first decide how to activate it.
You can either run it from the internet super daemon (inetd or xinetd)
or as a daemon of its own. In the first case you have to edit the
(x)inetd config file, in the latter case the 'ftp' entry must be
removed from this file so that FTP-Proxy can open the port itself
for listening.

It is always a good idea to consider sending syslog(3) output to
another machine, so an intruder will find it more difficult to wipe
out his trail.

Enjoy!

