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 @@ + + + +mod_ftp - Apache HTTP Server + + + + + + +
<-
+
+Apache > HTTP Server > Documentation > Version 2.3 > Modules
+
+

Apache Module mod_ftp

+
+

Available Languages:  en 

+
+ + + + +
Description:Provides support for the File Transfer Protocol
Status:External
Module Identifier:ftp_module
Source File:mod_ftp.c
Compatibility:Apache 2.3 and higher
+

Summary

+ +

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.

+ +

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.

+ +

Further details, discussion and examples are provided in the FTP documentation.

+
+

Directives

+ +

See also

+
+ +
top
+

FTP Directive

+ + + + + + + +
Description:Run an FTP Server on this host
Syntax:FTP on|off
Default:FTP off
Context:server config, virtual host
Status:External
Module:mod_ftp
+

You must define a Listen directive to + listen for FTP requests. This directive is not + inherited from the global configuration file.

+ +
+
top
+

FTPActiveRange Directive

+ + + + + + + +
Description:Ports the server will use for connecting to the + client
Syntax:FTPActiveRange min [max]
Default:If this directive is not specified, the server will use + random high-numbered ports
Context:server config, virtual host
Status:External
Module:mod_ftp
+

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.

+ +

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. +

+
+

FTPActiveRange 5050

Force the server to use port 5050

FTPActiveRange 5050 5080

Allow the server to use any port between 5050 and 5080, + inclusive.

+
This directive is inherited to all virtual hosts from + the global configuration file.
+ +
+
top
+

FTPBannerMessage Directive

+ + + + + + + +
Description:Set initial login message
Syntax:FTPBannerMessage + message|file:/path/to/file
Default:Unset
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive sets a message 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:

+ + + + + + + + + + + + + +
%TLocal time (in the form Mon Apr 29 + 20:36:48 2002)
%CCurrent working directory
%hRemote host
%LLocal host
%EServer administrator (as given by + ServerAdmin)
%aRemote IP-address
%ALocal IP-address
%uRemote user
%fNumber of files transferred
%tTotal number of bytes downloaded
%xNumber of data transfers
%bTotal traffic for the session (both + control and data)
+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPDataBlockSize Directive

+ + + + + + + +
Description:Block size in bytes to use during data transfers
Syntax:
Default:
Context:server config, virtual host
Status:External
Module:mod_ftp
+
Not documented by Covalent
+ +
+
top
+

FTPDirUmask Directive

+ + + + + + + +
Description:Set the umask for created directory
Syntax:FTPDirUmask umask
Default:Unknown
Context:server config, virtual host
Status:External
Module:mod_ftp
+
Not documented by Covalent
+ +
+
top
+

FTPDocRootEnv Directive

+ + + + + + + +
Description:Set the DocumentRoot based on the given environment + variable, such as a per-user LDAP property
Syntax:FTPDocRootEnv envvar
Default:Unset
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive will cause FTP to use the value of the + envvar environment variable in place of the + default DocumentRoot, if the environment variable + is defined. The envvar variable must contain a + full, rooted file path, e.g. /some/path on Unix + or d:/some/path on Windows.

+ +

This may be used with the CovalentLDAPPassProperty + directive, or other directives that provide an + environment variable assignment, to change FTP's Document Root + on a per-user basis.

+

CovalentLDAPPassProperty homeDir

FTPDocRootEnv homeDir

Extract a user's LDAP homeDir property, and + then use it for the user's FTP Document Root.

+ +
+
top
+

FTPExitMessage Directive

+ + + + + + + +
Description:Set logout message
Syntax:FTPExitMessage + message|file:/path/to/file
Default:
Context:server config, virtual host
Status:External
Module:mod_ftp

This directive sets a message 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 + FTPBannerMessage).

+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPHomeDir Directive

+ + + + + + + +
Description:Set the path to directory + containing user's home directories
Syntax:FTPHomeDir /directory
Default:Unset
Context:server config, virtual host
Status:External
Module:mod_ftp

