source: server/major/vsftpd.xml@ f8ff412

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY vsftpd-download-http " ">
  <!ENTITY vsftpd-download-ftp  "ftp://vsftpd.beasts.org/users/cevans/vsftpd-&vsftpd-version;.tar.gz">
  <!ENTITY vsftpd-md5sum        "63838791ec8b1375ed154fb2603e52e9">
  <!ENTITY vsftpd-size          "148 KB">
  <!ENTITY vsftpd-buildsize     "492 KB">
  <!ENTITY vsftpd-time          "0.01 SBU">
]>

<sect1 id="vsftpd" xreflabel="vsFTPD-&vsftpd-version;">
  <?dbhtml filename="vsftpd.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>vsFTPD-&vsftpd-version;</title>

  <indexterm zone="vsftpd">
    <primary sortas="a-vsFTPD">vsFTPD</primary>
  </indexterm>

  <sect2>
    <title>Introduction to vsFTPD</title>

    <para>The <application>vsFTPD</application> package contains a very
    secure and very small FTP daemon. This is useful for serving files
    over a network.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&vsftpd-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&vsftpd-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &vsftpd-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &vsftpd-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &vsftpd-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &vsftpd-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">vsFTPD Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="Linux_PAM"/>,
    <xref linkend="openssl"/>, and
    <xref linkend="tcpwrappers"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of vsFTPD</title>

    <para>For security reasons, running <application>vsFTPD</application>
    as an unprivileged user and group is encouraged. Also, a user to map
    anonymous users to should be created.</para>

<screen role="root"><userinput>install -v -d -m 0755 /var/ftp/empty &amp;&amp;
install -v -d -m 0755 /home/ftp &amp;&amp;
groupadd vsftpd &amp;&amp;
useradd -d /dev/null -c "vsFTPD User" -g vsftpd -s /bin/false vsftpd &amp;&amp;
groupadd ftp &amp;&amp;
useradd -c anonymous_user -d /home/ftp -g ftp -s /bin/false ftp</userinput></screen>

    <para>Install <application>vsFTPD</application> by running
    the following commands:</para>

<screen><userinput>make &amp;&amp;
install -v -m 755 vsftpd /usr/sbin/vsftpd &amp;&amp;
install -v -m 644 vsftpd.8 /usr/share/man/man8 &amp;&amp;
install -v -m 644 vsftpd.conf.5 /usr/share/man/man5 &amp;&amp;
install -v -m 644 vsftpd.conf /etc</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>install -v -d [...]</parameter>: This creates the
    directory that anonymous users will use (<filename
    class='directory'>/home/ftp</filename>)
    and the directory the daemon will chroot into
    (<filename class='directory'>/var/ftp/empty</filename>).</para>

    <note>
      <para><filename class="directory">/home/ftp</filename> should not be
      owned by the user <systemitem class="username">vsftpd</systemitem>,
      or the user <systemitem class="username">ftp</systemitem>.</para>
    </note>

    <para><option>echo "#define VSF_BUILD_TCPWRAPPERS" >>builddefs.h</option>:
    Use this prior to <command>make</command> to add support for
    <application>tcpwrappers</application>.</para>

    <para><option>echo "#define VSF_BUILD_SSL" >>builddefs.h</option>:
    Use this prior to <command>make</command> to add support for SSL.</para>

    <para><option>install -m [...]</option>:
    The <filename>Makefile</filename> hardwires
    <filename class='directory'>/usr/local</filename> (if it exists). These
    commands install the files in
    <filename class='directory'>/usr</filename>.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring vsFTPD</title>

    <sect3 id="vsftpd-config">
      <title>Config Files</title>

      <para><filename>/etc/vsftpd.conf</filename></para>

      <indexterm zone="vsftpd vsftpd-config">
        <primary sortas="e-etc-vsftpd.conf">/etc/vsftpd.conf</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para><application>vsFTPD</application> comes with a basic
      anonymous-only configuration file that was copied to
      <filename class='directory'>/etc</filename> above. This file should be
      modified because it is now recommended to run <command>vsftpd</command>
      in standalone mode as opposed to
      <command>inetd</command>/<command>xinetd</command> mode. Also, you
      should specify the privilege separation user created above. Finally,
      you should specify the <command>chroot</command> directory.
      <command>man vsftpd.conf</command> will give you all the details.</para>

<screen role="root"><userinput>cat &gt;&gt; /etc/vsftpd.conf &lt;&lt; "EOF"
<literal>background=YES
listen=YES
nopriv_user=vsftpd
secure_chroot_dir=/var/ftp/empty</literal>
EOF</userinput></screen>

    </sect3>

    <sect3  id="vsftpd-init">
      <title>Boot Script</title>

      <para>Install the <filename>/etc/rc.d/init.d/vsftpd</filename>
      init script included in the
      <xref linkend="intro-important-bootscripts"/> package.</para>

<screen role="root"><userinput>make install-vsftpd</userinput></screen>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>vsftpd</seg>
        <seg>None</seg>
        <seg>Not determined at this time</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="vsftpd-prog">
        <term><command>vsftpd</command></term>
        <listitem>
          <para>is the FTP daemon.</para>
          <indexterm zone="vsftpd vsftpd-prog">
            <primary sortas="b-vsftpd">vsftpd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>