proftpd  1.3.6b
About: ProFTPD is a highly configurable FTP server software (with FTPS and SFTP support).
  Fossies Dox: proftpd-1.3.6b.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

proftpd Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies
  4. proftpd-1.3.6b.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

ProFTPD 1.3.x README

Status

Build Status Coverage Status Coverity Scan Status Release License

Introduction

ProFTPD is a highly configurable FTP daemon for Unix and Unix-like operating systems. See the README.ports file for more details about the platforms on which ProFTPD in known or thought to build and run.

ProFTPD grew from a desire for a secure and configurable FTP server. It was inspired by a significant admiration of the Apache web server. Unlike most other Unix FTP servers, it has not been derived from the old BSD ftpd code base, but is a completely new design and implementation.

ProFTPD's extensive configurability provides systems administrators great flexibility in user authentication and access controls, including virtual users and easy chroot() FTP sessions for individual users.

ProFTPD is popular with many service providers for delivering update access to user web pages, without resorting to Unix shell accounts.

Latest Release

see RELEASE_NOTES for an overview of the changes in this release.

Major Features

  • A single main configuration file, with directives and directive groups patterned after those of the Apache web server.

  • Per directory ".ftpaccess" configuration similar to Apache's ".htaccess".

  • Designed to run either as a stand-alone server or from inetd/xinetd.

  • Multiple virtual FTP servers and anonymous FTP services.

  • Multiple password files.

  • Shadow password support, including support for expired accounts.

  • Multiple authentication methods, including PAM, LDAP, SQL, and RADIUS.

  • Virtual users.

  • ProFTPD never executes any external program at any time. There is no SITE EXEC command, and all file and directory listings are generated internally, without using an external ls command.

  • Anonymous FTP and other chroot directories do not require any specific directory structure, executable programs or other system files.

  • Modular architecture with an API that facilitates well structured extensions to meet user needs.

  • Visibility of directories or files controlled based on Unix style permissions or user/group ownership.

  • Logging and utmp/wtmp support. Logging is compatible with wu-ftpd, and extended, customizable logging is available.

  • If supported by the capabilities the host system, it can run as a non-privileged user in stand-alone mode, thwarting attacks aimed at exploiting "root" privileges.

  • GPLv2 source license. The source code is available to audit.

Documentation

Installation Overview

For detailed installation instructions, see the INSTALL file in the root directory of the source distribution.

The ProFTPD source distribution is designed to be configured using the GNU autotools, so compiling and installing follows the familiar command sequence of

$ ./configure
$ make
$ make install

However, a significant portion of ProFTPD's configurability is done at compile time, so it is highly recommended that you read INSTALL and all of the README.* files that pertain to your platform and desired features before building the sources.

ProFTPD uses a single configuration file. A few examples are included in the sample-configurations/ subdirectory of the source distribution.

On most systems, the inetd or xinetd configuration must be changed, either to remove the current ftpd entry to run ProFTPD standalone, or to change the current ftpd entry to use the proftpd daemon.

Questions

If you have questions, please ask them on the appropriate mailing lists.

If you don't understand the documentation, please tell us, so we can explain it better. The general idea is: if you need to ask for help, then something needs to be fixed so you (and others) don't need to ask for help. Asking questions helps us to know what needs to be documented, described, and/or fixed.