$Id: README,v 1.3 2003/06/03 11:08:16 jt Exp $

Abstract:

This is the README for the Cygwin ProFTPD distribution.

ProFTPD is an enhanced FTP server with a focus toward simplicity, security,
and ease of configuration. It features a very Apache-like configuration
syntax, and a highly customizable server infrastructure, including support for
multiple 'virtual' FTP servers, anonymous FTP, and permission-based directory
visibility.

Requirements:

The following packages or later are required to build and/or execute
Cygwin ProFTPD:

    binutils 20030307-1
    crypt 1.0-1
    cygwin 1.3.22-1
    gcc 3.2-3
    libncurses7 5.3-1
    ncurses 5.3-1

Install:

The following is the procedure to install Cygwin ProFTPD as a stand-alone
FTP server (under NT/2000/XP):

1. If inetd or xinetd is configured to run inetutils ftpd, then edit the
appropriate configuration file to disabled inetutils ftpd:

    a. For inetd, comment out the following line in /etc/inetd.conf:

       ftp stream tcp nowait root /usr/sbin/in.ftpd in.ftpd

    b. For xinetd, comment out the following line in /etc/xinetd.d/ftpd:

       server = /usr/sbin/in.ftpd

2. Restart the daemon:

    $ net stop $daemon; net start $daemon

where $daemon is inetd or xinetd as appropriate.

3. Install ProFTPD as a NT service:

    $ cygrunsrv --install proftpd --path /usr/sbin/proftpd --args --nodaemon --termsig TERM --shutdown

4. Start the ProFTPD service:

    $ net start proftpd

The following is the procedure to install Cygwin ProFTPD as an inetd invoked
FTP server:

1. Edit /etc/proftpd.conf changing "ServerType" from "standalone" to "inetd".

2. Edit /etc/inetd.conf changing the ftp line from:

    ftp stream tcp nowait root /usr/sbin/in.ftpd in.ftpd

to:

    ftp stream tcp nowait root /usr/sbin/in.proftpd in.proftpd

3. Restart the inetd daemon:

    $ net stop inetd; net start inetd

The following is the procedure to install Cygwin ProFTPD as a xinetd invoked
FTP server:

1. Edit /etc/proftpd.conf changing "ServerType" from "standalone" to "inetd".

2. Edit /etc/xinetd.d/ftpd changing the server line from:

    server = /usr/sbin/in.ftpd

to:

    server = /usr/sbin/in.proftpd

3. Restart the xinetd daemon:

    $ net stop xinetd; net start xinetd

Source:

Although ProFTPD builds OOTB under Cygwin, two patches have been applied:

    http://bugs.proftpd.org/show_bug.cgi?id=2043
    http://bugs.proftpd.org/show_bug.cgi?id=2075

to address the standard Cygwin text vs. binary mode idiosyncrasy and a
ProFTPD "ls /" bug, respectively.

I also added the following files to the source archive:

    CYGWIN-PATCHES/README
    CYGWIN-PATCHES/build.sh
    CYGWIN-PATCHES/proftpd.patch
    CYGWIN-PATCHES/proftpd.sh

and renamed the original source archive to match Cygwin's setup.exe
naming conventions.

To restore the ProFTPD source to its original state, perform the
following:

    $ cd proftpd-$version-$package
    $ patch -R -p1 <CYGWIN-PATCHES/proftpd.patch
    $ rm -fr CYGWIN-PATCHES

where $version is the ProFTPD version (e.g., 1.2.9) and $package is the
Cygwin package number.

Build:

This distribution has been configured as follows:

    configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var

See CYGWIN-PATCHES/build.sh in the source archive for my exact build
recipe for configuring, making, and packaging this distribution.

Test:

ProFTPD does not contain any regression tests.

Issues:

The following are the known Cygwin ProFTPD issues:

1. Under 9x/Me, the User and Group directives in the /etc/proftp.conf
file must be set to be your user and group, respectively.  Otherwise,
ProFTPD will fail to start as reported in the following Cygwin mailing
list thread:

    http://cygwin.com/ml/cygwin/2003-05/msg01211.html

Homepage:

The primary ProFTPD web site is:

    http://www.proftpd.org/

Download:

The primary ProFTPD ftp site is:

    ftp://ftp.proftpd.org/

Mailing Lists:

Please report problems, suggestions, etc. dependent on their nature to
one of the following:

    proftp-user@lists.sourceforge.net
    cygwin@cygwin.com

Maintainer:

    Jason Tishler <jason@tishler.net>