You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by wr...@apache.org on 2007/02/18 00:54:21 UTC
svn commit: r508829 - in /httpd/mod_ftp/trunk/docs/manual/mod: mod_ftp.html
mod_ftp.html.en
Author: wrowe
Date: Sat Feb 17 15:54:20 2007
New Revision: 508829
URL: http://svn.apache.org/viewvc?view=rev&rev=508829
Log:
Whoops - apparently I hadn't checked in the generated mod_ftp page.
Added:
httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html (with props)
httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en (with props)
Added: httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html
URL: http://svn.apache.org/viewvc/httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html?view=auto&rev=508829
==============================================================================
Binary file - no diff available.
Propchange: httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html
------------------------------------------------------------------------------
svn:mime-type = application/x-type-map
Added: httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en
URL: http://svn.apache.org/viewvc/httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en?view=auto&rev=508829
==============================================================================
--- httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en (added)
+++ httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en Sat Feb 17 15:54:20 2007
@@ -0,0 +1,645 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>mod_ftp - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body>
+<div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.3</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Modules</a></div>
+<div id="page-content">
+<div id="preamble"><h1>Apache Module mod_ftp</h1>
+<div class="toplang">
+<p><span>Available Languages: </span><a href="../en/mod/mod_ftp.html" title="English"> en </a></p>
+</div>
+<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides support for the File Transfer Protocol</td></tr>
+<tr><th><a href="module-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>ftp_module</td></tr>
+<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_ftp.c</td></tr>
+<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Apache 2.3 and higher</td></tr></table>
+<h3>Summary</h3>
+
+ <p>This module provides support for the File Transfer Protocol
+ within the Apache HTTP Server. It was originally developed by
+ Covalent Technologies, Inc. and contributed by them to the
+ Apache HTTP Server project.</p>
+
+ <p>The FTP protocol module for Apache can work with the access
+ control modules, mod_ssl and any dynamic content generator to
+ provide veratile, scalable and secure FTP services.</p>
+
+ <p>Further details, discussion and examples are provided in the <a href="../ftp/">FTP documentation</a>.</p>
+ </div>
+<div id="quickview"><h3 class="directives">Directives</h3>
+<ul id="toc">
+<li><img alt="" src="../images/down.gif" /> <a href="#ftp">FTP</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpactiverange">FTPActiveRange</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpbannermessage">FTPBannerMessage</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpdatablocksize">FTPDataBlockSize</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpdirumask">FTPDirUmask</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpdocrootenv">FTPDocRootEnv</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpexitmessage">FTPExitMessage</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftphomedir">FTPHomeDir</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpimplicitssl">FTPImplicitSSL</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpjailuser">FTPJailUser</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftplimitdbfile">FTPLimitDBFile</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftplimitloginip">FTPLimitLoginIP</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftplimitloginserver">FTPLimitLoginServer</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftplimitloginuser">FTPLimitLoginUser</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpmaxloginattempts">FTPMaxLoginAttempts</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpoptions">FTPOptions</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftppasvaddr">FTPPASVaddr</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftppasvbindaddr">FTPPASVbindaddr</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftppasvrange">FTPPASVrange</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpreadmemessage">FTPReadmeMessage</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftptimeoutdata">FTPTimeoutData</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftptimeoutidle">FTPTimeoutIdle</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftptimeoutlogin">FTPTimeoutLogin</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#ftpumask">FTPUmask</a></li>
+</ul>
+<h3>See also</h3>
+<ul class="seealso">
+<li><a href="../ftp/">FTP Documentation</a></li>
+<li><code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code></li>
+</ul></div>
+
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTP" id="FTP">FTP</a> <a name="ftp" id="ftp">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Run an FTP Server on this host</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTP on|off</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTP off</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>You must define a <code class="directive">Listen</code> directive to
+ listen for FTP requests. This directive is <strong>not</strong>
+ inherited from the global configuration file.</p>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPActiveRange" id="FTPActiveRange">FTPActiveRange</a> <a name="ftpactiverange" id="ftpactiverange">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ports the server will use for connecting to the
+ client</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPActiveRange <em>min [max]</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>If this directive is not specified, the server will use
+ random high-numbered ports</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive defines the port or ports that the Covalent
+ Enterprise FTP Server will use when making an active connection
+ to the client. It accepts one or two arguments. If only one
+ argument is given, the server will always use that port. If
+ two arguments are given, the server will treat them as a range
+ of ports to be used.</p>
+
+ <div class="note"><p>By default, Apache will not allow the FTP server to use
+ privileged ports for active connections. If you specify a
+ port range under 1024 in FTPActiveRange, the server will
+ default to a random high-level port instead.
+ </p>
+ </div>
+ <div class="example"><p><code>FTPActiveRange 5050</code></p><p>Force the server to use port 5050</p><p><code>FTPActiveRange 5050 5080</code></p><p>Allow the server to use any port between 5050 and 5080,
+ inclusive.</p></div>
+ <div class="note">This directive is inherited to all virtual hosts from
+ the global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPBannerMessage" id="FTPBannerMessage">FTPBannerMessage</a> <a name="ftpbannermessage" id="ftpbannermessage">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set initial login message</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPBannerMessage
+ <em>message</em>|<em>file:/path/to/file</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive sets a <em>message</em> that is displayed to
+ the client on initial connection. This can either be a string,
+ or a path to a file. The message can contain a variety of
+ meta-characters:</p>
+ <table>
+ <tr><th><code>%T</code></th><td>Local time (in the form <code>Mon Apr 29
+ 20:36:48 2002</code>)</td></tr>
+ <tr><th><code>%C</code></th><td>Current working directory</td></tr>
+ <tr><th><code>%h</code></th><td>Remote host</td></tr>
+ <tr><th><code>%L</code></th><td>Local host</td></tr>
+ <tr><th><code>%E</code></th><td>Server administrator (as given by
+ <code class="directive"><a href="../mod/core.html#serveradmin">ServerAdmin</a></code>)</td></tr>
+ <tr><th><code>%a</code></th><td>Remote IP-address</td></tr>
+ <tr><th><code>%A</code></th><td>Local IP-address</td></tr>
+ <tr><th><code>%u</code></th><td>Remote user</td></tr>
+ <tr><th><code>%f</code></th><td>Number of files transferred</td></tr>
+ <tr><th><code>%t</code></th><td>Total number of bytes downloaded</td></tr>
+ <tr><th><code>%x</code></th><td>Number of data transfers</td></tr>
+ <tr><th><code>%b</code></th><td>Total traffic for the session (both
+ control and data)</td></tr>
+ </table>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPDataBlockSize" id="FTPDataBlockSize">FTPDataBlockSize</a> <a name="ftpdatablocksize" id="ftpdatablocksize">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Block size in bytes to use during data transfers</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code /></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code /></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <div class="note">Not documented by Covalent</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPDirUmask" id="FTPDirUmask">FTPDirUmask</a> <a name="ftpdirumask" id="ftpdirumask">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the umask for created directory</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPDirUmask <em>umask</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unknown</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <div class="note">Not documented by Covalent</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPDocRootEnv" id="FTPDocRootEnv">FTPDocRootEnv</a> <a name="ftpdocrootenv" id="ftpdocrootenv">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the DocumentRoot based on the given environment
+ variable, such as a per-user LDAP property</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPDocRootEnv <em>envvar</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive will cause FTP to use the value of the
+ <code>envvar</code> environment variable in place of the
+ default <code>DocumentRoot</code>, if the environment variable
+ is defined. The <code>envvar</code> variable must contain a
+ full, rooted file path, e.g. <code>/some/path</code> on Unix
+ or <code>d:/some/path</code> on Windows.</p>
+
+ <p>This may be used with the <code class="directive">CovalentLDAPPassProperty
+ </code> directive, or other directives that provide an
+ environment variable assignment, to change FTP's Document Root
+ on a per-user basis.</p>
+ <div class="example"><p><code>CovalentLDAPPassProperty homeDir </code></p><p><code>FTPDocRootEnv homeDir</code></p><p>Extract a user's LDAP <code>homeDir</code> property, and
+ then use it for the user's FTP Document Root.</p></div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPExitMessage" id="FTPExitMessage">FTPExitMessage</a> <a name="ftpexitmessage" id="ftpexitmessage">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set logout message</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPExitMessage
+ <em>message</em>|<em>file:/path/to/file</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code /></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table><p>This directive sets a <em>message</em> that is displayed to
+ the client on disconnect. This can either be a string, or a
+ path to a file. The message can contain a variety of
+ meta-characters (see
+ <code class="directive"><a href="#ftpbannermessage">FTPBannerMessage</a></code>).</p>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPHomeDir" id="FTPHomeDir">FTPHomeDir</a> <a name="ftphomedir" id="ftphomedir">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the path to directory
+ containing user's home directories</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPHomeDir /directory</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table><p>This directive defines where the user home <em>directory</em>
+ is located. This directory must be given as an absolute path,
+ but is actually relative to the configured
+ <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> for the server. For
+ example, <code>FTPHomeDir /home</code> will cause the Apache FTP
+ Server to look for the user home in the directory <code class="directive"><a href="../mod/code.html#documentroot">DocumentRoot</a></code><code>/home/</code><code>username</code>
+ (where <em>username</em> is the login name of the user).</p>
+ <p>If <code class="directive">FTPHomeDir</code> has been specified and
+ the home directory for the user does not exist, the server logs
+ an error and user is logged into the root
+ ("<code>/</code>") directory. If you want the home
+ directory created automatically, see the
+ <code class="directive">CreateHomeDirs</code> option to the
+ <code class="directive"><a href="#ftpoptions">FTPOptions</a></code> directive.</p>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPImplicitSSL" id="FTPImplicitSSL">FTPImplicitSSL</a> <a name="ftpimplicitssl" id="ftpimplicitssl">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use SSL implicitly</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPImplicitSSL on|off</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPImplicitSSL off</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive determines the security on the control
+ connection when the user connects. When set to
+ <code>On</code>, the user is expected to connect using SSL.
+ When set to <code>Off</code>, the user must connect insecurely
+ then issue the <code>AUTH</code> command to start a secure
+ session.</p>
+ <div class="note">This directive is <strong>not</strong> inherited from the global
+ configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPJailUser" id="FTPJailUser">FTPJailUser</a> <a name="ftpjailuser" id="ftpjailuser">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Users are not allowed to leave their home
+ directories</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPJailUser on|off</code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPJailUser off</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive confines the user to the directory tree in
+ which they were placed upon login. The user can access any
+ subdirectory of their default directory, but cannot access the
+ parent directory or any other related directories.</p>
+ <p>If the <code class="directive"><a href="#ftphomedir">FTPHomeDir</a></code>
+ directive is not used, then <code class="directive">FTPJailUser</code>
+ has no effect. This combination of directives can be very
+ powerful for restricting where in your filesystem users may
+ traverse.</p>
+ <div class="note">This directive is <strong>not</strong> inherited from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPLimitDBFile" id="FTPLimitDBFile">FTPLimitDBFile</a> <a name="ftplimitdbfile" id="ftplimitdbfile">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the location for the Login Limit DB file</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPLimitDBFile <em>file-path</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+
+ <p>To allow for <code class="directive"><a href="#ftplimitloginuser">FTPLimitLoginUser</a></code> and
+ <code class="directive"><a href="#ftplimitloginserver">FTPLimitLoginServer</a></code> capability, the FTP
+ server uses a small DBM file to store login data. This
+ directive determines the filename-path of that database file.
+ If either <code>FTPLimit</code> directive is used, this
+ must point to a valid file-location.</p>
+ <div class="example"><p><code><code>FTPLimitDBFile logs/ftplogins</code></code></p></div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPLimitLoginIP" id="FTPLimitLoginIP">FTPLimitLoginIP</a> <a name="ftplimitloginip" id="ftplimitloginip">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum number of concurrent logins per IP
+ address</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code /></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code /></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <div class="note">Not documented by Covalent</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPLimitLoginServer" id="FTPLimitLoginServer">FTPLimitLoginServer</a> <a name="ftplimitloginserver" id="ftplimitloginserver">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum number of concurrent logins per
+ server</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPLimitLoginServer <em>number</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPLimitLoginServer 0 (unlimited)</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive allows the administrator to limit the total
+ number of concurrent/simultaneous FTP logins. For example, if
+ set to 10, no more than 10 FTP logins would be allowed. The
+ default value is 0 (unlimited).</p>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPLimitLoginUser" id="FTPLimitLoginUser">FTPLimitLoginUser</a> <a name="ftplimitloginuser" id="ftplimitloginuser">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum number of concurrent logins per
+ user</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPLimitLoginUser <em>number</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPLimitLoginUser 0 (unlimited)</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table><p>This directive allows the administrator to limit the
+ number of concurrent/simultaneous logins of a single FTP user.
+ For example, if set to 3, then no single FTP account would be
+ allowed to have more than 3 concurrent logins (including the
+ guest/anonymous account). The default value is 0 (unlimited).</p>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPMaxLoginAttempts" id="FTPMaxLoginAttempts">FTPMaxLoginAttempts</a> <a name="ftpmaxloginattempts" id="ftpmaxloginattempts">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Maximum number of login attempts</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPMaxLoginAttempts <em>attempts</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPMaxLoginAttempts 3</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive controls the number of failed
+ <em>attempts</em> to log in that are allowed before breaking
+ the connection and logging the failed attempts.</p>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPOptions" id="FTPOptions">FTPOptions</a> <a name="ftpoptions" id="ftpoptions">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set options for this server</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPOptions <em>option1 [option2] ...</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive sets per server options.</p>
+ <p>Current options:</p>
+ <dl>
+ <dt><code>RequireSSL</code></dt>
+ <dd><p>This option requires the client to issue an
+ <code>AUTH</code> command to switch to SSL before sending any
+ password information. This is much like implicit SSL in that
+ it forces the client to use SSL to send password information.
+ The difference is that using the <code>RequireSSL</code>
+ option will allow a client to connect without SSL, but then
+ issue the <code>AUTH</code> SSL command before sending the
+ username and password.</p>
+ </dd>
+ <dt><code>CheckMaxClients</code></dt>
+ <dd><p>This option denies login to a client when the server is
+ full. If it is not enabled, the client will wait on the
+ accept queue until another client disconnects.</p>
+ </dd>
+ <dt><code>CreateHomeDirs</code></dt>
+ <dd><p>This option causes the server to automatically create a
+ home directory in the location specified by the
+ <code class="directive"><a href="#ftphomedir">FTPHomeDir</a></code> directive.
+ If the <code class="directive"><a href="#ftphomedir">FTPHomeDir</a></code>
+ directive is not specified, this option has no effect.</p>
+ <div class="note"><p>Setting this option on an anonymous site is not
+ recommended. This is because a directory is created for
+ each unique user (usually identified by their email
+ address) that logs onto the server. </p>
+ <p>This option will only work if the <code class="directive"><a href="#ftphomedir">FTPHomeDir</a></code> directories are
+ accessible to the process owner of the Apache HTTP Server,
+ typically on UNIX systems the user
+ <code>nobody</code>.</p>
+ </div>
+ </dd>
+ <dt><code>RemoveUserGroup</code></dt>
+ <dd><p>This option causes the
+ server to print the UID and GID rather than the user name
+ and group name for directory listings. It has no effect on
+ Windows systems.</p>
+ </dd>
+ <dt><code>NLSTShowDirs</code></dt>
+ <dd><p>This option causes the server
+ to display directories as well as files when it receives
+ an <code>NLST</code> request. Some FTP clients send an
+ <code>NLST</code> requests when the user issues an
+ <code>ls</code> or <code>dir</code> commands. Since the
+ default response is to display files only, the user may be
+ confused.</p>
+ <div class="note"><p>
+ Setting this option will cause commands that request
+ multiple files to fail and should be used with
+ caution.</p>
+ </div>
+ </dd>
+ <dt><code>NLSTisLIST</code></dt>
+ <dd><p>This option causes the server
+ to display identical output when it receives either a
+ <code>LIST</code> request or an <code>NLST</code> request.
+ Like <code class="directive">NLSTShowDirs</code>, this option is
+ used for FTP clients that send different requests for
+ <code>ls</code> or <code>dir</code> commands.</p>
+ <div class="note">
+ <p>Setting this option will cause commands that request
+ multiple files to fail and should be used with
+ caution.</p>
+ </div>
+ </dd>
+ <dt><code>LISTisNLST</code></dt>
+ <dd><p>This option causes the server to display identical output
+ when it receives either a <code>LIST</code> request or an
+ <code>NLST</code> request. Unlike
+ <code class="directive">NLSTisLIST</code>, the output is a list of
+ files without details. If the -l option is passed to
+ <code>LIST</code> requests, details will be provided,
+ whether this option is set or not.</p>
+ </dd>
+ <dt><code>ShowUnAuthorizedFiles</code></dt>
+ <dd><p>This option causes
+ the server to show files that the user does not have
+ authorization to retrieve and directories that the user
+ does not have authorization to enter (<code>cd</code> will
+ fail) when it receives a <code>LIST</code> request. This
+ enables the Covalent Enterprise FTP Server to behave like
+ most standard FTP servers, where users are allowed to list
+ all files and directories, even those they are not allowed
+ to access.</p>
+ </dd>
+ </dl>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPPASVaddr" id="FTPPASVaddr">FTPPASVaddr</a> <a name="ftppasvaddr" id="ftppasvaddr">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the allowed PASV server IP address for the data
+ channel</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPPASVAddr <em>IP address</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive allows you to specify a different <em>IP
+ address</em> to be sent on replies to <code>PASV</code> requests.
+ You will find this useful when the FTP Server is behind a
+ firewall.</p>
+ <div class="note">This directive is <strong>not</strong> inherited from the global
+ configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPPASVbindaddr" id="FTPPASVbindaddr">FTPPASVbindaddr</a> <a name="ftppasvbindaddr" id="ftppasvbindaddr">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set and bind the allowed PASV server IP address for
+ the data channel</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPPASVbindaddr <em>IP address</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive is identical to
+ <code class="directive"><a href="#ftppasvaddr">FTPPASVaddr</a></code> except
+ that the Apache FTP Server attempts to bind to the specified
+ <em>IP address</em>.</p>
+ <div class="note">This directive is <strong>not</strong> inherited from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPPASVrange" id="FTPPASVrange">FTPPASVrange</a> <a name="ftppasvrange" id="ftppasvrange">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the allowed PASV port range</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPPASVrange <em>number number</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive defines the port range (<em>number</em> to
+ <em>number</em> inclusive) to be used for passive connections.
+ This directive is designed for use in environments where you
+ only want to open a specific range of ports on your
+ firewall.</p>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPReadmeMessage" id="FTPReadmeMessage">FTPReadmeMessage</a> <a name="ftpreadmemessage" id="ftpreadmemessage">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set per-directory Readme file</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPReadmeMessage
+ <em>message</em>|<em>file:/path/to/file</em>
+ </code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Unset</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table><p>This directive sets a <em>message</em> that is displayed
+ to the client upon entering a new directory. This can either
+ be a string, or a path to a file. The message can contain a
+ variety of meta-characters (see <code class="directive"><a href="#ftpbannermessage">FTPBannerMessage</a></code>).</p>
+ <p>When this directive is placed in the <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> container, the README
+ message will apply to all directories. When it is used in a
+ <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>
+ container or placed in an <code>.htaccess</code> file, only
+ that directory will inherit the README message.</p>
+ <p>Configuring a README message for a directory will also override any
+ global README messages.</p>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPTimeoutData" id="FTPTimeoutData">FTPTimeoutData</a> <a name="ftptimeoutdata" id="ftptimeoutdata">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Idle time allowed during a data transfer</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPTimeoutData <em>time</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPTimeoutData 300</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive sets the <em>time</em> in seconds the server
+ will wait during a data transfer. If no data is sent to the
+ client in this amount of time, the data connection is
+ closed.</p>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPTimeoutIdle" id="FTPTimeoutIdle">FTPTimeoutIdle</a> <a name="ftptimeoutidle" id="ftptimeoutidle">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Idle time allowed during a FTP session</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPTimeoutIdle <em>time</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPTimeoutIdle 600</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive sets the amount of <em>time</em> in seconds
+ allowed between commands sent by the client. If no commands
+ are received in this amount of time, the user is
+ disconnected.</p>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPTimeoutLogin" id="FTPTimeoutLogin">FTPTimeoutLogin</a> <a name="ftptimeoutlogin" id="ftptimeoutlogin">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Idle time allowed when logging in</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPTimeoutLogin <em>time</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPTimeoutLogin 60</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive sets the amount of <em>time</em> in seconds
+ that a user has to send a username to the server. If the
+ username is not received in this amount of time, the user is
+ disconnected.</p>
+ <div class="note">This directive is inherited to all virtual hosts from the
+ global configuration file.</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="FTPUmask" id="FTPUmask">FTPUmask</a> <a name="ftpumask" id="ftpumask">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the umask for created files</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FTPUmask <em>umask</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FTPUmask 022</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>External</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_ftp</td></tr>
+</table>
+ <p>This directive sets the permission mask for file creation
+ access. The default is 022 which gives the owner complete
+ access and disables write access for the group and other
+ users.</p>
+ <div class="note">This directive is inherited to all virtual
+ hosts from the global configuration file.</div>
+ <div class="note">This directive is not supported on Windows.</div>
+
+</div>
+</div>
+<div class="bottomlang">
+<p><span>Available Languages: </span><a href="../en/mod/mod_ftp.html" title="English"> en </a></p>
+</div><div id="footer">
+<p class="apache">Copyright 2006 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html>
\ No newline at end of file
Propchange: httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: httpd/mod_ftp/trunk/docs/manual/mod/mod_ftp.html.en
------------------------------------------------------------------------------
svn:mime-type = text/html