python/hypothesis: update to 6.122.3
[oi-userland.git] / components / network / proftpd / proftpd_migration.txt
blob981ec01d01882bfd1ec0515b7d7fe6ef769cc900
1                  Migration from Solaris WU-FTPD to ProFTPD
4 Introduction
5 ------------
7 This document provides an overview of migrating the Solaris WU-FTPD
8 configuration to Solaris ProFTPD. ProFTPD replaces WU-FTPD in this
9 Oracle Solaris release and has a different configuration system.
11 Migration from the previous Solaris FTP server setup must be done
12 manually.
14 This document contains the following sections:
16     * Section 1 - basic overview of configuration
17     * Section 2 - managing access
18     * Section 3 - virtual host configuration
19     * Section 4 - other options
21 1. Basic overview of configuration
23 WU-FTPD uses several configuration files to manage the FTP server:
25   /etc/ftpd/ftpaccess
26   /etc/ftpd/ftpservers
27   /etc/ftpd/ftphosts
28   /etc/ftpd/ftpconversions
29   /etc/ftpd/ftpgroups
31 These configuration files manage all aspects from general options to
32 account management and virtual servers.
34 Configuration of ProFTPD is contained in /etc/proftpd.conf. It is also
35 possible to manage some options on per-directory basis with .ftpaccess
36 files.
38 ProFTPD consists of a core server and a series of "modules".
39 Configuration of ProFTPD is separated into "contexts" containing
40 "directives".
42 2. Managing access
44 WU-FTPD uses several files to manage access to system:
46   /etc/ftpd/ftpaccess
47   /etc/ftpd/ftphosts
48   /etc/ftpd/ftpgroups
50 ProFTPD uses the "Limit" context to configure access.
52 For backward compatibility /etc/ftpd/ftpusers is provided and
53 /etc/ftpusers is symlink to /etc/ftpd/ftpusers. It is used if
54 UseFtpUsers is set to "on" which is the default setting.
56 2.1. Anonymous access
58 In WU-FTPD anonymous access is enabled by the ftpconfig(1M) command
59 which also created the necessary chroot(1M) environment. ProFTPD does
60 not need chroot(1M) as all access management is handled as part of the
61 "Anonymous" context.
63 2.2. Allow/deny retrieve of files
65 In ProFTPD it is possible to manage access to files on a per-directory
66 basis with .ftpaccess files.
68 2.3. Control of download/upload size
70 Directives are provided for control of download and upload size:
72   MaxRetrieveFileSize - size of downloaded files
73   MaxStoreFileSize - size of uploaded files
75 2.4. Maximum login failures before terminating the FTP connection
77 MaxLoginAttempts controls the maximum number of login failures. The
78 default is 3.
80 3. Virtual host configuration
82 ProFTPD provides a comprehensive set of directives to manage virtual
83 FTP servers. Refer to the VirtualHost documentation for details.
85 4. Other options
87 Other common WU-FTPD /etc/ftpd/ftpaccess options are configured in
88 ProFTPD as follows:
90 4.1. Connection management
92 4.1.1. Limit IP address on which FTP server listens
94 For a standalone FTP server DefaultAddress configures the listener
95 address. For virtual servers the IP addresses are part of the
96 VirtualHost context.
98 4.1.2. IP Class of Service setup
100 ProFTPD does not support manipulation of IP Class of Service within FTP
101 server implementation.
103 4.1.3. Keepalive
105 ProFTPD always sets the SO_KEEPALIVE socket option.
107 4.1.4. TCP window size
109 Directives are provided for control of socket options:
111   SocketOptions - tune socket-level options, including
112                   TCP send/receive window sizes.
114 4.1.5. Enable/disable reverse remote host lookup
116 Reverse DNS lookup is configured using UseReverseDNS, the default is
117 "on".
119 4.2. Session management
121 4.2.1. Timeouts management
123 ProFTPD provides the following set of timeouts:
125   TimeoutIdle - the idle connection timeout
126   TimeoutLinger - the timeout used for lingering closes
127   TimeoutLogin - the login timeout
128   TimeoutNoTransfer - the connection without data transfer timeout
129   TimeoutSession - the timeout for the whole session
130   TimeoutStalled - the timeout on stalled downloads
132 4.2.2. banner option
134 The DisplayConnect directive configures an ASCII text filename which
135 will be displayed to the user when they initially connect but before
136 they login.
138 4.2.3. message option
140 Two directives are provided:
142   DisplayLogin - for message file after login
143   DisplayChdir - for message file after every chdir
145 4.2.4. Control of list options
147 ProFTPD does not allow the use of an external command to generate
148 directory listings. Listing output is controlled by ListOptions.
150 4.3. Process management
152 4.3.1. Setting nice(1)
154 ProFTPD does not provide an interface for changing the nice value.  The
155 nice value needs to managed outside of ProFTPD for example using the
156 nice(1) command.
158 4.3.2. Setting umask
160 Use the Umask directive.
162 4.3.3. E-mail notification for uploads
164 ProFTPD provides /usr/sbin/ftpmail script which reads TranferLog
165 entries and sends e-mail notifications when uploads occur.
167 4.3.4. Shutdown management
169 ftpshut(1M) and ftprestart(1M) commands are provided. The file
170 monitored by FTP server is set to /etc/shutmsg and it is not possible
171 to configure the path.
173 4.4. Log options
175 The ProFTPD mod_log module handles logging. By default it uses
176 syslogd(1M). Control of the log format is provided by the LogFormat
177 directive.
179 4.5. Kerberos support
181 ProFTPD supports Kerberos authentication through the mod_gss module.
183 4.6. Miscellaneous options
185 4.6.1. cdpath
187 Provided by the CDPath directive.
189 4.7. Removed options
191 4.7.1 alias
193 Aliasing of directory paths is not provided by ProFTPD.
195 4.7.2 ftpconversion and compress
197 ftpconversion is not supported by ProFTPD. For compression external
198 modules mod_deflate and mod_gzipfs can be used but they are not
199 provided in the Solaris default installation.
201 4.7.3. SITE EXEC
203 SITE EXEC is not provided by ProFTPD. Consider using other more secure
204 methods for command execution.
206 4.7.4. quota-info
208 quota-info option replacement is not provided by ProFTPD.
210 4.7.5. passive address
212 passive address option replacement is not provided by ProFTPD.
214 -- end --