www.usr.com/support/gpl/USR9113_release1.0.tar.gz

[bcm963xx.git] / userapps / opensource / ftpd / doc / en / bftpddoc-en.sgml

<!doctype linuxdoc system>\r
\r
<article>\r
\r
<!-- Title information -->\r
\r
<title>bftpd documentation</title>\r
<author>\r
 <name>written by Max-Wilhelm Bruker <tt/&lt;brukie@gmx.net/&gt;</name>\r
</author>\r
<!--<date>$Id: bftpddoc-en.sgml,v 1.1.1.1 2006/05/24 20:04:52 mshtulberg Exp $</date>-->\r
\r
<abstract>\r
This document is the documentation for the bftpd FTP server.\r
</abstract>\r
\r
<!-- Table of contents -->\r
<toc>\r
\r
<!-- Begin the document -->\r
\r
<sect>Introduction\r
 <p>\r
bftpd is an FTP server for Linux, BSD/OS, FreeBSD, Solaris, DG-UX and Tru64. (I don't know if it runs on other systems, please mail me if you have tried it). It runs either with inetd or standalone.\r
 </p>\r
 <p>\r
  It tries to be very configurable while being fast and small. You can make defaults for each configuration option, and then override these defaults in user-specific and directory-specific structures.\r
 </p>\r
 <p>\r
Features of bftpd include:\r
  <itemize>\r
<item>Easy configuration\r
<item>Speed\r
<item>Support for most RFC FTP commands\r
<item>tar.gz on-the-fly compression/archiving\r
<item>Security with chroot without special setup\r
<item>No need for files (sh, ls...) in a chroot environment\r
<item>Logging to wtmp and to a logfile or syslog\r
<item>PAM and passwd/shadow support\r
<item>Support for SITE CHOWN/CHMOD\r
  </itemize>\r
 </p>\r
</sect>\r
\r
<sect>Installation\r
<sect1>Compiling\r
 <p>\r
First execute the following commands (replacing x.x.x by the version number you are installing):\r
  <tscreen><verb>\r
tar xzf bftpd-x.x.x.tar.gz\r
cd bftpd-x.x.x\r
./configure\r
make\r
make install\r
  </verb></tscreen>\r
Note that you have to copy bftpd.conf from the source directory to /etc manually if you are upgrading from a previous version, as 'make install' does not overwrite your existing configuration.\r
 </p>\r
 <p>\r
 Note: If you want to use the 'tar.gz on-the-fly' feature of bftpd, you must\r
 grab the source code of the program &quot;pax&quot; and extract it into\r
 a subdirectory of the bftpd source directory. Then, instead of doing\r
 &quot;./configure&quot;, do &quot;./configure --enable-pax=pax-sourcedir --enable-libz&quot;.\r
 You must also have the library libz and its header file, /usr/include/zlib.h.\r
 </p>\r
<sect1>Running the server\r
<p>\r
bftpd runs in either standalone or inetd mode.\r
  <descrip>\r
<tag>If you want inetd mode</tag>\r
  Add the following to your /etc/inetd.conf:\r
<tscreen><verb>ftp stream tcp nowait root /usr/sbin/bftpd bftpd</verb></tscreen>\r
  Give inetd a HUP or reboot your system. Your FTP server\r
  should work now.\r
<tag>If you want inetd mode with xinetd</tag>\r
  Add the following to your /etc/xinetd.conf:\r
<tscreen><verb>\r
service ftp\r
{\r
    disable = no\r
    socket_type             = stream\r
    wait                    = no\r
    user                    = root\r
    server                  = /usr/sbin/bftpd\r
    log_on_success          += DURATION USERID\r
    log_on_failure          += USERID\r
    nice                    = 10\r
}\r
</verb></tscreen>\r
(contributed by JackRipper)\r
<tag>If you want standalone mode:</tag>\r
  Make the OS execute\r
  <tscreen><verb>/usr/sbin/bftpd -d</verb></tscreen>\r
  at bootup.\r
  </descrip>\r
 </p>\r
\r
<sect>Configuration\r
<sect1>User management\r
<p>\r
You can manage the users simply by editing /etc/passwd and, if your system supports it, /etc/shadow. Any user existent in /etc/passwd can connect to the FTP server if he has a usable password and meets certain configurable criteria. Having anonymous users is possible by setting a configuration variable called ANONYMOUS_USER to yes. PAM is also supported.\r
</p>\r
<sect1>The configuration file\r
<sect2>The global structure\r
<p>\r
In the &dquot;global&dquot; structure, you can assign values to configuration options. The syntax is like the following:\r
<tscreen><verb>\r
global {\r
  name1="value1"\r
  name2="value2"\r
}\r
</verb></tscreen>\r
</p>\r
<sect2>User structures\r
<p>\r
There are also user structures, in which you can override the global settings for particular users. Example:\r
<tscreen><verb>\r
global {\r
  name1="value1"\r
  name2="value2"\r
}\r
user foo {\r
  name1="value3"\r
}\r
</verb></tscreen>\r
If the user foo is logged in, name1 will be value3. If another user is logged in, name1 will be value1. name2 is always value2.\r
</p>\r
<sect2>Group structures\r
<p>\r
You can also define options for groups of users. It is just as it would be for one user, but you can put more than one user in a group. You can also put system groups into them by using the @ character. Example:\r
<tscreen><verb>\r
group foo,bar,@baz {\r
  name1="value1"\r
}\r
</verb></tscreen>\r
This options affect the users foo and bar and every user who is in the system group baz. A supplementary membership is sufficient.\r
</p>\r
<sect2>Directory structures\r
<p>\r
You can set options which affects only the users who are in a certain directory, or in any subdirectory of it, recursively. Note that you must put these structures <em>inside</em> the global, user and group structures. This way, you can also override directory-specific settings for particular users. Example:\r
<tscreen><verb>\r
global {\r
  name1="value1"\r
  directory "/foo" {\r
    name1="value2"\r
  }\r
}\r
user bar {\r
  directory "/foo" {\r
    name1="value3"\r
  }\r
}\r
</verb></tscreen>\r
In this example, name1 will be value3 if the user bar is in the directory /foo. It will be value2 if another user is in the directory /foo. In any other case, it will be value1.\r
</p>\r
<p>\r
An explanation of the name/value pairs is in the example configuration file supplied with bftpd (if you are not upgrading, this file has already been copied to /etc on your system). Modify it so that it fits your needs. The defaults should be OK though.\r
</p>\r
\r
<sect>FAQ\r
<sect1>Problems while compiling\r
<sect2>I can't compile bftpd\r
<p>\r
Let me know. Please tell me what architecture and operating system you are using, and give me the output of the complete compilation process (configure and make). I don't get a lot of mail, so I'll try to answer your questions. If I don't reply, I have almost certainly forgotten your mail, so please send it again :)\r
</p>\r
<sect2>There are strange warnings\r
<p>\r
It is likely that compiling bftpd on a platform I haven't tested may give you some warnings. Even if it compiles successfully and runs without crashing, please tell me, as compiler warnings <em>can</em> cause problems which are not obvious.\r
</p>\r
<sect2>Make tells me I can't use wtmp\r
<p>\r
You are probably running Solaris. As I don't have access to a Solaris computer, I have never been able to test the wtmp functions in it. If you get a warning like this and you don't know what wtmp is, just don't care, else help me to fix the error.\r
</p>\r
<sect1>Problems when trying to run it\r
<sect2>I get a warning like &dquot;Could not get peer IP address.&dquot;\r
<p>\r
You have started bftpd on the console. If you want to run it as a standalone server, you have to invoke it with the &dquot;-d&dquot; option. If you have set it up as an inetd server, you can test it with:\r
<tscreen><verb>\r
hostname:&tilde;$ ftp localhost\r
</verb></tscreen>\r
</p>\r
<sect2>I get an error like &dquot;Bind failed: Address already in use.&dquot;\r
<p>\r
This error means that another process has bound itself to the port you want to run bftpd on. You can set this port in bftpd.conf with the option PORT in the global structure. It defaults to 21. If you have not changed that, you probably forgot to turn off your old FTP server. Look in /etc/inetd.conf and in &dquot;ps auxwww | grep ftp&dquot;.\r
</p>\r
<sect1>Problems during the FTP sessions\r
<sect2>I get an error like &dquot;500 Unknown command: 'foo'&dquot;\r
<p>\r
Your client has sent a command to the server which it didn't understand. This is my fault, unless you have written a really inexistent command. Please check your command for typographic errors and report the error to me if you are sure that the command was right.\r
</p>\r
<sect2>The session terminates with a 421 error\r
<p>\r
If you try to log in with a wrong password, bftpd will terminate the connection. If you already had logged in before the error appeared, or the error appeared before you could log in, it definitely is a bug. Please tell me everything about it.\r
</p>\r
<sect1>Miscellaneous\r
<sect2>How does the on-the-fly compression work?\r
<p>\r
Let's say you have a directory called foo. Even if there is no file called foo.tar.gz, you can RETR this file over FTP and it will contain the contents of the directory foo, tar-gzipped. You can also RETR the following files:\r
<itemize>\r
<item>dirname.tar</item>\r
<item>filename.gz</item>\r
</itemize>\r
If you want to use this, you must compile it in (see the installation section).\r
</p>\r
<sect2>My options for an anonymous user don't work\r
<p>\r
If you have a structure with an ALIAS=... in it, you mustn't put any more options in it. Instead, put them into the structure the alias points to.\r
</p>\r
<sect2>Why is there so little documentation?\r
<p>\r
The answer is simple, nobody has written anything :)<newline>\r
I never know what to write, so if you have any idea of how to improve the documentation, please tell me. The same applies to translations of documentation. If you want to contribute something, just do it, but <em>please</em> care about typographic errors and grammar.\r
</p>\r
<sect>Credits\r
<sect1>Portability testing\r
<p>\r
<itemize>\r
<item>David L. Nicol (david@kasey.umkc.edu) tested bftpd on Tru64.</item>\r
<item>JackRipper (vic@altoona.net) tested bftpd on BSD/OS and DG-UX.</item>\r
<item>Christian Beyerlein (christian@beyerlein.de) tested bftpd on FreeBSD and Solaris.</item>\r
<item>The people from #linux (IRCNet) tested bftpd on various operating systems.</item>\r
</itemize>\r
</p>\r
<sect1>Suggestions, bug reports &amp; code contributions\r
<p>\r
<itemize>\r
<item>Josh Woodcock (josh@hamparts.com) gave some hints about Solaris 8.</item>\r
<item>Floh (floh@maflohsoft.de) suggested the ASCII mode support.</item>\r
<item>Erik Hensema (erik@hensema.xs4all.nl) found a Linux 2.4.0 netfilter bug which affected bftpd.</item>\r
<item>Heiko Rother (rother@cmsnet.de) suggested a lot of things (see changelog).</item>\r
<item>Christophe Bailleux (cb@grolier.fr) loves to find problems in the directory listing routines. He also suggested a lot of things and contributed some code.</item>\r
<item>Jonathan Heusser (jonathanheusser@gyml.unibas.ch) found a buffer overflow bug.</item>\r
<item>Christian Beyerlein (christian@beyerlein.de) suggested to make user aliases.</item>\r
<item>Elmusafir (jslmarti@campus.cem.itesm.mx) reported the StarOffice problem fixed in 1.0.8.</item>\r
<item>Alex Madden (alexm@immstudios.com) and Daniel Mack (daniel.mack@nextra.de) reported the Solaris imcompatibility fixed in 1.0.8.</item>\r
<item>Daniel Mack (daniel.mack@nextra.de) contributed a big patch (see changelog).</item>\r
</itemize>\r
</p>\r
<sect1>Documentation contributions\r
<p>\r
<itemize>\r
<item>Radek Michalski (radek@end.p-s.com.pl) translates the bftpd docs into Polish and also contributes new text.</item>\r
</itemize>\r
</p>\r
<sect1>Others\r
<p>\r
<itemize>\r
<item>Some ideas about code structure and portability where taken from betaftpd bei Steinar H. Gunderson. But these were only a few lines!\r
</itemize>\r
</p>\r
</article>\r