# BRCM_VERSION=3

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

  bftpd documentation
  written by Max-Wilhelm Bruker <brukie@gmx.net>


  This document is the documentation for the bftpd FTP server.
  ______________________________________________________________________

  Table of Contents


  1. Introduction
  2. Installation
     2.1 Compiling
     2.2 Running the server

  3. Configuration
     3.1 User management
     3.2 The configuration file
        3.2.1 The global structure
        3.2.2 User structures
        3.2.3 Group structures
        3.2.4 Directory structures

  4. FAQ
     4.1 Problems while compiling
        4.1.1 I can't compile bftpd
        4.1.2 There are strange warnings
        4.1.3 Make tells me I can't use wtmp
     4.2 Problems when trying to run it
        4.2.1 I get a warning like "Could not get peer IP address."
        4.2.2 I get an error like "Bind failed: Address already in use."
     4.3 Problems during the FTP sessions
        4.3.1 I get an error like "500 Unknown command: 'foo'"
        4.3.2 The session terminates with a 421 error
     4.4 Miscellaneous
        4.4.1 How does the on-the-fly compression work?
        4.4.2 My options for an anonymous user don't work
        4.4.3 Why is there so little documentation?

  5. Credits
     5.1 Portability testing
     5.2 Suggestions, bug reports & code contributions
     5.3 Documentation contributions
     5.4 Others


  ______________________________________________________________________

  \e[1m1.  Introduction\e[0m

  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.

  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.

  Features of bftpd include:

  +\bo  Easy configuration

  +\bo  Speed

  +\bo  Support for most RFC FTP commands

  +\bo  tar.gz on-the-fly compression/archiving

  +\bo  Security with chroot without special setup

  +\bo  No need for files (sh, ls...) in a chroot environment

  +\bo  Logging to wtmp and to a logfile or syslog

  +\bo  PAM and passwd/shadow support

  +\bo  Support for SITE CHOWN/CHMOD

  \e[1m2.  Installation\e[0m

  \e[1m2.1.  Compiling\e[0m

  First execute the following commands (replacing x.x.x by the version
  number you are installing):


       tar xzf bftpd-x.x.x.tar.gz
       cd bftpd-x.x.x
       ./configure
       make
       make install



  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.

  Note: If you want to use the 'tar.gz on-the-fly' feature of bftpd, you
  must grab the source code of the program "pax" and extract it into a
  subdirectory of the bftpd source directory. Then, instead of doing
  "./configure", do "./configure --enable-pax=pax-sourcedir --enable-
  libz".  You must also have the library libz and its header file,
  /usr/include/zlib.h.

  \e[1m2.2.  Running the server\e[0m

  bftpd runs in either standalone or inetd mode.

     \e[1mIf you want inetd mode\e[0m
        Add the following to your /etc/inetd.conf:


          ftp stream tcp nowait root /usr/sbin/bftpd bftpd



     Give inetd a HUP or reboot your system. Your FTP server should work
     now.

     \e[1mIf you want inetd mode with xinetd\e[0m
        Add the following to your /etc/xinetd.conf:



     service ftp
     {
         disable = no
         socket_type             = stream
         wait                    = no
         user                    = root
         server                  = /usr/sbin/bftpd
         log_on_success          += DURATION USERID
         log_on_failure          += USERID
         nice                    = 10
     }



     (contributed by JackRipper)

     \e[1mIf you want standalone mode:\e[0m
        Make the OS execute


          /usr/sbin/bftpd -d



     at bootup.

  \e[1m3.  Configuration\e[0m

  \e[1m3.1.  User management\e[0m

  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.

  \e[1m3.2.  The configuration file\e[0m

  \e[1m3.2.1.  The global structure\e[0m

  In the "global" structure, you can assign values to configuration
  options. The syntax is like the following:


       global {
         name1="value1"
         name2="value2"
       }



  \e[1m3.2.2.  User structures\e[0m

  There are also user structures, in which you can override the global
  settings for particular users. Example:



  global {
    name1="value1"
    name2="value2"
  }
  user foo {
    name1="value3"
  }



  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.

  \e[1m3.2.3.  Group structures\e[0m

  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:


       group foo,bar,@baz {
         name1="value1"
       }



  This options affect the users foo and bar and every user who is in the
  system group baz. A supplementary membership is sufficient.

  \e[1m3.2.4.  Directory structures\e[0m

  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 \e[4minside\e[24m the global, user and group
  structures. This way, you can also override directory-specific
  settings for particular users. Example:


       global {
         name1="value1"
         directory "/foo" {
           name1="value2"
         }
       }
       user bar {
         directory "/foo" {
           name1="value3"
         }
       }



  In this example, name1 will be value3 if the user bar is in the direc-
  tory /foo. It will be value2 if another user is in the directory /foo.
  In any other case, it will be value1.

  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.


  \e[1m4.  FAQ\e[0m

  \e[1m4.1.  Problems while compiling\e[0m

  \e[1m4.1.1.  I can't compile bftpd\e[0m

  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 :)

  \e[1m4.1.2.  There are strange warnings\e[0m

  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 \e[4mcan\e[24m cause
  problems which are not obvious.

  \e[1m4.1.3.  Make tells me I can't use wtmp\e[0m

  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.

  \e[1m4.2.  Problems when trying to run it\e[0m

  \e[1m4.2.1.  I get a warning like "Could not get peer IP address."\e[0m

  You have started bftpd on the console. If you want to run it as a
  standalone server, you have to invoke it with the "-d" option. If you
  have set it up as an inetd server, you can test it with:


       hostname:~$ ftp localhost



  \e[1m4.2.2.  I get an error like "Bind failed: Address already in use."\e[0m

  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 "ps auxwww | grep ftp".

  \e[1m4.3.  Problems during the FTP sessions\e[0m

  \e[1m4.3.1.  I get an error like "500 Unknown command: 'foo'"\e[0m

  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.

  \e[1m4.3.2.  The session terminates with a 421 error\e[0m

  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.



  \e[1m4.4.  Miscellaneous\e[0m

  \e[1m4.4.1.  How does the on-the-fly compression work?\e[0m

  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:

  +\bo  dirname.tar

  +\bo  filename.gz

     If you want to use this, you must compile it in (see the
     installation section).

  \e[1m4.4.2.  My options for an anonymous user don't work\e[0m

  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.

  \e[1m4.4.3.  Why is there so little documentation?\e[0m

  The answer is simple, nobody has written anything :)
  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
  \e[4mplease\e[24m care about typographic errors and grammar.

  \e[1m5.  Credits\e[0m

  \e[1m5.1.  Portability testing\e[0m


  +\bo  David L. Nicol (david@kasey.umkc.edu) tested bftpd on Tru64.

  +\bo  JackRipper (vic@altoona.net) tested bftpd on BSD/OS and DG-UX.

  +\bo  Christian Beyerlein (christian@beyerlein.de) tested bftpd on
     FreeBSD and Solaris.

  +\bo  The people from #linux (IRCNet) tested bftpd on various operating
     systems.

  \e[1m5.2.  Suggestions, bug reports & code contributions\e[0m


  +\bo  Josh Woodcock (josh@hamparts.com) gave some hints about Solaris 8.

  +\bo  Floh (floh@maflohsoft.de) suggested the ASCII mode support.

  +\bo  Erik Hensema (erik@hensema.xs4all.nl) found a Linux 2.4.0 netfilter
     bug which affected bftpd.

  +\bo  Heiko Rother (rother@cmsnet.de) suggested a lot of things (see
     changelog).

  +\bo  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.

  +\bo  Jonathan Heusser (jonathanheusser@gyml.unibas.ch) found a buffer
     overflow bug.


  +\bo  Christian Beyerlein (christian@beyerlein.de) suggested to make user
     aliases.

  +\bo  Elmusafir (jslmarti@campus.cem.itesm.mx) reported the StarOffice
     problem fixed in 1.0.8.

  +\bo  Alex Madden (alexm@immstudios.com) and Daniel Mack
     (daniel.mack@nextra.de) reported the Solaris imcompatibility fixed
     in 1.0.8.

  +\bo  Daniel Mack (daniel.mack@nextra.de) contributed a big patch (see
     changelog).

  \e[1m5.3.  Documentation contributions\e[0m


  +\bo  Radek Michalski (radek@end.p-s.com.pl) translates the bftpd docs
     into Polish and also contributes new text.

  \e[1m5.4.  Others\e[0m


  +\bo  Some ideas about code structure and portability where taken from
     betaftpd bei Steinar H. Gunderson. But these were only a few lines!