This directive defines where the user home directory + is located. This directory must be given as an absolute path, + but is actually relative to the configured + DocumentRoot for the server. For + example, FTPHomeDir /home will cause the Apache FTP + Server to look for the user home in the directory DocumentRoot/home/username + (where username is the login name of the user).

+

If FTPHomeDir 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 + ("/") directory. If you want the home + directory created automatically, see the + CreateHomeDirs option to the + FTPOptions directive.

+ +
+
top
+

FTPImplicitSSL Directive

+ + + + + + + +
Description:Use SSL implicitly
Syntax:FTPImplicitSSL on|off
Default:FTPImplicitSSL off
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive determines the security on the control + connection when the user connects. When set to + On, the user is expected to connect using SSL. + When set to Off, the user must connect insecurely + then issue the AUTH command to start a secure + session.

+
This directive is not inherited from the global + configuration file.
+ +
+
top
+

FTPJailUser Directive

+ + + + + + + +
Description:Users are not allowed to leave their home + directories
Syntax:FTPJailUser on|off
Default:FTPJailUser off
Context:server config, virtual host
Status:External
Module:mod_ftp
+

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.

+

If the FTPHomeDir + directive is not used, then FTPJailUser + has no effect. This combination of directives can be very + powerful for restricting where in your filesystem users may + traverse.

+
This directive is not inherited from the + global configuration file.
+ +
+
top
+

FTPLimitDBFile Directive

+ + + + + + + +
Description:Set the location for the Login Limit DB file
Syntax:FTPLimitDBFile file-path
Default:Unset
Context:server config
Status:External
Module:mod_ftp
+ +

To allow for FTPLimitLoginUser and + FTPLimitLoginServer 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 FTPLimit directive is used, this + must point to a valid file-location.

+

FTPLimitDBFile logs/ftplogins

+ +
+
top
+

FTPLimitLoginIP Directive

+ + + + + + + +
Description:Set the maximum number of concurrent logins per IP + address
Syntax:
Default:
Context:server config, virtual host
Status:External
Module:mod_ftp
+
Not documented by Covalent
+ +
+
top
+

FTPLimitLoginServer Directive

+ + + + + + + +
Description:Set the maximum number of concurrent logins per + server
Syntax:FTPLimitLoginServer number
Default:FTPLimitLoginServer 0 (unlimited)
Context:server config
Status:External
Module:mod_ftp
+

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).

+ +
+
top
+

FTPLimitLoginUser Directive

+ + + + + + + +
Description:Set the maximum number of concurrent logins per + user
Syntax:FTPLimitLoginUser number
Default:FTPLimitLoginUser 0 (unlimited)
Context:server config
Status:External
Module:mod_ftp

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).

+ +
+
top
+

FTPMaxLoginAttempts Directive

+ + + + + + + +
Description:Maximum number of login attempts
Syntax:FTPMaxLoginAttempts attempts
Default:FTPMaxLoginAttempts 3
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive controls the number of failed + attempts to log in that are allowed before breaking + the connection and logging the failed attempts.

+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPOptions Directive

+ + + + + + + +
Description:Set options for this server
Syntax:FTPOptions option1 [option2] ...
Default:None
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive sets per server options.

+

Current options:

+
+
RequireSSL
+

This option requires the client to issue an + AUTH 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 RequireSSL + option will allow a client to connect without SSL, but then + issue the AUTH SSL command before sending the + username and password.

+
+
CheckMaxClients
+

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.

+
+
CreateHomeDirs
+

This option causes the server to automatically create a + home directory in the location specified by the + FTPHomeDir directive. + If the FTPHomeDir + directive is not specified, this option has no effect.

+

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.

+

This option will only work if the FTPHomeDir directories are + accessible to the process owner of the Apache HTTP Server, + typically on UNIX systems the user + nobody.

+
+
+
RemoveUserGroup
+

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.

