Lets keep our version of opftpd in the CVS
[oftpd.git] / README
1 $Id$
2
3
4 Installation
5
6 See the INSTALL file for directions on compiling and installing the
7 binary.  Short version (as root):
8
9   # ./configure
10   # make
11   # make install
12
13 This will install the oftpd daemon itself.  To run the server via the
14 standard Unix startup mechanism, you'll need to add it to your startup
15 files.  In most Linux systems, this means putting a shell script in the
16 /etc/rc.d/init.d directory and linking to it from the directories for
17 your various run levels.  If you have a Red Hat 7.0 (or similiar)
18 system, you can use the oftpd.redhat7 script for this purpose:
19
20   # cp init/oftpd.redhat7 /etc/rc.d/init.d/oftpd
21   # chkconfig --add oftpd
22
23 Be sure to read the FAQ if you have any questions!
24
25
26 Introduction
27
28 oftpd is designed to be as secure as an anonymous FTP server can
29 possibly be.  It runs as non-root for most of the time, and uses the
30 Unix chroot() command to hide most of the systems directories from
31 external users - they cannot change into them even if the server is
32 totally compromised!  It contains its own directory change code, so that
33 it can run efficiently as a threaded server, and its own directory
34 listing code (many FTP servers execute the system "ls" command to list
35 files).  It is currently being code-reviewed for buffer overflows, and
36 being load-tested.
37
38
39 History
40
41 I wrote oftpd to fill a need we had at my company.  Our public FTP site
42 was a mess, and in addition to reorganizing organizing the hierarchy and
43 file layout I wanted to get the latest version of our FTP server
44 software.  It turns out that the version we had had had a number of
45 security issues.  So I decided to find an anonymous-only, secure FTP
46 server.  None of the ones I found were fully baked.  Time to write my
47 own.  :)
48
49
50 Portability
51
52 oftpd currently runs on modern Linux systems, including Red Hat-derived
53 (Mandrake, Trustix, etc.) and Debian systems.  oftpd has been ported to
54 FreeBSD and is in the FreeBSD ports collection.  I expect to install
55 FreeBSD and Solaris sometime in 2001 to properly support those
56 environments.
57
58
59 Don't hesitate to e-mail if you have questions or suggestions.  
60 Good luck!
61
62
63 Shane Kerr
64 shane@time-travellers.org