[08254fc] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[08254fc] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[0aeb696] | 6 |
|
---|
[edeebe2] | 7 | <!ENTITY proftpd-download-http " ">
|
---|
[de65afe] | 8 | <!ENTITY proftpd-download-ftp "ftp://ftp.proftpd.org/distrib/source/proftpd-&proftpd-version;.tar.gz">
|
---|
[e89d59a] | 9 | <!ENTITY proftpd-md5sum "aff1bff40e675244d72c4667f203e5bb">
|
---|
| 10 | <!ENTITY proftpd-size "7.2 MB">
|
---|
| 11 | <!ENTITY proftpd-buildsize "34 MB">
|
---|
[0af9bb66] | 12 | <!ENTITY proftpd-time "0.3 SBU">
|
---|
[08254fc] | 13 | ]>
|
---|
| 14 |
|
---|
[1598426] | 15 | <sect1 id="proftpd" xreflabel="ProFTPD-&proftpd-version;">
|
---|
[ce49e897] | 16 | <?dbhtml filename="proftpd.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>ProFTPD-&proftpd-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="proftpd">
|
---|
| 26 | <primary sortas="a-proftpd">Proftpd</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to ProFTPD</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>ProFTPD</application> package contains a secure
|
---|
| 33 | and highly configurable FTP daemon. This is useful for serving large
|
---|
| 34 | file archives over a network.</para>
|
---|
| 35 |
|
---|
[b8c3180] | 36 | &lfs76_checked;
|
---|
[e5bc4ed] | 37 |
|
---|
[ce49e897] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>Download (HTTP): <ulink url="&proftpd-download-http;"/></para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>Download (FTP): <ulink url="&proftpd-download-ftp;"/></para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>Download MD5 sum: &proftpd-md5sum;</para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>Download size: &proftpd-size;</para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>Estimated disk space required: &proftpd-buildsize;</para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>Estimated build time: &proftpd-time;</para>
|
---|
| 57 | </listitem>
|
---|
| 58 | </itemizedlist>
|
---|
| 59 |
|
---|
| 60 | <bridgehead renderas="sect3">ProFTPD Dependencies</bridgehead>
|
---|
| 61 |
|
---|
| 62 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[e5bc4ed] | 63 | <para role="optional">
|
---|
[2f62a072] | 64 | <xref linkend="linux-pam"/>,
|
---|
[5e0662d] | 65 | <xref linkend="mariadb"/> or <ulink url="http://www.mysql.com/">MySQL</ulink>,
|
---|
[2f62a072] | 66 | <xref linkend="openssl"/>,
|
---|
| 67 | <xref linkend="pcre"/>,
|
---|
[e89d59a] | 68 | <xref linkend="postgresql"/> and to run tests:
|
---|
[e5bc4ed] | 69 | <xref linkend="check"/> and
|
---|
| 70 | <ulink url='http://search.cpan.org/~clemburg/Test-Unit-0.14/'>Test::Unit-0.14</ulink>
|
---|
| 71 | </para>
|
---|
[ce49e897] | 72 |
|
---|
[3cb0c57] | 73 | <para condition="html" role="usernotes">User Notes:
|
---|
| 74 | <ulink url="&blfs-wiki;/proftpd"/></para>
|
---|
| 75 |
|
---|
[ce49e897] | 76 | </sect2>
|
---|
| 77 |
|
---|
| 78 | <sect2 role="installation">
|
---|
| 79 | <title>Installation of ProFTPD</title>
|
---|
| 80 |
|
---|
| 81 | <para>For security reasons, you should install
|
---|
| 82 | <application>ProFTPD</application> using an unprivileged user and group.
|
---|
| 83 | As the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 84 |
|
---|
[283bd88] | 85 | <screen role="root"><userinput>groupadd -g 46 proftpd &&
|
---|
[13be1e2] | 86 | useradd -c proftpd -d /srv/ftp -g proftpd \
|
---|
[283bd88] | 87 | -s /usr/bin/proftpdshell -u 46 proftpd &&
|
---|
| 88 |
|
---|
[13be1e2] | 89 | install -v -d -m775 -o proftpd -g proftpd /srv/ftp &&
|
---|
[b8c3180] | 90 | ln -sfv /bin/false /usr/bin/proftpdshell &&
|
---|
[13be1e2] | 91 | echo /usr/bin/proftpdshell >> /etc/shells</userinput></screen>
|
---|
[08254fc] | 92 |
|
---|
[4c288b0] | 93 | <para>Install <application>ProFTPD</application> as an unprivileged user by
|
---|
[ce49e897] | 94 | running the following commands:</para>
|
---|
[08254fc] | 95 |
|
---|
[e5bc4ed] | 96 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var/run &&
|
---|
[ce49e897] | 97 | make</userinput></screen>
|
---|
[1728f4e] | 98 |
|
---|
[e5bc4ed] | 99 | <para>The tests for this package require a very old (2001) version of the
|
---|
[e89d59a] | 100 | Perl Module Test::Unit. Even when using that version of Test::Unit, there
|
---|
| 101 | are many failures (41/1397) although the program appears to run
|
---|
| 102 | well. The tests take a long time (45 minutes, not CPU dependent) and are
|
---|
| 103 | not recommended. To test the results anyway, add the switch: <parameter>
|
---|
| 104 | --enable-tests</parameter> to the <command>configure</command>, and
|
---|
| 105 | issue: <command>make check</command>. If the tests are run with root
|
---|
| 106 | privileges, more tests are run, but there are more failures.</para>
|
---|
[e5bc4ed] | 107 |
|
---|
[ce49e897] | 108 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[08254fc] | 109 |
|
---|
[ce49e897] | 110 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[08254fc] | 111 |
|
---|
[ce49e897] | 112 | </sect2>
|
---|
[08254fc] | 113 |
|
---|
[ce49e897] | 114 | <sect2 role="commands">
|
---|
| 115 | <title>Command Explanations</title>
|
---|
[1728f4e] | 116 |
|
---|
[ce49e897] | 117 | <para><command>install -v -d -m775 -o proftpd -g proftpd
|
---|
[13be1e2] | 118 | /srv/ftp</command>: Create the home directory for
|
---|
[ce49e897] | 119 | <application>ProFTPD</application>.</para>
|
---|
[1728f4e] | 120 |
|
---|
[13be1e2] | 121 | <para><command>ln -v -s /bin/false /usr/bin/proftpdshell</command>:
|
---|
[4c288b0] | 122 | Set the default shell as a link to an invalid shell.</para>
|
---|
[1728f4e] | 123 |
|
---|
[13be1e2] | 124 | <para><command>echo /usr/bin/proftpdshell >>
|
---|
[bfb7882] | 125 | /etc/shells</command>: Fake a valid shell for compatibility purposes.</para>
|
---|
[1728f4e] | 126 |
|
---|
[ce49e897] | 127 | <note>
|
---|
[13be1e2] | 128 | <para>The above two commands can be omitted if the following directive is
|
---|
[ce49e897] | 129 | placed in the configuration file:</para>
|
---|
[1728f4e] | 130 |
|
---|
[ce49e897] | 131 | <screen><literal>RequireValidShell off</literal></screen>
|
---|
[1728f4e] | 132 |
|
---|
[ce49e897] | 133 | <para>By default, proftpd will require that users logging in have valid
|
---|
| 134 | shells. The RequireValidShell directive turns off this requirement. This
|
---|
| 135 | is only recommended if you are setting up your FTP server exclusively
|
---|
| 136 | for anonymous downloads.</para>
|
---|
| 137 | </note>
|
---|
[08254fc] | 138 |
|
---|
[2f62a072] | 139 | <note>
|
---|
| 140 | <para>
|
---|
| 141 | Support for most of the dependency packages requires using options
|
---|
| 142 | passed to the <command>configure</command> script. View the output
|
---|
| 143 | from <command>./configure --help</command> for complete information
|
---|
| 144 | about enabling dependency packages.
|
---|
| 145 | </para>
|
---|
| 146 | </note>
|
---|
[08254fc] | 147 |
|
---|
[ce49e897] | 148 | </sect2>
|
---|
[08254fc] | 149 |
|
---|
[ce49e897] | 150 | <sect2 role="configuration">
|
---|
| 151 | <title>Configuring ProFTPD</title>
|
---|
[1728f4e] | 152 |
|
---|
[ce49e897] | 153 | <sect3 id='proftpd-config'>
|
---|
| 154 | <title>Config Files</title>
|
---|
[1728f4e] | 155 |
|
---|
[ce49e897] | 156 | <para><filename>/etc/proftpd.conf</filename></para>
|
---|
[1728f4e] | 157 |
|
---|
[ce49e897] | 158 | <indexterm zone="proftpd proftpd-config">
|
---|
| 159 | <primary sortas="e-etc-proftpd">/etc/proftpd.conf</primary>
|
---|
| 160 | </indexterm>
|
---|
[1586494] | 161 |
|
---|
[ce49e897] | 162 | </sect3>
|
---|
[08254fc] | 163 |
|
---|
[ce49e897] | 164 | <sect3>
|
---|
| 165 | <title>Configuration Information</title>
|
---|
[08254fc] | 166 |
|
---|
[ce49e897] | 167 | <para>This is a simple, download-only sample configuration. See the
|
---|
| 168 | <application>ProFTPD</application> documentation in
|
---|
| 169 | <filename class="directory">/usr/share/doc/proftpd</filename> and
|
---|
| 170 | consult the website at <ulink url="http://www.proftpd.org/"/> for
|
---|
| 171 | example configurations.</para>
|
---|
[1728f4e] | 172 |
|
---|
[8e37798] | 173 | <screen role="root"><?dbfo keep-together="auto"?><userinput>cat > /etc/proftpd.conf << "EOF"
|
---|
[ce49e897] | 174 | <literal># This is a basic ProFTPD configuration file
|
---|
[08254fc] | 175 | # It establishes a single server and a single anonymous login.
|
---|
| 176 |
|
---|
| 177 | ServerName "ProFTPD Default Installation"
|
---|
| 178 | ServerType standalone
|
---|
| 179 | DefaultServer on
|
---|
| 180 |
|
---|
| 181 | # Port 21 is the standard FTP port.
|
---|
| 182 | Port 21
|
---|
| 183 | # Umask 022 is a good standard umask to prevent new dirs and files
|
---|
| 184 | # from being group and world writable.
|
---|
| 185 | Umask 022
|
---|
| 186 |
|
---|
| 187 | # To prevent DoS attacks, set the maximum number of child processes
|
---|
| 188 | # to 30. If you need to allow more than 30 concurrent connections
|
---|
| 189 | # at once, simply increase this value. Note that this ONLY works
|
---|
| 190 | # in standalone mode, in inetd mode you should use an inetd server
|
---|
| 191 | # that allows you to limit maximum number of processes per service
|
---|
[59048cd9] | 192 | <!--# (such as xinetd)-->
|
---|
[08254fc] | 193 | MaxInstances 30
|
---|
| 194 |
|
---|
| 195 | # Set the user and group that the server normally runs at.
|
---|
| 196 | User proftpd
|
---|
| 197 | Group proftpd
|
---|
| 198 |
|
---|
[e89d59a] | 199 | # To cause every FTP user to be "jailed" (chrooted) into their home
|
---|
| 200 | # directory, uncomment this line.
|
---|
| 201 | #DefaultRoot ~
|
---|
| 202 |
|
---|
| 203 |
|
---|
[1586494] | 204 | # Normally, files should be overwritable.
|
---|
[08254fc] | 205 | <Directory /*>
|
---|
| 206 | AllowOverwrite on
|
---|
| 207 | </Directory>
|
---|
| 208 |
|
---|
| 209 | # A basic anonymous configuration, no upload directories.
|
---|
| 210 | <Anonymous ~proftpd>
|
---|
| 211 | User proftpd
|
---|
| 212 | Group proftpd
|
---|
[1586494] | 213 | # Clients should be able to login with "anonymous" as well as "proftpd"
|
---|
[08254fc] | 214 | UserAlias anonymous proftpd
|
---|
| 215 |
|
---|
| 216 | # Limit the maximum number of anonymous logins
|
---|
| 217 | MaxClients 10
|
---|
| 218 |
|
---|
[1586494] | 219 | # 'welcome.msg' should be displayed at login, and '.message' displayed
|
---|
[08254fc] | 220 | # in each newly chdired directory.
|
---|
| 221 | DisplayLogin welcome.msg
|
---|
[e5bc4ed] | 222 | DisplayChdir .message
|
---|
[08254fc] | 223 |
|
---|
| 224 | # Limit WRITE everywhere in the anonymous chroot
|
---|
| 225 | <Limit WRITE>
|
---|
| 226 | DenyAll
|
---|
| 227 | </Limit>
|
---|
[ce49e897] | 228 | </Anonymous></literal>
|
---|
| 229 | EOF</userinput></screen>
|
---|
| 230 |
|
---|
| 231 | </sect3>
|
---|
| 232 |
|
---|
| 233 | <sect3 id="proftpd-init">
|
---|
[2b27f103] | 234 | <title>Systemd Units</title>
|
---|
[ce49e897] | 235 |
|
---|
[2b27f103] | 236 | <para>
|
---|
| 237 | To start the <command>proftpd</command> daemon at boot,
|
---|
| 238 | install the systemd unit from the <xref linkend="bootscripts"/>
|
---|
| 239 | package by running the following command as the
|
---|
| 240 | <systemitem class="username">root</systemitem> user:
|
---|
| 241 | </para>
|
---|
[ce49e897] | 242 |
|
---|
| 243 | <indexterm zone="proftpd proftpd-init">
|
---|
| 244 | <primary sortas="f-proftpd">proftpd</primary>
|
---|
| 245 | </indexterm>
|
---|
| 246 |
|
---|
| 247 | <screen role="root"><userinput>make install-proftpd</userinput></screen>
|
---|
| 248 |
|
---|
| 249 | </sect3>
|
---|
| 250 |
|
---|
| 251 | </sect2>
|
---|
| 252 |
|
---|
| 253 | <sect2 role="content">
|
---|
| 254 | <title>Contents</title>
|
---|
| 255 |
|
---|
| 256 | <segmentedlist>
|
---|
| 257 | <segtitle>Installed Programs</segtitle>
|
---|
| 258 | <segtitle>Installed Libraries</segtitle>
|
---|
| 259 | <segtitle>Installed Directory</segtitle>
|
---|
| 260 |
|
---|
| 261 | <seglistitem>
|
---|
[0d7900a] | 262 | <seg>ftpcount, ftpdctl, ftpasswd, ftpmail, ftpquota, ftpscrub,
|
---|
[10405e6] | 263 | ftptop, ftpshut, ftpcount, ftpwho, and proftpd</seg>
|
---|
[ce49e897] | 264 | <seg>None</seg>
|
---|
[2f62a072] | 265 | <seg>/usr/lib/proftpd</seg>
|
---|
[ce49e897] | 266 | </seglistitem>
|
---|
| 267 | </segmentedlist>
|
---|
| 268 |
|
---|
| 269 | <variablelist>
|
---|
| 270 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 271 | <?dbfo list-presentation="list"?>
|
---|
| 272 | <?dbhtml list-presentation="table"?>
|
---|
| 273 |
|
---|
| 274 | <varlistentry id="proftpd-prog">
|
---|
| 275 | <term><command>proftpd</command></term>
|
---|
| 276 | <listitem>
|
---|
| 277 | <para>is the FTP daemon.</para>
|
---|
| 278 | <indexterm zone="proftpd proftpd-prog">
|
---|
| 279 | <primary sortas="b-proftpd">proftpd</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
| 284 | <varlistentry id="ftpcount">
|
---|
| 285 | <term><command>ftpcount</command></term>
|
---|
| 286 | <listitem>
|
---|
| 287 | <para>shows the current number of connections.</para>
|
---|
| 288 | <indexterm zone="proftpd ftpcount">
|
---|
| 289 | <primary sortas="b-ftpcount">ftpcount</primary>
|
---|
| 290 | </indexterm>
|
---|
| 291 | </listitem>
|
---|
| 292 | </varlistentry>
|
---|
| 293 |
|
---|
[e5bc4ed] | 294 | <varlistentry id="ftpdctl">
|
---|
| 295 | <term><command>ftpdctl</command></term>
|
---|
| 296 | <listitem>
|
---|
| 297 | <para>is used to control the proftpd daemon while it is running.</para>
|
---|
| 298 | <indexterm zone="proftpd ftpdctl">
|
---|
| 299 | <primary sortas="b-ftpdctl">ftpdctl</primary>
|
---|
| 300 | </indexterm>
|
---|
| 301 | </listitem>
|
---|
| 302 | </varlistentry>
|
---|
| 303 |
|
---|
| 304 | <varlistentry id="ftpasswd">
|
---|
| 305 | <term><command>ftpasswd</command></term>
|
---|
| 306 | <listitem>
|
---|
[0d7900a] | 307 | <para>is a Perl script designed to create and manage
|
---|
[e5bc4ed] | 308 | AuthUserFiles and AuthGroupFiles of the correct format for proftpd.</para>
|
---|
| 309 | <indexterm zone="proftpd ftpasswd">
|
---|
| 310 | <primary sortas="b-ftpasswd">ftpasswd</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 |
|
---|
| 315 | <varlistentry id="ftpmail">
|
---|
| 316 | <term><command>ftpmail</command></term>
|
---|
| 317 | <listitem>
|
---|
[601a838] | 318 | <para>is a Perl script for sending email based on the proftpd TransferLog.
|
---|
[e5bc4ed] | 319 | </para>
|
---|
| 320 | <indexterm zone="proftpd ftpmail">
|
---|
| 321 | <primary sortas="b-ftpmail">ftpmail</primary>
|
---|
| 322 | </indexterm>
|
---|
| 323 | </listitem>
|
---|
| 324 | </varlistentry>
|
---|
| 325 |
|
---|
| 326 | <varlistentry id="ftpquota">
|
---|
| 327 | <term><command>ftpquota</command></term>
|
---|
| 328 | <listitem>
|
---|
[0d7900a] | 329 | <para>is a Perl script designed to create and manage limits and tally
|
---|
| 330 | files for the mod_quotatab + mod_quotatab_file module combination
|
---|
[e5bc4ed] | 331 | for proftpd.</para>
|
---|
| 332 | <indexterm zone="proftpd ftpquota">
|
---|
| 333 | <primary sortas="b-ftpquota">ftpquota</primary>
|
---|
| 334 | </indexterm>
|
---|
| 335 | </listitem>
|
---|
| 336 | </varlistentry>
|
---|
| 337 |
|
---|
| 338 | <varlistentry id="ftpscrub">
|
---|
| 339 | <term><command>ftpscrub</command></term>
|
---|
| 340 | <listitem>
|
---|
| 341 | <para>provides a way to scrub the scoreboard file on demand.</para>
|
---|
| 342 | <indexterm zone="proftpd ftpscrub">
|
---|
| 343 | <primary sortas="b-ftpscrub">ftpscrub</primary>
|
---|
| 344 | </indexterm>
|
---|
| 345 | </listitem>
|
---|
| 346 | </varlistentry>
|
---|
| 347 |
|
---|
[ce49e897] | 348 | <varlistentry id="ftpshut">
|
---|
| 349 | <term><command>ftpshut</command></term>
|
---|
| 350 | <listitem>
|
---|
| 351 | <para>shuts down all <application>proftpd</application> servers
|
---|
| 352 | at a given time.</para>
|
---|
| 353 | <indexterm zone="proftpd ftpshut">
|
---|
| 354 | <primary sortas="b-ftpshut">ftpshut</primary>
|
---|
| 355 | </indexterm>
|
---|
| 356 | </listitem>
|
---|
| 357 | </varlistentry>
|
---|
| 358 |
|
---|
| 359 | <varlistentry id="ftptop">
|
---|
| 360 | <term><command>ftptop</command></term>
|
---|
| 361 | <listitem>
|
---|
| 362 | <para>displays running status on connections.</para>
|
---|
| 363 | <indexterm zone="proftpd ftptop">
|
---|
| 364 | <primary sortas="b-ftptop">ftptop</primary>
|
---|
| 365 | </indexterm>
|
---|
| 366 | </listitem>
|
---|
| 367 | </varlistentry>
|
---|
| 368 |
|
---|
| 369 | <varlistentry id="ftpwho">
|
---|
| 370 | <term><command>ftpwho</command></term>
|
---|
| 371 | <listitem>
|
---|
| 372 | <para>shows current process information for each session.</para>
|
---|
| 373 | <indexterm zone="proftpd ftpwho">
|
---|
| 374 | <primary sortas="b-ftpwho">ftpwho</primary>
|
---|
| 375 | </indexterm>
|
---|
| 376 | </listitem>
|
---|
| 377 | </varlistentry>
|
---|
| 378 |
|
---|
| 379 | </variablelist>
|
---|
| 380 |
|
---|
| 381 | </sect2>
|
---|
[1598426] | 382 |
|
---|
| 383 | </sect1>
|
---|