+
+
NLSTShowDirs
+

This option causes the server + to display directories as well as files when it receives + an NLST request. Some FTP clients send an + NLST requests when the user issues an + ls or dir commands. Since the + default response is to display files only, the user may be + confused.

+

+ Setting this option will cause commands that request + multiple files to fail and should be used with + caution.

+
+
+
NLSTisLIST
+

This option causes the server + to display identical output when it receives either a + LIST request or an NLST request. + Like NLSTShowDirs, this option is + used for FTP clients that send different requests for + ls or dir commands.

+
+

Setting this option will cause commands that request + multiple files to fail and should be used with + caution.

+
+
+
LISTisNLST
+

This option causes the server to display identical output + when it receives either a LIST request or an + NLST request. Unlike + NLSTisLIST, the output is a list of + files without details. If the -l option is passed to + LIST requests, details will be provided, + whether this option is set or not.

+
+
ShowUnAuthorizedFiles
+

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 (cd will + fail) when it receives a LIST 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.

+
+
+ +
+
top
+

FTPPASVaddr Directive

+ + + + + + + +
Description:Set the allowed PASV server IP address for the data + channel
Syntax:FTPPASVAddr IP address
Default:Unset
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive allows you to specify a different IP + address to be sent on replies to PASV requests. + You will find this useful when the FTP Server is behind a + firewall.

+
This directive is not inherited from the global + configuration file.
+ +
+
top
+

FTPPASVbindaddr Directive

+ + + + + + + +
Description:Set and bind the allowed PASV server IP address for + the data channel
Syntax:FTPPASVbindaddr IP address
Default:Unset
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive is identical to + FTPPASVaddr except + that the Apache FTP Server attempts to bind to the specified + IP address.

+
This directive is not inherited from the + global configuration file.
+ +
+
top
+

FTPPASVrange Directive

+ + + + + + + +
Description:Set the allowed PASV port range
Syntax:FTPPASVrange number number
Default:Unset
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive defines the port range (number to + number 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.

+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPReadmeMessage Directive

+ + + + + + + +
Description:Set per-directory Readme file
Syntax:FTPReadmeMessage + message|file:/path/to/file +
Default:Unset
Context:server config, virtual host, directory, .htaccess
Status:External
Module:mod_ftp

This directive sets a message 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 FTPBannerMessage).

+

When this directive is placed in the <VirtualHost> container, the README + message will apply to all directories. When it is used in a + <Directory> + container or placed in an .htaccess file, only + that directory will inherit the README message.

+

Configuring a README message for a directory will also override any + global README messages.

+ +
+
top
+

FTPTimeoutData Directive

+ + + + + + + +
Description:Idle time allowed during a data transfer
Syntax:FTPTimeoutData time
Default:FTPTimeoutData 300
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive sets the time 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.

+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPTimeoutIdle Directive

+ + + + + + + +
Description:Idle time allowed during a FTP session
Syntax:FTPTimeoutIdle time
Default:FTPTimeoutIdle 600
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive sets the amount of time in seconds + allowed between commands sent by the client. If no commands + are received in this amount of time, the user is + disconnected.

+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPTimeoutLogin Directive

+ + + + + + + +
Description:Idle time allowed when logging in
Syntax:FTPTimeoutLogin time
Default:FTPTimeoutLogin 60
Context:server config, virtual host
Status:External
Module:mod_ftp
+

This directive sets the amount of time 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.

+
This directive is inherited to all virtual hosts from the + global configuration file.
+ +
+
top
+

FTPUmask Directive

+ + + + + + + +
Description:Set the umask for created files
Syntax:FTPUmask umask
Default:FTPUmask 022
Context:server config, virtual host
Status:External
Module:mod_ftp
+

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.

+
This directive is inherited to all virtual + hosts from the global configuration file.
+
This directive is not supported on Windows.
+ +
+
+
+

Available Languages:  en 

+
+ \ 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