1# ProFTPD 1.3.x README
2
3## Status
4
5[![TravisCI Build Status](https://travis-ci.org/proftpd/proftpd.svg?branch=master)](https://travis-ci.org/proftpd/proftpd)
6[![CirrusCI Build Status](https://api.cirrus-ci.com/github/proftpd/proftpd.svg?branch=master)](https://cirrus-ci.com/github/proftpd/proftpd)
7[![Coverage Status](https://coveralls.io/repos/proftpd/proftpd/badge.svg?branch=master&service=github)](https://coveralls.io/github/proftpd/proftpd?branch=master)
8[![Coverity Scan Status](https://scan.coverity.com/projects/198/badge.svg)](https://scan.coverity.com/projects/198)
9[![C/C++ Language Grade](https://img.shields.io/lgtm/grade/cpp/g/proftpd/proftpd.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/proftpd/proftpd/context:cpp)
10[![Release](https://img.shields.io/badge/release-1.3.7b-brightgreen)](https://github.com/proftpd/proftpd/releases/latest)
11[![License](https://img.shields.io/badge/license-GPL-brightgreen.svg)](https://img.shields.io/badge/license-GPL-brightgreen.svg)
12
13## Introduction
14
15ProFTPD is a highly configurable FTP daemon for Unix and Unix-like
16operating systems.  See the _**README.ports**_ file for more details about
17the platforms on which ProFTPD in known or thought to build and run.
18
19ProFTPD grew from a desire for a secure and configurable FTP server.
20It was inspired by a significant admiration of the Apache web server.
21Unlike most other Unix FTP servers, it has not been derived from the old
22BSD `ftpd` code base, but is a completely new design and implementation.
23
24ProFTPD's extensive configurability provides systems administrators great
25flexibility in user authentication and access controls, including virtual
26users and easy `chroot()` FTP sessions for individual users.
27
28ProFTPD is popular with many service providers for delivering update
29access to user web pages, without resorting to Unix shell accounts.
30
31## Latest Release
32
33- [ftp://ftp.proftpd.org/distrib/source/](ftp://ftp.proftpd.org/distrib/source/)
34- [http://www.proftpd.org/](http://www.proftpd.org/)
35
36> see _**RELEASE_NOTES**_ for an overview of the changes in this release.
37
38## Major Features
39
40- A single main configuration file, with directives and directive groups patterned after those of the Apache web server.
41- Per directory ".ftpaccess" configuration similar to Apache's ".htaccess".
42- Designed to run either as a stand-alone server or from `inetd`/`xinetd`.
43- Multiple virtual FTP servers and anonymous FTP services.
44- Multiple password files.
45- Shadow password support, including support for expired accounts.
46- Multiple authentication methods, including PAM, LDAP, SQL, and RADIUS.
47- Virtual users.
48- 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.
49- Anonymous FTP and other chroot directories do not require any specific directory structure, executable programs or other system files.
50- Modular architecture with an API that facilitates well structured extensions to meet user needs.
51- Visibility of directories or files controlled based on Unix style permissions or user/group ownership.
52- Logging and `utmp`/`wtmp` support.  Extensible, customizable logging is available.
53- 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.
54- GPLv2 source license.  The source code is available to audit.
55
56## Documentation
57
58- The [doc/](doc/) directory
59- [http://www.proftpd.org/docs/](http://www.proftpd.org/docs/)
60
61## Installation Overview
62
63For detailed installation instructions, see the _**INSTALL**_ file in the root
64directory of the source distribution.
65
66The ProFTPD source distribution is designed to be configured using the GNU
67autotools, so compiling and installing follows the familiar command sequence of
68```bash
69./configure
70make
71make install
72```
73
74However, a significant portion of ProFTPD's configurability is done at compile
75time, so it is highly recommended that you read _**INSTALL**_ and all of the
76_**README.***_ files that pertain to your platform and desired features before
77building the sources.
78
79ProFTPD uses a single configuration file.  A few examples are included in the
80[sample-configurations/](sample-configurations/) subdirectory of the source
81distribution.
82
83On most systems, the `inetd` or `xinetd` configuration must be changed, either
84to remove the current ftpd entry to run ProFTPD standalone, or to change the
85current ftpd entry to use the proftpd daemon.
86
87## Questions
88
89If you have questions, please ask them on the appropriate [mailing lists](http://www.proftpd.org/lists.html).
90
91If you don't understand the documentation, please tell us, so we can explain it
92better.  The general idea is: if you need to ask for help, then something needs
93to be fixed so you (and others) don't need to ask for help.  Asking questions
94helps us to know what needs to be documented, described, and/or fixed.
95