1 files changed, 49 insertions, 0 deletions
diff --git a/debian/twoftpd.README.Debian b/debian/twoftpd.README.Debian
new file mode 100644
index 0000000..280d4a8
--- /dev/null
+++ b/debian/twoftpd.README.Debian
@@ -0,0 +1,49 @@
+twoftpd for Debian
+------------------
+
+The binaries are installed in /usr/bin/.  Normally the twoftpd services are
+run under tcpserver from the ucspi-tcp package, set up with the daemontools
+package to log to a multilog process.
+
+In Debian, the twoftpd-conf and twoftpd-anon-conf programs are changed to
+create service directories that utilize programs from the runit and ipsvd
+packages instead.
+
+If you want to run twoftpd as default ftp service on your machine, install
+the twoftpd-run package.  The twoftpd-run package sets up the twoftpd service
+to listen on 0.0.0.0:21, and additionally provides a service directory to set
+up an anonymous twoftpd service.
+
+If you want another ftp-server to be installed as the default, and to run a
+twoftpd service for example on a virtual interface, you can use the
+twoftpd-conf program to create a service directory
+
+ # twoftpd-conf logacct /etc/twoftpd4 /var/log/twoftpd4 cvm 1.2.3.4 1
+
+where logacct is a user name, the logging process will run under the uid
+and gid of logacct; /etc/twoftpd4 is the service directory; /var/log/twoftpd4
+is the log directory; 1.2.3.4 the IP address the service listens on, and cvm
+is a credential validation module (from the cvm package, .e.g. cvm-unix).
+
+To configure an anonymous twoftpd service, use the twoftpd-anon-conf program
+
+ # twoftpd-anon-conf acct logacct /etc/twoftpd-anon4 /var/log/twoftpd-anon4 \
+     /var/ftp 1.2.3.4
+
+where acct and logacct are user names, the twoftpd-anon process will run
+under the uid and gid of acct, and the logging process will run under the
+uid and gid of logacct; /etc/twoftpd-anon4 is the service directory;
+/var/log/twoftpd-anon4 is the log directory; and /var/ftp is the ftp root.
+
+To enable twoftpd services, make sure that the ipsvd and runit packages
+are installed, and runit's service supervision is enabled.  Then use the
+update-service(8) program, e.g.
+
+ # update-service --add /etc/twoftpd-anon4
+
+The service will be started within 5 seconds and automatically on system
+boot.
+
+Running twoftpd services from inetd is no longer supported by this package.
+
+ -- Gerrit Pape <pape@smarden.org>, Sat, 05 Jul 2003 15:37:17 +0200