From f1f45df3399244e14ce7982b6256402f23ebb368 Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Wed, 6 Mar 2002 17:08:19 +0000 Subject: [PATCH] Bring the html transformations up-to-date. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@93731 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/core.html | 4385 ++++--------------------- docs/manual/mod/mod_access.html | 423 +-- docs/manual/mod/mod_actions.html | 204 +- docs/manual/mod/mod_alias.html | 566 +--- docs/manual/mod/mod_asis.html | 100 +- docs/manual/mod/mod_auth.html | 336 +- docs/manual/mod/mod_auth_anon.html | 402 +-- docs/manual/mod/mod_auth_dbm.html | 331 +- docs/manual/mod/mod_auth_digest.html | 512 +-- docs/manual/mod/mod_autoindex.html | 1228 ++----- docs/manual/mod/mod_cern_meta.html | 187 +- docs/manual/mod/mod_cgi.html | 335 +- docs/manual/mod/mod_cgid.html | 120 +- docs/manual/mod/mod_charset_lite.html | 241 +- docs/manual/mod/mod_dav.html | 247 +- docs/manual/mod/mod_deflate.html | 179 +- docs/manual/mod/mod_dir.html | 130 +- docs/manual/mod/mod_env.html | 134 +- docs/manual/mod/mod_include.html | 362 +- docs/manual/mod/mod_info.html | 156 +- docs/manual/mod/mod_log_config.html | 390 +-- docs/manual/mod/mod_rewrite.html | 1842 +++-------- docs/manual/mod/mod_setenvif.html | 475 +-- docs/manual/mod/mod_so.html | 125 +- docs/manual/mod/mod_speling.html | 90 +- docs/manual/mod/mod_status.html | 199 +- docs/manual/mod/mod_suexec.html | 107 +- docs/manual/mod/mod_unique_id.html | 115 +- docs/manual/mod/mod_userdir.html | 208 +- docs/manual/mod/mod_vhost_alias.html | 359 +- docs/manual/mod/mpm_common.html | 1201 +------ docs/manual/mod/mpm_winnt.html | 64 +- docs/manual/mod/prefork.html | 334 +- 33 files changed, 2733 insertions(+), 13354 deletions(-) diff --git a/docs/manual/mod/core.html b/docs/manual/mod/core.html index 9ccd54a78f..421a2c8798 100644 --- a/docs/manual/mod/core.html +++ b/docs/manual/mod/core.html @@ -1,301 +1,45 @@ - - - - -core - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module core

- - - - -
- - - - - - - -
Description: -Core Apache HTTP Server features that are always -available -
Status:Core
-
-

Directives

- -
-

-AcceptPathInfo Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Controls whether requests can contain trailing pathname information
Syntax: -AcceptPathInfo On|Off|Default -
Default:AcceptPathInfo Default
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
Compatibility:Available in Apache 2.0.30 and later
-
- +-->core - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module core

Description:Core Apache HTTP Server features that are always +available
Status:Core

Directives

AcceptPathInfo Directive

Description: Controls whether requests can contain trailing pathname information
Syntax:AcceptPathInfo On|Off|Default
Default:AcceptPathInfo Default
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
Compatibility:Available in Apache 2.0.30 and later
- -

This directive controls whether requests that contain trailing +

This directive controls whether requests that contain trailing pathname information that follows an actual filename (or non-existent file in an existing directory) will be accepted or rejected. The trailing pathname information can be made available to scripts in the PATH_INFO environment variable.

- -

For example, assume the location /test/ points to +

For example, assume the location /test/ points to a directory that contains only the single file here.html. Then requests for /test/here.html/more and /test/nothere.html/more both collect /more as PATH_INFO.

- -

The three possible arguments for the +

The three possible arguments for the AcceptPathInfo directive are:

- -
- -
-off -
-
A request will only be accepted if it +
+
off
A request will only be accepted if it maps to a literal path that exists. Therefore a request with trailing pathname information after the true filename such as /test/here.html/more in the above example will return a 404 NOT FOUND error.
- -
-on -
-
A request will be accepted if a +
on
A request will be accepted if a leading path component maps to a file that exists. The above example /test/here.html/more will be accepted if /test/here.html maps to a valid file.
- -
-default -
-
The treatment of requests with +
default
The treatment of requests with trailing pathname information is determined by the handler responsible for the request. The core handler for normal files defaults to rejecting PATH_INFO. Handlers that serve scripts, such as cgi-script and isapi-isa, generally accept PATH_INFO by default.
- -
+
- -

The primary purpose of the AcceptPathInfo +

The primary purpose of the AcceptPathInfo directive is to allow you to override the handler's choice of accepting or rejecting PATH_INFO. This override is required, for example, when you use a filter, such @@ -303,142 +47,38 @@ available based on PATH_INFO. The core handler would usually reject the request, so you can use the following configuration to enable such a script:

- -
- - -
+
- -
<Files "mypaths.shtml">
Options +Includes
SetOutputFilter INCLUDES
AcceptPathInfo on
</Files> -
-
- - -
-

-AccessFileName Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the name of the .htaccess file
Syntax: -AccessFileName filename [filename] ... -
Default:AccessFileName .htaccess
Context:server config, virtual host
Status:Core
Module:core
-
- - -

When returning a document to the client the server looks for +

+

AccessFileName Directive

Description: Sets the name of the .htaccess file
Syntax:AccessFileName filename [filename] ...
Default:AccessFileName .htaccess
Context:server config, virtual host
Status:Core
Module:core
+

When returning a document to the client the server looks for the first existing access control file from this list of names in every directory of the path to the document, if access control files are enabled for that directory. For example:

- -
- - -
+
- -
AccessFileName .acl -
-
+
- -

before returning the document +

before returning the document /usr/local/web/index.html, the server will read /.acl, /usr/.acl, /usr/local/.acl and /usr/local/web/.acl for directives, unless they have been disabled with

- -
- - -
+
- -
<Directory />
  AllowOverride None
</Directory> -
-
- - -

-See also: -

- -
-

-AddDefaultCharset Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Specifies the default character set to be added for a -response without an explicit character set
Syntax: -AddDefaultCharset On|Off|charset - -
Default:AddDefaultCharset Off
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
-
- +
+

See also

AddDefaultCharset Directive

Description: Specifies the default character set to be added for a +response without an explicit character set
Syntax:AddDefaultCharset On|Off|charset
Default:AddDefaultCharset Off
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
- -

This directive specifies the name of the character set that +

This directive specifies the name of the character set that will be added to any response that does not have any parameter on the content type in the HTTP headers. This will override any character set specified in the body of the document via a @@ -449,504 +89,162 @@ response without an explicit character set required by the directive. You can also specify an alternate charset to be used. For example:

- -
- - -
+
- -
AddDefaultCharset utf-8 -
-
- - -
-

-AddModule Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description:
Syntax: -AddModule module [module] ... -
Context:server config
Status:Core
Module:core
-
- - -

The server can have modules compiled in which are not +

+

AddModule Directive

Description:
Syntax:AddModule module [module] ...
Context:server config
Status:Core
Module:core
+

The server can have modules compiled in which are not actively in use. This directive can be used to enable the use of those modules. The server comes with a pre-loaded list of - active modules; this list can be cleared with the ClearModuleList directive.

+ active modules; this list can be cleared with the ClearModuleList directive.

- -

For example:

- -
- - -
+

For example:

+
- -
AddDefaultCharset utf-8 -
-
- - -
-

-AllowOverride Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the types of directives that are allowed in -.htaccess files
Syntax: -AllowOverride All|None|directive-type [directive-type] ... -
Default:AllowOverride All
Context:directory
Status:Core
Module:core
-
- - -

When the server finds an .htaccess file (as specified by AccessFileName) it needs to know +

+

AllowOverride Directive

Description: Sets the types of directives that are allowed in +.htaccess files
Syntax:AllowOverride All|None|directive-type [directive-type] ...
Default:AllowOverride All
Context:directory
Status:Core
Module:core
+

When the server finds an .htaccess file (as specified by AccessFileName) it needs to know which directives declared in that file can override earlier access information.

- -

When this directive is set to None, then +

When this directive is set to None, then .htaccess files are completely ignored. In this case, the server will not even attempt to read .htaccess files in the filesystem.

- -

When this directive is set to All, then any +

When this directive is set to All, then any directive which has the .htaccess Context is allowed in .htaccess files.

- -

The directive-type can be one of the following +

The directive-type can be one of the following groupings of directives.

- -
- -
AuthConfig
- - -
- - Allow use of the authorization directives (AuthDBMGroupFile, - AuthDBMUserFile, - AuthGroupFile, - AuthName, - AuthType, AuthUserFile, Require, etc.).
- - -
FileInfo
- - -
- Allow use of the directives controlling document types (DefaultType, ErrorDocument, ForceType, LanguagePriority, - SetHandler, SetInputFilter, SetOutputFilter, and +
+
AuthConfig
+ +
+ + Allow use of the authorization directives (AuthDBMGroupFile, + AuthDBMUserFile, + AuthGroupFile, + AuthName, + AuthType, AuthUserFile, Require, etc.).
+ +
FileInfo
+ +
+ Allow use of the directives controlling document types (DefaultType, ErrorDocument, ForceType, LanguagePriority, + SetHandler, SetInputFilter, SetOutputFilter, and mod_mime Add* and Remove* directives, etc.).
- -
Indexes
+
Indexes
- -
+
Allow use of the directives controlling directory indexing - (AddDescription, - AddIcon, AddIconByEncoding, - AddIconByType, - DefaultIcon, DirectoryIndex, FancyIndexing, HeaderName, IndexIgnore, IndexOptions, ReadmeName, + (AddDescription, + AddIcon, AddIconByEncoding, + AddIconByType, + DefaultIcon, DirectoryIndex, FancyIndexing, HeaderName, IndexIgnore, IndexOptions, ReadmeName, etc.).
- -
Limit
+
Limit
- -
- Allow use of the directives controlling host access (Allow, Deny and Order).
+
+ Allow use of the directives controlling host access (Allow, Deny and Order).
- -
Options
+
Options
- -
+
Allow use of the directives controlling specific directory - features (Options and - XBitHack).
- -
+ features (Options and + XBitHack).
+
- -

Example:

+

Example:

- -
- - - - -
AllowOverride AuthConfig Indexes
-
- - -

-See also: -

- -
-

-AuthName Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the authorization realm for use in HTTP -authentication
Syntax: -AuthName auth-domain - -
Context:directory, .htaccess
Override:AuthConfig
Status:Core
Module:core
-
- - -

This directive sets the name of the authorization realm for a +

AllowOverride AuthConfig Indexes
+

See also

AuthName Directive

Description: Sets the authorization realm for use in HTTP +authentication
Syntax:AuthName auth-domain
Context:directory, .htaccess
Override:AuthConfig
Status:Core
Module:core
+

This directive sets the name of the authorization realm for a directory. This realm is given to the client so that the user knows which username and password to send. AuthName takes a single argument; if the realm name contains spaces, it must be enclosed in quotation - marks. It must be accompanied by AuthType and Require directives, and directives such - as AuthUserFile and - AuthGroupFile to + marks. It must be accompanied by AuthType and Require directives, and directives such + as AuthUserFile and + AuthGroupFile to work.

- -

For example:

+

For example:

- -
- - - - -
AuthName "Top Secret"
-
+
AuthName "Top Secret"
- -

The string provided for the AuthRealm is what will +

The string provided for the AuthRealm is what will appear in the password dialog provided by most browsers.

- - -

-See also: -

- -
-

-AuthType Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Selects the type of user authentication
Syntax: -AuthType Basic|Digest -
Context:directory, .htaccess
Status:Core
Module:core
-
- - -

This directive selects the type of user authentication for a +

See also

AuthType Directive

Description: Selects the type of user authentication
Syntax:AuthType Basic|Digest
Context:directory, .htaccess
Status:Core
Module:core
+

This directive selects the type of user authentication for a directory. Only Basic and Digest are currently implemented. - It must be accompanied by AuthName and Require directives, and directives such - as AuthUserFile and - AuthGroupFile to + It must be accompanied by AuthName and Require directives, and directives such + as AuthUserFile and + AuthGroupFile to work.

- - -

-See also: -

- -
-

-ContentDigest Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Description: Enables the generation of Content-MD5 HTTP Response -headers
Syntax: -ContentDigest on|off -
Default:ContentDigest off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Core
Module:core
Compatibility:Available in Apache 1.1 and later
-
- - -

This directive enables the generation of +

See also

ContentDigest Directive

Description: Enables the generation of Content-MD5 HTTP Response +headers
Syntax:ContentDigest on|off
Default:ContentDigest off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Core
Module:core
Compatibility:Available in Apache 1.1 and later
+

This directive enables the generation of Content-MD5 headers as defined in RFC1864 respectively RFC2068.

- -

MD5 is an algorithm for computing a "message digest" +

MD5 is an algorithm for computing a "message digest" (sometimes called "fingerprint") of arbitrary-length data, with a high degree of confidence that any alterations in the data will be reflected in alterations in the message digest.

- -

The Content-MD5 header provides an end-to-end +

The Content-MD5 header provides an end-to-end message integrity check (MIC) of the entity-body. A proxy or client may check this header for detecting accidental modification of the entity-body in transit. Example header:

- -
- - -
+
- -
Content-MD5: AuLb7Dp1rqtRtxz2m9kRpA== -
-
+
- -

Note that this can cause performance problems on your server +

Note that this can cause performance problems on your server since the message digest is computed on every request (the values are not cached).

- -

-Content-MD5 is only sent for documents served +

Content-MD5 is only sent for documents served by the core, and not by any module. For example, SSI documents, output from CGI scripts, and byte range responses do not have this header.

- - -
-

-DefaultType Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets the MIME content-type that will be sent if the -server cannot determine a type in any other way
Syntax: -DefaultType MIME-type - -
Default:DefaultType text/html
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Core
Module:core
-
- - -

There will be times when the server is asked to provide a +

DefaultType Directive

Description: Sets the MIME content-type that will be sent if the +server cannot determine a type in any other way
Syntax:DefaultType MIME-type
Default:DefaultType text/html
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Core
Module:core
+

There will be times when the server is asked to provide a document whose type cannot be determined by its MIME types mappings.

- -

The server must inform the client of the content-type of the +

The server must inform the client of the content-type of the document, so in the event of an unknown type it uses the DefaultType. For example:

- -
- - -
+
- -
DefaultType image/gif -
-
+
would be appropriate for a directory which contained many gif images with filenames missing the .gif extension. -

Note that unlike ForceType, this directive is only +

Note that unlike ForceType, this directive is only provides the default mime-type. All other mime-type definitions, including filename extensions, that might identify the media type will override this default.

- - -
-

-<Directory> Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Enclose a group of directives that apply only to the -named file-system directory and sub-directories
Syntax: -<Directory directory-path> -... </Directory> -
Context:server config, virtual host
Status:Core
Module:core
-
- - -

-<Directory> and +

<Directory> Directive

Description: Enclose a group of directives that apply only to the +named file-system directory and sub-directories
Syntax:<Directory directory-path> +... </Directory>
Context:server config, virtual host
Status:Core
Module:core
+

<Directory> and </Directory> are used to enclose a group of directives which will apply only to the named directory and sub-directories of that directory. Any directive which is allowed @@ -957,34 +255,18 @@ named file-system directory and sub-directories also use `[]' character ranges like in the shell. Also as of Apache 1.3 none of the wildcards match a `/' character, which more closely mimics the behavior of Unix shells. Example:

- -
- - - - -
+
<Directory /usr/local/httpd/htdocs>
  Options Indexes FollowSymLinks
</Directory>
+
-
-
- - -

Extended regular +

Extended regular expressions can also be used, with the addition of the ~ character. For example:

- -
- - -
+
- -
<Directory ~ "^/www/.*/[0-9]{3}"> -
-
+
would match directories in /www/ that consisted of three numbers. @@ -994,345 +276,141 @@ named file-system directory and sub-directories first, interspersed with the directives from the .htaccess files. For example, with

- -
- - -
+
- -
<Directory />
  AllowOverride None
</Directory>
- -
+
<Directory /home/*>
  AllowOverride FileInfo
</Directory> -
-
- -

for access to the document /home/web/dir/doc.html +

+

for access to the document /home/web/dir/doc.html the steps are:

- -
    - -
  • Apply directive AllowOverride None +
      +
    • Apply directive AllowOverride None (disabling .htaccess files).
      • - -
    • Apply directive AllowOverride FileInfo (for +
    • Apply directive AllowOverride FileInfo (for directory /home/web).
      • - -
    • Apply any FileInfo directives in - /home/web/.htaccess -
      • - -
    +
  • Apply any FileInfo directives in + /home/web/.htaccess
    • +
- -

Regular expressions are not considered until after all of the +

Regular expressions are not considered until after all of the normal sections have been applied. Then all of the regular expressions are tested in the order they appeared in the configuration file. For example, with

- -
- - - - -
<Directory ~ abc$>
+
<Directory ~ abc$>
... directives here ...
</Directory>
+
-
-
- - -

The regular expression section won't be considered until after +

The regular expression section won't be considered until after all normal <Directory>s and .htaccess files have been applied. Then the regular expression will match on /home/abc/public_html/abc and be applied.

- -

-Note that the default Apache access for +

Note that the default Apache access for <Directory /> is Allow from All. This means that Apache will serve any file mapped from an URL. It is recommended that you change this with a block such - as -

+ as

- -
- - -
+
- -
<Directory />
  Order Deny,Allow
  Deny from All
</Directory> -
-
+
- -

-and then override this for directories you +

and then override this for directories you want accessible. See the Security Tips page for more - details. -

+ details.

- -

The directory sections typically occur in +

The directory sections typically occur in the access.conf file, but they may appear in any configuration file. <Directory> directives - cannot nest, and cannot appear in a <Limit> or <LimitExcept> section.

- - -

-See also: -

-
    -
  • -How + cannot nest, and cannot appear in a <Limit> or <LimitExcept> section.

    +

    See also

    -
    -

    -<DirectoryMatch> Directive -

    - - -
    - - -
    Description: Enclose a group of directives that apply only to + request is received

    <DirectoryMatch> Directive

    - -
    - - - - - - - - - - - - - -
    Description: Enclose a group of directives that apply only to file-system directories that match a regular expression and their -subdirectories
    Syntax: -<Directory regex> -... </Directory> -
    Context:server config, virtual host
    Status:Core
    Module:core
    -
    - - -

    -<DirectoryMatch> and +subdirectories

    Syntax:<Directory regex> +... </Directory>
    Context:server config, virtual host
    Status:Core
    Module:core
    +

    <DirectoryMatch> and </DirectoryMatch> are used to enclose a group of directives which will apply only to the named directory and - sub-directories of that directory, the same as <Directory>. However, it + sub-directories of that directory, the same as <Directory>. However, it takes as an argument a regular expression. For example:

    - -
    - - -
    +
    - -
    <DirectoryMatch "^/www/.*/[0-9]{3}"> -
    -
    +
    - -

    would match directories in /www/ that consisted of three +

    would match directories in /www/ that consisted of three numbers.

    - -     -

    -See also: -

    -

    DocumentRoot Directive

    Description: Sets the directory that forms the main document tree visible +from the web
    Syntax:DocumentRoot directory-path
    Default:DocumentRoot /usr/local/apache/htdocs
    Context:server config, virtual host
    Status:Core
    Module:core
    +

    This directive sets the directory from which httpd will serve files. Unless matched by a directive like Alias, the server appends the path from the requested URL to the document root to make the path to the document. Example:

    - -
    - - -
    +
    - -
    DocumentRoot /usr/web -
    -
    - -

    then an access to +

    +

    then an access to http://www.my.host.com/index.html refers to /usr/web/index.html.

    - -

    The DocumentRoot should be specified without +

    The DocumentRoot should be specified without a trailing slash.

    - -     -

    -See also: -

    - -
    -

    -ErrorDocument Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - -
    Description: Specifies what the server will return to the client -in case of an error
    Syntax: -ErrorDocument error-code document - -
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Quoting syntax for text messages is different in Apache -2.0
    -
    - - -

    In the event of a problem or error, Apache can be configured +

    See also

    ErrorDocument Directive

    Description: Specifies what the server will return to the client +in case of an error
    Syntax:ErrorDocument error-code document
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    Compatibility:Quoting syntax for text messages is different in Apache +2.0
    +

    In the event of a problem or error, Apache can be configured to do one of four things,

    - -
      - -
    1. output a simple hardcoded error message
      2. +
        +
      1. output a simple hardcoded error message
        2. - -
      2. output a customized message
        3. +
      3. output a customized message
        4. - -
      4. redirect to a local URL-path to handle the +
      5. redirect to a local URL-path to handle the problem/error
        6. - -
      6. redirect to an external URL to handle the +
      7. redirect to an external URL to handle the problem/error
        8. - -
      +
    - -

    The first option is the default, while options 2-4 are +

    The first option is the default, while options 2-4 are configured using the ErrorDocument directive, which is followed by the HTTP response code and a URL or a message. Apache will sometimes offer additional information regarding the problem/error.

    - -

    URLs can begin with a slash (/) for local URLs, or be a full +

    URLs can begin with a slash (/) for local URLs, or be a full URL which the client can resolve. Alternatively, a message can be provided to be displayed by the browser. Examples:

    - -
    - - -
    +
    - -
    ErrorDocument 500 http://foo.example.com/cgi-bin/tester
    ErrorDocument 404 /cgi-bin/bad_urls.pl
    ErrorDocument 401 /subscription_info.html
    ErrorDocument 403 "Sorry can't allow you access today" -
    -
    +
    - -

    Note that when you specify an ErrorDocument +

    Note that when you specify an ErrorDocument that points to a remote URL (ie. anything with a method such as "http" in front of it), Apache will send a redirect to the client to tell it where to find the document, even if the @@ -1346,128 +424,35 @@ in case of an error know to prompt the user for a password since it will not receive the 401 status code. Therefore, if you use an "ErrorDocument 401" directive then it must refer to a local - document. -

    + document.

    - -

    Prior to version 2.0, messages were indicated by prefixing +

    Prior to version 2.0, messages were indicated by prefixing them with a single unmatched double quote character.

    - -     -

    -See also: -

    - -
    -

    -ErrorLog Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the name of the file to which the server -will log errors
    Syntax: - ErrorLog file-path|syslog[:facility] -
    Default:ErrorLog logs/error_log (Unix) -ErrorLog logs/error.log (Windows and OS/2)
    Context:server config, virtual host
    Status:Core
    Module:core
    -
    - - -

    The ErrorLog directive sets the name of +

    See also

    ErrorLog Directive

    Description: Sets the name of the file to which the server +will log errors
    Syntax: ErrorLog file-path|syslog[:facility]
    Default:ErrorLog logs/error_log (Unix) +ErrorLog logs/error.log (Windows and OS/2)
    Context:server config, virtual host
    Status:Core
    Module:core
    +

    The ErrorLog directive sets the name of the file to which the server will log any errors it encounters. If the file-path does not begin with a slash (/) then it is - assumed to be relative to the ServerRoot. If the file-path + assumed to be relative to the ServerRoot. If the file-path begins with a pipe (|) then it is assumed to be a command to spawn to handle the error log.

    - -

    Using syslog instead of a filename enables logging +

    Using syslog instead of a filename enables logging via syslogd(8) if the system supports it. The default is to use syslog facility local7, but you can override this by using the syslog:facility syntax where facility can be one of the names usually documented in syslog(1).

    - -

    SECURITY: See the security tips +

    SECURITY: See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.

    - -     -

    -See also: -

    - -
    -

    -FileETag Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Configures the file attributes used to create the ETag -HTTP response header
    Syntax: -FileETag component ... -
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    -
    - - -

    +

    See also

    FileETag Directive

    Description: Configures the file attributes used to create the ETag +HTTP response header
    Syntax:FileETag component ...
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Core
    Module:core
    +

    The FileETag directive configures the file attributes that are used to create the ETag (entity tag) response header field when the document is based on a file. (The ETag @@ -1477,52 +462,28 @@ HTTP response header FileETag directive allows you to choose which of these -- if any -- should be used. The recognized keywords are:

    - -
    - -
    -INode -
    - -
    The file's i-node number will be included in the calculation
    - -
    -MTime -
    - -
    The date and time the file was last modified will be included
    - -
    -Size -
    - -
    The number of bytes in the file will be included
    - -
    -All -
    - -
    All available fields will be used (equivalent to +
    +
    INode
    +
    The file's i-node number will be included in the calculation
    +
    MTime
    +
    The date and time the file was last modified will be included
    +
    Size
    +
    The number of bytes in the file will be included
    +
    All
    +
    All available fields will be used (equivalent to 'FileETag INode MTime Size')
    - -
    -None -
    - -
    If a document is file-based, no ETag field will be included in the +
    None
    +
    If a document is file-based, no ETag field will be included in the response
    - -
    - -

    +

    +

    The INode, MTime, and Size keywords may be prefixed with either '+' or '-', which allow changes to be made to the default setting inherited from a broader scope. Any keyword appearing without such a prefix immediately and completely cancels the inherited setting.

    - -

    +

    If a directory's configuration includes 'FileETag INode MTime Size', and a subdirectory's includes 'FileETag -INode', @@ -1530,249 +491,74 @@ HTTP response header any sub-subdirectories that don't override it) will be equivalent to 'FileETag MTime Size'.

    - -     -
    -

    -<Files> Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Contains that directives that apply to matched -filenames
    Syntax: -<Files filename> ... </Files> -
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    -
    - - -

    The <Files> directive +

    <Files> Directive

    Description: Contains that directives that apply to matched +filenames
    Syntax:<Files filename> ... </Files>
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    The <Files> directive provides for access control by filename. It is comparable to the - Directory - directive and Location directives. It should be + Directory + directive and Location directives. It should be matched with a </Files> directive. The directives given within this section will be applied to any object with a basename (last component of filename) matching the specified filename. <Files> sections are processed in the order they appear in the - configuration file, after the <Directory> sections and - .htaccess files are read, but before <Location> sections. Note + configuration file, after the <Directory> sections and + .htaccess files are read, but before <Location> sections. Note that <Files> can be nested - inside <Directory> sections to restrict the + inside <Directory> sections to restrict the portion of the filesystem they apply to.

    - -

    The filename argument should include a filename, or +

    The filename argument should include a filename, or a wild-card string, where `?' matches any single character, and `*' matches any sequences of characters. Extended regular expressions can also be used, with the addition of the ~ character. For example:

    - -
    - - -
    +
    - -
    <Files ~ "\.(gif|jpe?g|png)$"> -
    -
    - -

    would match most common Internet graphics formats. In Apache 1.3 - and later, <FilesMatch> is preferred, however.

    +
    +

    would match most common Internet graphics formats. In Apache 1.3 + and later, <FilesMatch> is preferred, however.

    - -

    Note that unlike <Directory> and <Location> sections, <Files> sections can be used inside +

    Note that unlike <Directory> and <Location> sections, <Files> sections can be used inside .htaccess files. This allows users to control access to their own files, at a file-by-file level.

    - -     -

    -See also: -

    -

    <FilesMatch> Directive

    Description: Contains that directives that apply to regular-expression matched +filenames
    Syntax:<FilesMatch regex> ... </FilesMatch>
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    The <FilesMatch> directive + provides for access control by filename, just as the <Files> directive does. However, it accepts a regular expression. For example:

    - -
    - - -
    +
    - -
    <FilesMatch "\.(gif|jpe?g|png)$"> -
    -
    +
    - -

    would match most common Internet graphics formats.

    - -     -

    -See also: -

    -

    ForceType Directive

    Description: Forces all matching files to be served with the specified +MIME content-type
    Syntax:ForceType mime-type
    Context:directory, .htaccess
    Status:Core
    Module:core
    Compatibility:Moved to the core in Apache 2.0
    +

    When placed into an .htaccess file or a + <Directory>, or + <Location> or + <Files> section, this directive forces all matching files to be served with the content type identification given by mime-type. For example, if you had a directory full of GIF files, but did not want to label them all with ".gif", you might want to use:

    - -
    - - -
    +
    - -
    ForceType image/gif -
    -
    +
    - -

    Note that unlike DefaultType, +

    Note that unlike DefaultType, this directive overrides all mime-type associations, including filename extensions, that might identify the media type.

    - -     -
    -

    -HostnameLookups Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Enables DNS lookups on client IP addresses
    Syntax: -HostnameLookups on|off|double -
    Default:HostnameLookups off
    Context:server config, virtual host, directory
    Status:Core
    Module:core
    -
    - - -

    This directive enables DNS lookups so that host names can be +

    HostnameLookups Directive

    Description: Enables DNS lookups on client IP addresses
    Syntax:HostnameLookups on|off|double
    Default:HostnameLookups off
    Context:server config, virtual host, directory
    Status:Core
    Module:core
    +

    This directive enables DNS lookups so that host names can be logged (and passed to CGIs/SSIs in REMOTE_HOST). The value double refers to doing double-reverse DNS. That is, after a reverse lookup is performed, a forward @@ -1781,8 +567,7 @@ MIME content-type address. (In "tcpwrappers" terminology this is called PARANOID.)

    - -

    Regardless of the setting, when mod_access is +

    Regardless of the setting, when mod_access is used for controlling access by hostname, a double reverse lookup will be performed. This is necessary for security. Note that the result of this double-reverse isn't generally available unless you @@ -1792,8 +577,7 @@ MIME content-type the double-reverse fails or not, CGIs will still be passed the single-reverse result in REMOTE_HOST.

    - -

    The default is off in order to save the network +

    The default is off in order to save the network traffic for those sites that don't truly need the reverse lookups done. It is also better for the end users because they don't have to suffer the extra latency that a lookup entails. @@ -1802,143 +586,56 @@ MIME content-type amounts of time. The utility logresolve, provided in the /support directory, can be used to look up host names from logged IP addresses offline.

    - -     -
    -

    -IdentityCheck Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Enables logging of the RFC1413 identity of the remote -user
    Syntax: -IdentityCheck on|off -
    Default:IdentityCheck off
    Context:
    Status:Core
    Module:core
    -
    - - -

    This directive enables RFC1413-compliant logging of the +

    IdentityCheck Directive

    Description: Enables logging of the RFC1413 identity of the remote +user
    Syntax:IdentityCheck on|off
    Default:IdentityCheck off
    Context:
    Status:Core
    Module:core
    +

    This directive enables RFC1413-compliant logging of the remote user name for each connection, where the client machine runs identd or something similar. This information is logged in the access log.

    - -

    The information should not be trusted in any way except for +

    The information should not be trusted in any way except for rudimentary usage tracking.

    - -

    Note that this can cause serious latency problems accessing +

    Note that this can cause serious latency problems accessing your server since every request requires one of these lookups to be performed. When firewalls are involved each lookup might possibly fail and add 30 seconds of latency to each hit. So in general this is not very useful on public servers accessible from the Internet.

    - -     -
    -

    -<IfDefine> Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Encloses directives that will be processed only -if a test is true at startup
    Syntax: -<IfDefine [!]parameter-name> ... - </IfDefine> -
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    -
    - - -

    The <IfDefine +

    <IfDefine> Directive

    Description: Encloses directives that will be processed only +if a test is true at startup
    Syntax:<IfDefine [!]parameter-name> ... + </IfDefine>
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    The <IfDefine test>...</IfDefine> section is used to mark directives that are conditional. The directives within an <IfDefine> section are only processed if the test is true. If test is false, everything between the start and end markers is ignored.

    - -

    The test in the <IfDefine> section directive can be one +

    The test in the <IfDefine> section directive can be one of two forms:

    - -
      - -
    • -parameter-name -
      • - - -
    • -!parameter-name -
      • - -
    +
      +
    • parameter-name
      • - -

      In the former case, the directives between the start and end +

    • !parameter-name
      • +
    + +

    In the former case, the directives between the start and end markers are only processed if the parameter named parameter-name is defined. The second format reverses the test, and only processes the directives if parameter-name is not defined.

    - -

    The parameter-name argument is a define as given on +

    The parameter-name argument is a define as given on the httpd command line via -Dparameter-, at the time the server was started.

    - -

    -<IfDefine> sections are +

    <IfDefine> sections are nest-able, which can be used to implement simple multiple-parameter tests. Example:

    - -
    - - -
    -
    +
    
   LoadModule rewrite_module modules/mod_rewrite.so
   LoadModule proxy_module   modules/libproxy.so
   </IfDefine>
-
-
-
-
       $ httpd -DReverseProxy ...
 
   # httpd.conf
@@ -1946,170 +643,70 @@ if a test is true at startup
    
-
    
-
-
-
-
    
-
    
-<IfModule> Directive
-
    
-
-
-
-
-
    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
    Description: Encloses directives that are processed conditional on the
-presence of absence of a specific module
    Syntax:
-<IfModule [!]module-name> ...
-    </IfModule>
-
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    
-
    
-
-    
-
    The <IfModule
+
    + +

    <IfModule> Directive

    Description: Encloses directives that are processed conditional on the +presence of absence of a specific module
    Syntax:<IfModule [!]module-name> ... + </IfModule>
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    The <IfModule test>...</IfModule> section is used to mark directives that are conditional. The directives within an <IfModule> section are only processed if the test is true. If test is false, everything between the start and end markers is ignored.

    - -

    The test in the <IfModule> section directive can be one +

    The test in the <IfModule> section directive can be one of two forms:

    - -
      - -
    • -module name -
      • - - -
    • !module name -
      • - -
    +
      +
    • module name
      • - -

      In the former case, the directives between the start and end +

    • !module name
      • +
    + +

    In the former case, the directives between the start and end markers are only processed if the module named module name is included in Apache -- either compiled in or - dynamically loaded using LoadModule. The second format + dynamically loaded using LoadModule. The second format reverses the test, and only processes the directives if module name is not included.

    - -

    The module name argument is the file name of the +

    The module name argument is the file name of the module, at the time it was compiled. For example, mod_rewrite.c.

    - -

    -<IfModule> sections are +

    <IfModule> sections are nest-able, which can be used to implement simple multiple-module tests.

    - -     -
    -

    -Include Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Includes other configuration files from within -the server configuration files
    Syntax: -Include file-path|directory-path - -
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    This directive allows inclusion of other configuration files +

    Include Directive

    Description: Includes other configuration files from within +the server configuration files
    Syntax:Include file-path|directory-path
    Context:server config
    Status:Core
    Module:core
    +

    This directive allows inclusion of other configuration files from within the server configuration files.

    - -

    If Include points to a directory, rather than a +

    If Include points to a directory, rather than a file, Apache will read all files in that directory, and any subdirectory, and parse those as configuration files.

    - -

    The file path specified may be a fully qualified path (i.e. +

    The file path specified may be a fully qualified path (i.e. starting with a slash), or may be relative to the - ServerRoot directory.

    - - -

    Examples:

    + ServerRoot directory.

    +

    Examples:

    -
    - - -
    +
    - -
    Include /usr/local/apache/conf/ssl.conf
    Include /usr/local/apache/conf/vhosts/ -
    -
    +
    - -

    Or, providing paths relative to your ServerRoot +

    Or, providing paths relative to your ServerRoot directory:

    - -
    - - -
    +
    - -
    Include conf/ssl.conf
    Include conf/vhosts/ -
    -
    +
    - -

    Make sure that an included directory does not contain any stray +

    Make sure that an included directory does not contain any stray files, such as editor temporary files, for example, as Apache will attempt to read them in and use the contents as configuration directives, which may cause the server to fail on start up. @@ -2117,71 +714,18 @@ the server configuration files the files that are being processed during the configuration check:

    - -
    - - -
    -
    +
    
-
-
      root@host# apachectl configtest
   Processing config directory: /usr/local/apache/conf/vhosts
   Processing config file: /usr/local/apache/conf/vhosts/vhost1
   Processing config file: /usr/local/apache/conf/vhosts/vhost2
  Syntax OK
-
    
-
    
-
    
-
-     
-
    This will help in verifying that you are getting only the files
-     that you intended as part of your configuration.
    
+
    -     -

    -See also: -

    - -
    -

    -KeepAlive Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Turns on or off HTTP persistent connections.
    Syntax: -KeepAlive on|off -
    Default:KeepAlive On
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    The Keep-Alive extension to HTTP/1.0 and the persistent +

    This will help in verifying that you are getting only the files + that you intended as part of your configuration.

    +

    See also

    KeepAlive Directive

    Description: Turns on or off HTTP persistent connections.
    Syntax:KeepAlive on|off
    Default:KeepAlive On
    Context:server config
    Status:Core
    Module:core
    +

    The Keep-Alive extension to HTTP/1.0 and the persistent connection feature of HTTP/1.1 provide long-lived HTTP sessions which allow multiple requests to be sent over the same TCP connection. In some cases this has been shown to result in an @@ -2189,8 +733,7 @@ the server configuration files many images. To enable Keep-Alive connections in Apache 1.2 and later, set KeepAlive On.

    - -

    For HTTP/1.0 clients, Keep-Alive connections will only be +

    For HTTP/1.0 clients, Keep-Alive connections will only be used if they are specifically requested by a client. In addition, a Keep-Alive connection with an HTTP/1.0 client can only be used when the length of the content is known in @@ -2201,106 +744,27 @@ the server configuration files unless otherwise specified. If the client requests it, chunked encoding will be used in order to send content of unknown length over persistent connections.

    - -     -

    -See also: -

    - -
    -

    -KeepAliveTimeout Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the amount of time the server will wait for subsequent -requests on a persistent connection
    Syntax: -KeepAliveTimeout seconds - -
    Default:KeepAliveTimeout 15
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    The number of seconds Apache will wait for a subsequent +

    See also

    KeepAliveTimeout Directive

    Description: Sets the amount of time the server will wait for subsequent +requests on a persistent connection
    Syntax:KeepAliveTimeout seconds
    Default:KeepAliveTimeout 15
    Context:server config
    Status:Core
    Module:core
    +

    The number of seconds Apache will wait for a subsequent request before closing the connection. Once a request has been received, the timeout value specified by the - Timeout directive applies.

    + Timeout directive applies.

    - -

    Setting KeepAliveTimeout to a high value +

    Setting KeepAliveTimeout to a high value may cause performance problems in heavily loaded servers. The higher the timeout, the more server processes will be kept occupied waiting on connections with idle clients.

    - -     -
    -

    -<Limit> Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Restrict access controls to only certain HTTP -methods
    Syntax: -<Limit method [method] ... > ... - </Limit> -
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    -
    - - -

    Access controls are normally effective for +

    <Limit> Directive

    Description: Restrict access controls to only certain HTTP +methods
    Syntax:<Limit method [method] ... > ... + </Limit>
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    Access controls are normally effective for all access methods, and this is the usual desired behavior. In the general case, access control directives should not be placed within a - <limit> section. -

    + <limit> section.

    - -

    The purpose of the <Limit> +

    The purpose of the <Limit> directive is to restrict the effect of the access controls to the nominated HTTP methods. For all other methods, the access restrictions that are enclosed in the <Limit> @@ -2308,113 +772,35 @@ methods example applies the access control only to the methods POST, PUT, and DELETE, leaving all other methods unprotected:

    - -
    - - -
    +
    - -
    <Limit POST PUT DELETE>
      Require valid-user
    </Limit>     -
    -
    - -

    The method names listed can be one or more of: GET, POST, PUT, +

    +

    The method names listed can be one or more of: GET, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH, PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, and UNLOCK. The method name is case-sensitive. If GET is used it will also restrict HEAD requests.

    - -     -
    -

    -<LimitExcept> Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Restrict access controls to all HTTP methods -except the named ones
    Syntax: -<LimitExcept method [method] ... > ... - </LimitExcept> -
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    -
    - - -

    -<LimitExcept> and +

    <LimitExcept> Directive

    Description: Restrict access controls to all HTTP methods +except the named ones
    Syntax:<LimitExcept method [method] ... > ... + </LimitExcept>
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    <LimitExcept> and </LimitExcept> are used to enclose a group of access control directives which will then apply to any HTTP access method not listed in the arguments; i.e., it is - the opposite of a <Limit> section and can be used to control + the opposite of a <Limit> section and can be used to control both standard and nonstandard/unrecognized methods. See the - documentation for <Limit> for more details.

    - -     -
    -

    -LimitRequestBody Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Restricts the total size of the HTTP request body sent -from the client
    Syntax: -LimitRequestBody bytes - -
    Default:LimitRequestBody 0
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    -
    - - -

    This directive specifies the number of bytes from 0 + documentation for <Limit> for more details.

    +

    LimitRequestBody Directive

    Description: Restricts the total size of the HTTP request body sent +from the client
    Syntax:LimitRequestBody bytes
    Default:LimitRequestBody 0
    Context:server config, virtual host, directory, .htaccess
    Status:Core
    Module:core
    +

    This directive specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in a request body. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_BODY (0 as distributed).

    - -

    The LimitRequestBody directive allows +

    The LimitRequestBody directive allows the user to set a limit on the allowed size of an HTTP request message body within the context in which the directive is given (server, per-directory, per-file or per-location). If the client @@ -2427,57 +813,18 @@ from the client least as large as any representation that the server wishes to accept for that resource.

    - -

    This directive gives the server administrator greater +

    This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks.

    - -     -
    -

    -LimitRequestFields Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Limits the number of HTTP request header fields that -will be accepted from the client
    Syntax: -LimitRequestFields number - -
    Default:LimitRequestFields 100
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    -Number is an integer from 0 (meaning unlimited) to +

    LimitRequestFields Directive

    Description: Limits the number of HTTP request header fields that +will be accepted from the client
    Syntax:LimitRequestFields number
    Default:LimitRequestFields 100
    Context:server config
    Status:Core
    Module:core
    +

    Number is an integer from 0 (meaning unlimited) to 32767. The default value is defined by the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDS (100 as distributed).

    - -

    The LimitRequestFields directive allows +

    The LimitRequestFields directive allows the server administrator to modify the limit on the number of request header fields allowed in an HTTP request. A server needs this value to be larger than the number of fields that a normal @@ -2488,59 +835,21 @@ will be accepted from the client content negotiation. Optional HTTP extensions are often expressed using request header fields.

    - -

    This directive gives the server administrator greater +

    This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. The value should be increased if normal clients see an error response from the server that indicates too many fields were sent in the request.

    - -     -
    -

    -LimitRequestFieldSize Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Limits the size of the HTTP request header allowed from the -client
    Syntax: -LimitRequestFieldsize bytes - -
    Default:LimitRequestFieldsize 8190
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    This directive specifies the number of bytes from 0 +

    LimitRequestFieldSize Directive

    Description: Limits the size of the HTTP request header allowed from the +client
    Syntax:LimitRequestFieldsize bytes
    Default:LimitRequestFieldsize 8190
    Context:server config
    Status:Core
    Module:core
    +

    This directive specifies the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_FIELDSIZE (8190 as distributed) that will be allowed in an HTTP request header.

    - -

    The LimitRequestFieldsize directive +

    The LimitRequestFieldsize directive allows the server administrator to reduce the limit on the allowed size of an HTTP request header field below the normal input buffer size compiled with the server. A server needs this value to be @@ -2550,57 +859,19 @@ client upon the extent to which a user has configured their browser to support detailed content negotiation.

    - -

    This directive gives the server administrator greater +

    This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. Under normal conditions, the value should not be changed from the default.

    - -     -
    -

    -LimitRequestLine Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Limit the size of the HTTP request line that will be accepted -from the client
    Syntax: -LimitRequestLine bytes - -
    Default:LimitRequestLine 8190
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    This directive sets the number of bytes from 0 to +

    LimitRequestLine Directive

    Description: Limit the size of the HTTP request line that will be accepted +from the client
    Syntax:LimitRequestLine bytes
    Default:LimitRequestLine 8190
    Context:server config
    Status:Core
    Module:core
    +

    This directive sets the number of bytes from 0 to the value of the compile-time constant DEFAULT_LIMIT_REQUEST_LINE (8190 as distributed) that will be allowed on the HTTP request-line.

    - -

    The LimitRequestLine directive allows +

    The LimitRequestLine directive allows the server administrator to reduce the limit on the allowed size of a client's HTTP request-line below the normal input buffer size compiled with the server. Since the request-line consists of the @@ -2611,170 +882,73 @@ from the client hold any of its resource names, including any information that might be passed in the query part of a GET request.

    - -

    This directive gives the server administrator greater +

    This directive gives the server administrator greater control over abnormal client request behavior, which may be useful for avoiding some forms of denial-of-service attacks. Under normal conditions, the value should not be changed from the default.

    - -     -
    -

    -LimitXMLRequestBody Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Limits the size of an XML-based request body
    Syntax: -LimitXMLRequestBody number - -
    Default:LimitXMLRequestBody 1000000
    Context:server config
    Status:Core
    Module:core
    -
    - - -

    Limit (in bytes) on maximum size of an XML-based request +

    LimitXMLRequestBody Directive

    Description: Limits the size of an XML-based request body
    Syntax:LimitXMLRequestBody number
    Default:LimitXMLRequestBody 1000000
    Context:server config
    Status:Core
    Module:core
    +

    Limit (in bytes) on maximum size of an XML-based request body. A value of 0 will disable any checking.

    - -     -
    -

    -<Location> Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Applies the enclosed directives only to matching -URLs
    Syntax: -<Location - URL-path|URL> ... </Location> -
    Context:server config, virtual host
    Status:Core
    Module:core
    -
    - - -

    The <Location> directive +

    <Location> Directive

    Description: Applies the enclosed directives only to matching +URLs
    Syntax:<Location + URL-path|URL> ... </Location>
    Context:server config, virtual host
    Status:Core
    Module:core
    +

    The <Location> directive provides for access control by URL. It is similar to the - <Directory> + <Directory> directive, and starts a subsection which is terminated with a </Location> directive. <Location> sections are processed in the - order they appear in the configuration file, after the <Directory> sections and - .htaccess files are read, and after the <Files> sections.

    + order they appear in the configuration file, after the <Directory> sections and + .htaccess files are read, and after the <Files> sections.

    - -

    Note that URLs do not have to line up with the filesystem at +

    Note that URLs do not have to line up with the filesystem at all, it should be emphasized that <Location> operates completely outside the filesystem.

    - -

    For all origin (non-proxy) requests, the URL to be matched +

    For all origin (non-proxy) requests, the URL to be matched is of the form /path/, and you should not include any http://servername prefix. For proxy requests, the URL to be matched is of the form scheme://servername/path, and you must include the prefix.

    - -

    The URL may use wildcards In a wild-card string, `?' matches +

    The URL may use wildcards In a wild-card string, `?' matches any single character, and `*' matches any sequences of characters.

    - -

    Extended regular +

    Extended regular expressions can also be used, with the addition of the ~ character. For example:

    - -
    - - -
    +
    - -
    <Location ~ "/(extra|special)/data"> -
    -
    +
    - -

    would match URLs that contained the substring "/extra/data" or +

    would match URLs that contained the substring "/extra/data" or "/special/data". In Apache 1.3 and above, a new directive - <LocationMatch> + <LocationMatch> exists which behaves identical to the regex version of <Location>.

    - -

    The <Location> +

    The <Location> functionality is especially useful when combined with the - SetHandler + SetHandler directive. For example, to enable status requests, but allow them only from browsers at foo.com, you might use:

    - -
    - - -
    +
    - -
    <Location /status>
    SetHandler server-status
    Order Deny,Allow
    Deny from all
    Allow from .foo.com
    </Location> -
    -
    - - -
    - - -
    -

    -Note about / (slash) -

    -

    The slash character has +

    + +
    - -

    Note about / (slash)

    The slash character has special meaning depending on where in a URL it appears. People may be used to its behavior in the filesystem where multiple adjacent slashes are frequently collapsed to a single slash (i.e., /home///foo is the same as /home/foo). In -URL-space this is not necessarily true. The <LocationMatch> directive and the regex +URL-space this is not necessarily true. The <LocationMatch> directive and the regex version of <Location> require you to explicitly specify multiple slashes if that is your intention. For example, <LocationMatch ^/abc> would match the @@ -2784,413 +958,182 @@ used for proxy requests. But when (non-regex) <Locati will implicitly match multiple slashes with a single slash. For example, if you specify <Location /abc/def> and the request is to /abc//def then it will match.

    - -
    -
    - - -

    -See also: -

    -
    +

    See also

    -
    -

    -<LocationMatch> Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Applies the enclosed directives only to regular-expression -matching URLs
    Syntax: -<LocationMatch - regex> ... </Location> -
    Context:server config, virtual host
    Status:Core
    Module:core
    -
    - - -

    The <LocationMatch> directive + request is received

<LocationMatch> Directive

Description: Applies the enclosed directives only to regular-expression +matching URLs
Syntax:<LocationMatch + regex> ... </Location>
Context:server config, virtual host
Status:Core
Module:core
+

The <LocationMatch> directive provides for access control by URL, in an identical manner to - <Location>. However, it takes a regular + <Location>. However, it takes a regular expression as an argument instead of a simple string. For example:

- -
- - -
+
- -
<LocationMatch "/(extra|special)/data"> -
-
+
- -

would match URLs that contained the substring "/extra/data" +

would match URLs that contained the substring "/extra/data" or "/special/data".

- - -

-See also: -

-

LogLevel Directive

Description: Controls the verbosity of the ErrorLog
Syntax:LogLevel level
Default:LogLevel warn
Context:server config, virtual host
Status:Core
Module:core
+

LogLevel adjusts the verbosity of the + messages recorded in the error logs (see ErrorLog directive). The following levels are available, in order of decreasing significance:

- - - - - - +
Level
+ + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - + - - - - + + - - + - - - - + - - - -
Level Description
+
Example
emerg
emerg Emergencies - system is unusable.
+
"Child cannot open lock file. Exiting"
alert
alert Action must be taken immediately.
+
"getpwuid: couldn't determine user name from uid"
crit
crit Critical Conditions.
+
"socket: Failed to get a socket, exiting child"
error
error Error conditions.
+
"Premature end of script headers"
warn
warn Warning conditions.
+
"child process 1234 did not exit, sending another SIGHUP"
notice
notice Normal but significant condition.
+
"httpd: caught SIGBUS, attempting to dump core in ..."
info
info Informational.
+
"Server seems busy, (you may need to increase StartServers, or Min/MaxSpareServers)..."
debug
debug Debug-level messages
+
"Opening config file ..."
+ + - -

When a particular level is specified, messages from all +

When a particular level is specified, messages from all other levels of higher significance will be reported as well. E.g., when LogLevel info is specified, then messages with log levels of notice and warn will also be posted.

- -

Using a level of at least crit is +

Using a level of at least crit is recommended.

- - -
-

-MaxKeepAliveRequests Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the number of requests allowed on a persistent -connection
Syntax: -MaxKeepAliveRequests number - -
Default:MaxKeepAliveRequests 100
Context:server config
Status:Core
Module:core
-
- - -

The MaxKeepAliveRequests directive +

MaxKeepAliveRequests Directive

Description: Sets the number of requests allowed on a persistent +connection
Syntax:MaxKeepAliveRequests number
Default:MaxKeepAliveRequests 100
Context:server config
Status:Core
Module:core
+

The MaxKeepAliveRequests directive limits the number of requests allowed per connection when - KeepAlive is on. If it is + KeepAlive is on. If it is set to "0", unlimited requests will be allowed. We recommend that this setting be kept to a high value for maximum server performance.

- - -
-

-NameVirtualHost Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Configures an IP address for name-virtual -hosting
Syntax: -NameVirtualHost addr[:port] -
Context:server config
Status:Core
Module:core
-
- - -

The NameVirtualHost directive is a +

NameVirtualHost Directive

Description: Configures an IP address for name-virtual +hosting
Syntax:NameVirtualHost addr[:port]
Context:server config
Status:Core
Module:core
+

The NameVirtualHost directive is a required directive if you want to configure name-based virtual hosts.

- -

Although addr can be hostname it is recommended - that you always use an IP address, e.g. -

- +

Although addr can be hostname it is recommended + that you always use an IP address, e.g.

-
- - - - -
NameVirtualHost 111.22.33.44
-
+
NameVirtualHost 111.22.33.44
- -

With the NameVirtualHost directive you +

With the NameVirtualHost directive you specify the IP address on which the server will receive requests for the name-based virtual hosts. This will usually be the address to which your name-based virtual host names resolve. In cases @@ -3200,173 +1143,92 @@ hosting servicing the requests. If you have multiple name-based hosts on multiple addresses, repeat the directive for each address.

- -

Note: the "main server" and any _default_ servers will +

Note: the "main server" and any _default_ servers will never be served for a request to a NameVirtualHost IP Address (unless for some reason you specify NameVirtualHost but then don't define any VirtualHosts for that address).

- -

Optionally you can specify a port number on which the - name-based virtual hosts should be used, e.g. -

+

Optionally you can specify a port number on which the + name-based virtual hosts should be used, e.g.

+
NameVirtualHost 111.22.33.44:8080
-
- - - - -
NameVirtualHost 111.22.33.44:8080
-
- - -

IPv6 addresses must be enclosed in square brackets, as shown +

IPv6 addresses must be enclosed in square brackets, as shown in the following example:

+
NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080
-
- - - - -
NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080
-
- - - -
-

-Options Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Configures what features are available in a particular -directory
Syntax: -Options - [+|-]option [[+|-]option] ... -
Default:Options All
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Core
Module:core
-
- - -

The Options directive controls which +

Options Directive

Description: Configures what features are available in a particular +directory
Syntax:Options + [+|-]option [[+|-]option] ...
Default:Options All
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Core
Module:core
+

The Options directive controls which server features are available in a particular directory.

- -

-option can be set to None, in which +

option can be set to None, in which case none of the extra features are enabled, or one or more of the following:

- -
- -
All
+
+
All
- -
All options except for MultiViews. This is the default +
All options except for MultiViews. This is the default setting.
- -
ExecCGI
+
ExecCGI
- -
+
Execution of CGI scripts is permitted.
- -
FollowSymLinks
+
FollowSymLinks
- -
+
The server will follow symbolic links in this directory.
- -Note: even though the server follows the + Note: even though the server follows the symlink it does not change the pathname used to match - against <Directory> sections.
- -Note: this option gets ignored if set inside a - <Location> + against <Directory> sections.
+ Note: this option gets ignored if set inside a + <Location> section.
- -
Includes
+
Includes
- -
+
Server-side includes are permitted.
- -
IncludesNOEXEC
+
IncludesNOEXEC
- -
+
Server-side includes are permitted, but the #exec command and #exec CGI are disabled. It is still possible to #include virtual CGI scripts from ScriptAliase'd directories.
- -
Indexes
+
Indexes
- -
+
If a URL which maps to a directory is requested, and the there is no DirectoryIndex (e.g., index.html) in that directory, then the server will return a formatted listing of the directory.
- -
MultiViews
+
MultiViews
- -
- -Content negotiated +
+ Content negotiated MultiViews are allowed.
- -
SymLinksIfOwnerMatch
+
SymLinksIfOwnerMatch
- -
+
The server will only follow symbolic links for which the target - file or directory is owned by the same user id as the link.
-Note: this option gets ignored if set inside - a <Location> + file or directory is owned by the same user id as the link.
Note: this option gets ignored if set inside + a <Location> section.
- -
- -

Normally, if multiple Options could apply to a +

+

Normally, if multiple Options could apply to a directory, then the most specific one is taken complete; the options are not merged. However if all the options on the Options directive are preceded by a + or - @@ -3375,213 +1237,90 @@ directory preceded by a - are removed from the options currently in force.

- -

For example, without any + and - symbols:

- +

For example, without any + and - symbols:

-
- - -
<Directory /web/docs>
+
- -
<Directory /web/docs>
Options Indexes FollowSymLinks
</Directory>
<Directory /web/docs/spec>
Options Includes
</Directory> -
-
- -

then only Includes will be set for the +

+

then only Includes will be set for the /web/docs/spec directory. However if the second Options directive uses the + and - symbols:

- -
- - -
+
- -
<Directory /web/docs>
Options Indexes FollowSymLinks
</Directory>
<Directory /web/docs/spec>
Options +Includes -Indexes
</Directory> -
-
- -

then the options FollowSymLinks and +

+

then the options FollowSymLinks and Includes are set for the /web/docs/spec directory.

- -

-Note: Using -IncludesNOEXEC or +

Note: Using -IncludesNOEXEC or -Includes disables server-side includes completely regardless of the previous setting.

- -

The default in the absence of any other settings is +

The default in the absence of any other settings is All.

- - -
-

-Require Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Selects which authenticated users can access -a resource
Syntax: -Require entity-name [entity-name] ... -
Context:directory, .htaccess
Override:AuthConfig
Status:Core
Module:core
-
- - -

This directive selects which authenticated users can access +

Require Directive

Description: Selects which authenticated users can access +a resource
Syntax:Require entity-name [entity-name] ...
Context:directory, .htaccess
Override:AuthConfig
Status:Core
Module:core
+

This directive selects which authenticated users can access a directory. The allowed syntaxes are:

- -
    - -
  • +
      +
    • Require user userid [userid] ...

      Only the named users can access the directory.

      - -
      • + - -
    • +
    • Require group group-name [group-name] ...

      Only users in the named groups can access the directory.

      - -
      • + - -
    • +
    • Require valid-user

      All valid users can access the directory.

      - -
      • - -
    +
    • +
- -

-Require must be accompanied by - AuthName and AuthType directives, and directives such - as AuthUserFile - and AuthGroupFile (to +

Require must be accompanied by + AuthName and AuthType directives, and directives such + as AuthUserFile + and AuthGroupFile (to define users and groups) in order to work correctly. Example:

- -
- - - - -
+
AuthType Basic
AuthName "Restricted Directory"
AuthUserFile /web/users
AuthGroupFile /web/groups
Require group admin
+
-
-
- - -

Access controls which are applied in this way are effective for +

Access controls which are applied in this way are effective for all methods. This is what is normally desired. If you wish to apply access controls only to specific methods, while leaving other methods unprotected, then place the Require statement into a - <Limit> + <Limit> section.

- - -

-See also: -

- -
-

-RLimitCPU Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Limits the CPU consumption of processes launched -by Apache children
Syntax: -RLimitCPU number|max [number|max] -
Default:Unset; uses operating system defaults
Context:server config, virtual host
Status:Core
Module:core
Compatibility:Moved in version 2.0 to - the MPMs
-
- - -

Takes 1 or 2 parameters. The first parameter sets the soft +

See also

RLimitCPU Directive

Description: Limits the CPU consumption of processes launched +by Apache children
Syntax:RLimitCPU number|max [number|max]
Default:Unset; uses operating system defaults
Context:server config, virtual host
Status:Core
Module:core
Compatibility:Moved in version 2.0 to + the MPMs
+

Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit should @@ -3590,68 +1329,17 @@ by Apache children the server is running as root, or in the initial startup phase.

- -

This applies to processes forked off from Apache children +

This applies to processes forked off from Apache children servicing requests, not the Apache children themselves. This includes CGI scripts and SSI exec commands, but not any processes forked off from the Apache parent such as piped logs.

- -

CPU resource limits are expressed in seconds per +

CPU resource limits are expressed in seconds per process.

- - -

-See also: -

- -
-

-RLimitMEM Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Limits the memory consumption of processes launched -by Apache children
Syntax: -RLimitMEM number|max [number|max] -
Default:Unset; uses operating system defaults
Context:server config, virtual host
Status:Core
Module:core
Compatibility:Moved in version 2.0 to the MPMs.
-
- - -

Takes 1 or 2 parameters. The first parameter sets the soft +

See also

RLimitMEM Directive

Description: Limits the memory consumption of processes launched +by Apache children
Syntax:RLimitMEM number|max [number|max]
Default:Unset; uses operating system defaults
Context:server config, virtual host
Status:Core
Module:core
Compatibility:Moved in version 2.0 to the MPMs.
+

Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit should @@ -3660,68 +1348,17 @@ by Apache children the server is running as root, or in the initial startup phase.

- -

This applies to processes forked off from Apache children +

This applies to processes forked off from Apache children servicing requests, not the Apache children themselves. This includes CGI scripts and SSI exec commands, but not any processes forked off from the Apache parent such as piped logs.

- -

Memory resource limits are expressed in bytes per +

Memory resource limits are expressed in bytes per process.

- - -

-See also: -

- -
-

-RLimitNPROC Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Limits the number of processes that can be launched by -processes launched by Apache children
Syntax: -RLimitNPROC number|max [number|max] -
Default:Unset; uses operating system defaults
Context:server config, virtual host
Status:Core
Module:core
Compatibility:Moved in version 2.0 to the MPMs.
-
- - -

Takes 1 or 2 parameters. The first parameter sets the soft +

See also

RLimitNPROC Directive

Description: Limits the number of processes that can be launched by +processes launched by Apache children
Syntax:RLimitNPROC number|max [number|max]
Default:Unset; uses operating system defaults
Context:server config, virtual host
Status:Core
Module:core
Compatibility:Moved in version 2.0 to the MPMs.
+

Takes 1 or 2 parameters. The first parameter sets the soft resource limit for all processes and the second parameter sets the maximum resource limit. Either parameter can be a number, or max to indicate to the server that the limit @@ -3730,72 +1367,23 @@ processes launched by Apache children the server is running as root, or in the initial startup phase.

- -

This applies to processes forked off from Apache children +

This applies to processes forked off from Apache children servicing requests, not the Apache children themselves. This includes CGI scripts and SSI exec commands, but not any processes forked off from the Apache parent such as piped logs.

- -

Process limits control the number of processes per user.

+

Process limits control the number of processes per user.

- -

Note: If CGI processes are not running +

Note: If CGI processes are not running under userids other than the web server userid, this directive will limit the number of processes that the server itself can create. Evidence of this situation will be indicated by cannot fork messages in the error_log.

- - -

-See also: -

- -
-

-Satisfy Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Configures how host-level access control and user authentication -interact
Syntax: -Satisfy any|all -
Default:Satisfy all
Context:directory, .htaccess
Status:Core
Module:core
-
- - -

Access policy if both Allow and Require used. The parameter can be +

See also

Satisfy Directive

Description: Configures how host-level access control and user authentication +interact
Syntax:Satisfy any|all
Default:Satisfy all
Context:directory, .htaccess
Status:Core
Module:core
+

Access policy if both Allow and Require used. The parameter can be either 'all' or 'any'. This directive is only useful if access to a particular area is being restricted by both username/password and client host address. In this case @@ -3806,206 +1394,42 @@ interact valid username and password. This can be used to password restrict an area, but to let clients from particular addresses in without prompting for a password.

- - -
-

-ScriptInterpreterSource Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Controls how the interpreter for CGI scripts is -located
Syntax: -ScriptInterpreterSource registry|script -
Default:ScriptInterpreterSource script
Context:directory, .htaccess
Status:Core
Module:core
Compatibility:Win32 only
-
- - -

This directive is used to control how Apache finds the +

ScriptInterpreterSource Directive

Description: Controls how the interpreter for CGI scripts is +located
Syntax:ScriptInterpreterSource registry|script
Default:ScriptInterpreterSource script
Context:directory, .htaccess
Status:Core
Module:core
Compatibility:Win32 only
+

This directive is used to control how Apache finds the interpreter used to run CGI scripts. The default technique is to use the interpreter pointed to by the #! line in the script. Setting ScriptInterpreterSource registry will cause the Windows Registry to be searched using the script file extension (e.g., .pl) as a search key.

- - -
-

-ServerAdmin Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Sets the email address that the server includes in error -messages sent to the client
Syntax: -ServerAdmin email-address - -
Context:server config, virtual host
Status:Core
Module:core
-
- - -

The ServerAdmin sets the e-mail address +

ServerAdmin Directive

Description: Sets the email address that the server includes in error +messages sent to the client
Syntax:ServerAdmin email-address
Context:server config, virtual host
Status:Core
Module:core
+

The ServerAdmin sets the e-mail address that the server includes in any error messages it returns to the client.

- -

It may be worth setting up a dedicated address for this, - e.g. -

- -
- - - - -
ServerAdmin www-admin@foo.bar.com
-
- -

as users do not always mention that they are talking about the +

It may be worth setting up a dedicated address for this, + e.g.

+
ServerAdmin www-admin@foo.bar.com
+

as users do not always mention that they are talking about the server!

- - -
-

-ServerAlias Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Sets alternate names for a host used when matching requests -to name-virtual hosts
Syntax: -ServerAlias hostname [hostname] ... -
Context:virtual host
Status:Core
Module:core
-
- - -

The ServerAlias directive sets the +

ServerAlias Directive

Description: Sets alternate names for a host used when matching requests +to name-virtual hosts
Syntax:ServerAlias hostname [hostname] ...
Context:virtual host
Status:Core
Module:core
+

The ServerAlias directive sets the alternate names for a host, for use with name-based virtual hosts.

- -
- - -
+
- -
<VirtualHost *>
ServerName server.domain.com
ServerAlias server server2.domain.com server2
...
</VirtualHost> -
-
- - -

-See also: -

- -
-

-ServerName Directive -

- - -
- - - - - - - - - - - - - - - - - -
Description: Sets the hostname and port that the server uses to identify -itself
Syntax: -ServerName fully-qualified-domain-name[:port] - -
Context:server config, virtual host
Status:Core
Module:core
Compatibility:In version 2.0, this +
+

See also

ServerName Directive

- -
- -
Description: Sets the hostname and port that the server uses to identify +itself
Syntax:ServerName fully-qualified-domain-name[:port]
Context:server config, virtual host
Status:Core
Module:core
Compatibility:In version 2.0, this directive supersedes the functionality of the Port - directive from version 1.3.
-
- - -

The ServerName directive sets the hostname and + directive from version 1.3.

+

The ServerName directive sets the hostname and port that the server uses to identify itself. This is used when creating redirection URLs. For example, if the name of the machine hosting the webserver is simple.example.com, @@ -4013,17 +1437,9 @@ itself and you wish the webserver to be so identified, the following directive should be used:

+
ServerName www.example.com:80
-
- - - - -
ServerName www.example.com:80
-
- - -

If no ServerName is specified, then the +

If no ServerName is specified, then the server attempts to deduce the hostname by performing a reverse lookup on the IP address. If no port is specified in the servername, then the server will use the port from the incoming @@ -4031,178 +1447,34 @@ itself specify an explicit hostname and port using the ServerName directive.

- -

If you are using name-based virtual hosts, +

If you are using name-based virtual hosts, the ServerName inside a - <VirtualHost> + <VirtualHost> section specifies what hostname must appear in the request's Host: header to match this virtual host.

- -

See the description of the - UseCanonicalName directive for +

See the description of the + UseCanonicalName directive for settings which determine whether self-referential URL's (e.g., by the mod_dir module) will refer to the specified port, or to the port number given in the client's request.

- - -

-See also: -

- -
-

-ServerPath Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Sets the legacy URL pathname for a name-virtual host that -is accessed by an incompatible browser
Syntax: -ServerPath directory-path - -
Context:virtual host
Status:Core
Module:core
-
- - -

The ServerPath directive sets the legacy +

See also

ServerPath Directive

Description: Sets the legacy URL pathname for a name-virtual host that +is accessed by an incompatible browser
Syntax:ServerPath directory-path
Context:virtual host
Status:Core
Module:core
+

The ServerPath directive sets the legacy URL pathname for a host, for use with name-based virtual hosts.

- - -

-See also: -

- -
-

-ServerRoot Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the base directory for the server installation
Syntax: -ServerRoot directory-path - -
Default:ServerRoot /usr/local/apache
Context:server config
Status:Core
Module:core
-
- - -

The ServerRoot directive sets the +

See also

ServerRoot Directive

Description: Sets the base directory for the server installation
Syntax:ServerRoot directory-path
Default:ServerRoot /usr/local/apache
Context:server config
Status:Core
Module:core
+

The ServerRoot directive sets the directory in which the server lives. Typically it will contain the subdirectories conf/ and logs/. Relative paths for other configuration files are taken as relative to this directory.

- - -

-See also: -

-

ServerSignature Directive

Description: Configures the footer on server-generated documents
Syntax:ServerSignature On|Off|EMail
Default:ServerSignature Off
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
+

The ServerSignature directive allows the configuration of a trailing footer line under server-generated documents (error messages, mod_proxy ftp directory listings, mod_info output, ...). The reason why you would want to enable @@ -4212,407 +1484,130 @@ is accessed by an incompatible browser setting, which is the default, suppresses the error line (and is therefore compatible with the behavior of Apache-1.2 and below). The On setting simply adds a line with the - server version number and ServerName of the serving virtual host, + server version number and ServerName of the serving virtual host, and the EMail setting additionally creates a - "mailto:" reference to the ServerAdmin of the referenced + "mailto:" reference to the ServerAdmin of the referenced document.

- - -
-

-ServerTokens Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Configures the Server HTTP response header
Syntax: -ServerTokens Minimal|ProductOnly|OS|Full -
Default:ServerTokens Full
Context:server config
Status:Core
Module:core
-
- - -

This directive controls whether Server response +

ServerTokens Directive

Description: Configures the Server HTTP response header
Syntax:ServerTokens Minimal|ProductOnly|OS|Full
Default:ServerTokens Full
Context:server config
Status:Core
Module:core
+

This directive controls whether Server response header field which is sent back to clients includes a description of the generic OS-type of the server as well as information about compiled-in modules.

- -
- -
-ServerTokens Prod[uctOnly] -
- - -
Server sends (e.g.): Server: - Apache -
- - -
-ServerTokens Min[imal] -
- - -
Server sends (e.g.): Server: - Apache/1.3.0 -
- - -
-ServerTokens OS -
- - -
Server sends (e.g.): Server: Apache/1.3.0 - (Unix) -
- - -
-ServerTokens Full (or not specified)
- - -
Server sends (e.g.): Server: Apache/1.3.0 - (Unix) PHP/3.0 MyMod/1.2 -
- -
+
+
ServerTokens Prod[uctOnly]
- -

This setting applies to the entire server, and cannot be - enabled or disabled on a virtualhost-by-virtualhost basis.

+
Server sends (e.g.): Server: + Apache
- -
-

-SetHandler Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Forces all matching files to be processed by a -handler
Syntax: -SetHandler handler-name - -
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
Compatibility:Moved into the core in Apache 2.0
-
- - -

When placed into an .htaccess file or a - <Directory> or - <Location> +

ServerTokens Min[imal]
+ +
Server sends (e.g.): Server: + Apache/1.3.0
+ +
ServerTokens OS
+ +
Server sends (e.g.): Server: Apache/1.3.0 + (Unix)
+ +
ServerTokens Full (or not specified)
+ +
Server sends (e.g.): Server: Apache/1.3.0 + (Unix) PHP/3.0 MyMod/1.2
+
+ +

This setting applies to the entire server, and cannot be + enabled or disabled on a virtualhost-by-virtualhost basis.

+

SetHandler Directive

Description: Forces all matching files to be processed by a +handler
Syntax:SetHandler handler-name
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
Compatibility:Moved into the core in Apache 2.0
+

When placed into an .htaccess file or a + <Directory> or + <Location> section, this directive forces all matching files to be parsed through the handler given by handler-name. For example, if you had a directory you wanted to be parsed entirely as imagemap rule files, regardless of extension, you might put the following into an .htaccess file in that directory:

- -
- - -
+
- -
SetHandler imap-file -
-
+
- -

Another example: if you wanted to have the server display a +

Another example: if you wanted to have the server display a status report whenever a URL of http://servername/status was called, you might put the following into httpd.conf:

- -
- - -
+
- -
<Location /status>
SetHandler server-status
</Location> -
-
- - -
-

-SetInputFilter Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Sets the filters that will process client requests and POST -input
Syntax: -SetInputFilter filter[;filter...] -
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
-
- - -

The SetInputFilter directive sets the +

+

SetInputFilter Directive

Description: Sets the filters that will process client requests and POST +input
Syntax:SetInputFilter filter[;filter...]
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
+

The SetInputFilter directive sets the filter or filters which will process client requests and POST input when they are received by the server. This is in addition to any filters defined elsewhere, including the - AddInputFilter + AddInputFilter directive.

- -

If more than one filter is specified, they must be separated +

If more than one filter is specified, they must be separated by semicolons in the order in which they should process the content.

- - -

-See also: -

- -
-

-SetOutputFilter Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Sets the filters that will process responses from the -server
Syntax: -SetOutputFilter filter [filter] ... -
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
-
- - -

The SetOutputFilter directive sets the filters +

See also

SetOutputFilter Directive

Description: Sets the filters that will process responses from the +server
Syntax:SetOutputFilter filter [filter] ...
Context:server config, virtual host, directory, .htaccess
Status:Core
Module:core
+

The SetOutputFilter directive sets the filters which will process responses from the server before they are sent to the client. This is in addition to any filters defined elsewhere, including the - AddOutputFilter + AddOutputFilter directive.

- -

For example, the following configuration will process all files +

For example, the following configuration will process all files in the /www/data/ directory for server-side includes.

- -
- - -
+
- -
<Directory /www/data/>
  SetOutputFilter INCLUDES
</Directory> -
-
+
- -

If more than one filter is specified, they must be separated +

If more than one filter is specified, they must be separated by semicolons in the order in which they should process the content.

- - -

-See also: -

- -
-

-TimeOut Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Defines the amount of time the server will wait for -certain events before failing a request
Syntax: -TimeOut number - -
Default:TimeOut 300
Context:server config
Status:Core
Module:core
-
- - -

The TimeOut directive currently defines +

See also

TimeOut Directive

Description: Defines the amount of time the server will wait for +certain events before failing a request
Syntax:TimeOut number
Default:TimeOut 300
Context:server config
Status:Core
Module:core
+

The TimeOut directive currently defines the amount of time Apache will wait for three things:

- -
    - -
  1. The total amount of time it takes to receive a GET +
      +
    1. The total amount of time it takes to receive a GET request.
      2. - -
    2. The amount of time between receipt of TCP packets on a +
    3. The amount of time between receipt of TCP packets on a POST or PUT request.
      4. - -
    4. The amount of time between ACKs on transmissions of TCP +
    5. The amount of time between ACKs on transmissions of TCP packets in responses.
      6. +
    -
- - -

We plan on making these separately configurable at some point +

We plan on making these separately configurable at some point down the road. The timer used to default to 1200 before 1.2, but has been lowered to 300 which is still far more than necessary in most situations. It is not set any lower by default because there may still be odd places in the code where the timer is not reset when a packet is sent.

- - -
-

-UseCanonicalName Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Configures how the server determines its own name and -port
Syntax: -UseCanonicalName on|off|dns -
Default:UseCanonicalName on
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Core
Module:core
-
- - -

In many situations Apache has to construct a +

UseCanonicalName Directive

Description: Configures how the server determines its own name and +port
Syntax:UseCanonicalName on|off|dns
Default:UseCanonicalName on
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Core
Module:core
+

In many situations Apache has to construct a self-referential URL. That is, a URL which refers back to the same server. With UseCanonicalName on Apache will - use the hostname and port specified in the ServerName directive to construct a canonical + use the hostname and port specified in the ServerName directive to construct a canonical name for the server. This name is used in all self-referential URLs, and for the values of SERVER_NAME and SERVER_PORT in CGIs.

- -

With UseCanonicalName off Apache will form +

With UseCanonicalName off Apache will form self-referential URLs using the hostname and port supplied by the client if any are supplied (otherwise it will use the canonical name). These values are the same that are used to @@ -4622,8 +1617,7 @@ port SERVER_PORT will be constructed from the client supplied values as well.

- -

An example where this may be useful is on an intranet server +

An example where this may be useful is on an intranet server where you have users connecting to the machine using short names such as www. You'll notice that if the users type a shortname, and a URL which is a directory, such as @@ -4636,71 +1630,24 @@ port UseCanonicalName is set off, then Apache will redirect to http://www/splat/.

- -

There is a third option, UseCanonicalName DNS, +

There is a third option, UseCanonicalName DNS, which is intended for use with mass IP-based virtual hosting to support ancient clients that do not provide a Host: header. With this option Apache does a reverse DNS lookup on the server IP address that the client connected to in order to work out self-referential URLs.

- -

-Warning: if CGIs make assumptions about the +

Warning: if CGIs make assumptions about the values of SERVER_NAME they may be broken by this option. The client is essentially free to give whatever value they want as a hostname. But if the CGI is only using SERVER_NAME to construct self-referential URLs then it should be just fine.

- - -

-See also: -

- -
-

-<VirtualHost> Directive -

- - -
- - - - - -
Description: Contains directives that apply only to a specific -hostname or IP address
Syntax: -<VirtualHost +

See also

<VirtualHost> Directive

- -
- - - - - - - - - - -
Description: Contains directives that apply only to a specific +hostname or IP address
Syntax:<VirtualHost addr[:port] [addr[:port]] - ...> ... </VirtualHost> -
Context:server config
Status:Core
Module:core
-
- - -

-<VirtualHost> and + ...> ... </VirtualHost>

Context:server config
Status:Core
Module:core
+

<VirtualHost> and </VirtualHost> are used to enclose a group of directives which will apply only to a particular virtual host. Any directive which is allowed in a virtual host context may be @@ -4709,44 +1656,29 @@ hostname or IP address enclosed in the <VirtualHost> section. Addr can be

- -
    - -
  • The IP address of the virtual host
    • +
      +
    • The IP address of the virtual host
      • - -
    • A fully qualified domain name for the IP address of the +
    • A fully qualified domain name for the IP address of the virtual host.
      • - -
    +
Example: -
- - -
<VirtualHost 10.1.2.3>
+
- -
<VirtualHost 10.1.2.3>
ServerAdmin webmaster@host.foo.com
DocumentRoot /www/docs/host.foo.com
ServerName host.foo.com
ErrorLog logs/host.foo.com-error_log
TransferLog logs/host.foo.com-access_log
</VirtualHost> -
-
+
- -

IPv6 addresses must be specified in square brackets because +

IPv6 addresses must be specified in square brackets because the optional port number could not be determined otherwise. An IPv6 example is shown below:

- -
- - -
+
ErrorLog logs/host.foo.com-error_log
TransferLog logs/host.foo.com-access_log
</VirtualHost> - - -
<VirtualHost [fe80::a00:20ff:fea7:ccea]>
ServerAdmin webmaster@host.foo.com
DocumentRoot /www/docs/host.foo.com
@@ -4754,13 +1686,9 @@ hostname or IP address
-
+
- -

Each Virtual Host must correspond to a different IP address, +

Each Virtual Host must correspond to a different IP address, different port number or a different host name for the server, in the former case the server machine must be configured to accept IP packets for multiple addresses. (If the machine does @@ -4768,60 +1696,31 @@ hostname or IP address accomplished with the ifconfig alias command (if your OS supports it), or with kernel patches like VIF (for SunOS(TM) 4.1.x)).

- -

The special name _default_ can be specified in +

The special name _default_ can be specified in which case this virtual host will match any IP address that is not explicitly listed in another virtual host. In the absence of any _default_ virtual host the "main" server config, consisting of all those definitions outside any VirtualHost section, is used when no match occurs.

- -

You can specify a :port to change the port that is +

You can specify a :port to change the port that is matched. If unspecified then it defaults to the same port as the - most recent Listen + most recent Listen statement of the main server. You may also specify :* to match all ports on that address. (This is recommended when used with _default_.)

- -

-SECURITY: See the security tips document +

SECURITY: See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.

- -

-NOTE: The use of <VirtualHost> does not +

NOTE: The use of <VirtualHost> does not affect what addresses Apache listens on. You may need to ensure - that Apache is listening on the correct addresses using Listen.

- - -

-See also: -

-
- - + request is received

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_access.html b/docs/manual/mod/mod_access.html index 6db8ed5cf9..3d39bcd9af 100644 --- a/docs/manual/mod/mod_access.html +++ b/docs/manual/mod/mod_access.html @@ -1,222 +1,100 @@ - - - - -mod_access - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_access

- - - - -
- - - - - - - - - - -
Description: -Provides access control based on client hostname, IP -address, or other characteristics of the client request. -
Status:Base
Module Identifier:access_module
-
-

Summary

- - -

The directives provided by mod_access are used in <Directory>, <Files>, and <Location> sections as well as +-->mod_access - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_access

Description:Provides access control based on client hostname, IP +address, or other characteristics of the client request.
Status:Base
Module Identifier:access_module

Summary

+

The directives provided by mod_access are used in <Directory>, <Files>, and <Location> sections as well as .htaccess files to control access to particular parts of the server. Access can be controlled based on the client hostname, IP address, or - other characteristics of the client request, as captured in environment variables. The Allow and Deny directives are used to + other characteristics of the client request, as captured in environment variables. The Allow and Deny directives are used to specify which clients are or are not allowed access to the server, - while the Order + while the Order directive sets the default access state, and configures how the - Allow and Deny directives interact with each + Allow and Deny directives interact with each other.

- -

Both host-based access restrictions and password-based +

Both host-based access restrictions and password-based authentication may be implemented simultaneously. In that case, - the Satisfy directive is used + the Satisfy directive is used to determine how the two sets of restrictions interact.

- -

In general, access restriction directives apply to all +

In general, access restriction directives apply to all access methods (GET, PUT, POST, etc). This is the desired behavior in most cases. However, it is possible to restrict some methods, while leaving other methods unrestricted, by enclosing the directives - in a <Limit> section.

- - -

-See also: -

- -

Directives

- -
-

-Allow Directive -

- - -
- - - - - -
Description: Controls which hosts can access an area of the -server
Syntax: - Allow from + in a <Limit> section.

+

See also

Directives

Allow Directive

- -
- - - - - - - - - - - - - -
Description: Controls which hosts can access an area of the +server
Syntax: Allow from all|host|env=env-variable - [host|env=env-variable] ... -
Context:directory, .htaccess
Override:Limit
Status:Base
Module:mod_access
-
- - - -

The Allow directive affects which hosts can + [host|env=env-variable] ...

Context:directory, .htaccess
Override:Limit
Status:Base
Module:mod_access
+ +

The Allow directive affects which hosts can access an area of the server. Access can be controlled by hostname, IP Address, IP Address range, or by other characteristics of the client request captured in environment variables.

- -

The first argument to this directive is always +

The first argument to this directive is always from. The subsequent arguments can take three different forms. If Allow from all is specified, then all hosts are allowed access, subject to the configuration of the - Deny and Order directives as discussed + Deny and Order directives as discussed below. To allow only particular hosts or groups of hosts to access the server, the host can be specified in any of the following formats:

- -
- -
A (partial) domain-name
+
+
A (partial) domain-name
- -
Example: Allow from apache.org -
+
Example: Allow from apache.org
Hosts whose names match, or end in, this string are allowed access. Only complete components are matched, so the above example will match foo.apache.org but it will not match fooapache.org. This configuration will cause the server to perform a reverse DNS lookup on the - client IP address, regardless of the setting of the HostnameLookups + client IP address, regardless of the setting of the HostnameLookups directive.
- -
A full IP address
+
A full IP address
- -
Example: Allow from 10.1.2.3 -
+
Example: Allow from 10.1.2.3
An IP address of a host allowed access
- -
A partial IP address
+
A partial IP address
- -
Example: Allow from 10.1 -
+
Example: Allow from 10.1
The first 1 to 3 bytes of an IP address, for subnet restriction.
- -
A network/netmask pair
+
A network/netmask pair
- -
Example: Allow from - 10.1.0.0/255.255.0.0 -
+
Example: Allow from + 10.1.0.0/255.255.0.0
A network a.b.c.d, and a netmask w.x.y.z. For more fine-grained subnet restriction.
- -
A network/nnn CIDR specification
+
A network/nnn CIDR specification
- -
Example: Allow from 10.1.0.0/16 -
+
Example: Allow from 10.1.0.0/16
Similar to the previous case, except the netmask consists of nnn high-order 1 bits.
- -
+
- -

Note that the last three examples above match exactly the +

Note that the last three examples above match exactly the same set of hosts.

- -

IPv6 addresses and IPv6 subnets can be specified as shown +

IPv6 addresses and IPv6 subnets can be specified as shown below:

- -
- - -
+
- -
Allow from fe80::a00:20ff:fea7:ccea
Allow from fe80::a00:20ff:fea7:ccea/10 -
-
+
- -

The third format of the arguments to the +

The third format of the arguments to the Allow directive allows access to the server to be controlled based on the existence of an environment variable. When Allow from env=env-variable is specified, then the request is @@ -229,15 +107,7 @@ server User-Agent (browser type), Referer, or other HTTP request header fields.

- -
- - -
-

-Example: -

- +
- -

Example:

SetEnvIf User-Agent ^KnockKnock/2.0 let_me_in
<Directory /docroot>
@@ -245,185 +115,79 @@ SetEnvIf User-Agent ^KnockKnock/2.0 let_me_in
   Deny from all
   Allow from env=let_me_in
</Directory> -
-
+
- -

In this case, browsers with a user-agent string beginning +

In this case, browsers with a user-agent string beginning with KnockKnock/2.0 will be allowed access, and all others will be denied.

- - -
-

-Deny Directive -

- - -
- - - - - -
Description: Controls which hosts are denied access to the -server
Syntax: - Deny from +

Deny Directive

- -
- - - - - - - - - - - - - -
Description: Controls which hosts are denied access to the +server
Syntax: Deny from all|host|env=env-variable - [host|env=env-variable] ... -
Context:directory, .htaccess
Override:Limit
Status:Base
Module:mod_access
-
- - -

This directive allows access to the server to be restricted + [host|env=env-variable] ...

Context:directory, .htaccess
Override:Limit
Status:Base
Module:mod_access
+

This directive allows access to the server to be restricted based on hostname, IP address, or environment variables. The arguments for the Deny directive are - identical to the arguments for the Allow directive.

- - -
-

-Order Directive -

- - -
- - -
Description: Controls the default access state and the order in which + identical to the arguments for the Allow directive.

+

Order Directive

- -
- - - - - - - - - - - - - - - - - - - -
Description: Controls the default access state and the order in which Allow and Deny are -evaluated.
Syntax: - Order ordering - -
Default:Order Deny,Allow
Context:directory, .htaccess
Override:Limit
Status:Base
Module:mod_access
-
- - - -

The Order directive controls the default - access state and the order in which Allow and Deny directives are evaluated. +evaluated.

Syntax: Order ordering
Default:Order Deny,Allow
Context:directory, .htaccess
Override:Limit
Status:Base
Module:mod_access
+ +

The Order directive controls the default + access state and the order in which Allow and Deny directives are evaluated. Ordering is one of

- -
- -
Deny,Allow
+
+
Deny,Allow
- -
The Deny directives - are evaluated before the Allow directives. Access is +
The Deny directives + are evaluated before the Allow directives. Access is allowed by default. Any client which does not match a - Deny directive or does - match an Allow + Deny directive or does + match an Allow directive will be allowed access to the server.
- -
Allow,Deny
+
Allow,Deny
- -
The Allow - directives are evaluated before the Deny directives. Access is denied - by default. Any client which does not match an Allow directive or does match a - Deny directive will be +
The Allow + directives are evaluated before the Deny directives. Access is denied + by default. Any client which does not match an Allow directive or does match a + Deny directive will be denied access to the server.
- -
Mutual-failure
+
Mutual-failure
- -
Only those hosts which appear on the Allow list and do not appear on - the Deny list are +
Only those hosts which appear on the Allow list and do not appear on + the Deny list are granted access. This ordering has the same effect as Order Allow,Deny and is deprecated in favor of that configuration.
- -
+
- -

Keywords may only be separated by a comma; no whitespace is - allowed between them. Note that in all cases every Allow and Deny statement is evaluated.

+

Keywords may only be separated by a comma; no whitespace is + allowed between them. Note that in all cases every Allow and Deny statement is evaluated.

- -

In the following example, all hosts in the apache.org domain +

In the following example, all hosts in the apache.org domain are allowed access; all other hosts are denied access.

- -
- - - - -
+
Order Deny,Allow
Deny from all
Allow from apache.org
+
-
-
- - -

In the next example, all hosts in the apache.org domain are +

In the next example, all hosts in the apache.org domain are allowed access, except for the hosts which are in the foo.apache.org subdomain, who are denied access. All hosts not in the apache.org domain are denied access because the default state is to deny access to the server.

- -
- - - - -
+
Order Allow,Deny
Allow from apache.org
Deny from foo.apache.org
+
-
-
- - -

On the other hand, if the Order in the last +

On the other hand, if the Order in the last example is changed to Deny,Allow, all hosts will be allowed access. This happens because, regardless of the actual ordering of the directives in the configuration file, @@ -433,47 +197,30 @@ evaluated. be allowed access because the default state will change to allow.

- -

The presence of an Order directive can affect +

The presence of an Order directive can affect access to a part of the server even in the absence of accompanying - Allow and Deny directives because of its effect + Allow and Deny directives because of its effect on the default access state. For example,

- -
- - -
+
- -
<Directory /www>
  Order Allow,Deny
</Directory> -
-
+
- -

will deny all access to the /www directory +

will deny all access to the /www directory because the default access state will be set to deny.

- -

The Order directive controls the order of access +

The Order directive controls the order of access directive processing only within each phase of the server's configuration processing. This implies, for example, that an - Allow or Deny directive occurring in a - <Location> section will - always be evaluated after an Allow or Deny directive occurring in a - <Directory> section or + Allow or Deny directive occurring in a + <Location> section will + always be evaluated after an Allow or Deny directive occurring in a + <Directory> section or .htaccess file, regardless of the setting of the Order directive. For details on the merging of configuration sections, see the documentation on How Directory, Location and Files sections work.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_actions.html b/docs/manual/mod/mod_actions.html index 20d0444b25..a813f3a24d 100644 --- a/docs/manual/mod/mod_actions.html +++ b/docs/manual/mod/mod_actions.html @@ -1,201 +1,58 @@ - - - - -mod_actions - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_actions

- - - - -
- - - - - - - - - - -
Description: -This module provides for executing CGI scripts based on -media type or request method. -
Status:Base
Module Identifier:actions_module
-
-

Summary

- - -

This module has two directives. The Action directive lets you run CGI +-->mod_actions - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_actions

Description:This module provides for executing CGI scripts based on +media type or request method.
Status:Base
Module Identifier:actions_module

Summary

+

This module has two directives. The Action directive lets you run CGI scripts whenever a file of a certain type is requested. The - Script directive lets + Script directive lets you run CGI scripts whenever a particular method is used in a request. This makes it much easier to execute scripts that process files.

- - -

Directives

- -
-

-Action Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Activates a CGI script for a particular handler or -content-type
Syntax: -Action action-type cgi-script - -
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_actions
-
- - -

This directive adds an action, which will activate +

Directives

Action Directive

Description: Activates a CGI script for a particular handler or +content-type
Syntax:Action action-type cgi-script
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_actions
+

This directive adds an action, which will activate cgi-script when action-type is triggered by the request. The action-type can be either a handler or a MIME content type. It sends the URL and file path of the requested document using the standard CGI PATH_INFO and PATH_TRANSLATED environment variables.

- -
- - - - -
-

-Examples -

- +

Examples

# Requests for files of a particular type:
Action image/gif /cgi-bin/images.cgi
-
# Files of a particular file extension
AddHandler my-file-type .xyz
Action my-file-type /cgi-bin/program.cgi
+
-
-
- - -

In the first example, requests for files with a MIME content +

In the first example, requests for files with a MIME content type of image/gif will instead be handled by the specified cgi script /cgi-bin/images.cgi.

- -

In the second example, requests for files with a file extension of +

In the second example, requests for files with a file extension of .xyz are handled instead by the specified cgi script /cgi-bin/program.cgi.

- - -

-See also: -

- -
-

-Script Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Activates a CGI script for a particular request -method.
Syntax: - Script method cgi-script - -
Context:server config, virtual host, directory
Status:Base
Module:mod_actions
-
- - -

This directive adds an action, which will activate +

See also

Script Directive

Description: Activates a CGI script for a particular request +method.
Syntax: Script method cgi-script
Context:server config, virtual host, directory
Status:Base
Module:mod_actions
+

This directive adds an action, which will activate cgi-script when a file is requested using the method of method. It sends the URL and file path of the requested document using the standard CGI PATH_INFO and PATH_TRANSLATED environment variables.

- -
- - -
+
- -
Any arbitrary method name may be used. Method names are case-sensitive, so Script PUT and Script put have two entirely different effects. -
-
+
- -

Note that the Script command defines default actions only. +

Note that the Script command defines default actions only. If a CGI script is called, or some other resource that is capable of handling the requested method internally, it will do so. Also note that Script with a method of GET @@ -203,30 +60,11 @@ method. (e.g., foo.html?hi). Otherwise, the request will proceed normally.

- -
- - -
-

-Examples -

- +
- -

Examples

# For <ISINDEX>-style searching
Script GET /cgi-bin/search
# A CGI PUT handler
Script PUT /~bob/put.cgi
- -
-
- - -
-

Apache HTTP Server Version 2.0

-IndexHome - - - +
+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_alias.html b/docs/manual/mod/mod_alias.html index 34579569cf..f3972598f4 100644 --- a/docs/manual/mod/mod_alias.html +++ b/docs/manual/mod/mod_alias.html @@ -1,598 +1,178 @@ - - - - -mod_alias - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_alias

- - - - -
- - - - - - - - - - -
Description: -Provides for mapping different parts of the host - filesystem in the document tree and for URL redirection -
Status:Base
Module Identifier:alias_module
-
-

Summary

- - -

The directives contained in this module allow for manipulation +-->mod_alias - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_alias

Description:Provides for mapping different parts of the host + filesystem in the document tree and for URL redirection
Status:Base
Module Identifier:alias_module

Summary

+

The directives contained in this module allow for manipulation and control of URLs as requests arrive at the server. The - Alias and ScriptAlias directives are used to + Alias and ScriptAlias directives are used to map between URLs and filesystem paths. This allows for content - which is not directly under the DocumentRoot served as part of the web - document tree. The ScriptAlias directive has the + which is not directly under the DocumentRoot served as part of the web + document tree. The ScriptAlias directive has the additional effect of marking the target directory as containing only CGI scripts.

- -

The Redirect +

The Redirect directives are used to instruct clients to make a new request with a different URL. They are often used when a resource has moved to a new location.

- -

A more powerful and flexible set of directives for +

A more powerful and flexible set of directives for manipulating URLs is contained in the mod_rewrite module.

+

Directives

Alias Directive

Description: Maps URLs to filesystem locations
Syntax: Alias URL-path + file-path|directory-path
Context:server config, virtual host
Status:Base
Module:mod_alias
-
 -

Directives

- -
-

-Alias Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Maps URLs to filesystem locations
Syntax: - Alias URL-path - file-path|directory-path - -
Context:server config, virtual host
Status:Base
Module:mod_alias
-
- - - -

The Alias directive allows documents to +

The Alias directive allows documents to be stored in the local filesystem other than under the - DocumentRoot. URLs with a + DocumentRoot. URLs with a (%-decoded) path beginning with url-path will be mapped to local files beginning with directory-filename.

- -

Example:

- +

Example:

-
- - - - -
Alias /image /ftp/pub/image
-
+
Alias /image /ftp/pub/image
- -

A request for http://myserver/image/foo.gif would cause the +

A request for http://myserver/image/foo.gif would cause the server to return the file /ftp/pub/image/foo.gif.

- -

Note that if you include a trailing / on the +

Note that if you include a trailing / on the url-path then the server will require a trailing / in order to expand the alias. That is, if you use Alias /icons/ /usr/local/apache/icons/ then the url /icons will not be aliased.

- -

Note that you may need to specify additional <Directory> sections which cover +

Note that you may need to specify additional <Directory> sections which cover the destination of aliases. Aliasing occurs before - <Directory> sections + <Directory> sections are checked, so only the destination of aliases are affected. - (Note however <Location> + (Note however <Location> sections are run through once before aliases are performed, so they will apply.)

- - -
-

-AliasMatch Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Maps URLs to filesystem locations using regular -expressions
Syntax: -AliasMatch regex - file-path|directory-path - -
Context:server config, virtual host
Status:Base
Module:mod_alias
-
- - -

This directive is equivalent to Alias, but makes use of standard +

AliasMatch Directive

Description: Maps URLs to filesystem locations using regular +expressions
Syntax:AliasMatch regex + file-path|directory-path
Context:server config, virtual host
Status:Base
Module:mod_alias
+

This directive is equivalent to Alias, but makes use of standard regular expressions, instead of simple prefix matching. The supplied regular expression is matched against the URL-path, and if it matches, the server will substitute any parenthesized matches into the given string and use it as a filename. For example, to activate the /icons directory, one might use:

- -
- - -
+
- -
AliasMatch ^/icons(.*) /usr/local/apache/icons$1 -
-
- - -
-

-Redirect Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sends an external redirect asking the client to fetch -a different URL
Syntax: -Redirect [status] URL-path URL - -
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
-
- - -

The Redirect directive maps an old URL into a new one. The +

+

Redirect Directive

Description: Sends an external redirect asking the client to fetch +a different URL
Syntax:Redirect [status] URL-path URL
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
+

The Redirect directive maps an old URL into a new one. The new URL is returned to the client which attempts to fetch it again with the new address. URL-path a (%-decoded) path; any requests for documents beginning with this path will be returned a redirect error to a new (%-encoded) URL beginning with URL.

- -

Example:

- +

Example:

-
- - - - -
Redirect /service http://foo2.bar.com/service
-
+
Redirect /service http://foo2.bar.com/service
- -

If the client requests http://myserver/service/foo.txt, it +

If the client requests http://myserver/service/foo.txt, it will be told to access http://foo2.bar.com/service/foo.txt instead.

- -
- - -
-

-Note -

-

Redirect directives take precedence over +

- -

Note

Redirect directives take precedence over Alias and ScriptAlias directives, irrespective of their ordering in the configuration file. Also, URL-path must be an absolute path, not a relative path, even when used with .htaccess files or -inside of <Directory> -sections.

-
-
+inside of <Directory> +sections.

- -

If no status argument is given, the redirect will +

If no status argument is given, the redirect will be "temporary" (HTTP status 302). This indicates to the client that the resource has moved temporarily. The status argument can be used to return other HTTP status codes:

- -
- -
permanent
+
+
permanent
- -
Returns a permanent redirect status (301) indicating that +
Returns a permanent redirect status (301) indicating that the resource has moved permanently.
- -
temp
+
temp
- -
Returns a temporary redirect status (302). This is the +
Returns a temporary redirect status (302). This is the default.
- -
seeother
+
seeother
- -
Returns a "See Other" status (303) indicating that the +
Returns a "See Other" status (303) indicating that the resource has been replaced.
- -
gone
+
gone
- -
Returns a "Gone" status (410) indicating that the +
Returns a "Gone" status (410) indicating that the resource has been permanently removed. When this status is used the url argument should be omitted.
- -
+
- -

Other status codes can be returned by giving the numeric +

Other status codes can be returned by giving the numeric status code as the value of status. If the status is between 300 and 399, the url argument must be present, otherwise it must be omitted. Note that the status must be known to the Apache code (see the function send_error_response in http_protocol.c).

- - -
-

-RedirectMatch Directive -

- - -
- - -
Description: Sends an external redirect asking the client to fetch +

RedirectMatch Directive

- -
- - - - - - - - - - - - - - - - -
Description: Sends an external redirect asking the client to fetch a different URL based on a regular expression match of the -current URL
Syntax: -RedirectMatch [status] regex URL - -
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
-
- - -

This directive is equivalent to Redirect, but makes use of standard +current URL

Syntax:RedirectMatch [status] regex URL
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
+

This directive is equivalent to Redirect, but makes use of standard regular expressions, instead of simple prefix matching. The supplied regular expression is matched against the URL-path, and if it matches, the server will substitute any parenthesized matches into the given string and use it as a filename. For example, to redirect all GIF files to like-named JPEG files on another server, one might use:

- -
- - -
+
- -
RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg -
-
- - -
-

-RedirectPermanent Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sends an external permanent redirect asking the client to fetch -a different URL
Syntax: -RedirectPermanent URL-path URL - -
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
-
- - -

This directive makes the client know that the Redirect is +

+

RedirectPermanent Directive

Description: Sends an external permanent redirect asking the client to fetch +a different URL
Syntax:RedirectPermanent URL-path URL
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
+

This directive makes the client know that the Redirect is permanent (status 301). Exactly equivalent to Redirect permanent.

- - -
-

-RedirectTemp Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sends an external temporary redirect asking the client to fetch -a different URL
Syntax: -RedirectTemp URL-path URL - -
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
-
- - -

This directive makes the client know that the Redirect is +

RedirectTemp Directive

Description: Sends an external temporary redirect asking the client to fetch +a different URL
Syntax:RedirectTemp URL-path URL
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_alias
+

This directive makes the client know that the Redirect is only temporary (status 302). Exactly equivalent to Redirect temp.

- - -
-

-ScriptAlias Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Maps a URL to a filesystem location and designates the -target as a CGI script
Syntax: -ScriptAlias -URL-path file-path|directory-path - -
Context:server config, virtual host
Status:Base
Module:mod_alias
-
- - -

The ScriptAlias directive has the same - behavior as the Alias +

ScriptAlias Directive

Description: Maps a URL to a filesystem location and designates the +target as a CGI script
Syntax:ScriptAlias +URL-path file-path|directory-path
Context:server config, virtual host
Status:Base
Module:mod_alias
+

The ScriptAlias directive has the same + behavior as the Alias directive, except that in addition it marks the target directory as containing CGI scripts that will be processed by mod_cgi's cgi-script handler. URLs with a (%-decoded) path beginning with URL-path will be mapped to scripts beginning with the second argument which is a full pathname in the local filesystem.

- -

Example:

+

Example:

+
ScriptAlias /cgi-bin/ /web/cgi-bin/
-
- - - - -
ScriptAlias /cgi-bin/ /web/cgi-bin/
-
- - -

A request for http://myserver/cgi-bin/foo would cause the +

A request for http://myserver/cgi-bin/foo would cause the server to run the script /web/cgi-bin/foo.

- - -
-

-ScriptAliasMatch Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Maps a URL to a filesystem location using a regular expression -and designates the target as a CGI script
Syntax: -ScriptAliasMatch -regex file-path|directory-path - -
Context:server config, virtual host
Status:Base
Module:mod_alias
-
- - -

This directive is equivalent to ScriptAlias, but makes use of standard +

ScriptAliasMatch Directive

Description: Maps a URL to a filesystem location using a regular expression +and designates the target as a CGI script
Syntax:ScriptAliasMatch +regex file-path|directory-path
Context:server config, virtual host
Status:Base
Module:mod_alias
+

This directive is equivalent to ScriptAlias, but makes use of standard regular expressions, instead of simple prefix matching. The supplied regular expression is matched against the URL-path, and if it matches, the server will substitute any parenthesized matches into the given string and use it as a filename. For example, to activate the standard /cgi-bin, one might use:

- -
- - -
+
- -
ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1 -
-
- - -
-

Apache HTTP Server Version 2.0

-IndexHome - - - +
+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_asis.html b/docs/manual/mod/mod_asis.html index 6b517585a8..95b43908c4 100644 --- a/docs/manual/mod/mod_asis.html +++ b/docs/manual/mod/mod_asis.html @@ -1,98 +1,42 @@ - - - - -mod_asis - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_asis

- - - - -
- - - - - - - - - - -
Description: -Sends files that contain their own -HTTP headers -
Status:Base
Module Identifier:asis_module
-
-

Summary

- - -

This module provides the handler send-as-is +-->mod_asis - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_asis

Description:Sends files that contain their own +HTTP headers
Status:Base
Module Identifier:asis_module

Summary

+

This module provides the handler send-as-is which causes Apache to send the document without adding most of the usual HTTP headers.

- -

This can be used to send any kind of data from the server, +

This can be used to send any kind of data from the server, including redirects and other special HTTP responses, without requiring a cgi-script or an nph script.

- -

For historical reasons, this module will also process any +

For historical reasons, this module will also process any file with the mime type httpd/send-as-is.

+

Directives

This module provides no directives.

Usage

-
 -

Directives

-

This module provides no directives.

-

Usage

+

In the server configuration file, associate files with the + send-as-is handler e.g.

- -

In the server configuration file, associate files with the - send-as-is handler e.g. -

+
AddHandler send-as-is asis
- -
- - - - -
AddHandler send-as-is asis
-
- - -

The contents of any file with a .asis extension +

The contents of any file with a .asis extension will then be sent by Apache to the client with almost no changes. Clients will need HTTP headers to be attached, so do not forget them. A Status: header is also required; the data should be the 3-digit HTTP response code, followed by a textual message.

- -

Here's an example of a file whose contents are sent as +

Here's an example of a file whose contents are sent as is so as to tell the client that a file has redirected.

- -
- - -
Status: 301 Now where did I leave that URL
+
- -
Status: 301 Now where did I leave that URL
Location: http://xyz.abc.com/foo/bar.html
Content-type: text/html
- -
+
<HTML>
<HEAD>
<TITLE>Lame excuses'R'us</TITLE>
@@ -106,20 +50,10 @@ HTTP headers </H1>
</BODY>
</HTML> -
-
+
- -

Notes: the server always adds a Date: and Server: header to +

Notes: the server always adds a Date: and Server: header to the data returned to the client, so these should not be included in the file. The server does not add a Last-Modified header; it probably should.

- -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_auth.html b/docs/manual/mod/mod_auth.html index 28edd22ded..b694e01f98 100644 --- a/docs/manual/mod/mod_auth.html +++ b/docs/manual/mod/mod_auth.html @@ -1,131 +1,23 @@ - - - - -mod_auth - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_auth

- - - - -
- - - - - - - - - - -
Description: -User authentication using text files -
Status:Base
Module Identifier:auth_module
-
-

Summary

- +-->mod_auth - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_auth

Description:User authentication using text files
Status:Base
Module Identifier:auth_module

Summary

- -

This module allows the use of HTTP Basic Authentication to +

This module allows the use of HTTP Basic Authentication to restrict access by looking up users in plain text password and group files. Similar functionality and greater scalability is provided by mod_auth_dbm. HTTP Digest Authentication is provided by mod_auth_digest.

+

See also

Directives

AuthAuthoritative Directive

Description: Sets whether authorization and authentication are +passed to lower level modules
Syntax:AuthAuthoritative on|off
Default:AuthAuthoritative on
Context:directory, .htaccess
Override:AuthConfig
Status:Base
Module:mod_auth
-
 -

-See also: -

- -

Directives

- -
-

-AuthAuthoritative Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets whether authorization and authentication are -passed to lower level modules
Syntax: -AuthAuthoritative on|off -
Default:AuthAuthoritative on
Context:directory, .htaccess
Override:AuthConfig
Status:Base
Module:mod_auth
-
- +
This information has not been updated for Apache 2.0, which +uses a different system for module ordering.
- -
- - - - -
This information has not been updated for Apache 2.0, which -uses a different system for module ordering.
-
- - -

Setting the AuthAuthoritative directive +

Setting the AuthAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on to lower level modules (as defined in the Configuration and @@ -135,234 +27,90 @@ uses a different system for module ordering. password and access checks will be applied and a failure will give an Authorization Required reply.

- -

So if a userID appears in the database of more than one module; - or if a valid Require +

So if a userID appears in the database of more than one module; + or if a valid Require directive applies to more than one module; then the first module will verify the credentials; and no access is passed on; regardless of the AuthAuthoritative setting.

- -

A common use for this is in conjunction with one of the +

A common use for this is in conjunction with one of the database modules; such as auth_dbm, mod_auth_msql, and mod_auth_anon. These modules supply the bulk of the user credential checking; but a few (administrator) related accesses fall through to a lower - level with a well protected AuthUserFile.

+ level with a well protected AuthUserFile.

- -

By default; control is not passed on; and an unknown userID or +

By default; control is not passed on; and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure; and forces an NCSA compliant behaviour.

- -
- - -
-

-Security -

Do consider the implications of +
- -

Security

Do consider the implications of allowing a user to allow fall-through in his .htaccess file; and verify that this is really what you want; Generally it is easier to just secure a single .htpasswd file, than it is to secure a - database such as mSQL. Make sure that the AuthUserFile is stored outside the + database such as mSQL. Make sure that the AuthUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to - download the AuthUserFile. -
-
- - -
-

-AuthGroupFile Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the name of a text file containing the list -of user groups for authentication
Syntax: -AuthGroupFile file-path - -
Context:directory, .htaccess
Override:AuthConfig
Status:Base
Module:mod_auth
-
- - -

The AuthGroupFile directive sets the + download the AuthUserFile. +

+

AuthGroupFile Directive

Description: Sets the name of a text file containing the list +of user groups for authentication
Syntax:AuthGroupFile file-path
Context:directory, .htaccess
Override:AuthConfig
Status:Base
Module:mod_auth
+

The AuthGroupFile directive sets the name of a textual file containing the list of user groups for user authentication. File-path is the path to the group file. If it is not absolute (i.e., if it doesn't begin - with a slash), it is treated as relative to the ServerRoot.

+ with a slash), it is treated as relative to the ServerRoot.

- -

Each line of the group file contains a groupname followed by a +

Each line of the group file contains a groupname followed by a colon, followed by the member usernames separated by spaces. Example:

+
mygroup: bob joe anne
-
- - - - -
mygroup: bob joe anne
-
- - -

Note that searching large text files is very - inefficient; AuthDBMGroupFile should be used +

Note that searching large text files is very + inefficient; AuthDBMGroupFile should be used instead.

- -
- - -
-

-Security -

- -

Make sure that the AuthGroupFile is stored outside +

- -

Security

+

Make sure that the AuthGroupFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthGroupFile.

- -
-
- - -
-

-AuthUserFile Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the name of a text file containing the list of users and -passwords for authentication
Syntax: -AuthUserFile file-path - -
Context:directory, .htaccess
Override:AuthConfig
Status:Base
Module:mod_auth
-
- - -

The AuthUserFile directive sets the name +

+

AuthUserFile Directive

Description: Sets the name of a text file containing the list of users and +passwords for authentication
Syntax:AuthUserFile file-path
Context:directory, .htaccess
Override:AuthConfig
Status:Base
Module:mod_auth
+

The AuthUserFile directive sets the name of a textual file containing the list of users and passwords for user authentication. File-path is the path to the user file. If it is not absolute (i.e., if it doesn't begin - with a slash), it is treated as relative to the ServerRoot.

+ with a slash), it is treated as relative to the ServerRoot.

- -

Each line of the user file file contains a username followed by +

Each line of the user file file contains a username followed by a colon, followed by the crypt() encrypted password. The behavior of multiple occurrences of the same user is undefined.

- -

The utility htpasswd +

The utility htpasswd which is installed as part of the binary distribution, or which can be found in src/support, is used to maintain this password file. See the man page for more details. In short:

- -

Create a password file 'Filename' with 'username' as the +

Create a password file 'Filename' with 'username' as the initial ID. It will prompt for the password:

- -
- - - - -
htpasswd -c Filename username
-
- +
htpasswd -c Filename username

Adds or modifies in password file 'Filename' the 'username':

+
htpasswd Filename username2
-
- - - - -
htpasswd Filename username2
-
- - -

Note that searching large text files is very - inefficient; AuthDBMUserFile should be used +

Note that searching large text files is very + inefficient; AuthDBMUserFile should be used instead.

- -
- - -
-

-Security -

-

Make sure that the AuthUserFile is +

- -

Security

Make sure that the AuthUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be -able to download the AuthUserFile.

-
-
- +able to download the AuthUserFile.

- -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_auth_anon.html b/docs/manual/mod/mod_auth_anon.html index 2fd5fc8bf8..4371363bda 100644 --- a/docs/manual/mod/mod_auth_anon.html +++ b/docs/manual/mod/mod_auth_anon.html @@ -1,133 +1,60 @@ - - - - -mod_auth_anon - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_auth_anon

- - - - -
- - - - - - - - - - -
Description: -Allows "anonymous" user access to authenticated - areas -
Status:Extension
Module Identifier:auth_anon_module
-
-

Summary

- - -

This module does access control in a manner similar to +-->mod_auth_anon - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_auth_anon

Description:Allows "anonymous" user access to authenticated + areas
Status:Extension
Module Identifier:auth_anon_module

Summary

+

This module does access control in a manner similar to anonymous-ftp sites; i.e. have a 'magic' user id 'anonymous' and the email address as a password. These email addresses can be logged.

- -

Combined with other (database) access control methods, this +

Combined with other (database) access control methods, this allows for effective user tracking and customization according to a user profile while still keeping the site open for 'unregistered' users. One advantage of using Auth-based user tracking is that, unlike magic-cookies and funny URL pre/postfixes, it is completely browser independent and it allows users to share URLs.

+

Directives

Example

-
 -

Directives

- -

Example

- - -

The example below (when combined with the Auth directives of a +

The example below (when combined with the Auth directives of a htpasswd-file based (or GDM, mSQL etc.) base access control system allows users in as 'guests' with the following properties:

- -
    - -
  • It insists that the user enters a userId. +
      +
    • It insists that the user enters a userId. (Anonymous_NoUserId)
      • - -
    • It insists that the user enters a password. +
    • It insists that the user enters a password. (Anonymous_MustGiveEmail)
      • - -
    • The password entered must be a valid email address, ie. +
    • The password entered must be a valid email address, ie. contain at least one '@' and a '.'. (Anonymous_VerifyEmail)
      • - -
    • The userID must be one of anonymous guest www test +
    • The userID must be one of anonymous guest www test welcome and comparison is not case sensitive.
      • - -
    • And the Email addresses entered in the passwd field are +
    • And the Email addresses entered in the passwd field are logged to the error log file (Anonymous_LogEmail)
      • - -
    - - -

    Excerpt of httpd.conf:

    +
+

Excerpt of httpd.conf:

-
- - -
+
- -
Anonymous_NoUserId off
Anonymous_MustGiveEmail on
Anonymous_VerifyEmail on
Anonymous_LogEmail on
Anonymous anonymous guest www test welcome
-
AuthName "Use 'anonymous' & Email address for guest entry"
AuthType basic
-
# An AuthUserFile/AuthDBUserFile/AuthDBMUserFile
@@ -137,303 +64,56 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX <Files *>
Order Deny,Allow
Allow from all
-
Require valid-user
</Files>
- -
-
- -
-

-Anonymous Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Specifies userIDs that areallowed access without -password verification
Syntax: -Anonymous user [user] ... -
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
-
- - -

A list of one or more 'magic' userIDs which are allowed +

+

Anonymous Directive

Description: Specifies userIDs that areallowed access without +password verification
Syntax:Anonymous user [user] ...
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
+

A list of one or more 'magic' userIDs which are allowed access without password verification. The userIDs are space separated. It is possible to use the ' and " quotes to allow a space in a userID as well as the \ escape character.

- -

Please note that the comparison is +

Please note that the comparison is case-IN-sensitive.
I strongly suggest that the magic username 'anonymous' is always one of the allowed userIDs.

- -

Example:

+

Example:

+
Anonymous anonymous "Not Registered" 'I don\'t know'
-
- - - - -
Anonymous anonymous "Not Registered" 'I don\'t know'
-
- - -

This would allow the user to enter without password +

This would allow the user to enter without password verification by using the userId's 'anonymous', 'AnonyMous','Not Registered' and 'I Don't Know'.

- - -
-

-Anonymous_Authoritative Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Configures if authorization will fall-through -to other methods
Syntax: -Anonymous_Authoritative on|off -
Default:Anonymous_Authoritative off
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
-
- - -

When set 'on', there is no fall-through to other authorization +

Anonymous_Authoritative Directive

Description: Configures if authorization will fall-through +to other methods
Syntax:Anonymous_Authoritative on|off
Default:Anonymous_Authoritative off
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
+

When set 'on', there is no fall-through to other authorization methods. So if a userID does not match the values specified in the - Anonymous directive, + Anonymous directive, access is denied.

- -

Be sure you know what you are doing when you decide to +

Be sure you know what you are doing when you decide to switch it on. And remember that it is the linking order of the modules (in the Configuration / Make file) which details the order in which the Authorization modules are queried.

- - -
-

-Anonymous_LogEmail Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets whether the password entered will be logged in the -error log
Syntax: -Anonymous_LogEmail on|off -
Default:Anonymous_LogEmail on
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
-
- - -

When set on, the default, the 'password' entered +

Anonymous_LogEmail Directive

Description: Sets whether the password entered will be logged in the +error log
Syntax:Anonymous_LogEmail on|off
Default:Anonymous_LogEmail on
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
+

When set on, the default, the 'password' entered (which hopefully contains a sensible email address) is logged in the error log.

- - -
-

-Anonymous_MustGiveEmail Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Specifies whether blank passwords are allowed
Syntax: -Anonymous_MustGiveEmail on|off -
Default:Anonymous_MustGiveEmail on
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
-
- - -

Specifies whether the user must specify an email address as +

Anonymous_MustGiveEmail Directive

Description: Specifies whether blank passwords are allowed
Syntax:Anonymous_MustGiveEmail on|off
Default:Anonymous_MustGiveEmail on
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
+

Specifies whether the user must specify an email address as the password. This prohibits blank passwords.

- - -
-

-Anonymous_NoUserID Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets whether the userID field may be empty
Syntax: -Anonymous_NoUserID on|off -
Default:Anonymous_NoUserID off
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
-
- - -

When set on, users can leave the userID (and +

Anonymous_NoUserID Directive

Description: Sets whether the userID field may be empty
Syntax:Anonymous_NoUserID on|off
Default:Anonymous_NoUserID off
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
+

When set on, users can leave the userID (and perhaps the password field) empty. This can be very convenient for MS-Explorer users who can just hit return or click directly on the OK button; which seems a natural reaction.

- - -
-

-AnonymousVerifyEmail Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets whether to check the password field for a correctly -formatted email address
Syntax: -Anonymous_VerifyEmail on|off -
Default:Anonymous_VerifyEmail off
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
-
- - -

When set on the 'password' entered is checked for +

Anonymous_VerifyEmail Directive

Description: Sets whether to check the password field for a correctly +formatted email address
Syntax:Anonymous_VerifyEmail on|off
Default:Anonymous_VerifyEmail off
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_anon
+

When set on the 'password' entered is checked for at least one '@' and a '.' to encourage users to enter valid email - addresses (see the above Auth_LogEmail).

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - + addresses (see the above Auth_LogEmail).

+

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_auth_dbm.html b/docs/manual/mod/mod_auth_dbm.html index c0a0c91acb..477f4aa6fa 100644 --- a/docs/manual/mod/mod_auth_dbm.html +++ b/docs/manual/mod/mod_auth_dbm.html @@ -1,131 +1,20 @@ - - - - -mod_auth_dbm - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_auth_dbm

- - - - -
- - - - - - - - - - -
Description: -Provides for user authentication using DBM - files -
Status:Extension
Module Identifier:auth_dbm_module
-
-

Summary

- - -

This module provides for HTTP Basic Authentication, where +-->mod_auth_dbm - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_auth_dbm

Description:Provides for user authentication using DBM + files
Status:Extension
Module Identifier:auth_dbm_module

Summary

+

This module provides for HTTP Basic Authentication, where the usernames and passwords are stored in DBM type database files. It is an alternative to the plain text password files provided by mod_auth.

+

See also

Directives

AuthDBMAuthoritative Directive

Description: Sets whether authentication and authorization will be +passwed on to lower level modules
Syntax:AuthDBMAuthoritative on|off
Default:AuthDBMAuthoritative on
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
-
 -

-See also: -

- -

Directives

- -
-

-AuthDBMAuthoritative Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets whether authentication and authorization will be -passwed on to lower level modules
Syntax: -AuthDBMAuthoritative on|off -
Default:AuthDBMAuthoritative on
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
-
- +
This information has not been updated to take into account the +new module ordering techniques in Apache 2.0
- -
- - - - -
This information has not been updated to take into account the -new module ordering techniques in Apache 2.0
-
- - -

Setting the AuthDBMAuthoritative +

Setting the AuthDBMAuthoritative directive explicitly to 'off' allows for both authentication and authorization to be passed on to lower level modules (as defined in the Configuration and @@ -135,91 +24,48 @@ new module ordering techniques in Apache 2.0 checks will be applied and a failure will give an Authorization Required reply.

- -

So if a userID appears in the database of more than one module; - or if a valid Require +

So if a userID appears in the database of more than one module; + or if a valid Require directive applies to more than one module; then the first module will verify the credentials; and no access is passed on; regardless of the AuthAuthoritative setting.

- -

A common use for this is in conjunction with one of the +

A common use for this is in conjunction with one of the basic auth modules; such as mod_auth. Whereas this DBM module supplies the bulk of the user credential checking; a few (administrator) related accesses fall through to a lower level with a well protected .htpasswd file.

- -

By default, control is not passed on and an unknown userID +

By default, control is not passed on and an unknown userID or rule will result in an Authorization Required reply. Not setting it thus keeps the system secure and forces an NCSA compliant behaviour.

- -

Security: Do consider the implications of allowing a user to +

Security: Do consider the implications of allowing a user to allow fall-through in his .htaccess file; and verify that this is really what you want; Generally it is easier to just secure a single .htpasswd file, than it is to secure a database which might have more access interfaces.

- - -
-

-AuthDBMGroupFile Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the name of the database file containing the list -of user groups for authentication
Syntax: -AuthDBMGroupFile file-path - -
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
-
- - -

The AuthDBMGroupFile directive sets the +

AuthDBMGroupFile Directive

Description: Sets the name of the database file containing the list +of user groups for authentication
Syntax:AuthDBMGroupFile file-path
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
+

The AuthDBMGroupFile directive sets the name of a DBM file containing the list of user groups for user authentication. File-path is the absolute path to the group file.

- -

The group file is keyed on the username. The value for a +

The group file is keyed on the username. The value for a user is a comma-separated list of the groups to which the users belongs. There must be no whitespace within the value, and it must never contain any colons.

- -

Security: make sure that the +

Security: make sure that the AuthDBMGroupFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthDBMGroupFile unless otherwise protected.

- -

Combining Group and Password DBM files: In some cases it is +

Combining Group and Password DBM files: In some cases it is easier to manage a single database which contains both the password and group details for each user. This simplifies any support programs that need to be written: they now only have to @@ -227,149 +73,52 @@ of user groups for authentication accomplished by first setting the group and password files to point to the same DBM:

- -
- - -
+
- -
AuthDBMGroupFile /www/userbase
AuthDBMUserFile /www/userbase -
-
+
- -

The key for the single DBM is the username. The value consists +

The key for the single DBM is the username. The value consists of

+
Unix Crypt-ed Password : List of Groups [ : (ignored) + ]
-
- - - - -
Unix Crypt-ed Password : List of Groups [ : (ignored) - ]
-
- - -

The password section contains the Unix crypt() +

The password section contains the Unix crypt() password as before. This is followed by a colon and the comma separated list of groups. Other data may optionally be left in the DBM file after another colon; it is ignored by the authentication module. This is what www.telescope.org uses for its combined password and group database.

- - -
-

-AuthDBMType Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Description: Sets the type of database file that is used to -store passwords
Syntax: -AuthDBMType default|SDBM|GDBM|DB -
Default:AuthDBMType default
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
Compatibility:Available in version 2.0.30 and later.
-
- - +

AuthDBMType Directive

Description: Sets the type of database file that is used to +store passwords
Syntax:AuthDBMType default|SDBM|GDBM|DB
Default:AuthDBMType default
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
Compatibility:Available in version 2.0.30 and later.

Sets the type of database file that is used to store the passwords. The default database type is determined at compile time. The availability of other types of database files also depends on compile-time settings.

-

It is crucial that whatever program you use to create your password files is configured to use the same type of database.

- - -
-

-AuthDBMUserFile Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets thename of a database file containing the list of users and -passwords for authentication
Syntax: -AuthDBMUserFile file-path - -
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
-
- - -

The AuthDBMUserFile directive sets the +

AuthDBMUserFile Directive

Description: Sets thename of a database file containing the list of users and +passwords for authentication
Syntax:AuthDBMUserFile file-path
Context:directory, .htaccess
Override:AuthConfig
Status:Extension
Module:mod_auth_dbm
+

The AuthDBMUserFile directive sets the name of a DBM file containing the list of users and passwords for user authentication. File-path is the absolute path to the user file.

- -

The user file is keyed on the username. The value for a user is +

The user file is keyed on the username. The value for a user is the crypt() encrypted password, optionally followed by a colon and arbitrary data. The colon and the data following it will be ignored by the server.

- -

Security: make sure that the +

Security: make sure that the AuthDBMUserFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthDBMUserFile.

- -

Important compatibility note: The implementation of +

Important compatibility note: The implementation of "dbmopen" in the apache modules reads the string length of the hashed values from the DBM data structures, rather than relying upon the string being NULL-appended. Some applications, such as @@ -378,16 +127,8 @@ passwords for authentication interchangeably between applications this may be a part of the problem.

- -

A perl script called +

A perl script called dbmmanage is included with Apache. This program can be used to create and update DBM format password files for use with this module.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_auth_digest.html b/docs/manual/mod/mod_auth_digest.html index 26d5570c6f..b43325af70 100644 --- a/docs/manual/mod/mod_auth_digest.html +++ b/docs/manual/mod/mod_auth_digest.html @@ -1,107 +1,22 @@ - - - - -mod_auth_digest - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_auth_digest

- - - - -
- - - - - - - - - - -
Description: -User authentication using MD5 - Digest Authentication. -
Status:Experimental
Module Identifier:auth_digest_module
-
-

Summary

- - -

This module implements HTTP Digest Authentication. However, it +-->mod_auth_digest - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_auth_digest

Description:User authentication using MD5 + Digest Authentication.
Status:Experimental
Module Identifier:auth_digest_module

Summary

+

This module implements HTTP Digest Authentication. However, it has not been extensively tested and is therefore marked experimental.

+

See also

Directives

Using Digest Authentication

-
 -

-See also: -

- -

Directives

- -

Using Digest Authentication

- - -

Using MD5 Digest authentication is very simple. Simply set +

Using MD5 Digest authentication is very simple. Simply set up authentication normally, using "AuthType Digest" and "AuthDigestFile" instead of the normal "AuthType Basic" and "AuthUserFile"; also, replace any "AuthGroupFile" with "AuthDigestGroupFile". Then add a "AuthDigestDomain" directive containing at least the root URI(s) for this protection space. Example:

- -
- - -
+
- -
<Location /private/>
AuthType Digest
AuthName "private area"
@@ -109,21 +24,10 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX AuthDigestFile /web/auth/.digest_pw
Require valid-user
</Location> -
-
+
- -
- - -
-

-Note -

- -

MD5 authentication provides a more +

- -

Note

+

MD5 authentication provides a more secure password system than Basic authentication, but only works with supporting browsers. As of this writing (October 2001), the only major browsers which support digest authentication are @@ -133,97 +37,19 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX Therefore, we do not yet recommend using this feature on a large Internet site. However, for personal and intra-net use, where browser users can be controlled, it is ideal.

- -
-
- -
-

-AuthDigestAlgorithm Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Selects the algorithm used to calculate the challenge and -response hases in digest authentication
Syntax: -AuthDigestAlgorithm MD5|MD5-sess -
Default:AuthDigestAlgorithm MD5
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

The AuthDigestAlgorithm directive +

+

AuthDigestAlgorithm Directive

Description: Selects the algorithm used to calculate the challenge and +response hases in digest authentication
Syntax:AuthDigestAlgorithm MD5|MD5-sess
Default:AuthDigestAlgorithm MD5
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

The AuthDigestAlgorithm directive selects the algorithm used to calculate the challenge and response hashes.

- -

-MD5-sess is not correctly implemented +

MD5-sess is not correctly implemented yet.

- - -
-

-AuthDigestDomain Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: URIs that are in the same protection space for digest -authentication
Syntax: -AuthDigestDomain URI [URI] ... -
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

The AuthDigestDomain directive allows +

AuthDigestDomain Directive

Description: URIs that are in the same protection space for digest +authentication
Syntax:AuthDigestDomain URI [URI] ...
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

The AuthDigestDomain directive allows you to specify one or more URIs which are in the same protection space (i.e. use the same realm and username/password info). The specified URIs are prefixes, i.e. the client will assume that all @@ -231,8 +57,7 @@ authentication username/password. The URIs may be either absolute URIs (i.e. inluding a scheme, host, port, etc) or relative URIs.

- -

This directive should always be specified and +

This directive should always be specified and contain at least the (set of) root URI(s) for this space. Omitting to do so will cause the client to send the Authorization header for every request sent to this @@ -240,249 +65,49 @@ authentication also have a detrimental effect on performance if "AuthDigestNcCheck" is on.

- -

The URIs specified can also point to different servers, in +

The URIs specified can also point to different servers, in which case clients (which understand this) will then share username/password info across multiple servers without prompting the user each time.

- - -
-

-AuthDigestFile Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Location of the text file containing the list -of users and encoded passwords for digest authentication
Syntax: -AuthDigestFile file-path - -
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

The AuthDigestFile directive sets the +

AuthDigestFile Directive

Description: Location of the text file containing the list +of users and encoded passwords for digest authentication
Syntax:AuthDigestFile file-path
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

The AuthDigestFile directive sets the name of a textual file containing the list of users and encoded passwords for digest authentication. File-path is the absolute path to the user file.

- -

The digest file uses a special format. Files in this format +

The digest file uses a special format. Files in this format can be created using the htdigest utility found in the support/ subdirectory of the Apache distribution.

- - -
-

-AuthDigestGroupFile Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Name of the text file containing the list of groups -for digest authentication
Syntax: -AuthDigestGroupFile file-path - -
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

The AuthDigestGroupFile directive sets +

AuthDigestGroupFile Directive

Description: Name of the text file containing the list of groups +for digest authentication
Syntax:AuthDigestGroupFile file-path
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

The AuthDigestGroupFile directive sets the name of a textual file containing the list of groups and their members (user names). File-path is the absolute path to the group file.

- -

Each line of the group file contains a groupname followed by +

Each line of the group file contains a groupname followed by a colon, followed by the member usernames separated by spaces. Example:

+
mygroup: bob joe anne
-
- - - - -
mygroup: bob joe anne
-
- - -

Note that searching large text files is very +

Note that searching large text files is very inefficient.

- -

Security: make sure that the AuthGroupFile is stored outside +

Security: make sure that the AuthGroupFile is stored outside the document tree of the web-server; do not put it in the directory that it protects. Otherwise, clients will be able to download the AuthGroupFile.

- - -
-

-AuthDigestNcCheck Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Enables or disables checking of the nonce-count sent by the -server
Syntax: -AuthDigestNcCheck On|Off -
Default:AuthDigestNcCheck Off
Context:server config
Status:Experimental
Module:mod_auth_digest
-
- - -

-Not implemented yet. - -

- - -
-

-AuthDigestNonceFormat Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Determines how the nonce is generated
Syntax: -??? -
Default:???
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

-Not implemented yet. - -

- - -
-

-AuthDigestNonceLifetime Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: How long the server nonce is valid
Syntax: -AuthDigestNonceLifetime seconds - -
Default:AuthDigestNonceLifetime 300
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

The AuthDigestNonceLifetime directive +

AuthDigestNcCheck Directive

Description: Enables or disables checking of the nonce-count sent by the +server
Syntax:AuthDigestNcCheck On|Off
Default:AuthDigestNcCheck Off
Context:server config
Status:Experimental
Module:mod_auth_digest
+

Not implemented yet. +

+

AuthDigestNonceFormat Directive

Description: Determines how the nonce is generated
Syntax:???
Default:???
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

Not implemented yet. +

+

AuthDigestNonceLifetime Directive

Description: How long the server nonce is valid
Syntax:AuthDigestNonceLifetime seconds
Default:AuthDigestNonceLifetime 300
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

The AuthDigestNonceLifetime directive controls how long the server nonce is valid. When the client contacts the server using an expired nonce the server will send back a 401 with stale=true. If seconds is @@ -491,47 +116,9 @@ server seconds. If seconds is less than 0 then the nonce never expires.

- - -
-

-AuthDigestQop Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Determines the quality-of-protection to use in digest -authentication
Syntax: -AuthDigestQop none|auth|auth-int [auth|auth-int] -
Default:AuthDigestQop auth
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
-
- - -

The AuthDigestQop directive determines +

AuthDigestQop Directive

Description: Determines the quality-of-protection to use in digest +authentication
Syntax:AuthDigestQop none|auth|auth-int [auth|auth-int]
Default:AuthDigestQop auth
Context:directory, .htaccess
Override:AuthConfig
Status:Experimental
Module:mod_auth_digest
+

The AuthDigestQop directive determines the quality-of-protection to use. auth will only do authentication (username/password); auth-int is authentication plus integrity checking (an MD5 hash of the entity @@ -542,15 +129,6 @@ authentication these to use. none should only be used if the browser for some reason does not like the challenge it receives otherwise.

- -

-auth-int is not implemented +

auth-int is not implemented yet.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_autoindex.html b/docs/manual/mod/mod_autoindex.html index 0c8134de17..071ef64803 100644 --- a/docs/manual/mod/mod_autoindex.html +++ b/docs/manual/mod/mod_autoindex.html @@ -1,220 +1,104 @@ - - - - -mod_autoindex - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_autoindex

- - -
- - -
Description: -Generates directory indexes, +-->mod_autoindex - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_autoindex

- -
- - - - - - - -
Description:Generates directory indexes, automatically, similar to the Unix ls command or the - Win32 dir shell command -
Status:Base
Module Identifier:autoindex_module
-
-

Summary

- - -

The index of a directory can come from one of two + Win32 dir shell command

Status:Base
Module Identifier:autoindex_module

Summary

+

The index of a directory can come from one of two sources:

- -
    - -
  • A file written by the user, typically called - index.html. The DirectoryIndex directive sets the +
      +
    • A file written by the user, typically called + index.html. The DirectoryIndex directive sets the name of this file. This is controlled by mod_dir.
      • - -
    • Otherwise, a listing generated by the server. The other - directives control the format of this listing. The AddIcon, AddIconByEncoding and - AddIconByType are +
    • Otherwise, a listing generated by the server. The other + directives control the format of this listing. The AddIcon, AddIconByEncoding and + AddIconByType are used to set a list of icons to display for various file types; for each file listed, the first icon listed that matches the file is displayed. These are controlled by mod_autoindex.
      • - -
    - -

    The two functions are separated so that you can completely +

+

The two functions are separated so that you can completely remove (or replace) automatic index generation should you want to.

- -

Automatic index generation is enabled with using +

Automatic index generation is enabled with using Options +Indexes. See the - Options directive for + Options directive for more details.

- -

If the FancyIndexing - option is given with the IndexOptions directive, +

If the FancyIndexing + option is given with the IndexOptions directive, the column headers are links that control the order of the display. If you select a header link, the listing will be regenerated, sorted by the values in that column. Selecting the same header repeatedly toggles between ascending and descending order. These column header links are suppressed with - IndexOptions directive's + IndexOptions directive's SuppressColumnSorting option.

- -

Note that when the display is sorted by "Size", it's the +

Note that when the display is sorted by "Size", it's the actual size of the files that's used, not the displayed value - so a 1010-byte file will always be displayed before a 1011-byte file (if in ascending order) even though they both are shown as "1K".

+

Directives

Autoindex Request Query Arguments

- -

Directives

- -

Autoindex Request Query Arguments

- - -

Apache 2.0.23 reorganized the Query Arguments for Column +

Apache 2.0.23 reorganized the Query Arguments for Column Sorting, and introduced an entire group of new query options. To effectively eliminate all client control over the output, the IndexOptions IgnoreClient option was introduced.

- -

The column sorting headers themselves are self-referencing +

The column sorting headers themselves are self-referencing hyperlinks that add the sort query options shown below. Any option below may be added to any request for the directory resource.

- -
    - -
  • -C=N sorts the directory by file name
    • - - -
  • -C=M sorts the directory by last-modified +
      +
    • C=N sorts the directory by file name
      • + +
    • C=M sorts the directory by last-modified date, then file name
      • - -
    • -C=S sorts the directory by size, then file +
    • C=S sorts the directory by size, then file name
      • - -
    • -C=D sorts the directory by description, then +
    • C=D sorts the directory by description, then file name
       
      • - -
    • -O=A sorts the listing in Ascending +
    • O=A sorts the listing in Ascending Order
      • - -
    • -O=D sorts the listing in Descending +
    • O=D sorts the listing in Descending Order
       
      • - -
    • -F=0 formats the listing as a simple list +
    • F=0 formats the listing as a simple list (not FancyIndexed)
      • - -
    • -F=1 formats the listing as a FancyIndexed +
    • F=1 formats the listing as a FancyIndexed list
      • - -
    • -F=2 formats the listing as an HTMLTable +
    • F=2 formats the listing as an HTMLTable FancyIndexed list
       
      • - -
    • -V=0 disables version sorting
      • +
    • V=0 disables version sorting
      • - -
    • -V=1 enables version sorting
      +
    • V=1 enables version sorting
       
      • - -
    • -P=pattern lists only files matching - the given pattern -
      • - -
    +
  • P=pattern lists only files matching + the given pattern
    • +
- -

Note that the 'P'attern query argument is tested +

Note that the 'P'attern query argument is tested after the usual IndexIgnore directives are processed, and all file names are still subjected to the same criteria as any other autoindex listing. The Query Arguments parser in @@ -222,18 +106,13 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX encountered. The Query Arguments must be well formed, according to the table above.

- -

The simple example below, which can be clipped and saved in +

The simple example below, which can be clipped and saved in a header.html file, illustrates these query options. Note that the unknown "X" argument, for the submit button, is listed last to assure the arguments are all parsed before mod_autoindex encounters the X=Go input.

- -
- - -
+
- -
<FORM METHOD="GET">
  Show me a <SELECT NAME="F">
    <OPTION VALUE="0"> Plain list
@@ -257,49 +136,11 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX   Matching <INPUT TYPE="text" NAME="P" VALUE="*">
  <INPUT TYPE="submit" NAME="X" VALUE="Go">
</FORM> -
-
- - -
-

-AddAlt Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Alternate text to display for a file, instead of an -icon selected by filename
Syntax: -AddAlt string file [file] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

-AddAlt provides the alternate text to +

+ +

AddAlt Directive

Description: Alternate text to display for a file, instead of an +icon selected by filename
Syntax:AddAlt string file [file] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

AddAlt provides the alternate text to display for a file, instead of an icon, for FancyIndexing. File is a file extension, partial filename, wild-card expression or full filename for files to describe. @@ -307,59 +148,15 @@ icon selected by filename This alternate text is displayed if the client is image-incapable, has image loading disabled, or fails to retrieve the icon.

- -

Examples:

- -
- - -
+

Examples:

+
- -
AddAlt "PDF" *.pdf
AddAlt "Compressed" *.gz *.zip *.Z -
-
- - -
-

-AddAltByEncoding Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Alternate text to display for a file instead of an icon -selected by MIME-encoding
Syntax: -AddAltByEncoding string MIME-encoding -[MIME-encoding] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

-AddAltByEncoding provides the alternate +

+

AddAltByEncoding Directive

Description: Alternate text to display for a file instead of an icon +selected by MIME-encoding
Syntax:AddAltByEncoding string MIME-encoding +[MIME-encoding] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

AddAltByEncoding provides the alternate text to display for a file, instead of an icon, for FancyIndexing. MIME-encoding is a valid content-encoding, such as x-compress. String is enclosed in double @@ -367,58 +164,14 @@ selected by MIME-encoding client is image-incapable, has image loading disabled, or fails to retrieve the icon.

- -

Example:

- -
- - -
+

Example:

+
- -
AddAltByEncoding "gzip" x-gzip -
-
- - -
-

-AddAltByType Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Alternate text to display for a file, instead of an -icon selected by MIME content-type
Syntax: -AddAltByType string - MIME-type [MIME-type] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

-AddAltByType sets the alternate text to +

+

AddAltByType Directive

Description: Alternate text to display for a file, instead of an +icon selected by MIME content-type
Syntax:AddAltByType string + MIME-type [MIME-type] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

AddAltByType sets the alternate text to display for a file, instead of an icon, for FancyIndexing. MIME-type is a valid content-type, such as text/html. String is enclosed in double @@ -426,74 +179,23 @@ icon selected by MIME content-type client is image-incapable, has image loading disabled, or fails to retrieve the icon.

- -

Example:

- -
- - -
+

Example:

+
- -
AddAltByType "TXT" text/plain -
-
- - -
-

-AddDescription Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description:
Syntax: -AddDescription - string file [file] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

This sets the description to display for a file, for +

+

AddDescription Directive

Description:
Syntax:AddDescription + string file [file] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

This sets the description to display for a file, for FancyIndexing. File is a file extension, partial filename, wild-card expression or full filename for files to describe. String is enclosed in double quotes ("). Example:

+
AddDescription "The planet Mars" + /web/pics/mars.gif
-
- - - - -
AddDescription "The planet Mars" - /web/pics/mars.gif
-
- - -

The typical, default description field is 23 bytes wide. 6 +

The typical, default description field is 23 bytes wide. 6 more bytes are added by the IndexOptions SuppressIcon option, 7 bytes are added by the IndexOptions SuppressSize @@ -502,314 +204,83 @@ icon selected by MIME content-type Therefore, the widest default the description column is ever assigned is 55 bytes.

- -

See the DescriptionWidth - IndexOptions keyword +

See the DescriptionWidth + IndexOptions keyword for details on overriding the size of this column, or allowing descriptions of unlimited length.

- -
- - -
-

-Caution -

-

Descriptive text defined with +

- -

Caution

Descriptive text defined with AddDescription may contain HTML markup, such as tags and character entities. If the width of the description column should happen to truncate a tagged element (such as cutting off the end of a bolded phrase), the results may affect the rest of the directory listing.

- -
-
- - -
-

-AddIcon Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Icon to display for a file selected by name
Syntax: -AddIcon icon - name [name] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

This sets the icon to display next to a file ending in +

+

AddIcon Directive

Description: Icon to display for a file selected by name
Syntax:AddIcon icon + name [name] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

This sets the icon to display next to a file ending in name for FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for an icon for non-graphical browsers.

- -

-Name is either ^^DIRECTORY^^ for directories, +

Name is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for blank lines (to format the list correctly), a file extension, a wildcard expression, a partial filename or a complete filename. Examples:

- -
- - -
+
- -
AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm
AddIcon /icons/dir.xbm ^^DIRECTORY^^
AddIcon /icons/backup.xbm *~ -
-
- +
-

-AddIconByType +

AddIconByType should be used in preference to AddIcon, when possible.

- - -
-

-AddIconByEncoding Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Icon to display next to files selected by MIME -content-encoding
Syntax: -AddIconByEncoding - icon MIME-encoding [MIME-encoding] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

This sets the icon to display next to files with FancyIndexing. +

AddIconByEncoding Directive

Description: Icon to display next to files selected by MIME +content-encoding
Syntax:AddIconByEncoding + icon MIME-encoding [MIME-encoding] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

This sets the icon to display next to files with FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for an icon for non-graphical browsers.

- -

-Mime-encoding is a wildcard expression matching +

Mime-encoding is a wildcard expression matching required the content-encoding. Examples:

- -
- - - - -
AddIconByEncoding /icons/compress.xbm x-compress
-
- - -
-

-AddIconByType Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Icon to display next to files selected by MIME -content-type
Syntax: -AddIconByType - icon MIME-type [MIME-type] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

This sets the icon to display next to files of type +

AddIconByEncoding /icons/compress.xbm x-compress
+

AddIconByType Directive

Description: Icon to display next to files selected by MIME +content-type
Syntax:AddIconByType + icon MIME-type [MIME-type] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

This sets the icon to display next to files of type MIME-type for FancyIndexing. Icon is either a (%-escaped) relative URL to the icon, or of the format (alttext,url) where alttext is the text tag given for an icon for non-graphical browsers.

- -

-Mime-type is a wildcard expression matching +

Mime-type is a wildcard expression matching required the mime types. Examples:

- -
- - - - -
AddIconByType (IMG,/icons/image.xbm) image/*
-
- - -
-

-DefaultIcon Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Icon to display for files when no specific icon is -configured
Syntax: -DefaultIcon url-path - -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

The DefaultIcon directive sets the icon +

AddIconByType (IMG,/icons/image.xbm) image/*
+

DefaultIcon Directive

Description: Icon to display for files when no specific icon is +configured
Syntax:DefaultIcon url-path
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

The DefaultIcon directive sets the icon to display for files when no specific icon is known, for FancyIndexing. Url is a (%-escaped) relative URL to the icon. Examples:

- -
- - - - -
DefaultIcon /icon/unknown.xbm
-
- - -
-

-HeaderName Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Name of the file that will be inserted at the top -of the index listing
Syntax: -HeaderName filename - -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

The HeaderName directive sets the name +

DefaultIcon /icon/unknown.xbm
+

HeaderName Directive

Description: Name of the file that will be inserted at the top +of the index listing
Syntax:HeaderName filename
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

The HeaderName directive sets the name of the file that will be inserted at the top of the index listing. Filename is the name of the file to include.

- -
- - -
- -

Both HeaderName and ReadmeName now treat +

filename may refer to a CGI script if the script's actual file type (as opposed to its output) is marked as text/html such as with a directive like:

- -
-
+

Both HeaderName and ReadmeName now treat Filename as a URI path relative to the one used to access the directory being indexed. Filename must resolve to a document with a major content type of @@ -818,75 +289,26 @@ of the index listing
- -
+
- -
AddType text/html .cgi -
-
- -

-Content negotiation - will be performed if the MultiViews Option is enabled. If +

+

Content negotiation + will be performed if the MultiViews Option is enabled. If filename resolves to a static text/html document (not a CGI script) and the Includes - option is enabled, the file + option is enabled, the file will be processed for server-side includes (see the mod_include documentation).

+
- - - -
- - -

If the file specified by HeaderName contains +

If the file specified by HeaderName contains the beginnings of an HTML document (<HTML>, <HEAD>, etc) then you will probably want to set IndexOptions +SuppressHTMLPreamble, so that these tags are not repeated.

- - -
-

-IndexIgnore Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Adds to the list of files to hide when listing -a directory
Syntax: -IndexIgnore file [file] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

The IndexIgnore directive adds to the +

IndexIgnore Directive

Description: Adds to the list of files to hide when listing +a directory
Syntax:IndexIgnore file [file] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

The IndexIgnore directive adds to the list of files to hide when listing a directory. File is a file extension, partial filename, wildcard expression or full filename for files to ignore. Multiple IndexIgnore directives add @@ -894,107 +316,43 @@ a directory files. By default, the list contains `.'. Example:

- -
- - - - -
IndexIgnore README .htaccess *~
-
- - -
-

-IndexOptions Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Various configuration settings for directory -indexing
Syntax: -IndexOptions [+|-]option [[+|-]option] ... -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

The IndexOptions directive specifies the +

IndexIgnore README .htaccess *~
+

IndexOptions Directive

Description: Various configuration settings for directory +indexing
Syntax:IndexOptions [+|-]option [[+|-]option] ...
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

The IndexOptions directive specifies the behavior of the directory indexing. Option can be one of

- -
- -
-DescriptionWidth=[n - | *] (Apache 1.3.10 or 2.0.23 and later) -
- - -
The DescriptionWidth keyword allows you to +
+
DescriptionWidth=[n + | *] (Apache 1.3.10 or 2.0.23 and later)
+ +
The DescriptionWidth keyword allows you to specify the width of the description column in characters.
- -
--DescriptionWidth (or unset) allows +
-DescriptionWidth (or unset) allows mod_autoindex to calculate the best width.
- -
-DescriptionWidth=n fixes the column width to +
DescriptionWidth=n fixes the column width to n bytes wide.
- -
-DescriptionWidth=* grows the column to the +
DescriptionWidth=* grows the column to the width necessary to accommodate the longest description string.
- -
-See the section on AddDescription for dangers - inherent in truncating descriptions. -
+
See the section on AddDescription for dangers + inherent in truncating descriptions.
- -
-FancyIndexing -
+
FancyIndexing
- -
+
This turns on fancy indexing of directories.
- -
-FoldersFirst (Apache - 1.3.10 or 2.0.23 and later) -
+
FoldersFirst (Apache + 1.3.10 or 2.0.23 and later)
- -
If this option is enabled, subdirectory listings will +
If this option is enabled, subdirectory listings will always appear first, followed by normal files in the directory. The listing is basically broken into two components, the files and the subdirectories, and each is @@ -1005,17 +363,12 @@ indexing Beta, which will be listed before normal files Gamma and Alpha. This option only has an effect if FancyIndexing - is also enabled. -
+ is also enabled.
- -
-HTMLTable (Experimental, - Apache 2.0.23 and later) -
+
HTMLTable (Experimental, + Apache 2.0.23 and later)
- -
+
This experimental option with FancyIndexing constructs a simple table for the fancy directory listing. Note this will confuse older browsers. It is particularly necessary if file @@ -1023,24 +376,16 @@ indexing left-to-right and right-to-left reading order, as can happen on WinNT or other utf-8 enabled platforms.
- -
-IconsAreLinks -
+
IconsAreLinks
- -
+
This makes the icons part of the anchor for the filename, for fancy indexing.
- -
-IconHeight[=pixels] - (Apache 1.3 and later) -
+
IconHeight[=pixels] + (Apache 1.3 and later)
- -
+
Presence of this option, when used with IconWidth, will cause the server to include HEIGHT and WIDTH attributes in the IMG tag for @@ -1050,14 +395,10 @@ indexing the standard height of the icons supplied with the Apache software.
- -
-IconWidth[=pixels] (Apache - 1.3 and later) -
+
IconWidth[=pixels] (Apache + 1.3 and later)
- -
+
Presence of this option, when used with IconHeight, will cause the server to include HEIGHT and WIDTH attributes in the IMG tag for @@ -1067,62 +408,41 @@ indexing the standard width of the icons supplied with the Apache software.
- -
-IgnoreClient -
+
IgnoreClient
- -
+
This option causes mod_autoindex to ignore all query variables from the client, including sort order (implies SuppressColumnSorting.)
- -
-NameWidth=[n | *] - (Apache 1.3.2 and later) -
+
NameWidth=[n | *] + (Apache 1.3.2 and later)
- -
The NameWidth keyword allows you to specify the width of +
The NameWidth keyword allows you to specify the width of the filename column in bytes.
- -
--NameWidth (or unset) allows mod_autoindex +
-NameWidth (or unset) allows mod_autoindex to calculate the best width.
- -
-NameWidth=n fixes the column width to n +
NameWidth=n fixes the column width to n bytes wide.
- -
-NameWidth=* grows the column to the +
NameWidth=* grows the column to the necessary width.
- -
-ScanHTMLTitles -
+
ScanHTMLTitles
- -
+
This enables the extraction of the title from HTML documents for fancy indexing. If the file does not have a description given by AddDescription then httpd will read the document for the value of the TITLE tag. This is CPU and disk intensive.
- -
-SuppressColumnSorting +
SuppressColumnSorting (Apache 1.3 and later)
- -
+
If specified, Apache will not make the column headings in a FancyIndexed directory listing into links for sorting. The default behavior is for them to be links; selecting the @@ -1132,13 +452,9 @@ indexing string. That behavior is now controlled by IndexOptions IgnoreClient in Apache 2.0.23.
- -
-SuppressDescription -
+
SuppressDescription
- -
+
This will suppress the file description in fancy indexing listings. By default, no file descriptions are defined, and so the use of this option will regain 23 characters of screen @@ -1148,15 +464,12 @@ indexing index option to limit the size of the description column.
- -
-SuppressHTMLPreamble +
SuppressHTMLPreamble (Apache 1.3 and later)
- -
+
If the directory actually contains a file specified by the - HeaderName + HeaderName directive, the module usually includes the contents of the file after a standard HTML preamble (<HTML>, <HEAD>, et cetera). The SuppressHTMLPreamble option disables @@ -1165,60 +478,42 @@ indexing HTML instructions in this case. If there is no header file, the preamble is generated as usual.
- -
-SuppressIcon (Apache +
SuppressIcon (Apache 2.0.23 and later)
- -
+
This will suppress the icon in fancy indexing listings. Combining both SuppressIcon and SuppressRules yields proper HTML 3.2 output, which by the final specification prohibits IMG and HR tags from the PRE block (used to format FancyIndexed listings.)
- -
-SuppressLastModified -
+
SuppressLastModified
- -
+
This will suppress the display of the last modification date, in fancy indexing listings.
- -
-SuppressRules +
SuppressRules (Apache 2.0.23 and later)
- -
+
This will suppress the horizontal rule lines (HR tags) in directory listings. Combining both SuppressIcon and SuppressRules yeilds proper HTML 3.2 output, which by the final specification prohibits IMG and HR tags from the PRE block (used to format FancyIndexed listings.)
- -
-SuppressSize -
+
SuppressSize
- -
+
This will suppress the file size in fancy indexing listings.
- -
-TrackModified (Apache - 1.3.15 or 2.0.23 and later) -
+
TrackModified (Apache + 1.3.15 or 2.0.23 and later)
- -
+
This returns the Last-Modified and ETag values for the listed directory in the HTTP header. It is only valid if the operating system and file system return appropriate stat() @@ -1233,84 +528,56 @@ indexing Last-Modified header on all Unix platforms. If this is a concern, leave this option disabled.
- -
-VersionSort (Apache 2.0a3 - and later) -
+
VersionSort (Apache 2.0a3 + and later)
- -
+
The VersionSort keyword causes files containing version numbers to sort in a natural way. Strings are sorted as usual, except that substrings of digits in the name and description are compared according to their numeric value. For example: -
- - -
+
- -
foo-1.7
foo-1.7.2
foo-1.7.12
foo-1.8.2
foo-1.8.2a
foo-1.12
- -
-
+
If the number starts with a zero, then it is considered to be a fraction: -
- - -
+
- -
foo-1.001
foo-1.002
foo-1.030
foo-1.04 -
-
- - - - -
- -

Incremental IndexOptions

- -
- - -
+
+
+ +
+

Incremental IndexOptions

+
+ +
Apache 1.3.3 introduced some significant changes in the handling of IndexOptions directives. In particular,
- -
+
- -
    - -
  • Multiple IndexOptions directives for a +
      +
    • Multiple IndexOptions directives for a single directory are now merged together. The result of the example above will now be the equivalent of IndexOptions FancyIndexing ScanHTMLTitles.
      • - -
    • The addition of the incremental syntax +
    • The addition of the incremental syntax (i.e., prefixing keywords with '+' or '-').
      • - -
    - -
    +
+
Whenever a '+' or '-' prefixed keyword is encountered, it is applied to the current IndexOptions settings (which may have been inherited from an upper-level @@ -1319,77 +586,31 @@ foo-1.04 incremental settings encountered so far. Consider the following example: -
- - -
IndexOptions +ScanHTMLTitles -IconsAreLinks +
- -
IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing
IndexOptions +SuppressSize
- -
-
+
The net effect is equivalent to IndexOptions FancyIndexing +SuppressSize, because the unprefixed FancyIndexing discarded the incremental keywords before it, but allowed them to start accumulating again afterward.
- -
+
To unconditionally set the IndexOptions for a particular directory, clearing the inherited settings, specify keywords without any '+' or '-' prefixes.
- -
- - -
-

-IndexOrderDefault Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Sets the default ordering of the directory index
Syntax: -IndexOrderDefault -Ascending|Descending Name|Date|Size|Description -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

The IndexOrderDefault directive is used + +

IndexOrderDefault Directive

Description: Sets the default ordering of the directory index
Syntax:IndexOrderDefault +Ascending|Descending Name|Date|Size|Description
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

The IndexOrderDefault directive is used in combination with the FancyIndexing index option. By default, fancyindexed directory listings are displayed in ascending order by filename; the IndexOrderDefault allows you to change this initial display order.

- -

-IndexOrderDefault takes two +

IndexOrderDefault takes two arguments. The first must be either Ascending or Descending, indicating the direction of the sort. The second argument must be one of the keywords Name, @@ -1397,61 +618,16 @@ Ascending|Descending Name|Date|Size|Description and identifies the primary key. The secondary key is always the ascending filename.

- -

You can force a directory listing to only be displayed in a +

You can force a directory listing to only be displayed in a particular order by combining this directive with the SuppressColumnSorting index option; this will prevent the client from requesting the directory listing in a different order.

- - -
-

-ReadmeName Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description:
Syntax: -ReadmeName filename - -
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
-
- - -

The ReadmeName directive sets the name +

ReadmeName Directive

Description:
Syntax:ReadmeName filename
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_autoindex
+

The ReadmeName directive sets the name of the file that will be appended to the end of the index listing. Filename is the name of the file to include, and is taken to be relative to the location being indexed.

- -

See also HeaderName, where this behavior +

See also HeaderName, where this behavior is described in greater detail.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome - - - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_cern_meta.html b/docs/manual/mod/mod_cern_meta.html index c9c4cc005f..9fef4c3663 100644 --- a/docs/manual/mod/mod_cern_meta.html +++ b/docs/manual/mod/mod_cern_meta.html @@ -1,44 +1,10 @@ - - - - -mod_cern_meta - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_cern_meta

- - - - -
- - - - - - - - - - -
Description: -CERN httpd metafile semantics -
Status:Extension
Module Identifier:cern_meta_module
-
-

Summary

- +-->mod_cern_meta - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_cern_meta

Description:CERN httpd metafile semantics
Status:Extension
Module Identifier:cern_meta_module

Summary

- -

Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP +

Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP headers that can be output in addition to the normal range of headers for each file accessed. They appear rather like the Apache .asis files, and are able to provide a crude way of @@ -47,151 +13,24 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX this one was chosen because there is already a large number of CERN users who can exploit this module.

- -

More information on the +

More information on the CERN metafile semantics is available.

- - -

Directives

- -
-

-MetaDir Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Name of the directory to find CERN-style meta information -files
Syntax: -MetaDir directory - -
Default:MetaDir .web
Context:directory
Status:Extension
Module:mod_cern_meta
-
- - -

Specifies the name of the directory in which Apache can find +

Directives

MetaDir Directive

Description: Name of the directory to find CERN-style meta information +files
Syntax:MetaDir directory
Default:MetaDir .web
Context:directory
Status:Extension
Module:mod_cern_meta
+

Specifies the name of the directory in which Apache can find meta information files. The directory is usually a 'hidden' subdirectory of the directory that contains the file being accessed. Set to "." to look in the same directory as the file.

- - -
-

-MetaFiles Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Activates CERN meta-file processing
Syntax: -MetaFiles on|off -
Default:MetaFiles off
Context:directory
Status:Extension
Module:mod_cern_meta
-
- - -

Turns on/off Meta file processing on a per-directory basis.

- - -
-

-MetaSuffix Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: File name suffix for the file containg CERN-style -meta information
Syntax: -MetaSuffix suffix - -
Default:MetaSuffix .meta
Context:directory
Status:Extension
Module:mod_cern_meta
-
- - -

Specifies the file name suffix for the file containing the +

MetaFiles Directive

Description: Activates CERN meta-file processing
Syntax:MetaFiles on|off
Default:MetaFiles off
Context:directory
Status:Extension
Module:mod_cern_meta
+

Turns on/off Meta file processing on a per-directory basis.

+

MetaSuffix Directive

Description: File name suffix for the file containg CERN-style +meta information
Syntax:MetaSuffix suffix
Default:MetaSuffix .meta
Context:directory
Status:Extension
Module:mod_cern_meta
+

Specifies the file name suffix for the file containing the meta information. For example, the default values for the two directives will cause a request to DOCUMENT_ROOT/somedir/index.html to look in DOCUMENT_ROOT/somedir/.web/index.html.meta and will use its contents to generate additional MIME header information.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_cgi.html b/docs/manual/mod/mod_cgi.html index 3bd2fd073e..8614578de6 100644 --- a/docs/manual/mod/mod_cgi.html +++ b/docs/manual/mod/mod_cgi.html @@ -1,114 +1,45 @@ - - - - -mod_cgi - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_cgi

- - - - -
- - - - - - - - - - -
Description: -Execution of CGI scripts -
Status:Base
Module Identifier:cgi_module
-
-

Summary

- +-->mod_cgi - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_cgi

Description:Execution of CGI scripts
Status:Base
Module Identifier:cgi_module

Summary

- -

Any file that has the mime type +

Any file that has the mime type application/x-httpd-cgi or handler cgi-script (Apache 1.1 or later) will be treated as a CGI script, and run by the server, with its output being returned to the client. Files acquire this type either by having a name containing an extension defined by the - AddType directive, or by being - in a ScriptAlias + AddType directive, or by being + in a ScriptAlias directory.

- -

When the server invokes a CGI script, it will add a variable +

When the server invokes a CGI script, it will add a variable called DOCUMENT_ROOT to the environment. This variable will contain the value of the - DocumentRoot configuration + DocumentRoot configuration variable.

- -

For an introduction to using CGI scripts with Apache, see +

For an introduction to using CGI scripts with Apache, see our tutorial on Dynamic Content With CGI.

- -

When using a multi-threaded MPM under unix, the module +

When using a multi-threaded MPM under unix, the module mod_cgid should be used in place of this module. At the user level, the two modules are essentially identical.

- - -

-See also: -

- -

Directives

- -

CGI Environment variables

- -

The server will set the CGI environment variables as described +

See also

Directives

CGI Environment variables

+

The server will set the CGI environment variables as described in the CGI specification, with the following provisions:

- -
- -
PATH_INFO
+
+
PATH_INFO
- -
This will not be available if the AcceptPathInfo directive is explicitly set to +
This will not be available if the AcceptPathInfo directive is explicitly set to off. The default behavior, if AcceptPathInfo is not given, is that mod_cgi will accept path info (trailing /more/path/info following the script filename in the URI), while @@ -117,157 +48,74 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX directive has the same effect as setting it on for mod_cgi requests.
- -
REMOTE_HOST
+
REMOTE_HOST
- -
This will only be set if HostnameLookups is set to on (it +
This will only be set if HostnameLookups is set to on (it is off by default), and if a reverse DNS lookup of the accessing host's address indeed finds a host name.
- -
REMOTE_IDENT
+
REMOTE_IDENT
- -
This will only be set if IdentityCheck is set to +
This will only be set if IdentityCheck is set to on and the accessing host supports the ident protocol. Note that the contents of this variable cannot be relied upon because it can easily be faked, and if there is a proxy between the client and the server, it is usually totally useless.
- -
REMOTE_USER
+
REMOTE_USER
- -
This will only be set if the CGI script is subject to +
This will only be set if the CGI script is subject to authentication.
- -
- -

-CGI Debugging -

- -

Debugging CGI scripts has traditionally been difficult, mainly +

+

CGI Debugging

+

Debugging CGI scripts has traditionally been difficult, mainly because it has not been possible to study the output (standard output and error) for scripts which are failing to run properly. These directives, included in Apache 1.2 and later, provide more detailed logging of errors when they occur.

-

CGI Logfile Format

- -

When configured, the CGI error log logs any CGI which does not +

When configured, the CGI error log logs any CGI which does not execute properly. Each CGI script which fails to operate causes several lines of information to be logged. The first two lines are always of the format:

- -
- - -
- %% [time] request-line -
+
- -
+ %% [time] request-line
%% HTTP-status CGI-script-filename -
-
- -

If the error is that CGI script cannot be run, the log file +

+

If the error is that CGI script cannot be run, the log file will contain an extra two lines:

- -
- - -
+
- -
%%error
- -error-message -
-
- -

Alternatively, if the error is the result of the script + error-message +

+

Alternatively, if the error is the result of the script returning incorrect header information (often due to a bug in the script), the following information is logged:

- -
- - -
+
- -
%request
- -All HTTP request headers received -
- -POST or PUT entity (if any) -
+ All HTTP request headers received
+ POST or PUT entity (if any)
%response
- -All headers output by the CGI script -
+ All headers output by the CGI script
%stdout
- -CGI standard output -
+ CGI standard output
%stderr
- -CGI standard error -
- -
-
- -

(The %stdout and %stderr parts may be missing if the script did + CGI standard error
+

+

(The %stdout and %stderr parts may be missing if the script did not output anything on standard output or standard error).

- -
-

-ScriptLog Directive -

- - - - -
- - - - - - - - - - - - - - - - -
Description: Location of the CGI script error logfile
Syntax: -ScriptLog file-path - -
Context:server config
Status:Base
Module:mod_cgi, mod_cgid
-
- - -

The ScriptLog directive sets the CGI +

ScriptLog Directive

Description: Location of the CGI script error logfile
Syntax:ScriptLog file-path
Context:server config
Status:Base
Module:mod_cgi, mod_cgid
+

The ScriptLog directive sets the CGI script error logfile. If no ScriptLog is given, no error log is created. If given, any CGI errors are logged into the filename given as argument. If this is a relative file or path it is taken relative to the server root.

- -

This log will be opened as the user the child processes run - as, ie. the user specified in the main User directive. This means that +

This log will be opened as the user the child processes run + as, ie. the user specified in the main User directive. This means that either the directory the script log is in needs to be writable by that user or the file needs to be manually created and set to be writable by that user. If you place the script log in @@ -275,105 +123,24 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX directory permissions to make it writable by the user the child processes run as.

- -

Note that script logging is meant to be a debugging feature +

Note that script logging is meant to be a debugging feature when writing CGI scripts, and is not meant to be activated continuously on running servers. It is not optimized for speed or efficiency, and may have security problems if used in a manner other than that for which it was designed.

- - -
-

-ScriptLogBuffer Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Maximum amount of PUT or POST requests that will be recorded -in the scriptlog
Syntax: -ScriptLogBuffer bytes - -
Default:ScriptLogBuffer 1024
Context:server config
Status:Base
Module:mod_cgi, mod_cgid
-
- - -

The size of any PUT or POST entity body that is logged to +

ScriptLogBuffer Directive

Description: Maximum amount of PUT or POST requests that will be recorded +in the scriptlog
Syntax:ScriptLogBuffer bytes
Default:ScriptLogBuffer 1024
Context:server config
Status:Base
Module:mod_cgi, mod_cgid
+

The size of any PUT or POST entity body that is logged to the file is limited, to prevent the log file growing too big too quickly if large bodies are being received. By default, up to 1024 bytes are logged, but this can be changed with this directive.

- - -
-

-ScriptLogLength Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description: Size limit of the CGI script logfile
Syntax: -ScriptLogLength bytes - -
Default:ScriptLogLength 10385760
Context:server config
Status:Base
Module:mod_cgi, mod_cgid
-
- - -

-ScriptLogLength can be used to limit the +

ScriptLogLength Directive

Description: Size limit of the CGI script logfile
Syntax:ScriptLogLength bytes
Default:ScriptLogLength 10385760
Context:server config
Status:Base
Module:mod_cgi, mod_cgid
+

ScriptLogLength can be used to limit the size of the CGI script logfile. Since the logfile logs a lot of information per CGI error (all request headers, all script output) it can grow to be a big file. To prevent problems due to unbounded growth, this directive can be used to set an maximum file-size for the CGI logfile. If the file exceeds this size, no more information will be written to it.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_cgid.html b/docs/manual/mod/mod_cgid.html index 97e8a9f749..6fc8cfe2c4 100644 --- a/docs/manual/mod/mod_cgid.html +++ b/docs/manual/mod/mod_cgid.html @@ -1,56 +1,15 @@ - - - - -mod_cgid - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_cgid

- - - - -
- - - - - - - - - - - - - -
Description: -Execution of CGI scripts using an - external CGI daemon -
Status:Base
Module Identifier:cgid_module
Compatibility: -Unix threaded MPMs only -
-
-

Summary

- - -

Except for the optimizations and the additional ScriptSock directive noted below, +-->mod_cgid - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_cgid

Description:Execution of CGI scripts using an + external CGI daemon
Status:Base
Module Identifier:cgid_module
Compatibility:Unix threaded MPMs only

Summary

+

Except for the optimizations and the additional ScriptSock directive noted below, mod_cgid behaves similarly to mod_cgi. See the mod_cgi Summary for additional details about - Apache and CGI. -

+ Apache and CGI.

- -

On certain unix operating systems, forking a process from a +

On certain unix operating systems, forking a process from a multi-threaded server is a very expensive operation because the new process will replicate all the threads of the parent process. In order to avoid incurring this expense on each CGI @@ -59,77 +18,18 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX main server communicates with this daemon using a unix domain socket.

- -

This module is used by default whenever a multi-threaded MPM +

This module is used by default whenever a multi-threaded MPM is selected during the compilation process. At the user level, this module is identical in configuration and operation to mod_cgi. The only exception is the additional directive ScriptSock which gives the name of the socket to use for communication with the cgi daemon.

- - -

Directives

- -
-

-ScriptSock Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - -
Description:
Syntax: -ScriptSock file-path - -
Default:ScriptSock logs/cgisock
Context:server config
Status:Base
Module:mod_cgid
-
- - -

This directive sets the name of the socket to use for +

Directives

ScriptSock Directive

Description:
Syntax:ScriptSock file-path
Default:ScriptSock logs/cgisock
Context:server config
Status:Base
Module:mod_cgid
+

This directive sets the name of the socket to use for communication with the CGI daemon. The socket will be opened using the permissions of the user who starts Apache (usually root). To maintain the security of communications with CGI scripts, it is important that no other user has permission to write in the directory where the socket is located.

- - -
-

Apache HTTP Server Version 2.0

-IndexHome -
- - +

Apache HTTP Server Version 2.0

IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_charset_lite.html b/docs/manual/mod/mod_charset_lite.html index 8a6d22054a..c0e203ec12 100644 --- a/docs/manual/mod/mod_charset_lite.html +++ b/docs/manual/mod/mod_charset_lite.html @@ -1,86 +1,48 @@ - - - - - - - Apache module mod_charset_lite - - - - - - -

Module mod_charset_lite

- -

This module provides the ability to specify character set - translation or recoding.

- -

Status: Experimental
- Source File: - mod_charset_lite.c
- Module Identifier: - charset_lite_module

- -

Summary

- +mod_charset_lite - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_charset_lite

Description:Specify character set translation or recoding
Status:Experimental
Module Identifier:charset_lite_module

Summary

This is an experimental module and should be used with care. Experiment with your mod_charset_lite configuration to ensure that it performs the desired function.

-

mod_charset_lite allows the administrator to +

mod_charset_lite allows the administrator to specify the source character set of objects as well as the - character set they should be translated into before sending to - the client. mod_charset_lite does not translate - the data itself but instead tells Apache what translation to - perform. mod_charset_lite is applicable to EBCDIC + character set they should be translated into before sending to the + client. mod_charset_lite does not translate the + data itself but instead tells Apache what translation to + perform. mod_charset_lite is applicable to EBCDIC and ASCII host environments. In an EBCDIC environment, Apache - normally translates text content from the code page of the - Apache process locale to ISO-8859-1. - mod_charset_lite can be used to specify that a - different translation is to be performed. In an ASCII - environment, Apache normally performs no translation, so - mod_charset_lite is needed in order for any - translation to take place.

+ normally translates text content from the code page of the Apache + process locale to ISO-8859-1. mod_charset_lite + can be used to specify that a different translation is to be + performed. In an ASCII environment, Apache normally performs no + translation, so mod_charset_lite is needed in + order for any translation to take place.

This module provides a small subset of configuration mechanisms implemented by Russian Apache and its associated mod_charset.

- -

Directives

- - - -

Common Problems

- -

Invalid character set names

- -

The character set name parameters of CharsetSourceEnc and - CharsetDefault must be acceptable to the translation mechanism - used by APR on the system where mod_charset_lite is deployed. - These character set names are not standardized and are usually - not the same as the corresponding values used in http headers. - Currently, APR can only use iconv(3), so you can easily test - your character set names using the iconv(1) program, as - follows:

-
+

Directives

Common Problems

+ +

Invalid character set names

+ +

The character set name parameters of CharsetSourceEnc and + CharsetDefault + must be acceptable to the translation mechanism used by APR on the + system where mod_charset_lite is deployed. These + character set names are not standardized and are usually not the + same as the corresponding values used in http headers. Currently, + APR can only use iconv(3), so you can easily test your character + set names using the iconv(1) program, as follows:

+
iconv -f charsetsourceenc-value -t charsetdefault-value - - +
+ -

Mismatch between character set of content and translation +

Mismatch between character set of content and translation rules

If the translation rules don't make sense for the content, @@ -94,68 +56,9 @@ characters (e.g., question marks) in the output buffer when it cannot translate the input buffer. -

- -

CharsetSourceEnc

- -

Syntax: CharsetSourceEnc - charset
- Default: None
- Context: directory, virtual - host
- Override: - FileInfo
- Status: Experimental
- Module: mod_charset_lite
-

- -

The CharsetSourceEnc directive specifies the - source charset of files in the associated container.

-

The value of the charset argument must be accepted - as a valid character set name by the character set support in - APR. Generally, this means that it must be supported by - iconv.

- Example: -
-    <Directory "/export/home/trawick/apacheinst/htdocs/convert">
-    CharsetSourceEnc  UTF-16BE
-    CharsetDefault    ISO8859-1
-    </Directory>
- 
-
- The character set names in this example work with the iconv - translation support in Solaris 8. -
- -

CharsetDefault

- -

Syntax: CharsetDefault - charset
- Default: None
- Context: directory, virtual - host
- Override: - FileInfo
- Status: Experimental
- Module: mod_charset_lite
-

- -

The CharsetDefault directive specifies the +

CharsetDefault Directive

Description: Charset to translate into
Syntax:CharsetDefault charset
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Experimental
Module:mod_charset_lite
+

The CharsetDefault directive specifies the charset that content in the associated container should be translated to.

@@ -164,47 +67,25 @@ APR. Generally, this means that it must be supported by iconv.

Example: -
-    <Directory "/export/home/trawick/apacheinst/htdocs/convert">
-    CharsetSourceEnc  UTF-16BE
-    CharsetDefault    ISO8859-1
+

+    <Directory "/export/home/trawick/apacheinst/htdocs/convert">

+    CharsetSourceEnc  UTF-16BE

+    CharsetDefault    ISO8859-1

     </Directory>
- 
-
-    

-
-    
CharsetOptions

-
-    
Syntax: CharsetOptions
-    option [option] ...

-     Default: DebugLevel=0
-    NoImplicitAdd

-     Context: directory, virtual
-    host

-     Override:
-    FileInfo

-     Status: Experimental

-     Module: mod_charset_lite

-    

-
-    
The CharsetOptions directive configures certain
-    behaviors of mod_charset_lite. Option can
+

+
CharsetOptions Directive
Description: Configures charset tranlation behavior
Syntax:CharsetOptions option [option] ...
Default:CharsetOptions DebugLevel=0 
+NoImplicitAdd
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Experimental
Module:mod_charset_lite

+    
The CharsetOptions directive configures certain
+    behaviors of mod_charset_lite. Option can
     be one of

 
     

       
DebugLevel=n

 
-      
The DebugLevel keyword allows you to specify
+      
The DebugLevel keyword allows you to specify
       the level of debug messages generated by
-      mod_charset_lite. By default, no messages are
-      generated. This is equivalent to DebugLevel=0.
+      mod_charset_lite. By default, no messages are
+      generated. This is equivalent to DebugLevel=0.
       With higher numbers, more debug messages are generated, and
       server performance will be degraded. The actual meanings of
       the numeric values are described with the definitions of the
@@ -213,17 +94,29 @@
 
       
ImplicitAdd | NoImplicitAdd

 
-      
The ImplicitAdd keyword specifies that
-      mod_charset_lite should implicitly insert its
+      
The ImplicitAdd keyword specifies that
+      mod_charset_lite should implicitly insert its
       filter when the configuration specifies that the character
       set of content should be translated. If the filter chain is
       explicitly configured using the AddOutputFilter directive,
-      NoImplicitAdd should be specified so that
-      mod_charset_lite doesn't add its filter.

+      NoImplicitAdd should be specified so that
+      mod_charset_lite doesn't add its filter.
     

-    

-     

-     
-  
-
+
CharsetSourceEnc Directive
Description: Source charset of files
Syntax:CharsetSourceEnc charset
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Experimental
Module:mod_charset_lite

+    
The CharsetSourceEnc directive specifies the
+    source charset of files in the associated container.

 
+    
The value of the charset argument must be accepted
+    as a valid character set name by the character set support in
+    APR. Generally, this means that it must be supported by
+    iconv.

+    Example: 
+

+    <Directory "/export/home/trawick/apacheinst/htdocs/convert">

+    CharsetSourceEnc  UTF-16BE

+    CharsetDefault    ISO8859-1

+    </Directory>
+

+    
The character set names in this example work with the iconv
+    translation support in Solaris 8.

+
Apache HTTP Server Version 2.0
IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_dav.html b/docs/manual/mod/mod_dav.html index fa0bd97ef7..3a7aa9a63a 100644 --- a/docs/manual/mod/mod_dav.html +++ b/docs/manual/mod/mod_dav.html @@ -1,34 +1,10 @@ - - - - - - - Apache module mod_dav - - - - - - -

Module mod_dav

- -

This module provides Distributed Authoring and Versioning - (WebDAV) - functionality.

- Status: Extension
- Source File: mod_dav.c
- Module Identifier: dav_module - -

Summary

- -

This module provides class 1 and class 2 WebDAV ('Web-based Distributed +mod_dav - Apache HTTP Server

[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_dav

Description:Distributed Authoring and Versioning +(WebDAV) functionality
Status:Extension
Module Identifier:dav_module

Summary

+

This module provides class 1 and class 2 WebDAV ('Web-based Distributed Authoring and Versioning') functionality for Apache. This extension to the HTTP protocol allows creating, moving, copying, and deleting resources and collections on a remote web @@ -37,178 +13,71 @@

To enable mod_dav, add the following to a container in your httpd.conf file:

-
- Dav On -
+
Dav On

Also, specify a valid filename for the DAV lock database by adding the following to the global section in your httpd.conf file:

-
- DavLockDB /tmp/DavLock     +
DavLockDB /tmp/DavLock     (Any web-server writable filename, without an extension) - - -

Directives

- - -
- -

Dav

- Syntax: Dav on|off
- Default: Dav - off
- Context: directory
- Status: extension
- Module: mod_dav
- Compatibility: Apache 1.3.4 and - above - -

Use the Dav directive to enable the WebDAV HTTP - methods for the given container. You may wish to add a <Limit> clause inside the location directive to limit - access to DAV-enabled locations.

- - - - - -
Example:
-
- DavLockDB /tmp/DavLock
-
- <Location /foo>
- Dav On
-
- AuthType Basic
- AuthName DAV
- AuthUserFile user.passwd
-
-   <LimitExcept GET HEAD OPTIONS>
-   require user admin
-   </LimitExcept>
- </Location>
-
-
- -
- -

DavLockDB

- Syntax: DavLockDB - filename
- Default: None
- Context: server config, virtual - host
- Status: extension
- Module: mod_dav - -

Use the DavLockDB directive to specify the full - path to the lock database, excluding an extension. The default - (file system) implementation of mod_dav uses a SDBM database to - track user locks. The utility - modules/dav/util/lockview can be used from the - server to display all locks in a lock database.

- - - - - -
Example:
-
- DavLockDB /tmp/DavLock
-
-
-
- -
- -

DavMinTimeout

- Syntax: DavMinTimeout - seconds
- Default: DavMinTimeout - 0
- Context: directory
- Status: extension
- Module: mod_dav - +
+

Directives

Dav Directive

Description: Enable WebDAV HTTP methods
Syntax:Dav on|off
Default:Dav off
Context:directory
Status:Extension
Module:mod_dav
+

Use the Dav directive to enable the + WebDAV HTTP methods for the given container. You may wish to add a + <Limit> clause + inside the <location> directive to limit access to + DAV-enabled locations.

+ +

Example

+ DavLockDB /tmp/DavLock
+
+ <Location /foo>
+ Dav On
+
+ AuthType Basic
+ AuthName DAV
+ AuthUserFile user.passwd
+
+   <LimitExcept GET HEAD OPTIONS>
+   require user admin
+   </LimitExcept>
+ </Location>
+
+

DavDepthInfinity Directive

Description: Allow PROPFIND, Depth: Infinity requests
Syntax:DavDepthInfinity on|off
Default:DavDepthInfinity off
Context:directory
Status:Extension
Module:mod_dav
+

Use the DavDepthInfinity directive to + allow the processing of PROPFIND requests containing the header + 'Depth: Infinity'. Because this type of request could constitute a + denial-of-service attack, by default it is not allowed.

+

DavLockDB Directive

Description: Location of the DAV lock database
Syntax:DavLockDB file-path
Context:server config, virtual host
Status:Extension
Module:mod_dav
+

Use the DavLockDB directive to specify + the full path to the lock database, excluding an extension. The + default (file system) implementation of mod_dav uses a SDBM + database to track user locks. The utility + modules/dav/util/lockview can be used from the server + to display all locks in a lock database.

+ +

Example

+DavLockDB /tmp/DavLock +
+

DavMinTimeout Directive

Description: Minimum amount of time the server holds a lock on +a DAV resource
Syntax:DavMinTimeout seconds
Default:DavMinTimeout 0
Context:directory
Status:Extension
Module:mod_dav

When a client requests a DAV resource lock, it can also specify a time when the lock will be automatically removed by the server. This value is only a request, and the server can ignore it or inform the client of an arbitrary value.

-

Use the DavMinTimeout directive to specify, in +

Use the DavMinTimeout directive to specify, in seconds, the minimum lock timeout to return to a client. Microsoft Web Folders defaults to a timeout of 120 seconds; the - DavMinTimeout can override this to a higher value + DavMinTimeout can override this to a higher value (like 600 seconds) to reduce the chance of the client losing the lock due to network latency.

- - - - -
Example:
-
- <Location /MSWord>
- DavMinTimeout 600
- </Location>
-
-
-
- -
- -

DavDepthInfinity

- Syntax: DavDepthInfinity - on|off
- Default: DavDepthInfinity - off
- Context: directory
- Status: extension
- Module: mod_dav - -

Use the DavDepthInfinity directive to allow the - processing of PROPFIND requests containing the header 'Depth: - Infinity'. Because this type of request could constitute a - denial-of-service attack, by default it is not allowed.

- - - - +

Example

+ <Location /MSWord>
+ DavMinTimeout 600
+ </Location>
+
+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_deflate.html b/docs/manual/mod/mod_deflate.html index 29eba6761a..3c91c1ffdd 100755 --- a/docs/manual/mod/mod_deflate.html +++ b/docs/manual/mod/mod_deflate.html @@ -1,56 +1,14 @@ - - - - - - - Apache module mod_deflate - - - - - - -

Module mod_deflate

- -

This module provides the ability to compress content before - it is delivered to the client.

- -

Status: Experimental
- Source File: - mod_deflate.c
- Module Identifier: - deflate_module
- Compatibility: Available in - Apache 2.0 and later.

- -

Summary

- -

The experimental mod_deflate module allows - output from your server to be compressed before being sent - to the client over the network.

- -

Directives

- - - -

See also: - AddOutputFilter and - SetOutputFilter - -

Enabling Compression

+mod_deflate - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_deflate

Description:Compress content before + it is delivered to the client
Status:experimental
Module Identifier:deflate_module

Summary

+

The experimental mod_deflate module provides + the DEFLATE output filter that allows output from + your server to be compressed before being sent to the client over + the network.

+

See also

Directives

Enabling Compression

Compression is implemented by the DEFLATE filter. The following directive @@ -60,101 +18,30 @@ so you may want to enable the 'gzip-only-text/html' note (see below)

-
- SetEnv gzip-only-text/html 1
- SetOutputFilter DEFLATE -
+
SetEnv gzip-only-text/html 1
+SetOutputFilter DEFLATE +

Here is an example of enabling compression for the Apache documentation:

-
- <Directory "/your-server-root/manual">
- SetEnv gzip-only-text/html 1
- SetOutputFilter DEFLATE
- leave the existing directives as-is
- </Directory> -
- -
- - -

DeflateFilterNote - directive

- -

Syntax: DeflateFilterNote notename -
- Default: none
- Context: server config
- Override: none
- Status: Experimental
- Module: mod_deflate
- Compatibility: Apache 2.0 and - above

- -

The DeflateFilterNote directive specifies that a note about - compression ratios should be attached to the request. The name - of the note is the value specified for the directive.

- -
- - -

DeflateWindowSize directive

- -

Syntax: DeflateWindowSize - value
- Default: none
- Context: server config
- Override: none
- Status: Experimental
- Module: mod_deflate
- Compatibility: Apache 2.0 and - above

- -

The DeflateWindowSize directive specifies the +

+<Directory "/your-server-root/manual">
+ SetEnv gzip-only-text/html 1
+ SetOutputFilter DEFLATE
+</Directory> +
+

DeflateFilterNote Directive

Description: Places the compression ratio in a note for logging
Syntax:DeflateFilterNote notename
Context:server config
Status:experimental
Module:mod_deflate
+

The DeflateFilterNote directive + specifies that a note about compression ratios should be attached + to the request. The name of the note is the value specified for + the directive.

+

DeflateMemLevel Directive

Description: Amount of memory available to zlib for compression
Syntax:DeflateMemLevel value
Context:server config
Status:experimental
Module:mod_deflate
+ +

The DeflateMemLevel directive specifies + the amount of memory available to zlib for compression.

+

DeflateWindowSize Directive

Description: Zlib compression window size
Syntax:DeflateWindowSize value
Context:server config
Status:experimental
Module:mod_deflate
+ +

The DeflateWindowSize directive specifies the zlib compression window size.

- -
- - -

DeflateMemLevel - directive

- -

Syntax: DeflateMemLevel - value
- Default: none
- Context: server config
- Override: none
- Status: Experimental
- Module: mod_deflate
- Compatibility: Apache 2.0 and - above

- -

The DeflateMemLevel directive specifies the amount of - memory available to zlib for compression.

- - - - +

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_dir.html b/docs/manual/mod/mod_dir.html index d1573a6674..67220cd180 100644 --- a/docs/manual/mod/mod_dir.html +++ b/docs/manual/mod/mod_dir.html @@ -1,115 +1,57 @@ - - - - - - - Apache module mod_dir - - - - - - -

Module mod_dir

- -

This module provides for "trailing slash" redirects and - serving directory index files.

- -

Status: Base
- Source File: mod_dir.c
- Module Identifier: - dir_module

- -

Summary

- The index of a directory can come from one of two sources: +mod_dir - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_dir

Description:Provides for "trailing slash" redirects and + serving directory index files
Status:Base
Module Identifier:dir_module

Summary

+

The index of a directory can come from one of two sources:

  • A file written by the user, typically called - index.html. The DirectoryIndex directive sets the + index.html. The DirectoryIndex directive sets the name of this file. This is controlled by - mod_dir.
    • + mod_dir.
  • Otherwise, a listing generated by the server. This is - provided by mod_autoindex.
    • + provided by mod_autoindex.
- The two functions are separated so that you can completely +

The two functions are separated so that you can completely remove (or replace) automatic index generation should you want - to. + to.

A "trailing slash" redirect is issued when the server receives a request for a URL - http://servername/foo/dirname where - dirname is a directory. Directories require a - trailing slash, so mod_dir issues a redirect to - http://servername/foo/dirname/.

- -

Directives

- - -
- -

DirectoryIndex directive

- - Syntax: DirectoryIndex - local-url [local-url] ...
- Default: DirectoryIndex - index.html
- Context: server config, virtual - host, directory, .htaccess
- Override: Indexes
- Status: Base
- Module: mod_dir - -

The DirectoryIndex directive sets the list of resources to - look for, when the client requests an index of the directory by - specifying a / at the end of the a directory name. - Local-url is the (%-encoded) URL of a document on the - server relative to the requested directory; it is usually the + http://servername/foo/dirname where + dirname is a directory. Directories require a + trailing slash, so mod_dir issues a redirect to + http://servername/foo/dirname/.

+

Directives

DirectoryIndex Directive

Description: List of resources to look for when the client requests +a directory
Syntax:DirectoryIndex + local-url [local-url] ...
Default:DirectoryIndex index.html
Context:server config, virtual host, directory, .htaccess
Override:Indexes
Status:Base
Module:mod_dir
+

The DirectoryIndex directive sets the + list of resources to look for, when the client requests an index + of the directory by specifying a / at the end of the a directory + name. Local-url is the (%-encoded) URL of a document on + the server relative to the requested directory; it is usually the name of a file in the directory. Several URLs may be given, in - which case the server will return the first one that it finds. - If none of the resources exist and the Indexes - option is set, the server will generate its own listing of the + which case the server will return the first one that it finds. If + none of the resources exist and the Indexes option is + set, the server will generate its own listing of the directory.

-

Example:

+

Example

+DirectoryIndex index.html +
-
- DirectoryIndex index.html -
- then a request for http://myserver/docs/ would +

then a request for http://myserver/docs/ would return http://myserver/docs/index.html if it - exists, or would list the directory if it did not. + exists, or would list the directory if it did not.

Note that the documents do not need to be relative to the directory;

-
- DirectoryIndex index.html index.txt - /cgi-bin/index.pl -
- would cause the CGI script /cgi-bin/index.pl to be +
DirectoryIndex index.html index.txt /cgi-bin/index.pl
+

would cause the CGI script /cgi-bin/index.pl to be executed if neither index.html or - index.txt existed in a directory. - -

-

- - - + index.txt existed in a directory.

+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_env.html b/docs/manual/mod/mod_env.html index fdd813b434..5bcecace29 100644 --- a/docs/manual/mod/mod_env.html +++ b/docs/manual/mod/mod_env.html @@ -1,132 +1,32 @@ - - - - - - - Apache module mod_env - - - - - - -

Apache module mod_env

- -

This module provides for modifying the environment which is - passed to CGI scripts and SSI pages.

- -

Status: Base
- Source File: mod_env.c
- Module Identifier: - env_module
- Compatibility: Available in - Apache 1.1 and later.

- -

Summary

- +mod_env - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_env

Description:Modifies the environment which is + passed to CGI scripts and SSI pages
Status:Base
Module Identifier:env_module

Summary

This module allows for control of the environment that will be provided to CGI scripts and SSI pages. Environment variables may be passed from the shell which invoked the httpd process. Alternatively, environment variables may be set or unset within the configuration process.

- -

For additional information, we provide a document on Environment Variables in Apache.

- -

Directives

- - -
- -

PassEnv directive

- Syntax: PassEnv - env-variable [env-variable] ...
- Context: server config, virtual - host, directory, .htaccess
- Override: FileInfo
- Status: Base
- Module: mod_env
- Compatibility: PassEnv is only - available in Apache 1.1 and later. Directory and .htaccess context - is availble in Apache 1.3.7 and later. - +

See also

Directives

PassEnv Directive

Description: Passes environment variables from the shell
Syntax:PassEnv + env-variable [env-variable] ...
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_env

Specifies one or more environment variables to pass to CGI scripts and SSI pages from the environment of the shell which invoked the httpd process. Example:

-
+

     PassEnv LD_LIBRARY_PATH
-
-    

-
-    
SetEnv directive

-    Syntax: SetEnv env-variable
-    value

-     Context: server config, virtual
-    host, directory, .htaccess

-     Override: FileInfo

-     Status: Base

-     Module: mod_env

-     Compatibility: SetEnv is only
-    available in Apache 1.1 and later.  Directory and .htaccess context
-    is availble in Apache 1.3.7 and later.
-
+

+
SetEnv Directive
Description: Sets environment variables
Syntax:SetEnv env-variable value
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_env

     
Sets an environment variable, which is then passed on to CGI
     scripts and SSI pages. Example:

-
+

     SetEnv SPECIAL_PATH /foo/bin
-
-    

-
-    
UnsetEnv
-    directive

-    Syntax: UnsetEnv
-    env-variable [env-variable] ...

-     Context: server config, virtual
-    host, directory, .htaccess

-     Override: FileInfo

-     Status: Base

-     Module: mod_env

-     Compatibility: UnsetEnv is only
-    available in Apache 1.1 and later.  Directory and .htaccess context
-    is availble in Apache 1.3.7 and later.
-
+

+
UnsetEnv Directive
Description: Removes variables from the environment
Syntax:UnsetEnv env-variable [env-variable] ...
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Base
Module:mod_env

     
Removes one or more environment variables from those passed
     on to CGI scripts and SSI pages. Example:

-
+

     UnsetEnv LD_LIBRARY_PATH
-
-    
-  
-
-
+

+
Apache HTTP Server Version 2.0
IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html index 6059477811..8ada13b557 100644 --- a/docs/manual/mod/mod_include.html +++ b/docs/manual/mod/mod_include.html @@ -1,32 +1,9 @@ - - - - - - - Apache module mod_include - - - - - - -

Module mod_include

- -

This module provides for server-parsed html documents.

- -

Status: Base
- Source File: - mod_include.c
- Module Identifier: - include_module

- -

Summary

+mod_include - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_include

Description:This module provides for server-parsed html +documents.
Status:Base
Module Identifier:include_module
Compatibility:

Summary

This module provides a filter which will process files before they are sent to the client. The processing is @@ -35,21 +12,13 @@ inclusion other files or programs, as well as the setting and printing of environment variables.

-

Directives

+ See also: + Options, + SetOutputFilter + and AcceptPathInfo. - - -

See also: Options, SetOutputFilter, - and AcceptPathInfo.

- -

Enabling Server-Side Includes

+

Directives

Enabling Server-Side Includes

+

Server Side Includes are implemented by the INCLUDES filter. If @@ -58,10 +27,10 @@ parse them and assign the resulting document the mime type of text/html:

-
- AddType text/html .shtml
- AddOutputFilter INCLUDES .shtml -
+
+ AddType text/html .shtml
+ AddOutputFilter INCLUDES .shtml +

The following directive must be given for the directories containing the shtml files (typically in a @@ -69,9 +38,9 @@ also valid .htaccess files if AllowOverride Options is set):

-
- Options +Includes -
+
+ Options +Includes +

For backwards compatibility, the server-parsed handler also activates the @@ -81,23 +50,23 @@ text/x-server-parsed-html3 (and the resulting output will have the mime type text/html).

-

For more information, see our Tutorial on Server Side - Includes.

+ For more information, see our Tutorial on Server Side + Includes. +

Basic Elements

+ +

The document is parsed as an HTML document, with special + commands embedded as SGML comments. A command has the syntax:

-

Basic Elements

- The document is parsed as an HTML document, with special - commands embedded as SGML comments. A command has the syntax: - -
+
<!--#element attribute=value attribute=value ... --> - - The value will often be enclosed in double quotes; many +
+ +

The value will often be enclosed in double quotes; many commands only allow a single attribute-value pair. Note that the comment terminator (-->) should be preceded by whitespace to ensure that it isn't considered part of an SSI - token. + token.

The allowed elements are:

@@ -133,11 +102,12 @@
echo
- This command prints one of the include - variables, defined - below. If the variable is unset, it is printed as - (none). Any dates printed are subject to the - currently configured timefmt. Attributes: +

This command prints one of the include + variables, defined below. If the variable is unset, it + is printed as (none). Any dates printed are + subject to the currently configured timefmt.

+ +

Attributes:

var
@@ -173,8 +143,7 @@
The exec command executes a given shell command or CGI - script. The IncludesNOEXEC Option disables this command + script. The IncludesNOEXEC Option disables this command completely. The valid attributes are:
@@ -188,9 +157,8 @@ invoked as a CGI script, even if the server would not normally recognize it as such. However, the directory containing the script must be enabled for CGI scripts - (with ScriptAlias or - the ExecCGI Option). + (with ScriptAlias + or the ExecCGI Option).

The CGI script is given the PATH_INFO and query string (QUERY_STRING) of the original request from the @@ -201,7 +169,7 @@

For example:

- <!--#exec cgi="/cgi-bin/example.cgi" --> +
<!--#exec cgi="/cgi-bin/example.cgi" -->

If the script returns a Location: header instead of output, then this will be translated into an HTML @@ -215,15 +183,17 @@ cgi, but can be done with include virtual, as shown here:

- <!--#include virtual="/cgi-bin/example.cgi?argument=value" --> +
+ <!--#include virtual="/cgi-bin/example.cgi?argument=value" --> +
+
cmd

The server will execute the given string using - /bin/sh. The include variables are available + /bin/sh. The include variables are available to the command, in addition to the usual set of CGI variables.

@@ -241,7 +211,9 @@ non-suexec configuration on unix, it will not produce the desired result under Win32, or when running suexec:

- <!--#exec cmd="perl /path/to/perlscript arg1 arg2" --> +
+ <!--#exec cmd="perl /path/to/perlscript arg1 arg2" --> +
@@ -289,8 +261,6 @@ Otherwise CGI scripts are invoked as normal using the complete URL given in the command, including any query string. - -

An attribute defines the location of the document; the inclusion is done for each attribute given to the include @@ -327,11 +297,13 @@ in the parsed file. You may include a query string in a CGI url:

- <!--#include virtual="/cgi-bin/example.cgi?argument=value" --> +
+ <!--#include virtual="/cgi-bin/example.cgi?argument=value" --> +

include virtual should be used in preference to exec cgi to include the output of CGI - programs into an HTML document. + programs into an HTML document.

@@ -341,13 +313,14 @@

This prints out a listing of all existing variables and their values. Starting with Apache 1.3.12, special characters - are entity encoded (see the echo element for details) + are entity encoded (see the echo element for details) before being output. There are no attributes.

For example:

-

<!--#printenv -->

+
+ <!--#printenv --> +

The printenv element is available only in Apache 1.2 and above.

@@ -366,16 +339,19 @@
The value to give a variable.
-

- For example: <!--#set var="category" value="help" - -->

+

For example:

+ +
+ <!--#set var="category" value="help" --> +

The set element is available only in Apache 1.2 and above.

+

Include Variables

+ -

Include Variables

In addition to the variables in the standard CGI environment, these are available for the echo command, for if and elif, and to any program @@ -406,8 +382,8 @@
The last modification date of the document requested by the user.
- -

Variable Substitution

+

Variable Substitution

+

Variable substitution is done within quoted strings in most cases where they may reasonably occur as an argument to an SSI @@ -417,18 +393,19 @@ as the arguments to conditional operators. You can insert a literal dollar sign into the string using backslash quoting:

-
+

     <!--#if expr="$a = \$test" -->
-
+

 
     
If a variable reference needs to be substituted in the
     middle of a character sequence that might otherwise be
     considered a valid identifier in its own right, it can be
     disambiguated by enclosing the reference in braces,
-    à la shell substitution:

-
+    a la shell substitution:

+
+

     <!--#set var="Zed" value="${REMOTE_HOST}_${REQUEST_METHOD}" -->
-
+

 
     
This will result in the Zed variable being set
     to "X_Y" if REMOTE_HOST is
@@ -438,26 +415,28 @@
     
EXAMPLE: the below example will print "in foo" if the
     DOCUMENT_URI is /foo/file.html, "in bar" if it is
     /bar/file.html and "in neither" otherwise:

-
-    <!--#if expr="\"$DOCUMENT_URI\" = \"/foo/file.html\"" -->
-    in foo
-    <!--#elif expr="\"$DOCUMENT_URI\" = \"/bar/file.html\"" -->
-    in bar
-    <!--#else -->
-    in neither
+
+

+    <!--#if expr="\"$DOCUMENT_URI\" = \"/foo/file.html\"" -->

+    in foo

+    <!--#elif expr="\"$DOCUMENT_URI\" = \"/bar/file.html\"" -->

+    in bar

+    <!--#else -->

+    in neither

     <!--#endif -->
-
+

+
Flow Control Elements

+    
 
-    
Flow Control
-    Elements

     These are available in Apache 1.2 and above. The basic flow
     control elements are: 
-
-    <!--#if expr="test_condition" -->
-    <!--#elif expr="test_condition" -->
-    <!--#else -->
+
+

+    <!--#if expr="test_condition" -->

+    <!--#elif expr="test_condition" -->

+    <!--#else -->

     <!--#endif -->
-
+

 
     
The if element works like an
     if statement in a programming language. The test condition is
@@ -482,11 +461,11 @@
 
       
true if string is not empty

 
-      
string1 = string2

-       string1 != string2

-       string1 < string2

-       string1 <= string2

-       string1 > string2

+      
string1 = string2

+       string1 != string2

+       string1 < string2

+       string1 <= string2

+       string1 > string2

        string1 >= string2

 
       
Compare string1 with string 2. If string2 has the form
@@ -517,10 +496,11 @@
     
"=" and "!=" bind more tightly than
     "&&" and "||". "!" binds
     most tightly. Thus, the following are equivalent:

-
-    <!--#if expr="$a = test1 && $b = test2" -->
+
+

+    <!--#if expr="$a = test1 && $b = test2" -->

     <!--#if expr="($a = test1) && ($b = test2)" -->
-
+

 
     
Anything that's not recognized as a variable or an operator
     is treated as a string. Strings can also be quoted:
@@ -528,12 +508,15 @@
     (blanks and tabs) because it is used to separate tokens such as
     variables. If multiple strings are found in a row, they are
     concatenated using blanks. So,

-
-     string1    string2  results in string1 string2
-    'string1    string2' results in string1    string2
-

 
-    
Using Server Side Includes for ErrorDocuments

+

+    
string1    string2  results in string1 string2

+    
'string1    string2' results in string1    string2

+

+
+
Using Server Side Includes for ErrorDocuments

+    
+
     There is a document
     which describes how to use the features of mod_include to offer
     internationalized customized server error documents. 
@@ -542,85 +525,29 @@
 
     
Files processed for server-side includes no longer accept
     requests with PATH_INFO (trailing pathname information) by
-    default.  You can use the AcceptPathInfo directive to
+    default.  You can use the AcceptPathInfo directive to
     configure the server to accept requests with PATH_INFO.

 
-    

-
-    
SSIEndTag directive
 
-    
Syntax: SSIEndTag tag
 Default: SSIEndTag
-    "-->"
 Context: server config, virtual
-    host
 Status: Base
 Module: mod_include

-    Compatibility:
-      Available in version 2.0.30 and later.

-
-
+
SSIEndTag Directive
Description: Changes the string that mod_include looks for to end an
+include command.
Syntax:SSIEndTag tag
Default:SSIEndTag "-->"
Context:server config, virtual host
Override:FileInfo
Status:Base
Module:mod_include
Compatibility:Apache 1.2 and Available in version 2.0.30 and later.
+

     
This directive changes the string that mod_include looks for 
     to mark the end of a include command.

 
-    
See also: SSIStartTag.

-
-    

-    
SSIErrorMsg
-    directive

-    
Syntax: SSIErrorMsg
-    message

-     Default: SSIErrorMsg
-    "[an error occurred while processing this directive]"

-     Context: server config, virtual
-    host, directory, .htaccess

-     Status: Base

-     Module: mod_include

-     Compatibility:
-      Available in version 2.0.30 and later.

-
-
+    See also: SSIStartTag.
+
SSIErrorMsg Directive
Description: Changes the error message displayed when there is an error
Syntax:SSIErrorMsg message
Default:SSIErrorMsg 
+"[an error occurred while processing this directive]"
Context:server config, virtual host, directory, .htaccess
Override:
Status:Base
Module:mod_include
Compatibility:Available in version 2.0.30 and later.

     
The SSIErrorMsg directive changes the error message displayed
     when mod_include encounters an error. For production servers you
     may consider changing the default error message to
-    "<-- Error -->" so that the message
+    "<-- Error -->" so that the message
     is not presented to the user.
     

     
This directive has the same effect as the <--#config
     errmsg=message --> element.

-    

-    
SSIStartTag
-    directive

-    
Syntax: SSIStartTag
-    tag

-     Default: SSIStartTag
-    "<--!"

-     Context: server config, virtual
-    host

-     Status: Base

-     Module: mod_include

-     Compatibility:
-      Available in version 2.0.30 and later.

 
+
SSIStartTag Directive
Description: 
Syntax:Changes the string that mod_include looks for to start an
+include element
Default:SSIStartTag "<--!"
Context:server config, virtual host
Override:
Status:Base
Module:mod_include
Compatibility:Available in version 2.0.30 and later.

 
     
This directive changes the string that mod_include looks for 
     to mark an include element to process.

@@ -629,54 +556,18 @@
     output of a file each processing different commands (possibly at
     different times).
 
 
-    
See also: SSIEndTag.

-
-    

-    
SSITimeFormat
-    directive

-    
Syntax: SSITimeFormat 
-    formatstring

-     Default: SSITimeFormat
-    "%A, %d-%b-%Y %H:%M:%S %Z"

-     Context: server config, virtual
-    host, directory, .htaccess

-     Status: Base

-     Module: mod_include

-     Compatibility:
-      Available in version 2.0.30 and later.

-
-    
This directive changes the format in which date strings are displayed 
+    See also: SSIEndTag
+
+
SSITimeFormat Directive
Description: Configures the format in which date strings are 
+displayed
Syntax:SSITimeFormat formatstring
Default:SSITimeFormat "%A, %d-%b-%Y %H:%M:%S %Z"
Context:server config, virtual host, directory, .htaccess
Override:
Status:Base
Module:mod_include
Compatibility:Available in version 2.0.30 and later.

+
This directive changes the format in which date strings are displayed 
     when echoing DATE environment variables.  The formatstring
     is as in strftime(3) from the C standard library.

 
     
This directive has the same effect as the <--#config
     timefmt=formatstring --> element.

-
-    

-    
XBitHack
-    directive

-      Syntax: XBitHack
-    on|off|full

-     Default: XBitHack
-    off

-     Context: server config, virtual
-    host, directory, .htaccess

-     Override: Options

-     Status: Base

-     Module: mod_include 
-
+
XBitHack Directive
Description: Parse SSI directives in files with the execute 
+bit set
Syntax:XBitHack on|off|full
Default:XBitHack off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Base
Module:mod_include
Compatibility:

     
The XBitHack directives controls the parsing of ordinary
     html documents. This directive only affects files associated
     with the MIME type text/html. XBitHack can take on
@@ -702,15 +593,12 @@
         this bit allows clients and proxies to cache the result of
         the request. 
 
-        
Note: you would not want to use the full
+        
Note: you would not want to use the full
         option, unless you assure the group-execute bit is unset for
         every SSI script which might #include a CGI 
         or otherwise produces different output on each hit (or could 
-        potentially change on subsequent requests).

+        potentially change on subsequent requests).

       

     
 
-    
-  
-
-
+    
Apache HTTP Server Version 2.0
IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_info.html b/docs/manual/mod/mod_info.html index 6942076ab1..ebf870ea19 100644 --- a/docs/manual/mod/mod_info.html +++ b/docs/manual/mod/mod_info.html @@ -1,93 +1,40 @@ - - - - -mod_info - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_info

- - -
- - -
Description: -This module provides a comprehensive overview of the server +-->mod_info - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_info

- -
- - - - - - - - - - -
Description:This module provides a comprehensive overview of the server configuration including all installed modules and directives in the -configuration files. -
Status:Extension
Module Identifier:info_module
Compatibility: -Available in Apache 1.1 and later -
-
-

Summary

- +configuration files.
Status:Extension
Module Identifier:info_module
Compatibility:Available in Apache 1.1 and later

Summary

- -

Using mod_info

+

Using mod_info

- -

To configure it, add the following to your +

To configure it, add the following to your httpd.conf file.

- -
- - -
+
- -
<Location /server-info>
SetHandler server-info
</Location>
- -
-
+
You may wish to add a - <Limit> + <Limit> clause inside the - <location> + <location> directive to limit access to your server configuration information.

Once configured, the server information is obtained by - accessing http://your.host.dom/server-info -

+ accessing http://your.host.dom/server-info

- -
- - -
+
- -
Note that the configuration files are read by the module at run-time, and therefore the display may not reflect the running server's active configuration if the files have been changed since the server was last reloaded. Also, the configuration files must be readable by the user as which the server is running (see the - User directive), or + User directive), or else the directive settings will not be listed.

It should also be noted that if @@ -96,78 +43,15 @@ SetHandler server-info
files, including per-directory files (e.g., .htaccess). This may have security-related ramifications for your site.

- -
-
- - -

Directives

- -
-

-AddModuleInfo Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Allows additional information to be added to the module -information displayed by the server-info handler
Syntax: -AddModuleInfo module-name string - -
Default:none
Context:server config, virtual -host
Status:Extension
Module:mod_info
Compatibility:Apache 1.3 and above
-
- - -

This allows the content of string to be shown as +

+

Directives

AddModuleInfo Directive

Description: Allows additional information to be added to the module +information displayed by the server-info handler
Syntax:AddModuleInfo module-name string
Default:none
Context:server config, virtual +host
Status:Extension
Module:mod_info
Compatibility:Apache 1.3 and above
+

This allows the content of string to be shown as HTML interpreted, Additional Information for the module module-name. Example:

- -
- - -
+
- -
AddModuleInfo mod_auth.c 'See <A HREF="http://www.apache.org/docs/mod/mod_auth.html">http://www.apache.org/docs/mod/mod_auth.html</A>' -
-
- - -
-

Apache HTTP Server Version 2.0

-IndexHome - - - +
+

Apache HTTP Server Version 2.0

IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_log_config.html b/docs/manual/mod/mod_log_config.html index 81088ae478..53be79d9f5 100644 --- a/docs/manual/mod/mod_log_config.html +++ b/docs/manual/mod/mod_log_config.html @@ -1,34 +1,10 @@ - - - - - - - Apache module mod_log_config - - - - - - -

Module mod_log_config

- -

This module provides for logging of the requests made to the - server, using the Common Log Format or a user-specified - format.

- -

Status: Base
- Source File: - mod_log_config.c
- Module Identifier: - log_config_module

- -

Summary

+mod_log_config - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_log_config

Description:This module provides for logging of the requests +made to the server, using the Common Log Format or a +user-specified format.
Status:Base
Module Identifier:log_config_module
Compatibility:

Summary

This module provides for flexible logging of client requests. Logs are written in a customizable format, and may be @@ -45,21 +21,11 @@ directives can be used multiple times in each server to cause each request to be logged to multiple files.

-

See also: Apache Log Files.

- -

Directives

- - - -

Custom Log Formats

The format argument to the LogFormat and CustomLog directives is a string. This string is @@ -72,47 +38,107 @@

The characteristics of the request itself are logged by placing "%" directives in the format string, which are replaced in the log file by the values as follows:

-
-%...a:          Remote IP-address
-%...A:          Local IP-address
-%...B:          Bytes sent, excluding HTTP headers.
-%...b:          Bytes sent, excluding HTTP headers. In CLF format
-                i.e. a '-' rather than a 0 when no bytes are sent.
-%...{Foobar}C:  The contents of cookie "Foobar" in the request sent to the
-                server.
-%...D:          The time taken to serve the request, in microseconds.
-%...{FOOBAR}e:  The contents of the environment variable FOOBAR
-%...f:          Filename
-%...h:          Remote host
-%...H           The request protocol
-%...{Foobar}i:  The contents of Foobar: header line(s) in the request
-                sent to the server.
-%...l:          Remote logname (from identd, if supplied)
-%...m           The request method
-%...{Foobar}n:  The contents of note "Foobar" from another module.
-%...{Foobar}o:  The contents of Foobar: header line(s) in the reply.
-%...p:          The canonical Port of the server serving the request
-%...P:          The process ID of the child that serviced the request.
-%...q           The query string (prepended with a ? if a query string exists,
-                otherwise an empty string)
-%...r:          First line of request
-%...s:          Status.  For requests that got internally redirected, this is
-                the status of the *original* request --- %...>s for the last.
-%...t:          Time, in common log format time format (standard english format)
-%...{format}t:  The time, in the form given by format, which should
-                be in strftime(3) format. (potentially localized)
-%...T:          The time taken to serve the request, in seconds.
-%...u:          Remote user (from auth; may be bogus if return status (%s) is 401)
-%...U:          The URL path requested, not including any query string.
-%...v:          The canonical ServerName of the server serving the request.
-%...V:          The server name according to the UseCanonicalName setting.
-%...X:          Connection status when response is completed.
-                'X' = connection aborted before the response completed.
-                '+' = connection may be kept alive after the response is sent.
-                '-' = connection will be closed after the response is sent.
-                (This directive was %...c in late versions of Apache 1.3, but
-                 this conflicted with the historical ssl %...{var}c syntax.)
-
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
%...a:Remote IP-address
%...A:Local IP-address
%...B:Bytes sent, excluding HTTP headers.
%...b:Bytes sent, excluding HTTP headers. In CLF format +i.e. a '-' rather than a 0 when no bytes are sent.
%...{Foobar}C:The contents of cookie "Foobar" in the request sent to the server.
%...D:The time taken to serve the request, in microseconds.
%...{FOOBAR}e:The contents of the environment variable FOOBAR
%...f:Filename
%...h:Remote host
%...HThe request protocol
%...{Foobar}i:The contents of Foobar: header line(s) in the request +sent to the server.
%...l:Remote logname (from identd, if supplied)
%...m:The request method
%...{Foobar}n:The contents of note "Foobar" from another module.
%...{Foobar}o:The contents of Foobar: header line(s) in the reply.
%...p:The canonical Port of the server serving the request
%...P:The process ID of the child that serviced the request.
%...q:The query string (prepended with a ? if a query string exists, +otherwise an empty string)
%...r:First line of request
%...s:Status. For requests that got internally redirected, this is +the status of the *original* request --- %...>s for the last.
%...t:Time, in common log format time format (standard english format)
%...{format}t:The time, in the form given by format, which should +be in strftime(3) format. (potentially localized)
%...T:The time taken to serve the request, in seconds.
%...u:Remote user (from auth; may be bogus if return status (%s) is 401)
%...U:The URL path requested, not including any query string.
%...v:The canonical ServerName of the server serving the request.
%...V:The server name according to the UseCanonicalName setting.
%...X:Connection status when response is completed. +
+'X' = connection aborted before the response completed.
+'+' = connection may be kept alive after the response is sent.
+'-' = connection will be closed after the response is sent. +
+
(This directive was %...c in late versions of Apache 1.3, but +this conflicted with the historical ssl %...{var}c syntax.)
+

The "..." can be nothing at all (e.g., "%h %u %r %s %b"), or it can indicate conditions for inclusion @@ -155,72 +181,42 @@

"%{User-agent}i"
-

Note that the canonical ServerName and Listen of the server serving the +

Note that the canonical ServerName and Listen of the server serving the request are used for %v and %p - respectively. This happens regardless of the UseCanonicalName setting + respectively. This happens regardless of the UseCanonicalName setting because otherwise log analysis programs would have to duplicate the entire vhost matching algorithm in order to decide what host really served the request.

+

Security Considerations

-

See the security tips + + +

See the security tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server.

-
- -

CookieLog - directive

- - -

Syntax: CookieLog - filename
- Context: server config, virtual - host
- Module: mod_cookies
- Compatibility: Only available - in Apache 1.2 and above

- -

The CookieLog directive sets the filename for logging of - cookies. The filename is relative to the ServerRoot. This directive is - included only for compatibility with mod_cookies, and is - deprecated.

-
- -

CustomLog directive

- -

Syntax: CustomLog + + + +

Directives

CookieLog Directive

Description: Sets filename for the logging of cookies
Syntax:CookieLog filename
Default:none
Context:server config, virtual +host
Status:Base
Module:mod_log_config
Compatibility:Only available in Apache 1.2 and above
+ +

The CookieLog directive sets the + filename for logging of cookies. The filename is relative to the + serverroot. This directive is + included only for compatibility with mod_cookies, + and is deprecated.

+

CustomLog Directive

Description: Sets filename and format of log file
Syntax:CustomLog file|pipe format|nickname - [env=[!]environment-variable]
- Context: server config, virtual - host
- Status: Base
- Compatibility: Nickname only - available in Apache 1.3 or later. Conditional logging available - in 1.3.5 or later.
- Module: mod_log_config

- -

The CustomLog directive is used to log requests - to the server. A log format is specified, and the logging can - optionally be made conditional on request characteristics using - environment variables.

+ [env=[!]environment-variable]
Default:none
Context:server config, virtual +host
Status:Base
Module:mod_log_config
Compatibility:Nickname only available in Apache 1.3 or later. +Conditional logging available in 1.3.5 or later.
+

The CustomLog directive is used to + log requests to the server. A log format is specified, and the + logging can optionally be made conditional on request + characteristics using environment variables.

The first argument, which specifies the location to which the logs will be written, can take on one of the following two @@ -229,8 +225,7 @@

file
-
A filename, relative to the ServerRoot.
+
A filename, relative to the ServerRoot.
pipe
@@ -250,14 +245,15 @@

For example, the following two sets of directives have exactly the same effect:

-
-     # CustomLog with format nickname
-     LogFormat "%h %l %u %t \"%r\" %>s %b" common
-     CustomLog logs/access_log common
 
-     # CustomLog with explicit format string
-     CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"
-
+
+ # CustomLog with format nickname
+ LogFormat "%h %l %u %t \"%r\" %>s %b" common
+ CustomLog logs/access_log common
+
+ # CustomLog with explicit format string
+ CustomLog logs/access_log "%h %l %u %t \"%r\" %>s %b"
+

The third argument is optional and allows the decision on whether or not to log a particular request to be based on the @@ -268,98 +264,64 @@ request will be logged.

Environment variables can be set on a per-request - basis using the mod_setenvif - and/or mod_rewrite modules. For + basis using the mod_setenvif + and/or mod_rewrite modules. For example, if you don't want to record requests for all GIF images on your server in a separate logfile but not your main log, you can use:

-
-    SetEnvIf Request_URI \.gif$ gif-image
-    CustomLog gif-requests.log common env=gif-image
+    
+

+    SetEnvIf Request_URI \.gif$ gif-image

+    CustomLog gif-requests.log common env=gif-image

     CustomLog nongif-requests.log common env=!gif-image
-
-    

-
-    
LogFormat
-    directive

-    
-
-    
Syntax: LogFormat
-    format|nickname [nickname]

-     Default: LogFormat "%h %l
-    %u %t \"%r\" %>s %b"

-     Context: server config, virtual
-    host

-     Status: Base

-     Compatibility: Nickname only
-    available in Apache 1.3 or later

-     Module: mod_log_config

-
+

+
LogFormat Directive
Description: Describes a format for use in a log file
Syntax:LogFormat
+    format|nickname [nickname]
Default:none
Context:server config, virtual
+host
Status:Base
Module:mod_log_config
Compatibility:Nickname only available in Apache 1.3 or later.
+

     
This directive specifies the format of the access log
     file.

 
-    
The LogFormat directive can take one of two
+    
The LogFormat directive can take one of two
     forms. In the first form, where only one argument is specified,
     this directive sets the log format which will be used by logs
-    specified in subsequent TransferLog
+    specified in subsequent TransferLog
     directives. The single argument can specify an explicit
     format as discussed in custom log
     formats section above. Alternatively, it can use a
     nickname to refer to a log format defined in a
-    previous LogFormat directive as described
+    previous LogFormat directive as described
     below.

 
-    
The second form of the LogFormat directive
-    associates an explicit format with a
+    
The second form of the LogFormat 
+    directive associates an explicit format with a
     nickname. This nickname can then be used in
-    subsequent LogFormat or CustomLog directives rather than
-    repeating the entire format string. A LogFormat
+    subsequent LogFormat or
+    CustomLog directives rather than
+    repeating the entire format string. A
+    LogFormat
     directive which defines a nickname does nothing
     else -- that is, it only defines the
     nickname, it doesn't actually apply the format and make it the
-    default. Therefore, it will not affect subsequent TransferLog directives.

-    

-
-    
TransferLog
-    directive

-    
-
-    
Syntax: TransferLog
-    file|pipe

-     Default: none

-     Context: server config, virtual
-    host

-     Status: Base

-     Module: mod_log_config

+    default. Therefore, it will not affect subsequent
+    TransferLog directives.

+
+
TransferLog Directive
Description: Specifly location of a log file
Syntax:TransferLog file|pipe
Default:none
Context:server config, virtual
+host
Status:Base
Module:mod_log_config
Compatibility:

 
     
This directive has exactly the same arguments and effect as
-    the CustomLog directive, with the
+    the CustomLog directive, with the
     exception that it does not allow the log format to be specified
     explicitly or for conditional logging of requests. Instead, the
     log format is determined by the most recently specified
-    specified LogFormat directive (which
+    specified LogFormat directive (which
     does not define a nickname). Common Log Format is used if no
     other format has been specified.

 
     
Example:

-
-   LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""
+

+   LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""

    TransferLog logs/access_log
-
-    
-  
-
+

 
+
Apache HTTP Server Version 2.0
IndexHome
\ No newline at end of file diff --git a/docs/manual/mod/mod_rewrite.html b/docs/manual/mod/mod_rewrite.html index e514ecd349..15acb55241 100644 --- a/docs/manual/mod/mod_rewrite.html +++ b/docs/manual/mod/mod_rewrite.html @@ -1,86 +1,38 @@ - - - - -mod_rewrite - Apache HTTP Server - - - -
-
-[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

-
-

Apache Module mod_rewrite

- - - - -
- - - - - - - - - - - - - -
Description: -Provides a rule-based rewriting engine to rewrite requested -URLs on the fly -
Status:Extension
Module Identifier:rewrite_module
Compatibility: -Available in Apache 1.3 and later -
-
-

Summary

- - -
- -``The great thing about mod_rewrite is it gives you +-->mod_rewrite - Apache HTTP Server
[APACHE DOCUMENTATION]

Apache HTTP Server Version 2.0

Apache Module mod_rewrite

Description:Provides a rule-based rewriting engine to rewrite requested +URLs on the fly
Status:Extension
Module Identifier:rewrite_module
Compatibility:Available in Apache 1.3 and later

Summary

+
+ ``The great thing about mod_rewrite is it gives you all the configurability and flexibility of Sendmail. The downside to mod_rewrite is that it gives you all the configurability and flexibility of Sendmail.'' - -
+
-- Brian Behlendorf
Apache Group
- -
+
- -
- -`` Despite the tons of examples and docs, +
+ `` Despite the tons of examples and docs, mod_rewrite is voodoo. Damned cool voodoo, but still voodoo. '' - -
+
-- Brian Moore
bem@news.cmc.net
- -
+
- -

Welcome to mod_rewrite, the Swiss Army Knife of URL +

Welcome to mod_rewrite, the Swiss Army Knife of URL manipulation!

- -

This module uses a rule-based rewriting engine (based on a +

This module uses a rule-based rewriting engine (based on a regular-expression parser) to rewrite requested URLs on the fly. It supports an unlimited number of rules and an unlimited number of attached rule conditions for each rule to @@ -91,8 +43,7 @@ URLs on the fly various formats can be used to achieve a really granular URL matching.

- -

This module operates on the full URLs (including the +

This module operates on the full URLs (including the path-info part) both in per-server context (httpd.conf) and per-directory context (.htaccess) and can even generate query-string @@ -100,78 +51,30 @@ URLs on the fly sub-processing, external request redirection or even to an internal proxy throughput.

- -

But all this functionality and flexibility has its +

But all this functionality and flexibility has its drawback: complexity. So don't expect to understand this entire module in just one day.

- -

This module was invented and originally written in April +

This module was invented and originally written in April 1996 and gifted exclusively to the The Apache Group in July 1997 by

- -
- -Ralf S. - Engelschall -
- -rse@engelschall.com -
- -www.engelschall.com - -
- -
 -

Directives

- -

-Interal Processing -

- - -

The internal processing of this module is very complex but +

+ Ralf S. + Engelschall
+ rse@engelschall.com
+ www.engelschall.com +
+

Directives

Interal Processing

+ +

The internal processing of this module is very complex but needs to be explained once even to the average user to avoid common mistakes and to let you exploit its full functionality.

+

API Phases

-

-API Phases -

- - -

First you have to understand that when Apache processes a +

First you have to understand that when Apache processes a HTTP request it does this in phases. A hook for each of these phases is provided by the Apache API. Mod_rewrite uses two of these hooks: the URL-to-filename translation hook which is @@ -181,8 +84,7 @@ URLs on the fly config files (.htaccess) have been read, but before the content handler is activated.

- -

So, after a request comes in and Apache has determined the +

So, after a request comes in and Apache has determined the corresponding server (or virtual server) the rewriting engine starts processing of all mod_rewrite directives from the per-server configuration in the URL-to-filename phase. A few @@ -196,10 +98,8 @@ URLs on the fly mod_rewrite can operate. To make this point more clear remember the following two points:

- -
    - -
  1. Although mod_rewrite rewrites URLs to URLs, URLs to +
      +
    1. Although mod_rewrite rewrites URLs to URLs, URLs to filenames and even filenames to filenames, the API currently provides only a URL-to-filename hook. In Apache 2.0 the two missing hooks will be added to make the @@ -208,8 +108,7 @@ URLs on the fly Apache does more in the URL-to-filename hook than the API intends for it.
      2. - -
    2. +
    3. Unbelievably mod_rewrite provides URL manipulations in per-directory context, i.e., within .htaccess files, although these are reached @@ -236,22 +135,15 @@ URLs on the fly egg problem. But on the other hand this is the only way mod_rewrite can provide (locally restricted) URL manipulations to the average user.

      - -
      4. - -
    - - -

    Don't forget these two points!

    +
    2. +
+

Don't forget these two points!

-

-Ruleset Processing -

+

Ruleset Processing

- -

Now when mod_rewrite is triggered in these two API phases, it +

Now when mod_rewrite is triggered in these two API phases, it reads the configured rulesets from its configuration structure (which itself was either created on startup for per-server context or during the directory walk of the Apache @@ -262,42 +154,30 @@ URLs on the fly configuration contexts. Only the final result processing is different.

- -

The order of rules in the ruleset is important because the +

The order of rules in the ruleset is important because the rewriting engine processes them in a special (and not very obvious) order. The rule is this: The rewriting engine loops - through the ruleset rule by rule (RewriteRule directives) and + through the ruleset rule by rule (RewriteRule directives) and when a particular rule matches it optionally loops through existing corresponding conditions (RewriteCond directives). For historical reasons the conditions are given first, and so the control flow is a little bit long-winded. See Figure 1 for more details.

- -
- - - - - - - - +
+
[Needs graphics capability to display]
+ + + - - - - + - - - -
[Needs graphics capability to display]
Figure 1: The +
Figure 1: The control flow through the rewriting ruleset
- -
- - -

As you can see, first the URL is matched against the + + + + +

As you can see, first the URL is matched against the Pattern of each rule. When it fails mod_rewrite immediately stops processing this rule and continues with the next rule. If the Pattern matches, mod_rewrite looks @@ -320,13 +200,9 @@ URLs on the fly +

Quoting Special Characters

-

-Quoting Special Characters -

- - -

As of Apache 1.3.20, special characters in +

As of Apache 1.3.20, special characters in TestString and Substitution strings can be escaped (that is, treated as normal characters without their usual special meaning) by prefixing them with a slosh ('\') @@ -336,13 +212,9 @@ URLs on the fly to treat it as a backreference.

+

Regex Back-Reference Availability

-

-Regex Back-Reference Availability -

- - -

One important thing here has to be remembered: Whenever you +

One important thing here has to be remembered: Whenever you use parentheses in Pattern or in one of the CondPattern, back-references are internally created which can be used with the strings $N and @@ -351,43 +223,28 @@ URLs on the fly Figure 2 shows to which locations the back-references are transfered for expansion.

- -
- - - - - - - - +
+
[Needs graphics capability to display]
+ + + - - - - + - - - -
[Needs graphics capability to display]
Figure 2: The +
Figure 2: The back-reference flow through a rule
- -
- - -

We know this was a crash course on mod_rewrite's internal + + + + +

We know this was a crash course on mod_rewrite's internal processing. But you will benefit from this knowledge when reading the following documentation of the available directives.

+

Environment Variables

-

-Environment Variables -

- - -

This module keeps track of two additional (non-standard) +

This module keeps track of two additional (non-standard) CGI/SSI environment variables named SCRIPT_URL and SCRIPT_URI. These contain the logical Web-view to the current resource, while the @@ -395,89 +252,34 @@ URLs on the fly SCRIPT_FILENAME contain the physical System-view.

- -

Notice: These variables hold the URI/URL as they were +

Notice: These variables hold the URI/URL as they were initially requested, i.e., before any rewriting. This is important because the rewriting process is primarily used to rewrite logical URLs to physical pathnames.

- -

-Example: -

- - -
- - - - -
+

Example:

+
 SCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html
 SCRIPT_FILENAME=/u/rse/.www/index.html
 SCRIPT_URL=/u/rse/
 SCRIPT_URI=http://en1.engelschall.com/u/rse/
+
-
-
- - -

-Practical Solutions -

+

Practical Solutions

- -

We also have an URL +

We also have an URL Rewriting Guide available, which provides a collection of practical solutions for URL-based problems. There you can find real-life rulesets and additional information about mod_rewrite.

- -
-

-RewriteBase Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Sets the base URL for per-directory rewrites
Syntax: -RewriteBase URL-path - -
Default:RewriteBase physical-directory-path
Context:directory, .htaccess
Override:FileInfo
Status:Extension
Module:mod_rewrite
-
- - -

The RewriteBase directive explicitly +

RewriteBase Directive

Description: Sets the base URL for per-directory rewrites
Syntax:RewriteBase URL-path
Default:RewriteBase physical-directory-path
Context:directory, .htaccess
Override:FileInfo
Status:Extension
Module:mod_rewrite
+

The RewriteBase directive explicitly sets the base URL for per-directory rewrites. As you will see - below, RewriteRule + below, RewriteRule can be used in per-directory config files (.htaccess). There it will act locally, i.e., the local directory prefix is stripped at this @@ -485,8 +287,7 @@ SCRIPT_URI=http://en1.engelschall.com/u/rse/ remainder. At the end it is automatically added back to the path.

- -

When a substitution occurs for a new URL, this module has +

When a substitution occurs for a new URL, this module has to re-inject the URL into the server processing. To be able to do this it needs to know what the corresponding URL-prefix or URL-base is. By default this prefix is the corresponding @@ -496,28 +297,15 @@ SCRIPT_URI=http://en1.engelschall.com/u/rse/ use the RewriteBase directive to specify the correct URL-prefix.

- -
- - -
If your webserver's URLs are not directly +
- -
If your webserver's URLs are not directly related to physical file paths, you have to use RewriteBase in every .htaccess -files where you want to use RewriteRule directives. -
-
+files where you want to use RewriteRule directives. +
- -

For example, assume the following per-directory config file:

- - -
- - - - -
+

For example, assume the following per-directory config file:

+
 #
 #  /abc/def/.htaccess -- per-dir config file for directory /abc/def
@@ -534,31 +322,16 @@ RewriteBase   /xyz
 #  now the rewriting rules
 RewriteRule   ^oldstuff\.html$  newstuff.html
+
-
-
- - -

In the above example, a request to +

In the above example, a request to /xyz/oldstuff.html gets correctly rewritten to the physical file /abc/def/newstuff.html.

- -
- - -
-

-For Apache Hackers -

- +
- -

For Apache Hackers

The following list gives detailed information about the internal processing steps:

- 
-
 Request:
   /xyz/oldstuff.html
 
@@ -571,11 +344,8 @@ Internal Processing:
 Result:
   /abc/def/newstuff.html
 
-
- -

-This seems very complicated but is +

This seems very complicated but is the correct Apache internal processing, because the per-directory rewriting comes too late in the process. So, when it occurs the (rewritten) request @@ -585,81 +355,30 @@ Result: internally to the Apache server and the same procedure is used by many other operations inside Apache. So, you can be sure the design and - implementation is correct. -

- -
-
- - - -
-

-RewriteCond Directive -

- - - - -
- - - - - - - - - - - - - - - - - - - - - - -
Description: Defines a condition under which rewriting will take place -
Syntax: - RewriteCond - TestString CondPattern - -
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Extension
Module:mod_rewrite
-
- - -

The RewriteCond directive defines a - rule condition. Precede a RewriteRule directive with one + implementation is correct.

+
+ +

RewriteCond Directive

Description: Defines a condition under which rewriting will take place +
Syntax: RewriteCond + TestString CondPattern
Default:None
Context:server config, virtual host, directory, .htaccess
Override:FileInfo
Status:Extension
Module:mod_rewrite
+

The RewriteCond directive defines a + rule condition. Precede a RewriteRule directive with one or more RewriteCond directives. The following rewriting rule is only used if its pattern matches the current state of the URI and if these additional conditions apply too.

- -

-TestString is a string which can contains the +

TestString is a string which can contains the following expanded constructs in addition to plain text:

- -
    - -
  • - -RewriteRule backreferences: These are +
      +
    • + RewriteRule backreferences: These are backreferences of the form
      - -$N - -
      + $N +
(0 <= N <= 9) which provide access to the grouped parts (parenthesis!) of the pattern from the corresponding RewriteRule directive (the one @@ -667,81 +386,60 @@ Result: directives). - -
  • - -RewriteCond backreferences: These are +
  • + RewriteCond backreferences: These are backreferences of the form
    - -%N - -
    + %N +
    • (1 <= N <= 9) which provide access to the grouped parts (parentheses!) of the pattern from the last matched RewriteCond directive in the current bunch of conditions. - -
  • - -RewriteMap expansions: These are +
  • + RewriteMap expansions: These are expansions of the form
    - -${mapname:key|default} - -
    + ${mapname:key|default} + See the documentation for RewriteMap for more details.
    • - -
  • - -Server-Variables: These are variables of +
  • + Server-Variables: These are variables of the form
    - -%{ NAME_OF_VARIABLE + %{ NAME_OF_VARIABLE } - -
    + where NAME_OF_VARIABLE can be a string taken from the following list: - - - - + +

    + - - +

    + + - - - - + +

    + +

    + - - - -
    +
    HTTP headers: - -

    -HTTP_USER_AGENT
    +

    HTTP_USER_AGENT
    HTTP_REFERER
    HTTP_COOKIE
    HTTP_FORWARDED
    HTTP_HOST
    HTTP_PROXY_CONNECTION
    HTTP_ACCEPT
    - -     -

    - -    		 connection & request: - -

    -REMOTE_ADDR
    +

    REMOTE_ADDR
    REMOTE_HOST
    REMOTE_USER
    REMOTE_IDENT
    @@ -750,41 +448,28 @@ Result: PATH_INFO
    QUERY_STRING
    AUTH_TYPE
    - -     -

    - -
    +
    server internals: - -

    -DOCUMENT_ROOT
    +

    DOCUMENT_ROOT
    SERVER_ADMIN
    SERVER_NAME
    SERVER_ADDR
    SERVER_PORT
    SERVER_PROTOCOL
    SERVER_SOFTWARE
    - -     -

    - -    		 system stuff: - -

    -TIME_YEAR
    +

    TIME_YEAR
    TIME_MON
    TIME_DAY
    TIME_HOUR
    @@ -792,39 +477,24 @@ Result: TIME_SEC
    TIME_WDAY
    TIME
    - -     -

    - -    		 specials: - -

    -API_VERSION
    +

    API_VERSION
    THE_REQUEST
    REQUEST_URI
    REQUEST_FILENAME
    IS_SUBREQ
    - -     -

    - -
    - +

    + + + -
    - - -
    - -

    These variables all +

    - -
    +

    These variables all correspond to the similarly named HTTP MIME-headers, C variables of the Apache server or struct tm fields of the Unix system. @@ -832,27 +502,18 @@ Result: the CGI specification. Those that are special to mod_rewrite include:

    - -
    - -
    -IS_SUBREQ -
    +
    +
    IS_SUBREQ
    - -
    Will contain the text "true" if the request +
    Will contain the text "true" if the request currently being processed is a sub-request, "false" otherwise. Sub-requests may be generated by modules that need to resolve additional files or URIs in order to complete their tasks.
    - -
    -API_VERSION -
    +
    API_VERSION
    - -
    This is the version of the Apache module API +
    This is the version of the Apache module API (the internal interface between server and module) in the current httpd build, as defined in include/ap_mmn.h. The module API version @@ -861,55 +522,33 @@ Result: instance, it is 19990320:10), but is mainly of interest to module authors.
    - -
    -THE_REQUEST -
    +
    THE_REQUEST
    - -
    The full HTTP request line sent by the +
    The full HTTP request line sent by the browser to the server (e.g., "GET /index.html HTTP/1.1"). This does not include any additional headers sent by the browser.
    - -
    -REQUEST_URI -
    +
    REQUEST_URI
    - -
    The resource requested in the HTTP request +
    The resource requested in the HTTP request line. (In the example above, this would be "/index.html".)
    - -
    -REQUEST_FILENAME -
    +
    REQUEST_FILENAME
    - -
    The full local filesystem path to the file or +
    The full local filesystem path to the file or script matching the request.
    - -
    - -
    -
    - - - - - - -

    Special Notes:

    - - -
      - -
    1. The variables SCRIPT_FILENAME and REQUEST_FILENAME + +
    +
    • + + +

    Special Notes:

    + +
      +
    1. The variables SCRIPT_FILENAME and REQUEST_FILENAME contain the same value, i.e., the value of the filename field of the internal request_rec structure of the Apache server. @@ -918,23 +557,20 @@ Result: REQUEST_URI (which contains the value of the uri field of request_rec).
      2. - -
    2. There is the special format: +
    3. There is the special format: %{ENV:variable} where variable can be any environment variable. This is looked-up via internal Apache structures and (if not found there) via getenv() from the Apache server process.
      4. - -
    4. There is the special format: +
    5. There is the special format: %{HTTP:header} where header can be any HTTP MIME-header name. This is looked-up from the HTTP request. Example: %{HTTP:Proxy-Connection} is the value of the HTTP header ``Proxy-Connection:''.
      6. - -
    6. There is the special format +
    7. There is the special format %{LA-U:variable} for look-aheads which perform an internal (URL-based) sub-request to determine the final value of variable. Use this when you want to use a @@ -952,61 +588,49 @@ Result: phases come before this phase, you just can use %{REMOTE_USER} there.
      8. - -
    8. There is the special format: +
    9. There is the special format: %{LA-F:variable} which performs an internal (filename-based) sub-request to determine the final value of variable. Most of the time this is the same as LA-U above.
      10. - -
    + - -

    -CondPattern is the condition pattern, +

    CondPattern is the condition pattern, i.e., a regular expression which is applied to the current instance of the TestString, i.e., TestString is evaluated and then matched against CondPattern.

    - -

    -Remember: CondPattern is a +

    Remember: CondPattern is a standard Extended Regular Expression with some additions:

    - -
      - -
    1. You can prefix the pattern string with a +
        +
      1. You can prefix the pattern string with a '!' character (exclamation mark) to specify a non-matching pattern.
        2. - -
      2. +
      3. There are some special variants of CondPatterns. Instead of real regular expression strings you can also use one of the following:
          - -
        • '<CondPattern' (is lexically +
        • '<CondPattern' (is lexically lower)
          Treats the CondPattern as a plain string and compares it lexically to TestString. True if TestString is lexically lower than CondPattern.
          • - -
        • '>CondPattern' (is lexically +
        • '>CondPattern' (is lexically greater)
          Treats the CondPattern as a plain string and compares it lexically to TestString. True if TestString is lexically greater than CondPattern.
          • - -
        • '=CondPattern' (is lexically +
        • '=CondPattern' (is lexically equal)
          Treats the CondPattern as a plain string and compares it lexically to TestString. True if @@ -1016,33 +640,28 @@ Result: is just "" (two quotation marks) this compares TestString to the empty string.
          • - -
        • '-d' (is +
        • '-d' (is directory)
          Treats the TestString as a pathname and tests if it exists and is a directory.
          • - -
        • '-f' (is regular +
        • '-f' (is regular file)
          Treats the TestString as a pathname and tests if it exists and is a regular file.
          • - -
        • '-s' (is regular file with +
        • '-s' (is regular file with size)
          Treats the TestString as a pathname and tests if it exists and is a regular file with size greater than zero.
          • - -
        • '-l' (is symbolic +
        • '-l' (is symbolic link)
          Treats the TestString as a pathname and tests if it exists and is a symbolic link.
          • - -
        • '-F' (is existing file via +
        • '-F' (is existing file via subrequest)
          Checks if TestString is a valid file and accessible via all the server's currently-configured @@ -1050,54 +669,35 @@ Result: subrequest to determine the check, so use it with care because it decreases your servers performance!
          • - -
        • '-U' (is existing URL via +
        • '-U' (is existing URL via subrequest)
          Checks if TestString is a valid URL and accessible via all the server's currently-configured access controls for that path. This uses an internal subrequest to determine the check, so use it with care because it decreases your server's performance!
          • - -
        - + -
        - - -
        -

        -Notice -

        +
        - -

        Notice

        All of these tests can also be prefixed by an exclamation mark ('!') to negate their meaning. -
        -
        - - - - - - -

        Additionally you can set special flags for +

        +
        4. +
      + +

      Additionally you can set special flags for CondPattern by appending

      - -
      - -[flags] - -
      +
      + [flags] +
      as the third argument to the RewriteCond directive. Flags is a comma-separated list of the following flags:
        - -
      • 'nocase|NC' +
      • 'nocase|NC' (no case)
        This makes the test case-insensitive, i.e., there is no difference between 'A-Z' and 'a-z' both in the @@ -1106,52 +706,33 @@ Result: TestString and CondPattern. It has no effect on filesystem and subrequest checks.
        • - -
      • +
      • 'ornext|OR' (or next condition)
        Use this to combine rule conditions with a local OR instead of the implicit AND. Typical example: -
        - - -
        - +
        - -
         RewriteCond %{REMOTE_HOST}  ^host1.*  [OR]
 RewriteCond %{REMOTE_HOST}  ^host2.*  [OR]
 RewriteCond %{REMOTE_HOST}  ^host3.*
 RewriteRule ...some special stuff for any of these hosts...
        - -
        -
        +
        Without this flag you would have to write the cond/rule three times.
        • - -
      + - -

      -Example: -

      +

      Example:

      - -

      To rewrite the Homepage of a site according to the +

      To rewrite the Homepage of a site according to the ``User-Agent:'' header of the request, you can use the following:

      - -
      - - - - -
      - +
       RewriteCond  %{HTTP_USER_AGENT}  ^Mozilla.*
 RewriteRule  ^/$                 /homepage.max.html  [L]
@@ -1161,14 +742,9 @@ RewriteRule  ^/$                 /homepage.min.html  [L]
 
 RewriteRule  ^/$                 /homepage.std.html  [L]
      +
      -
      -
      - - -

      Interpretation: If you use Netscape Navigator as your +

      Interpretation: If you use Netscape Navigator as your browser (which identifies itself as 'Mozilla'), then you get the max homepage, which includes Frames, etc. If you use the Lynx browser (which is Terminal-based), then @@ -1176,152 +752,39 @@ RewriteRule ^/$ /homepage.std.html [L] tables, etc. If you use any other browser you get the standard homepage.

      +

      RewriteEngine Directive

      Description:
      Syntax:RewriteEngine on|off
      Default:RewriteEngine off
      Context:server config, virtual host, directory, .htaccess
      Override:FileInfo
      Status:Extension
      Module:mod_rewrite
      - -
      -

      -RewriteEngine Directive -

      - - - - -
      - - - - - - - - - - - - - - - - - - - - - - -
      Description:
      Syntax: -RewriteEngine on|off -
      Default:RewriteEngine off
      Context:server config, virtual host, directory, .htaccess
      Override:FileInfo
      Status:Extension
      Module:mod_rewrite
      -
      - - - -

      The RewriteEngine directive enables or +

      The RewriteEngine directive enables or disables the runtime rewriting engine. If it is set to off this module does no runtime processing at all. It does not even update the SCRIPT_URx environment variables.

      - -

      Use this directive to disable the module instead of - commenting out all the RewriteRule directives!

      +

      Use this directive to disable the module instead of + commenting out all the RewriteRule directives!

      - -

      Note that, by default, rewrite configurations are not +

      Note that, by default, rewrite configurations are not inherited. This means that you need to have a RewriteEngine on directive for each virtual host in which you wish to use it.

      - -       -
      -

      -RewriteLock Directive -

      - - - - -
      - - - - - - - - - - - - - - - - - - - -
      Description: Sets the name of the lock file used for RewriteMap -synchronization
      Syntax: -RewriteLock file-path - -
      Default:None
      Context:server config
      Status:Extension
      Module:mod_rewrite
      -
      - - -

      This directive sets the filename for a synchronization - lockfile which mod_rewrite needs to communicate with RewriteMap +

      RewriteLock Directive

      Description: Sets the name of the lock file used for RewriteMap +synchronization
      Syntax:RewriteLock file-path
      Default:None
      Context:server config
      Status:Extension
      Module:mod_rewrite
      +

      This directive sets the filename for a synchronization + lockfile which mod_rewrite needs to communicate with RewriteMap programs. Set this lockfile to a local path (not on a NFS-mounted device) when you want to use a rewriting map-program. It is not required for other types of rewriting maps.

      - -       -
      -

      -RewriteLog Directive -

      - - - - -
      - - - - - - - - - - - - - - - - -
      Description: Sets the name of the file used for logging rewrite engine -processing
      Syntax: -RewriteLog file-path - -
      Context:server config, virtual host
      Status:Extension
      Module:mod_rewrite
      -
      - - -

      The RewriteLog directive sets the name +

      RewriteLog Directive

      Description: Sets the name of the file used for logging rewrite engine +processing
      Syntax:RewriteLog file-path
      Context:server config, virtual host
      Status:Extension
      Module:mod_rewrite
      +

      The RewriteLog directive sets the name of the file to which the server logs any rewriting actions it performs. If the name does not begin with a slash ('/') then it is assumed to be relative to the Server Root. The directive should occur only once per server config.

      - -
      - - -
      To disable the logging of +
      to the administrator! To disable logging either remove or comment out the RewriteLog directive or use RewriteLogLevel 0! - - -
      To disable the logging of rewriting actions it is not recommended to set Filename to /dev/null, because although the rewriting engine does not then output to a @@ -1330,202 +793,75 @@ processing
      -
      +
      - -
      - - -
      -

      -Security -

      +
      - -

      Security

      See the Apache Security Tips document for details on why your security could be compromised if the directory where logfiles are stored is writable by anyone other than the user that starts the server. -
      -
      - - -
      - - -
      -

      -Example -

      - +
      + +
      - -

      Example

      RewriteLog "/usr/local/var/apache/logs/rewrite.log" -
      -
      - - - -
      -

      -RewriteLogLevel Directive -

      - - - - -
      - - - - - - - - - - - - - - - - - - - -
      Description: Sets the verbosity of the log file used by the rewrite -engine
      Syntax: -RewriteLogLevel Level - -
      Default:RerwiteLogLevel 0
      Context:server config, virtual host
      Status:Extension
      Module:mod_rewrite
      -
      - - -

      The RewriteLogLevel directive sets the +

      + +

      RewriteLogLevel Directive

      Description: Sets the verbosity of the log file used by the rewrite +engine
      Syntax:RewriteLogLevel Level
      Default:RerwiteLogLevel 0
      Context:server config, virtual host
      Status:Extension
      Module:mod_rewrite
      +

      The RewriteLogLevel directive sets the verbosity level of the rewriting logfile. The default level 0 means no logging, while 9 or more means that practically all actions are logged.

      - -

      To disable the logging of rewriting actions simply set +

      To disable the logging of rewriting actions simply set Level to 0. This disables all rewrite action logs.

      - -
      - - -
      Using a high value for +
      - -
      Using a high value for Level will slow down your Apache server dramatically! Use the rewriting logfile at a Level greater than 2 only for debugging! -
      -
      - - -
      - - -
      -

      -Example -

      - +
      + +
      - -

      Example

      RewriteLogLevel 3 -
      -
      - - - -
      -

      -RewriteMap Directive -

      - - - - -
      - - - - - - - - - - - - - - - - - - - -
      Description: Defines a mapping function for key-lookup
      Syntax: -RewriteMap MapName MapType:MapSource - - -
      Default:None
      Context:server config, virtual host
      Status:Extension
      Module:mod_rewrite
      -
      - - -

      The RewriteMap directive defines a +

      + +

      RewriteMap Directive

      Description: Defines a mapping function for key-lookup
      Syntax:RewriteMap MapName MapType:MapSource +
      Default:None
      Context:server config, virtual host
      Status:Extension
      Module:mod_rewrite
      +

      The RewriteMap directive defines a Rewriting Map which can be used inside rule substitution strings by the mapping-functions to insert/substitute fields through a key lookup. The source of this lookup can be of various types.

      - -

      The MapName is +

      The MapName is the name of the map and will be used to specify a mapping-function for the substitution strings of a rewriting rule via one of the following constructs:

      - -
      - -${ MapName : - LookupKey } -
      - -${ MapName : +
      + ${ MapName : + LookupKey }
      + ${ MapName : LookupKey | DefaultValue }       - -
      +
      - -

      When such a construct occurs the map MapName is +

      When such a construct occurs the map MapName is consulted and the key LookupKey is looked-up. If the key is found, the map-function construct is substituted by SubstValue. If the key is not found then it is substituted by DefaultValue or by the empty string if no DefaultValue was specified.

      - -

      The following combinations for MapType and +

      The following combinations for MapType and MapSource can be used:

      - -
        - -
      • - -Standard Plain Text -
        +
          +
        • + Standard Plain Text
          MapType: txt, MapSource: Unix filesystem path to valid regular file @@ -1535,24 +871,12 @@ RewriteLogLevel 3 character) or pairs like the following - one per line.

          - -
          - -MatchingKey +
          + MatchingKey SubstValue - -
          - - -
          - - - - -
          -

          -Example -

          - + +

          Example

           ##
 ##  map.txt -- rewriting map
@@ -1561,30 +885,15 @@ RewriteLogLevel 3
 Ralf.S.Engelschall    rse   # Bastard Operator From Hell
 Mr.Joe.Average        joe   # Mr. Average
          +
          -
          -
          - - -
          - - -
          +
          - -
          RewriteMap real-to-user txt:/path/to/file/map.txt -
          -
          - - - - -
        • - -Randomized Plain Text -
          +
          • +
          • + +
        • + Randomized Plain Text
          MapType: rnd, MapSource: Unix filesystem path to valid regular file @@ -1599,12 +908,7 @@ RewriteMap real-to-user txt:/path/to/file/map.txt proxy situation where the looked up values are server names. Example:

          - -
          - - - - -
          - +
           ##
 ##  map.txt -- rewriting map
@@ -1613,30 +917,15 @@ RewriteMap real-to-user txt:/path/to/file/map.txt
 static   www1|www2|www3|www4
 dynamic  www5|www6
          +
          -
          -
          - - -
          - - -
          +
          - -
          RewriteMap servers rnd:/path/to/file/map.txt -
          -
          - - - - -
        • - -Hash File -
          +
          • +
          • + +
        • + Hash File
          MapType: dbm, MapSource: Unix filesystem path to valid regular file @@ -1647,12 +936,7 @@ RewriteMap servers rnd:/path/to/file/map.txt file with any NDBM tool or with the following Perl script:

          - -
          - - - - -
          - +
           #!/path/to/bin/perl
 ##
@@ -1675,30 +959,15 @@ while (<TXT>) {
 untie %DB;
 close(TXT);
          +
          -
          -
          - - -
          - - -
          +
          - -
          $ txt2dbm map.txt map.db -
          -
          - - - - -
        • - -Internal Function -
          +
          • +
          • + +
        • + Internal Function
          MapType: int, MapSource: Internal Apache function @@ -1706,39 +975,25 @@ $ txt2dbm map.txt map.db Currently you cannot create your own, but the following functions already exists:

          - -
            - -
          • -toupper:
            +
              +
            • toupper:
              Converts the looked up key to all upper case.
              • - -
            • -tolower:
              +
            • tolower:
              Converts the looked up key to all lower case.
              • - -
            • -escape:
              +
            • escape:
              Translates special characters in the looked up key to hex-encodings.
              • - -
            • -unescape:
              +
            • unescape:
              Translates hex-encodings in the looked up key back to special characters.
              • - -
            - -
            • - - -
          • - -External Rewriting Program -
            +
          +
          • + +
        • + External Rewriting Program
          MapType: prg, MapSource: Unix filesystem path to valid regular file @@ -1749,8 +1004,7 @@ $ txt2dbm map.txt map.db '#!/path/to/interpreter' as the first line).

          - -

          This program is started once at startup of the Apache +

          This program is started once at startup of the Apache servers and then communicates with the rewriting engine over its stdin and stdout file-handles. For each map-function lookup it will @@ -1763,12 +1017,7 @@ $ txt2dbm map.txt map.db program which will implement a 1:1 map (i.e., key == value) could be:

          - -
          - - - - -
          - +
           #!/usr/bin/perl
 $| = 1;
@@ -1777,38 +1026,26 @@ while (<STDIN>) {
     print $_;
 }
          +
          -
          -
          +

          But be very careful:

          - -

          But be very careful:

          - - -
            - -
          1. ``Keep it simple, stupid'' (KISS), because +
              +
            1. ``Keep it simple, stupid'' (KISS), because if this program hangs it will hang the Apache server when the rule occurs.
              2. - -
            2. Avoid one common mistake: never do buffered I/O on +
            3. Avoid one common mistake: never do buffered I/O on stdout! This will cause a deadloop! Hence the ``$|=1'' in the above example...
              4. - -
            4. Use the RewriteLock directive to +
            5. Use the RewriteLock directive to define a lockfile mod_rewrite can use to synchronize the communication to the program. By default no such synchronization takes place.
              6. - -
            - -
            2. - -
        +
    + + The RewriteMap directive can occur more than once. For each mapping-function use one RewriteMap directive to declare its rewriting @@ -1816,129 +1053,40 @@ while (<STDIN>) { per-directory context it is of course possible to use this map in per-directory context. -
    - - -
    -

    -Note -

    For plain text and DBM format files the +
    - -

    Note

    For plain text and DBM format files the looked-up keys are cached in-core until the mtime of the mapfile changes or the server does a restart. This way you can have map-functions in rules which are used for every request. This is no problem, because the external lookup only happens once! -
    -
    - - - -
    -

    -RewriteOptions Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets some special options for the rewrite engine
    Syntax: -RewriteOptions Options - -
    Default:None
    Context:server config, virtual host, directory, .htaccess
    Status:Extension
    Module:mod_rewrite
    -
    - - - -

    The RewriteOptions directive sets some +

    + +

    RewriteOptions Directive

    Description: Sets some special options for the rewrite engine
    Syntax:RewriteOptions Options
    Default:None
    Context:server config, virtual host, directory, .htaccess
    Status:Extension
    Module:mod_rewrite
    + +

    The RewriteOptions directive sets some special options for the current per-server or per-directory configuration. The Option strings can be one of the following:

    - -
      - -
    • 'inherit'
      +
        +
      • 'inherit'
        This forces the current configuration to inherit the configuration of the parent. In per-virtual-server context this means that the maps, conditions and rules of the main server are inherited. In per-directory context this means that conditions and rules of the parent directory's .htaccess configuration are inherited.
        • - -
      - - -
      -

      -RewriteRule Directive -

      - - - - -
      - - - - - - - - - - - - - - - - - - - - - - -
      Description: Defines rules for the rewriting engine
      Syntax: -RewriteRule - Pattern Substitution - -
      Default:None
      Context:server config, virtual host, directory, .htaccess
      Override:FileInfo
      Status:Extension
      Module:mod_rewrite
      -
      - - -

      The RewriteRule directive is the real +

    +

    RewriteRule Directive

    Description: Defines rules for the rewriting engine
    Syntax:RewriteRule + Pattern Substitution
    Default:None
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Extension
    Module:mod_rewrite
    +

    The RewriteRule directive is the real rewriting workhorse. The directive can occur more than once. Each directive then defines one single rewriting rule. The definition order of these rules is important, because this order is used when applying the rules at run-time.

    - -

    -Pattern can +

    Pattern can be (for Apache 1.1.x a System V8 and for Apache 1.2.x and later a POSIX) regular expression which gets applied to the current URL. Here @@ -1947,18 +1095,12 @@ once! because any number of rules may already have matched and made alterations to it.

    - -

    Some hints about the syntax of regular expressions:

    - - - - - - - + +
    +

    Some hints about the syntax of regular expressions:

    + + + - - - -
    -
 Text:
   .           Any single character
   [chars]     Character class: One  of chars
@@ -1984,15 +1126,11 @@ once!
   \char       escape that particular char
               (for instance to specify the chars ".[]()" etc.)
    - -
    - - -

    For more information about regular expressions either have +

    + +

    For more information about regular expressions either have a look at your local regex(3) manpage or its src/regex/regex.3 copy in the Apache 1.3 distribution. If you are interested in more detailed @@ -2000,20 +1138,15 @@ once! (POSIX regex, Perl regex, etc.) have a look at the following dedicated book on this topic:

    - -
    - -Mastering Regular Expressions -
    +
    + Mastering Regular Expressions
    Jeffrey E.F. Friedl
    Nutshell Handbook Series
    O'Reilly & Associates, Inc. 1997
    ISBN 1-56592-257-3
    - -
    +
    - -

    Additionally in mod_rewrite the NOT character +

    Additionally in mod_rewrite the NOT character ('!') is a possible pattern prefix. This gives you the ability to negate a pattern; to say, for instance: ``if the current URL does NOT match this @@ -2021,14 +1154,7 @@ once! it is easier to match the negative pattern, or as a last default rule.

    - -
    - - -
    -

    -Notice -

    +
    - -

    Notice

    When using the NOT character to negate a pattern you cannot have grouped wildcard parts in the pattern. This is impossible because when the @@ -2036,38 +1162,26 @@ When using the NOT character groups. In consequence, if negated patterns are used, you cannot use $N in the substitution string! -
    -
    - - -

    -Substitution of a +

    + +

    Substitution of a rewriting rule is the string which is substituted for (or replaces) the original URL for which Pattern matched. Beside plain text you can use

    - -
      - -
    1. back-references $N to the RewriteRule +
        +
      1. back-references $N to the RewriteRule pattern
        2. - -
      2. back-references %N to the last matched +
      3. back-references %N to the last matched RewriteCond pattern
        4. - -
      4. server-variables as in rule condition test-strings +
      5. server-variables as in rule condition test-strings (%{VARNAME})
        6. - -
      6. -mapping-function calls +
      7. mapping-function calls (${mapname:key|default})
        8. - -
      +
    Back-references are $N (N=0..9) identifiers which will be replaced by the contents of the Nth group of the @@ -2086,8 +1200,7 @@ When using the NOT character unless explicitly terminated by a L flag - see below.

    - -

    There is a special substitution string named +

    There is a special substitution string named '-' which means: NO substitution! Sounds silly? No, it is useful to provide rewriting rules which only match @@ -2096,8 +1209,7 @@ When using the NOT character able to have more than one pattern to be applied before a substitution occurs.

    - -

    One more note: You can even create URLs in the +

    One more note: You can even create URLs in the substitution string containing a query string part. Just use a question mark inside the substitution string to indicate that the following stuff should be re-injected into the @@ -2105,14 +1217,7 @@ When using the NOT character string, end the substitution string with just the question mark.

    - -
    - - -
    -

    -Note -

    +
    - -

    Note

    There is a special feature: When you prefix a substitution field with http://thishost[:thisport] @@ -2122,46 +1227,28 @@ There is a special feature: combination with a mapping-function which generates the hostname part. Have a look at the first example in the example section below to understand this. -
    -
    - - -
    - - -
    -

    -Remember -

    +
    + +
    - -

    Remember

    An unconditional external redirect to your own server will not work with the prefix http://thishost because of this feature. To achieve such a self-redirect, you have to use the R-flag (see below). -
    -
    +
    - -

    Additionally you can set special flags for +

    Additionally you can set special flags for Substitution by appending

    - -
    - -[flags] - -
    +
    + [flags] +
    as the third argument to the RewriteRule directive. Flags is a comma-separated list of the following flags:
      - -
    • +
    • 'redirect|R [=code]' (force redirect)
      Prefix Substitution with @@ -2179,9 +1266,7 @@ There is a special feature: /u/user, etc.
      - -

      -Note: When you use this flag, make +

      Note: When you use this flag, make sure that the substitution field is a valid URL! If not, you are redirecting to an invalid location! And remember that this flag itself only prefixes the URL with @@ -2189,11 +1274,9 @@ There is a special feature: continues. Usually you also want to stop and do the redirection immediately. To stop the rewriting you also have to provide the 'L' flag.

      - -
      • + - -
    • 'forbidden|F' (force URL +
    • 'forbidden|F' (force URL to be forbidden)
      This forces the current URL to be forbidden, i.e., it immediately sends back a HTTP response of @@ -2201,15 +1284,13 @@ There is a special feature: appropriate RewriteConds to conditionally block some URLs.
      • - -
    • 'gone|G' (force URL to be +
    • 'gone|G' (force URL to be gone)
      This forces the current URL to be gone, i.e., it immediately sends back a HTTP response of 410 (GONE). Use this flag to mark pages which no longer exist as gone.
      • - -
    • +
    • 'proxy|P' (force proxy)
      This flag forces the substitution part to be internally @@ -2232,11 +1313,9 @@ There is a special feature: available to mod_rewrite. If not, then you first have to rebuild the ``httpd'' program with mod_proxy enabled.

      - -
      • + - -
    • 'last|L' +
    • 'last|L' (last rule)
      Stop the rewriting process here and don't apply any more rewriting rules. This corresponds to the Perl @@ -2247,8 +1326,7 @@ There is a special feature: ('/') to a real one, e.g., '/e/www/'.
      • - -
    • 'next|N' +
    • 'next|N' (next round)
      Re-run the rewriting process (starting again with the first rewriting rule). Here the URL to match is again not @@ -2257,13 +1335,10 @@ There is a special feature: the continue command from the C language. Use this flag to restart the rewriting process, i.e., to immediately go to the top of the loop.
      - -But be careful not to create an infinite - loop! -
      • + But be careful not to create an infinite + loop! - -
    • 'chain|C' +
    • 'chain|C' (chained with next rule)
      This flag chains the current rule with the next rule (which itself can be chained with the following rule, @@ -2276,8 +1351,7 @@ There is a special feature: when you let an external redirect happen (where the ``.www'' part should not to occur!).
      • - -
    • +
    • 'type|T=MIME-type' (force MIME type)
      Force the MIME-type of the target file to be @@ -2287,8 +1361,7 @@ There is a special feature: inside the mapped directory to have a MIME type of ``application/x-httpd-cgi''.
      • - -
    • +
    • 'nosubreq|NS' (used only if no internal sub-request)
      @@ -2303,25 +1376,21 @@ There is a special feature: exclude some rules.
      - -

      Use the following rule for your decision: whenever you +

      Use the following rule for your decision: whenever you prefix some URLs with CGI-scripts to force them to be processed by the CGI-script, the chance is high that you will run into problems (or even overhead) on sub-requests. In these cases, use this flag.

      - -
      • + - -
    • 'nocase|NC' +
    • 'nocase|NC' (no case)
      This makes the Pattern case-insensitive, i.e., there is no difference between 'A-Z' and 'a-z' when Pattern is matched against the current URL.
      • - -
    • 'qsappend|QSA' +
    • 'qsappend|QSA' (query string append)
      This flag forces the rewriting engine to append a query @@ -2329,8 +1398,7 @@ There is a special feature: instead of replacing it. Use this when you want to add more data to the query string via a rewrite rule.
      • - -
    • +
    • 'noescape|NE' (no URI escaping of output)
      @@ -2341,22 +1409,15 @@ There is a special feature: '%24', and '%3B', respectively); this flag prevents this from being done. This allows percent symbols to appear in the output, as in -
      - - -
      +
      - -
      RewriteRule /foo/(.*) /bar?arg=P1\%3d$1 [R,NE] -
      -
      +
      which would turn '/foo/zed' into a safe request for '/bar?arg=P1=zed'.
      • - -
    • +
    • 'passthrough|PT' (pass through to next handler)
      @@ -2374,16 +1435,10 @@ There is a special feature: engine of mod_rewrite and then /def to /ghi with mod_alias: -
      - - -
      +
      - -
      RewriteRule ^/abc(.*) /def$1 [PT]
      Alias /def /ghi -
      -
      +
      If you omit the PT flag then mod_rewrite will do its job fine, i.e., it rewrites uri=/abc/... to @@ -2398,29 +1453,17 @@ There is a special feature: is the use of mod_alias and mod_rewrite..

      - -
      - - -
      -

      -For Apache hackers -

      +
      - -

      For Apache hackers

      If the current Apache API had a filename-to-filename hook additionally to the URI-to-filename hook then we wouldn't need this flag! But without such a hook this flag is the only solution. The Apache Group has discussed this problem and will add such a hook in Apache version 2.0. -
      -
      - - - - -
    • 'skip|S=num' +
      • +
      • + +
    • 'skip|S=num' (skip next rule(s))
      This flag forces the rewriting engine to skip the next num rules in sequence when the current rule @@ -2430,8 +1473,7 @@ There is a special feature: else-clause. (This is not the same as the 'chain|C' flag!)
      • - -
    • +
    • 'env|E=VAR:VAL' (set environment variable)
      This forces an environment variable named VAR to @@ -2446,17 +1488,9 @@ There is a special feature: it in a following RewriteCond pattern via %{ENV:VAR}. Use this to strip but remember information from URLs.
      • - -
    + - -
    - - - - -
    -

    -Note -

    Never forget that Pattern is +

    Note

    Never forget that Pattern is applied to a complete URL in per-server configuration files. But in per-directory configuration files, the per-directory prefix (which always is the same for a specific @@ -2471,20 +1505,9 @@ directory which is not always possible. prefix will not be added and an external redirect or proxy throughput (if flag P is used!) is forced!

    +
    -
    -
    - - -
    - - -
    -

    -Note -

    +
    - -

    Note

    To enable the rewriting engine for per-directory configuration files you need to set ``RewriteEngine On'' in these files @@ -2494,34 +1517,21 @@ directory which is not always possible. FollowSymLinks for a user's directory, then you cannot use the rewriting engine. This restriction is needed for security reasons. -
    -
    +
    - -

    Here are all possible substitution combinations and their +

    Here are all possible substitution combinations and their meanings:

    - -

    -Inside per-server configuration +

    Inside per-server configuration (httpd.conf)
    for request ``GET - /somepath/pathinfo'':     -
    - -

    - - - - - - - + +
    + /somepath/pathinfo'':
    +

    + + + - - - -
    -
 Given Rule                                      Resulting Substitution
 ----------------------------------------------  ----------------------------------
 ^/somepath(.*) otherpath$1                      not supported, because invalid!
@@ -2554,36 +1564,23 @@ directory which is not always possible.
 ^/somepath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
                                                 via internal proxy
    - -
    - - -

    -Inside per-directory configuration for - /somepath -
    +

    + +

    Inside per-directory configuration for + /somepath
    (i.e., file .htaccess in dir /physical/path/to/somepath containing RewriteBase /somepath)
    for request ``GET - /somepath/localpath/pathinfo'':     -
    - -

    - - - - - - - + +
    + /somepath/localpath/pathinfo'':
    +

    + + + - - - -
    -
 Given Rule                                      Resulting Substitution
 ----------------------------------------------  ----------------------------------
 ^localpath(.*) otherpath$1                      /somepath/otherpath/pathinfo
@@ -2617,65 +1614,36 @@ directory which is not always possible.
 ^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo
                                                 via internal proxy
    - -
    - - -

    -Example: -

    - - -

    We want to rewrite URLs of the form

    - - -
    - -/ Language /~ +
    + +

    Example:

    + +

    We want to rewrite URLs of the form

    + +
    + / Language /~ Realname /.../ File - -
    + into
    - -/u/ Username /.../ + /u/ Username /.../ File . Language - -
    + - -

    We take the rewrite mapfile from above and save it under +

    We take the rewrite mapfile from above and save it under /path/to/file/map.txt. Then we only have to add the following lines to the Apache server configuration file:

    - -
    - - - - -
    - +
     RewriteLog   /path/to/file/rewrite.log
 RewriteMap   real-to-user               txt:/path/to/file/map.txt
 RewriteRule  ^/([^/]+)/~([^/]+)/(.*)$   /u/${real-to-user:$2|nobody}/$3.$1
    +
    -
    -
    - - -     -
    -

    Apache HTTP Server Version 2.0

    -IndexHome - - - +

    Apache HTTP Server Version 2.0

    IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_setenvif.html b/docs/manual/mod/mod_setenvif.html index 3accd9b46a..e27c58a8e9 100644 --- a/docs/manual/mod/mod_setenvif.html +++ b/docs/manual/mod/mod_setenvif.html @@ -1,143 +1,31 @@ - - - - -mod_setenvif - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module mod_setenvif

    - - - - -
    - - - - - - - - - - - - - -
    Description: -Allows the setting of environment variables based -on characteristics of the request -
    Status:Base
    Module Identifier:setenvif_module
    Compatibility: -Available in Apache 1.3 and later -
    -
    -

    Summary

    - +-->mod_setenvif - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_setenvif

    Description:Allows the setting of environment variables based +on characteristics of the request
    Status:Base
    Module Identifier:setenvif_module
    Compatibility:Available in Apache 1.3 and later

    Summary

    - -

    The mod_setenvif module allows you to set +

    The mod_setenvif module allows you to set environment variables according to whether different aspects of the request match regular expressions you specify. These environment variables can be used by other parts of the server to make decisions about actions to be taken.

    - -

    The directives are considered in the order they appear in +

    The directives are considered in the order they appear in the configuration files. So more complex sequences can be used, such as this example, which sets netscape if the browser is mozilla but not MSIE.

    - -
    - - -
    +
    - -
    BrowserMatch ^Mozilla netscape
    BrowserMatch MSIE !netscape
    - -
    -
    - - -

    -See also: -

    - -

    Directives

    - -
    -

    -BrowserMatch Directive -

    - - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Description: Sets environment variables conditional on HTTP User-Agent -
    Syntax: -BrowserMatch regex env-variable[=value] -[env-variable[=value]] ... -
    Default:none
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.2 and +
    +

    See also

    Directives

    BrowserMatch Directive

    - -
    - -
    Description: Sets environment variables conditional on HTTP User-Agent +
    Syntax:BrowserMatch regex env-variable[=value] +[env-variable[=value]] ...
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.2 and above (in Apache 1.2 this directive was found in the - now-obsolete mod_browser module)
    -
    - - -

    The BrowserMatch directive defines + now-obsolete mod_browser module)

    +

    The BrowserMatch directive defines environment variables based on the User-Agent HTTP request header field. The first argument should be a POSIX.2 extended regular expression (similar to an @@ -145,25 +33,15 @@ on characteristics of the request the names of variables to set, and optionally values to which they should be set. These take the form of

    - -
      - -
    1. -varname, or
      2. +
        +
      1. varname, or
        2. - -
      2. -!varname, or
        3. +
      3. !varname, or
        4. - -
      4. -varname=value -
        5. - -
      +
    2. varname=value
      3. +
    - -

    In the first form, the value will be set to "1". The second +

    In the first form, the value will be set to "1". The second will remove the given variable if already defined, and the third will set the variable to the value given by value. If a User-Agent @@ -171,260 +49,109 @@ on characteristics of the request Entries are processed in the order in which they appear, and later entries can override earlier ones.

    - -

    For example:

    - -
    - - -
    +

    For example:

    +
    - -
    BrowserMatch ^Mozilla forms jpeg=yes browser=netscape
    BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript
    BrowserMatch MSIE !javascript
    - -
    -
    +
    - -

    Note that the regular expression string is +

    Note that the regular expression string is case-sensitive. For case-INsensitive matching, - see the BrowserMatchNoCase + see the BrowserMatchNoCase directive.

    - -

    The BrowserMatch and +

    The BrowserMatch and BrowserMatchNoCase directives are special cases of - the SetEnvIf and SetEnvIfNoCase + the SetEnvIf and SetEnvIfNoCase directives. The following two lines have the same effect:

    - -
    - - -
    +
    - -
    BrowserMatchNoCase Robot is_a_robot
    SetEnvIfNoCase User-Agent Robot is_a_robot
    - -
    -
    - - -
    -

    -BrowserMatchNoCase Directive -

    - - -
    - - - - - - - - - - - - - - - - - - - - - - - -
    Description: Sets environment variables conditional on User-Agent without -respect to case
    Syntax: -BrowserMatchNoCase regex env-variable[=value] - [env-variable[=value]] ... -
    Default:none
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.2 and +
    +

    BrowserMatchNoCase Directive

    - -
    - -
    Description: Sets environment variables conditional on User-Agent without +respect to case
    Syntax:BrowserMatchNoCase regex env-variable[=value] + [env-variable[=value]] ...
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.2 and above (in Apache 1.2 this directive was found in the - now-obsolete mod_browser module)
    -
    - + now-obsolete mod_browser module)
    - -

    The BrowserMatchNoCase directive is - semantically identical to the BrowserMatch directive. +

    The BrowserMatchNoCase directive is + semantically identical to the BrowserMatch directive. However, it provides for case-insensitive matching. For example:

    - -
    - - - - -
    +
    BrowserMatchNoCase mac platform=macintosh
    BrowserMatchNoCase win platform=windows
    +
    -
    -
    - - -

    The BrowserMatch and +

    The BrowserMatch and BrowserMatchNoCase directives are special cases of - the SetEnvIf and SetEnvIfNoCase + the SetEnvIf and SetEnvIfNoCase directives. The following two lines have the same effect:

    - -
    - - -
    +
    - -
    BrowserMatchNoCase Robot is_a_robot
    SetEnvIfNoCase User-Agent Robot is_a_robot
    - -
    -
    - - -
    -

    -SetEnvIf Directive -

    - - -
    - - - - - -
    Description: Sets environment variables based on attributes of the request -
    Syntax: -SetEnvIf attribute +
    +

    SetEnvIf Directive

    - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets environment variables based on attributes of the request +
    Syntax:SetEnvIf attribute regex env-variable[=value] - [env-variable[=value]] ... -
    Default:none
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.3 and + [env-variable[=value]] ...
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.3 and above; the Request_Protocol keyword and environment-variable - matching are only available with 1.3.7 and later
    -
    - - -

    The SetEnvIf directive defines environment + matching are only available with 1.3.7 and later

    +

    The SetEnvIf directive defines environment variables based on attributes of the request. These attributes can be the values of various HTTP request header fields (see RFC2616 for more information about these), or of other aspects of the request, including the following:

    - -
      - -
    • -Remote_Host - the hostname (if available) of +
        +
      • Remote_Host - the hostname (if available) of the client making the request
        • - -
      • -Remote_Addr - the IP address of the client +
      • Remote_Addr - the IP address of the client making the request
        • - -
      • -Remote_User - the authenticated username (if +
      • Remote_User - the authenticated username (if available)
        • - -
      • -Request_Method - the name of the method +
      • Request_Method - the name of the method being used (GET, POST, et cetera)
        • - -
      • -Request_Protocol - the name and version of +
      • Request_Protocol - the name and version of the protocol with which the request was made (e.g., "HTTP/0.9", "HTTP/1.1", etc.)
        • - -
      • -Request_URI - the portion of the URL +
      • Request_URI - the portion of the URL following the scheme and host portion
        • - -
      +
    - -

    Some of the more commonly used request header field names +

    Some of the more commonly used request header field names include Host, User-Agent, and Referer.

    - -

    If the attribute name doesn't match any of the +

    If the attribute name doesn't match any of the special keywords, nor any of the request's header field names, it is tested as the name of an environment variable in the list of those associated with the request. This allows SetEnvIf directives to test against the result of prior matches.

    - -
    - - -
    +
    - -
    Only those environment variables defined by earlier SetEnvIf[NoCase] directives are available for testing in this manner. 'Earlier' means that they were defined at a broader scope (such as server-wide) or previously in the current directive's scope. -
    -
    +
    - -

    -attribute may be a regular expression when used to +

    attribute may be a regular expression when used to match a request header. If attribute is a regular expression and it doesn't match any of the request's header names, then attribute is not tested against the request's environment variable list.

    - -
    - - - - -
    -

    -Example: -

    - +
    SetEnvIf object_is_image xbm XBIT_PROCESSING=1
    :
    SetEnvIf ^TS* ^[a-z].* HAVE_TS
    +

    Example:

    SetEnvIf Request_URI "\.gif$" object_is_image=gif
    SetEnvIf Request_URI "\.jpg$" object_is_image=jpg
    @@ -435,95 +162,33 @@ respect to case
    -
    -
    - - -

    The first three will set the environment variable +

    The first three will set the environment variable object_is_image if the request was for an image file, and the fourth sets intra_site_referral if the referring page was somewhere on the www.mydomain.com Web site.

    - -

    The last example will set environment variable +

    The last example will set environment variable HAVE_TS if the request contains any headers that begin with "TS" whose values begins with any character in the set [a-z].

    +

    SetEnvIfNoCase Directive

    Description: Sets environment variables based on attributes of the request +without respect to case
    Syntax:SetEnvIfNoCase attribute regex env-variable[=value] + [env-variable[=value]] ...
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.3 and above
    - -
    -

    -SetEnvIfNoCase Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -
    Description: Sets environment variables based on attributes of the request -without respect to case
    Syntax: -SetEnvIfNoCase attribute regex env-variable[=value] - [env-variable[=value]] ... -
    Default:none
    Context:server config, virtual host, directory, .htaccess
    Override:FileInfo
    Status:Base
    Module:mod_setenvif
    Compatibility:Apache 1.3 and above
    -
    - - - -

    The SetEnvIfNoCase is semantically identical to - the SetEnvIf directive, +

    The SetEnvIfNoCase is semantically identical to + the SetEnvIf directive, and differs only in that the regular expression matching is performed in a case-insensitive manner. For example:

    - -
    - - -
    +
    - -
    SetEnvIfNoCase Host Apache\.Org site=apache -
    -
    +
    - -

    This will cause the site environment variable +

    This will cause the site environment variable to be set to "apache" if the HTTP request header field Host: was included and contained Apache.Org, apache.org, or any other combination.

    - -     -
    -

    Apache HTTP Server Version 2.0

    -IndexHome -
    - - +

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mod_so.html b/docs/manual/mod/mod_so.html index 98c97b9f5e..6b306b0189 100644 --- a/docs/manual/mod/mod_so.html +++ b/docs/manual/mod/mod_so.html @@ -1,40 +1,13 @@ - - - - - - - Apache module mod_so - - - - - - -

    Module mod_so

    - -

    This module provides for loading of executable code and - modules into the server at start-up or restart time.

    - -

    Status: Base (Windows); - Optional (Unix)
    - Source File: mod_so.c
    - Module Identifier: - so_module
    - Compatibility: Available in - Apache 1.3 and later.

    - -

    Summary

    +mod_so - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_so

    Description: +This module provides for loading of executable code and +modules into the server at start-up or restart time.
    Status:Base (Windows>; Optional (Unix)
    Module Identifier:so_module
    Compatibility:Available in Apache 1.3 and later.

    Summary

    On selected operating systems this module can be used to - load modules into Apache at runtime via the Dynamic Shared Object (DSO) mechanism, + load modules into Apache at runtime via the Dynamic Shared Object (DSO) mechanism, rather than requiring a recompilation.

    On Unix, the loaded code typically comes from shared object @@ -52,21 +25,12 @@

    Warning: Apache 1.3 modules cannot be directly used with Apache 2.0 - the module must be modified to dynamically load or compile into Apache 2.0.

    +

    Directives

    Creating Loadable Modules +for Windows

    -

    Directives

    - - - -

    Creating Loadable Modules - for Windows

    - -

    Note: the module name format changed for Windows +

    Note: the module name format changed for Windows with Apache 1.3.15 and 2.0 - the modules are now named as - mod_foo.so. While mod_so still loads modules with + mod_foo.so
    . While mod_so still loads modules with ApacheModuleFoo.dll names, the new naming convention is preferred; if you are converting your loadable module for 2.0, please fix the name to this 2.0 convention.

    @@ -87,7 +51,7 @@

    The second way is to compile the module as a DLL, a shared library that can be loaded into the server at runtime, using - the LoadModule + the LoadModule directive. These module DLLs can be distributed and run on any Apache for Windows installation, without recompilation of the server.

    @@ -98,14 +62,15 @@ add the AP_MODULE_DECLARE_DATA (defined in the Apache header files) to your module's module record definition. For example, if your module has:

    -
    +
+
    
     module foo_module;
-
+
    
 
     
    Replace the above with:
    
-
    +
    
     module AP_MODULE_DECLARE_DATA foo_module;
-
+
    
 
     
    Note that this will only be activated on Windows, so the
     module can continue to be used, unchanged, with Unix if needed.
@@ -125,61 +90,29 @@
 
     
    This should create a DLL version of your module. Now simply
     place it in the modules directory of your server
-    root, and use the LoadModule directive to load
-    it.
    
-    
    
-
-    
    LoadFile
-    directive
    
-    
-    Syntax: LoadFile
-    filename [filename] ...
    
-     Context: server config
    
-     Status: Base
    
-     Module: mod_so 
+    root, and use the LoadModule
+    directive to load it.
    
+
+
    LoadFile Directive
    Description: Link in the named object file or library
    Syntax:LoadFile filename [filename] ...
    Default:none
    Context:server config
    Status:Base (Windows>; Optional (Unix)
    Module:mod_so
    
 
     
    The LoadFile directive links in the named object files or
     libraries when the server is started or restarted; this is used
     to load additional code which may be required for some module
     to work. Filename is either an absolute path or
     relative to ServerRoot.
    
-    
    
-
-    
    LoadModule
-    directive
    
-    
-    Syntax: LoadModule module
-    filename
    
-     Context: server config
    
-     Status: Base
    
-     Module: mod_so 
-
+
    LoadModule Directive
    Description: Links in the object file or library, and adds to the list
+of active modules
    Syntax:LoadModule module filename
    Default:none
    Context:server config
    Status:Base (Windows>; Optional (Unix)
    Module:mod_so
    
     
    The LoadModule directive links in the object file or library
     filename and adds the module structure named
     module to the list of active modules. Module
     is the name of the external variable of type
-    module in the file, and is listed as the Module Identifier
+    module in the file, and is listed as the Module Identifier
     in the module documentation. Example:
    
 
-    
    
-      LoadModule status_module modules/mod_status.so
-    
    
+    
    
+      LoadModule status_module modules/mod_status.so
+    
    
 
     
    loads the named module from the modules subdirectory of the
     ServerRoot.
    
-
-    
    
-    
    
-  
-
-
+
    Apache HTTP Server Version 2.0
    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mod_speling.html b/docs/manual/mod/mod_speling.html index f194f68926..6c1a8984bc 100644 --- a/docs/manual/mod/mod_speling.html +++ b/docs/manual/mod/mod_speling.html @@ -1,38 +1,11 @@ - - - - - - - Apache module mod_speling - - - - - - -

    Module mod_speling

    - -

    This module attempts to correct misspellings of URLs that - users might have entered, by ignoring capitalization and by - allowing up to one misspelling.

    - -

    Status: Extension
    - Source File: - mod_speling.c
    - Module Identifier: - speling_module
    - Compatibility: Available in - Apache 1.3 and later. Available as an External module in Apache - 1.1 and later.

    - -

    Summary

    +mod_speling - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_speling

    Description:This module attempts to correct misspellings of URLs that +users might have entered, by ignoring capitalization and by +allowing up to one misspelling.
    Status:Extension
    Module Identifier:speling_module
    Compatibility:Available in Apache 1.3 and later. Available as +an External module in Apache 1.1 and later.

    Summary

    Requests to documents sometimes cannot be served by the core apache server because the request was misspelled or @@ -60,43 +33,13 @@ the list of the matches is returned to the client, and the client can select the correct candidate. -
    -
    - - -

    Directives

    - - -
    - -

    CheckSpelling directive

    - - Syntax: CheckSpelling - on|off
    - Default: CheckSpelling - Off
    - Context: server config, virtual - host, directory, .htaccess
    - Override: Options
    - Status: Base
    - Module: mod_speling
    - Compatibility: CheckSpelling - was available as a separately available module for Apache 1.1, - but was limited to miscapitalizations. As of Apache 1.3, it is - part of the Apache distribution. Prior to Apache 1.3.2, the - CheckSpelling directive was only available in the - "server" and "virtual host" contexts. +

    Directives

    CheckSpelling Directive

    Description: This directive enables or disables the spelling +module.
    Syntax:CheckSpelling on|off
    Default:CheckSpelling Off
    Context:server config, virtual host, directory, .htaccess
    Override:Options
    Status:Extension
    Module:mod_speling
    Compatibility:CheckSpelling was available as a separately available +module for Apache 1.1, but was limited to miscapitalizations. As +of Apache 1.3, it is part of the Apache distribution. Prior to Apache +1.3.2, the CheckSpelling directive was only available in the +"server" and "virtual host" contexts.

    This directive enables or disables the spelling module. When enabled, keep in mind that

    @@ -120,7 +63,4 @@ get incorrectly treated as the negotiated file "/stats.html". - - - - +

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mod_status.html b/docs/manual/mod/mod_status.html index 0c18271b95..6551ff8f36 100644 --- a/docs/manual/mod/mod_status.html +++ b/docs/manual/mod/mod_status.html @@ -1,159 +1,76 @@ - - - - -mod_status - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module mod_status

    - - - - -
    - - - - - - - - - - - - - -
    Description: -This module provides information on server activity and -performance. -
    Status:Base
    Module Identifier:status_module
    Compatibility: -Available in Apache 1.1 and later -
    -
    -

    Summary

    - - - -
    - - -
    +-->mod_status - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_status

    Description:This module provides information on server activity and +performance.
    Status:Base
    Module Identifier:status_module
    Compatibility:Available in Apache 1.1 and later

    Summary

    + +
    - -
    Warning: This document has not been updated to take into account changes made in the 2.0 version of the Apache HTTP Server. Some of the information may still be relevant, but please use it with care. -
    -
    +
    - -

    The Status module allows a server administrator to find out +

    The Status module allows a server administrator to find out how well their server is performing. A HTML page is presented that gives the current server statistics in an easily readable form. If required this page can be made to automatically refresh (given a compatible browser). Another page gives a simple machine-readable list of the current server state.

    - -

    The details given are:

    +

    The details given are:

    - -
      - -
    • The number of children serving requests
      • +
        +
      • The number of children serving requests
        • - -
      • The number of idle children
        • +
      • The number of idle children
        • - -
      • The status of each child, the number of requests that +
      • The status of each child, the number of requests that child has performed and the total number of bytes served by the child (*)
        • - -
      • A total number of accesses and byte count served (*)
        • +
      • A total number of accesses and byte count served (*)
        • - -
      • The time the server was started/restarted and the time it +
      • The time the server was started/restarted and the time it has been running for
        • - -
      • Averages giving the number of requests per second, the +
      • Averages giving the number of requests per second, the number of bytes served per second and the average number of bytes per request (*)
        • - -
      • The current percentage CPU used by each child and in +
      • The current percentage CPU used by each child and in total by Apache (*)
        • - -
      • The current hosts and requests being processed (*)
        • - -
      +
    • The current hosts and requests being processed (*)
      • +
    A compile-time option must be used to display the details marked "(*)" as the instrumentation required for obtaining these statistics does not exist within standard Apache. -     -

    Directives

    - -

    Enabling Status Support

    +

    Directives

    Enabling Status Support

    To enable status reports only for browsers from the foo.com domain add this code to your httpd.conf configuration file -
    - - -
    +
    - -
    <Location /server-status>
    SetHandler server-status
    -
    Order Deny,Allow
    Deny from all
    Allow from .foo.com
    </Location> -
    -
    +
    - -

    You can now access server statistics by using a Web browser +

    You can now access server statistics by using a Web browser to access the page - http://your.server.name/server-status -

    + http://your.server.name/server-status

    - -
    - - -
    -

    Note that mod_status will only work +

    - -

    Note that mod_status will only work when you are running Apache in standalone mode and not - inetd mode.

    -
    -
    - + inetd mode.

    Automatic Updates

    @@ -172,69 +89,19 @@ performance. /support directory of Apache, log_server_status. -
    - - -
    +
    - -
    It should be noted that if mod_status is compiled into the server, its handler capability is available in all configuration files, including per-directory files (e.g., .htaccess). This may have security-related ramifications for your site. -
    -
    - - -
    -

    -ExtendedStatus Directive -

    - - -
    - - -
    Description: This directive controls whether the server keeps track of +
    + +

    ExtendedStatus Directive

    - -
    - - - - - - - - - - - - - - - - - - - -
    Description: This directive controls whether the server keeps track of extended status information for each request. This is only -useful if the status module is enabled on the server.
    Syntax: -ExtendedStatus On|Off -
    Default:ExtendedStatus Off
    Context:server config
    Status:Base
    Module:mod_status
    Compatibility:ExtendedStatus is only available in Apache 1.3.2 and -later.
    -
    - - -

    This setting applies to the entire server, and cannot be +useful if the status module is enabled on the server.

    Syntax:ExtendedStatus On|Off
    Default:ExtendedStatus Off
    Context:server config
    Status:Base
    Module:mod_status
    Compatibility:ExtendedStatus is only available in Apache 1.3.2 and +later.
    +

    This setting applies to the entire server, and cannot be enabled or disabled on a virtualhost-by-virtualhost basis.

    - -     -
    -

    Apache HTTP Server Version 2.0

    -IndexHome -
    - - +

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mod_suexec.html b/docs/manual/mod/mod_suexec.html index d9435e0092..9fdd2e2335 100644 --- a/docs/manual/mod/mod_suexec.html +++ b/docs/manual/mod/mod_suexec.html @@ -1,107 +1,16 @@ - - - - -mod_suexec - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module mod_suexec

    - - - - -
    - - - - - - - - - - - - - -
    Description: -This module allows CGI scripts to run as a specified user -and Group. -
    Status:Extension
    Module Identifier:suexec_module
    Compatibility: -Available in Apache 2.0 and later -
    -
    -

    Summary

    - - -

    This module allows CGI scripts to run as a specified user +-->mod_suexec - Apache HTTP Server

    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_suexec

    Description:This module allows CGI scripts to run as a specified user +and Group.
    Status:Extension
    Module Identifier:suexec_module
    Compatibility:Available in Apache 2.0 and later

    Summary

    +

    This module allows CGI scripts to run as a specified user and Group.

    - -     -

    Directives

    - -
    -

    -SuexecUserGroup Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - - - - -
    Description:
    Syntax: -SuexecUserGroup User Group - -
    Default:None
    Context:server config, virtual host
    Status:Extension
    Module:mod_suexec
    Compatibility:SuexecUserGroup is only available in 2.0 and -later.
    -
    - - -

    The SuexecUserGroup directive allows you to +

    Directives

    SuexecUserGroup Directive

    Description:
    Syntax:SuexecUserGroup User Group
    Default:None
    Context:server config, virtual host
    Status:Extension
    Module:mod_suexec
    Compatibility:SuexecUserGroup is only available in 2.0 and +later.
    +

    The SuexecUserGroup directive allows you to specify a user and group for CGI programs to run as. Non-CGI requests are still processes with the user specified in the User directive. This directive replaces using the User and Group directives inside of VirtualHosts.

    - -     -
    -

    Apache HTTP Server Version 2.0

    -IndexHome -
    - - +

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mod_unique_id.html b/docs/manual/mod/mod_unique_id.html index 4bec0ea316..02191fee7b 100644 --- a/docs/manual/mod/mod_unique_id.html +++ b/docs/manual/mod/mod_unique_id.html @@ -1,50 +1,11 @@ - - - - -mod_unique_id - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module mod_unique_id

    - - - - -
    - - - - - - - - - - - - - -
    Description: -This module provides an environment variable with a unique -identifier for each request. -
    Status:Extension
    Module Identifier:unique_id_module
    Compatibility: -Available in Apache 1.3 and later. -
    -
    -

    Summary

    - +-->mod_unique_id - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_unique_id

    Description:This module provides an environment variable with a unique +identifier for each request.
    Status:Extension
    Module Identifier:unique_id_module
    Compatibility:Available in Apache 1.3 and later.

    Summary

    - -

    This module provides a magic token for each request which is +

    This module provides a magic token for each request which is guaranteed to be unique across "all" requests under very specific conditions. The unique identifier is even unique across multiple machines in a properly configured cluster of @@ -52,15 +13,10 @@ identifier for each request. set to the identifier for each request. Unique identifiers are useful for various reasons which are beyond the scope of this document.

    - -     -

    Directives

    -

    This module provides no directives.

    -

    Theory

    +

    Directives

    This module provides no directives.

    Theory

    - -

    First a brief recap of how the Apache server works on Unix +

    First a brief recap of how the Apache server works on Unix machines. This feature currently isn't supported on Windows NT. On Unix machines, Apache creates several children, the children process requests one at a time. Each child can serve multiple @@ -68,8 +24,7 @@ identifier for each request. the children don't share any data with each other. We'll refer to the children as httpd processes.

    - -

    Your website has one or more machines under your +

    Your website has one or more machines under your administrative control, together we'll call them a cluster of machines. Each machine can possibly run multiple instances of Apache. All of these collectively are considered "the @@ -78,40 +33,32 @@ identifier for each request. without extensive communication between machines in the cluster.

    - -

    The machines in your cluster should satisfy these +

    The machines in your cluster should satisfy these requirements. (Even if you have only one machine you should synchronize its clock with NTP.)

    - -
      - -
    • The machines' times are synchronized via NTP or other +
        +
      • The machines' times are synchronized via NTP or other network time protocol.
        • - -
      • The machines' hostnames all differ, such that the module +
      • The machines' hostnames all differ, such that the module can do a hostname lookup on the hostname and receive a different IP address for each machine in the cluster.
        • - -
      +
    - -

    As far as operating system assumptions go, we assume that +

    As far as operating system assumptions go, we assume that pids (process ids) fit in 32-bits. If the operating system uses more than 32-bits for a pid, the fix is trivial but must be performed in the code.

    - -

    Given those assumptions, at a single point in time we can +

    Given those assumptions, at a single point in time we can identify any httpd process on any machine in the cluster from all other httpd processes. The machine's IP address and the pid of the httpd process are sufficient to do this. So in order to generate unique identifiers for requests we need only distinguish between different points in time.

    - -

    To distinguish time we will use a Unix timestamp (seconds +

    To distinguish time we will use a Unix timestamp (seconds since January 1, 1970 UTC), and a 16-bit counter. The timestamp has only one second granularity, so the counter is used to represent up to 65536 values during a single second. The @@ -120,8 +67,7 @@ identifier for each request. process. There are issues however with pid reuse over time, and the counter is used to alleviate this issue.

    - -

    When an httpd child is created, the counter is initialized +

    When an httpd child is created, the counter is initialized with ( current microseconds divided by 10 ) modulo 65536 (this formula was chosen to eliminate some variance problems with the low order bits of the microsecond timers on some systems). When @@ -130,8 +76,7 @@ identifier for each request. incremented every time an identifier is generated (and allowed to roll over).

    - -

    The kernel generates a pid for each process as it forks the +

    The kernel generates a pid for each process as it forks the process, and pids are allowed to roll over (they're 16-bits on many Unixes, but newer systems have expanded to 32-bits). So over time the same pid will be reused. However unless it is @@ -141,8 +86,7 @@ identifier for each request. be 32768 processes on some Unixes, but even this isn't likely to happen).

    - -

    Suppose that time repeats itself for some reason. That is, +

    Suppose that time repeats itself for some reason. That is, suppose that the system's clock is screwed up and it revisits a past time (or it is too far forward, is reset correctly, and then revisits the future time). In this case we can easily show @@ -155,8 +99,7 @@ identifier for each request. time, at least at one second resolution, has repeated itself). This is not a perfect defense.

    - -

    How good a defense is it? Suppose that one of your machines +

    How good a defense is it? Suppose that one of your machines serves at most 500 requests per second (which is a very reasonable upper bound at this writing, because systems generally do more than just shovel out static files). To do @@ -172,8 +115,7 @@ identifier for each request. such that it's still likely to occur, then perhaps you should make the counter 32 bits (by editing the code).

    - -

    You may be concerned about the clock being "set back" during +

    You may be concerned about the clock being "set back" during summer daylight savings. However this isn't an issue because the times used here are UTC, which "always" go forward. Note that x86 based Unixes may need proper configuration for this to @@ -182,8 +124,7 @@ identifier for each request. even still, if you're running NTP then your UTC time will be correct very shortly after reboot.

    - -

    The UNIQUE_ID environment variable is +

    The UNIQUE_ID environment variable is constructed by encoding the 112-bit (32-bit IP address, 32 bit pid, 32 bit time stamp, 16 bit counter) quadruple using the alphabet [A-Za-z0-9@-] in a manner similar to MIME @@ -201,8 +142,7 @@ identifier for each request. compared against other UNIQUE_IDs for equality only.

    - -

    The ordering was chosen such that it's possible to change +

    The ordering was chosen such that it's possible to change the encoding in the future without worrying about collision with an existing database of UNIQUE_IDs. The new encodings should also keep the time stamp as the first element, @@ -213,8 +153,7 @@ identifier for each request. encoding format. Afterwards they can resume requests and begin issuing the new encodings.

    - -

    This we believe is a relatively portable solution to this +

    This we believe is a relatively portable solution to this problem. It can be extended to multithreaded systems like Windows NT, and can grow with future needs. The identifiers generated have essentially an infinite life-time because future @@ -227,10 +166,4 @@ identifier for each request. shortened, but more information needs to be assumed (for example the 32-bit IP address is overkill for any site, but there is no portable shorter replacement for it).

    - -
    -

    Apache HTTP Server Version 2.0

    -IndexHome -
    - - +

    Apache HTTP Server Version 2.0

    IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_userdir.html b/docs/manual/mod/mod_userdir.html index 7dd4ece574..fb51735aef 100644 --- a/docs/manual/mod/mod_userdir.html +++ b/docs/manual/mod/mod_userdir.html @@ -1,132 +1,47 @@ - - - - -mod_userdir - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module mod_userdir

    - - - - -
    - - - - - - - - - - -
    Description: -This module provides for user-specific -directories. -
    Status:Base
    Module Identifier:userdir_module
    -
    -

    Summary

    - - - -

    Directives

    - -
    -

    -UserDir Directive -

    - - -
    - - -
    Description: Sets the directory from which to serve files when requests +-->mod_userdir - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_userdir

    Description:This module provides for user-specific +directories.
    Status:Base
    Module Identifier:userdir_module

    Summary

    +

    Directives

    UserDir Directive

    - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the directory from which to serve files when requests for a particular user are received, denoted by requests containing ~username, such as -http://server.example.com/~bob/
    Syntax: -UserDir directory-filename - -
    Default:UserDir public_html
    Context:server config, virtual -host
    Status:Base
    Module:mod_userdir
    Compatibility:All forms except the UserDir public_html +http://server.example.com/~bob/
    Syntax:UserDir directory-filename
    Default:UserDir public_html
    Context:server config, virtual +host
    Status:Base
    Module:mod_userdir
    Compatibility:All forms except the UserDir public_html form are only available in Apache 1.1 or above. Use of the enabled keyword, or disabled with a list of usernames, is only available in Apache 1.3 and -above.
    -
    - +above.
    - -

    The UserDir directive sets the real +

    The UserDir directive sets the real directory in a user's home directory to use when a request for a document for a user is received. Directory-filename is one of the following:

    - -
      - -
    • The name of a directory or a pattern such as those shown +
        +
      • The name of a directory or a pattern such as those shown below.
        • - -
      • The keyword disabled. This turns off +
      • The keyword disabled. This turns off all username-to-directory translations except those explicitly named with the enabled keyword (see below).
        • - -
      • The keyword disabled followed by a +
      • The keyword disabled followed by a space-delimited list of usernames. Usernames that appear in such a list will never have directory translation performed, even if they appear in an enabled clause.
        • - -
      • The keyword enabled followed by a +
      • The keyword enabled followed by a space-delimited list of usernames. These usernames will have directory translation performed even if a global disable is in effect, but not if they also appear in a disabled clause.
        • - -
      +
    - -

    If neither the enabled nor the +

    If neither the enabled nor the disabled keywords appear in the Userdir directive, the argument is treated as a filename pattern, and is used to turn the name into a directory @@ -134,79 +49,54 @@ above. http://www.foo.com/~bob/one/two.html will be translated to:

    - - - - - - - - - - - - - - - - - - - + + + + +
    UserDir directive usedTranslated path
    UserDir public_html~bob/public_html/one/two.html
    UserDir /usr/web/usr/web/bob/one/two.html
    UserDir /home/*/www/home/bob/www/one/two.html
    UserDir directive usedTranslated path
    UserDir public_html~bob/public_html/one/two.html
    UserDir /usr/web/usr/web/bob/one/two.html
    UserDir /home/*/www/home/bob/www/one/two.html
    - -

    The following directives will send redirects to the client:

    - +

    The following directives will send redirects to the client:

    - - - - - - - - - - - - - - - - - - + + + + +
    UserDir directive usedTranslated path
    UserDir http://www.foo.com/usershttp://www.foo.com/users/bob/one/two.html
    UserDir -http://www.foo.com/*/usrhttp://www.foo.com/bob/usr/one/two.html
    UserDir -http://www.foo.com/~*/http://www.foo.com/~bob/one/two.html
    UserDir directive usedTranslated path
    UserDir http://www.foo.com/usershttp://www.foo.com/users/bob/one/two.html
    UserDir +http://www.foo.com/*/usrhttp://www.foo.com/bob/usr/one/two.html
    UserDir +http://www.foo.com/~*/http://www.foo.com/~bob/one/two.html
    - -
    - - -
    +
    - -
    Be careful when using this directive; for instance, "UserDir ./" would map "/~root" to "/" - which is probably undesirable. If you are running Apache 1.3 or above, it is strongly recommended that your configuration include a "UserDir disabled root" declaration. - See also the Directory + See also the Directory directive and the Security Tips page for more information. -
    -
    +
    + +

    Additional examples:

    + +

    To allow a few users to have UserDir directories, but +not anyone else, use the following:

    + +
    +UserDir disabled
    +UserDir enabled user1 user2 user3 +
    + +

    To allow most users to have UserDir directories, but +deny this to a few, use the following:

    +
    +UserDir enabled
    +UserDir disabled user4 user5 user6 +
    -     -
    -

    Apache HTTP Server Version 2.0

    -IndexHome -
    - - +

    Apache HTTP Server Version 2.0

    IndexHome \ No newline at end of file diff --git a/docs/manual/mod/mod_vhost_alias.html b/docs/manual/mod/mod_vhost_alias.html index 95e8333aff..4071e06f74 100644 --- a/docs/manual/mod/mod_vhost_alias.html +++ b/docs/manual/mod/mod_vhost_alias.html @@ -1,37 +1,9 @@ - - - - - - - Apache module mod_vhost_alias - - - - - - -

    Module mod_vhost_alias

    - -

    This module provides support for dynamically configured mass virtual - hosting.

    - -

    Status: Extension
    - Source File: - mod_vhost_alias.c
    - Module Identifier: - vhost_alias_module
    - Compatibility: Available in - Apache 1.3.7 and later.

    - -

    Summary

    +mod_vhost_alias - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mod_vhost_alias

    Description:This module provides support for dynamically configured mass virtual +hosting.
    Status:Extension
    Module Identifier:vhost_alias_module
    Compatibility:Available in Apache 1.3.7 and later.

    Summary

    This module creates dynamically configured virtual hosts, by allowing the IP address and/or the Host: header of @@ -39,51 +11,31 @@ determine what files to serve. This allows for easy use of a huge number of virtual hosts with similar configurations.

    -

    Directives

    - - + See also: UseCanonicalName. -

    See also: UseCanonicalName.

    - -

    Directory Name Interpolation

    +

    Directives

    Directory Name Interpolation

    +

    All the directives in this module interpolate a string into a pathname. The interpolated string (henceforth called the - "name") may be either the server name (see the UseCanonicalName + "name") may be either the server name (see the UseCanonicalName directive for details on how this is determined) or the IP address of the virtual host on the server in dotted-quad format. The interpolation is controlled by specifiers inspired by printf which have a number of formats:

    -
    -
    %%
    - -
    insert a %
    - -
    %p
    + -
    insert the port number of the virtual host
    + + -
    %N.M
    + + -
    insert (part of) the name
    - -
    -
    + + +
    %%insert a %
    %pinsert the port number of the virtual host
    %N.Minsert (part of) the name

    N and M are used to specify substrings of the name. N selects from the @@ -93,97 +45,96 @@ present; the dot must be present if and only if M is present. The interpretation is as follows:

    -
    -
    0
    - -
    the whole name
    - -
    1
    - -
    the first part
    - -
    2
    - -
    the second part
    - -
    -1
    - -
    the last part
    + + + -
    -2
    + + -
    the penultimate part
    + + -
    2+
    + + -
    the second and all subsequent parts
    + + -
    -2+
    + + -
    the penultimate and all preceding parts
    + + -
    1+ and -1+
    + + +
    0the whole name
    1the first part
    2the second part
    -1the last part
    -2the penultimate part
    2+the second and all subsequent parts
    -2+the penultimate and all preceding parts
    1+ and -1+the same as 0
    -
    the same as 0
    -
    - If N or M is greater than the number - of parts available a single underscore is interpolated.
    -
    - +

    If N or M is greater than the number + of parts available a single underscore is interpolated.

    -

    Examples

    +

    Examples

    +

    For simple name-based virtual hosts you might use the following directives in your server configuration file:

    -
    -    UseCanonicalName    Off
+
+
    
+    UseCanonicalName    Off
    
     VirtualDocumentRoot /usr/local/apache/vhosts/%0
-
-    A request for
+
    
+
+    
    A request for
     http://www.example.com/directory/file.html will be
     satisfied by the file
     /usr/local/apache/vhosts/www.example.com/directory/file.html.
-    
    
-     
    
-     
+    
     
 
     
    For a very large number of virtual hosts it is a good idea
     to arrange the files to reduce the size of the
     vhosts directory. To do this you might use the
     following in your configuration file:
    
-
    -    UseCanonicalName    Off
+
+
    
+    UseCanonicalName    Off
    
     VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2
-
-    A request for
+
    
+
+    
    A request for
     http://www.example.isp.com/directory/file.html
     will be satisfied by the file
-    /usr/local/apache/vhosts/isp.com/e/x/a/example/directory/file.html.
-    A more even spread of files can be achieved by hashing from the
-    end of the name, for example: 
-
    +    /usr/local/apache/vhosts/isp.com/e/x/a/example/directory/file.html.
    
+
+    
    A more even spread of files can be achieved by hashing from the
+    end of the name, for example: 
    
+
+
    
     VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.-1/%2.-2/%2.-3/%2
-
-    The example request would come from
-    /usr/local/apache/vhosts/isp.com/e/l/p/example/directory/file.html.
-    Alternatively you might use: 
-
    +
    
+
+    
    The example request would come from
+    /usr/local/apache/vhosts/isp.com/e/l/p/example/directory/file.html.
    
+
+    
    Alternatively you might use: 
    
+
+
    
     VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2.4+
-
-    The example request would come from
-    /usr/local/apache/vhosts/isp.com/e/x/a/mple/directory/file.html.
-    
    
-     
    
-     
+
    
+
+    
    The example request would come from
+    /usr/local/apache/vhosts/isp.com/e/x/a/mple/directory/file.html.
    
 
     
    For IP-based virtual hosting you might use the following in
     your configuration file:
    
-
    -    UseCanonicalName DNS
-    VirtualDocumentRootIP   /usr/local/apache/vhosts/%1/%2/%3/%4/docs
+
+
    
+    UseCanonicalName DNS
    
+    VirtualDocumentRootIP   /usr/local/apache/vhosts/%1/%2/%3/%4/docs
    
     VirtualScriptAliasIP    /usr/local/apache/vhosts/%1/%2/%3/%4/cgi-bin
-
-    A request for
+
    
+
+    
    A request for
     http://www.example.isp.com/directory/file.html
     would be satisfied by the file
     /usr/local/apache/vhosts/10/20/30/40/docs/directory/file.html
@@ -191,147 +142,65 @@
     10.20.30.40. A request for
     http://www.example.isp.com/cgi-bin/script.pl would
     be satisfied by executing the program
-    /usr/local/apache/vhosts/10/20/30/40/cgi-bin/script.pl.
-    
    
-     
    
-     
+    /usr/local/apache/vhosts/10/20/30/40/cgi-bin/script.pl.
    
 
     
    If you want to include the . character in a
     VirtualDocumentRoot directive, but it clashes with
     a % directive, you can work around the problem in
     the following way:
    
-
    +
+
    
     VirtualDocumentRoot /usr/local/apache/vhosts/%2.0.%3.0
-
-    A request for
+
    
+
+    
    A request for
     http://www.example.isp.com/directory/file.html
     will be satisfied by the file
-    /usr/local/apache/vhosts/example.isp/directory/file.html.
-    
    
-     
    
+    /usr/local/apache/vhosts/example.isp/directory/file.html.
    
      
-
-    
    The LogFormat
-    directives %V and %A are useful
+    
    The LogFormat
+    directives %V and %A are useful
     in conjunction with this module.
    
-    
    
-
-    
    VirtualDocumentRoot
-    directive
    
-
-    
    Syntax: VirtualDocumentRoot
-    interpolated-directory
    
-     Default: None
    
-     Context: server config, virtual
-    host
    
-     Status: Extension
    
-     Module: mod_vhost_alias
    
-     Compatibility:
-    VirtualDocumentRoot is only available in 1.3.7 and later.
    
+
    VirtualDocumentRoot Directive
    Description: Dynamically configure the location of the document root
+for a given virtual host.
    Syntax:VirtualDocumentRoot interpolated-directory
    Default:none
    Context:server config, virtual host
    Override:
    Status:Extension
    Module:mod_vhost_alias
    Compatibility:VirtualDocumentRoot is only available in 1.3.7 and
+later.
    
 
     
    The VirtualDocumentRoot directive allows you to
     determine where Apache will find your documents based on the
     value of the server name. The result of expanding
     interpolated-directory is used as the root of the
-    document tree in a similar manner to the DocumentRoot
-    directive's argument. If interpolated-directory is
-    none then VirtaulDocumentRoot is
-    turned off. This directive cannot be used in the same context
-    as VirtualDocumentRootIP.
    
-    
    
-
-    
    VirtualDocumentRootIP
-    directive
    
-
-    
    Syntax: VirtualDocumentRootIP
-    interpolated-directory
    
-     Default: None
    
-     Context: server config, virtual
-    host
    
-     Status: Extension
    
-     Module: mod_vhost_alias
    
-     Compatibility:
-    VirtualDocumentRootIP is only available in 1.3.7 and later.
    
-
-    
    The VirtualDocumentRootIP directive is like the
-    VirtualDocumentRoot
+    document tree in a similar manner to the DocumentRoot directive's argument. 
+    If interpolated-directory is none then
+    VirtaulDocumentRoot is turned off. This directive 
+    cannot be used in the same context as
+    VirtualDocumentRootIP.
    
+
+
    VirtualDocumentRootIP Directive
    Description: Dynamically configure the location of the document root
+for a given virtual host
    Syntax:VirtualDocumentRootIP interpolated-directory
    Default:none
    Context:server config, virtual host
    Override:
    Status:Extension
    Module:mod_vhost_alias
    Compatibility:VirtualDocumentRootIP is only available in 1.3.7 
+and later.
    
+
+
    The VirtualDocumentRootIP directive is like the
+    VirtualDocumentRoot
     directive, except that it uses the IP address of the server end
     of the connection instead of the server name.
    
-    
    
-
-    
    VirtualScriptAlias directive
    
-
-    
    Syntax: VirtualScriptAlias
-    interpolated-directory
    
-     Default: None
    
-     Context: server config, virtual
-    host
    
-     Status: Extension
    
-     Module: mod_vhost_alias
    
-     Compatibility:
-    VirtualScriptAlias is only available in 1.3.7 and later.
    
+
    VirtualScriptAlias Directive
    Description: Dynamically configure the location of the CGI directory for
+a given virtual host.
    Syntax:VirtualScriptAlias interpolated-directory
    Default:none
    Context:server config, virtual host
    Override:
    Status:Extension
    Module:mod_vhost_alias
    Compatibility:VirtualScriptAlias is only available in 1.3.7
+and later.
    
 
     
    The VirtualScriptAlias directive allows you to
     determine where Apache will find CGI scripts in a similar
-    manner to VirtualDocumentRoot
+    manner to VirtualDocumentRoot
     does for other documents. It matches requests for URIs starting
-    /cgi-bin/, much like ScriptAlias
-    /cgi-bin/ would.
    
-    
    
-
-    
    VirtualScriptAliasIP
-    directive
    
-
-    
    Syntax: VirtualScriptAliasIP
-    interpolated-directory
    
-     Default: None
    
-     Context: server config, virtual
-    host
    
-     Status: Extension
    
-     Module: mod_vhost_alias
    
-     Compatibility:
-    VirtualScriptAliasIP is only available in 1.3.7 and later.
    
+    /cgi-bin/, much like ScriptAlias
+    /cgi-bin/ would.
    
+
+
    VirtualScriptAliasIP Directive
    Description: Dynamically configure the location of the cgi directory for
+a given virtual host.
    Syntax:VirtualScriptAliasIP interpolated-directory
    Default:none
    Context:server config, virtual host
    Override:
    Status:Extension
    Module:mod_vhost_alias
    Compatibility:VirtualScriptAliasIP is only available in 1.3.7 
+and later.
    
 
     
    The VirtualScriptAliasIP directive is like the
-    VirtualScriptAlias
+    VirtualScriptAlias
     directive, except that it uses the IP address of the server end
     of the connection instead of the server name.
    
 
-     
-  
-
-
+    
    Apache HTTP Server Version 2.0
    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mpm_common.html b/docs/manual/mod/mpm_common.html index 5ad70b1948..e439fbeec4 100644 --- a/docs/manual/mod/mpm_common.html +++ b/docs/manual/mod/mpm_common.html @@ -1,409 +1,99 @@ - - - - -mpm_common - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module mpm_common

    - - - - -
    - - - - - - - -
    Description: -A collection of directives that are implemented by -more than one multi-processing module (MPM) -
    Status:MPM
    -
    -

    Directives

    - -
    -

    -CoreDumpDirectory Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the directory where Apache attempts to -switch before dumping core
    Syntax: -CoreDumpDirectory directory - -
    Default:CoreDumpDirectory ServerRoot
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    -
    - +-->mpm_common - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mpm_common

    Description:A collection of directives that are implemented by +more than one multi-processing module (MPM)
    Status:MPM

    Directives

    CoreDumpDirectory Directive

    Description: Sets the directory where Apache attempts to +switch before dumping core
    Syntax:CoreDumpDirectory directory
    Default:CoreDumpDirectory ServerRoot
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    - -

    This controls the directory to which Apache attempts to +

    This controls the directory to which Apache attempts to switch before dumping core. The default is in the - ServerRoot directory, however + ServerRoot directory, however since this should not be writable by the user the server runs as, core dumps won't normally get written. If you want a core dump for debugging, you can use this directive to place it in a different location.

    - -     -
    -

    -Group Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the group under which the server will answer -requests
    Syntax: -Group unix-group - -
    Default:Group #-1
    Context:server config, virtual host
    Status:MPM
    Module:worker, perchild, prefork
    -
    - - -

    The Group directive sets the group under +

    Group Directive

    Description: Sets the group under which the server will answer +requests
    Syntax:Group unix-group
    Default:Group #-1
    Context:server config, virtual host
    Status:MPM
    Module:worker, perchild, prefork
    +

    The Group directive sets the group under which the server will answer requests. In order to use this directive, the stand-alone server must be run initially as root. Unix-group is one of:

    - -
    - -
    A group name
    +
    +
    A group name
    - -
    Refers to the given group by name.
    +
    Refers to the given group by name.
    - -
    # followed by a group number.
    +
    # followed by a group number.
    - -
    Refers to a group by its number.
    - -
    - -

    It is recommended that you set up a new group specifically for +

    Refers to a group by its number.
    +
    +

    It is recommended that you set up a new group specifically for running the server. Some admins use user nobody, but this is not always possible or desirable.

    - -

    Note: if you start the server as a non-root user, it will +

    Note: if you start the server as a non-root user, it will fail to change to the specified group, and will instead continue to run as the group of the original user.

    - -

    Special note: Use of this directive in <VirtualHost< is +

    Special note: Use of this directive in <VirtualHost< is no longer supported. To implement the suEXEC wrapper with Apache 2.0, use the - SuexecUserGroup - directive. SECURITY: See User for a discussion of the + SuexecUserGroup + directive. SECURITY: See User for a discussion of the security considerations.

    - -     -
    -

    -Listen Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: Sets the IP addresses and ports that the server -listens to
    Syntax: -Listen [IP-address:]portnumber - -
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    -
    - - -

    The Listen directive instructs Apache to +

    Listen Directive

    Description: Sets the IP addresses and ports that the server +listens to
    Syntax:Listen [IP-address:]portnumber
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    +

    The Listen directive instructs Apache to listen to only specific IP addresses or ports; by default it responds to requests on all IP interfaces. The Listen directive is now a required directive. If it is not in the config file, the server will fail to start. This is a change from previous versions of Apache.

    - -

    The Listen directive tells the server to accept incoming +

    The Listen directive tells the server to accept incoming requests on the specified port or address-and-port combination. If only a port number is specified, the server listens to the given port on all interfaces. If an IP address is given as well as a port, the server will listen on the given port and interface.

    - -

    Multiple Listen directives may be used to specify a number +

    Multiple Listen directives may be used to specify a number of addresses and ports to listen to. The server will respond to requests from any of the listed addresses and ports.

    - -

    For example, to make the server accept connections on both +

    For example, to make the server accept connections on both port 80 and port 8000, use:

    - -
    - - -
    +
    - -
    Listen 80
    Listen 8000 -
    -
    +
    To make the server accept connections on two specified interfaces and port numbers, use -
    - - -
    +
    - -
    Listen 192.170.2.1:80
    Listen 192.170.2.5:8000 -
    -
    +
    IPv6 addresses must be surrounded in square brackets, as in the following example: -
    - - -
    +
    - -
    Listen [fe80::a00:20ff:fea7:ccea]:80 -
    -
    - - -

    -See also: -

    - -
    -

    -ListenBackLog Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Maximum length of the queue of pending connections
    Syntax: -ListenBacklog backlog - -
    Default:ListenBacklog 511
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    -
    - - -

    The maximum length of the queue of pending connections. +

    +

    See also

    ListenBackLog Directive

    Description: Maximum length of the queue of pending connections
    Syntax:ListenBacklog backlog
    Default:ListenBacklog 511
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    +

    The maximum length of the queue of pending connections. Generally no tuning is needed or desired, however on some systems it is desirable to increase this when under a TCP SYN flood attack. See the backlog parameter to the listen(2) system call.

    - -

    This will often be limited to a smaller number by the +

    This will often be limited to a smaller number by the operating system. This varies from OS to OS. Also note that many OSes do not use exactly what is specified as the backlog, but use a number based on (but normally larger than) what is set.

    - -     -
    -

    -LockFile Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Location of the accept serialization lock file
    Syntax: -LockFile filename - -
    Default:LockFile logs/accept.lock
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork
    -
    - - -

    The LockFile directive sets the path to +

    LockFile Directive

    Description: Location of the accept serialization lock file
    Syntax:LockFile filename
    Default:LockFile logs/accept.lock
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork
    +

    The LockFile directive sets the path to the lockfile used when Apache is compiled with either USE_FCNTL_SERIALIZED_ACCEPT or USE_FLOCK_SERIALIZED_ACCEPT. This directive should normally be left at its default value. The main @@ -412,441 +102,114 @@ listens to disk. The PID of the main server process is automatically appended to the filename.

    - -

    -SECURITY: It is best to avoid putting this +

    SECURITY: It is best to avoid putting this file in a world writable directory such as /var/tmp because someone could create a denial of service attack and prevent the server from starting by creating a lockfile with the same name as the one the server will try to create.

    - - -
    -

    -MaxClients Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Maximum number of child processes that will be created -to serve requests
    Syntax: -MaxClients number - -
    Default:>MaxClients - 8 (with threads) MaxClients 256
    Context:server config
    Status:MPM
    Module:worker, prefork
    -
    - - -

    The MaxClients directive sets the limit +

    MaxClients Directive

    Description: Maximum number of child processes that will be created +to serve requests
    Syntax:MaxClients number
    Default:>MaxClients + 8 (with threads) MaxClients 256
    Context:server config
    Status:MPM
    Module:worker, prefork
    +

    The MaxClients directive sets the limit on the number of child processes that will be created to serve requests. When the server is built without threading, no more than this number of clients can be served simultaneously. To configure more than 256 clients with the prefork MPM, you must use the - ServerLimit directive. + ServerLimit directive. To configure more than 1024 clients with the worker MPM, you must - use the ServerLimit and - ThreadLimit directives.

    + use the ServerLimit and + ThreadLimit directives.

    - -

    Any connection attempts over the +

    Any connection attempts over the MaxClients limit will normally be queued, - up to a number based on the ListenBacklog directive. Once a child + up to a number based on the ListenBacklog directive. Once a child process is freed at the end of a different request, the connection will then be serviced.

    - -

    When the server is compiled with threading, then the maximum +

    When the server is compiled with threading, then the maximum number of simultaneous requests that can be served is obtained from the value of this directive multiplied by - ThreadsPerChild.

    - -     -
    -

    -MaxRequestPerChild Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Limit on the number of requests that an individual child server -will handle during its life
    Syntax: -MaxRequestsPerChild number - -
    Default:MaxRequestsPerChild 10000
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    -
    - - -

    The MaxRequestsPerChild directive sets + ThreadsPerChild.

    +

    MaxRequestsPerChild Directive

    Description: Limit on the number of requests that an individual child server +will handle during its life
    Syntax:MaxRequestsPerChild number
    Default:MaxRequestsPerChild 10000
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    +

    The MaxRequestsPerChild directive sets the limit on the number of requests that an individual child server process will handle. After MaxRequestsPerChild requests, the child process will die. If MaxRequestsPerChild is 0, then the process will never expire.

    - -

    Setting MaxRequestsPerChild to a +

    Setting MaxRequestsPerChild to a non-zero limit has two beneficial effects:

    - -
      - -
    • it limits the amount of memory that process can consume +
        +
      • it limits the amount of memory that process can consume by (accidental) memory leakage;
        • - -
      • by giving processes a finite lifetime, it helps reduce +
      • by giving processes a finite lifetime, it helps reduce the number of processes when the server load reduces.
        • - -
      +
    - -

    -NOTE: For KeepAlive requests, only +

    NOTE: For KeepAlive requests, only the first request is counted towards this limit. In effect, it changes the behavior to limit the number of connections per child.

    - -     -
    -

    -MaxSpareThreads Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Maximum number of idle threads
    Syntax: -MaxSpareThreads number - -
    Default:MaxSpareThreads 10 (Perchild) or 500 (worker)
    Context:server config
    Status:MPM
    Module:worker, perchild
    -
    - - -

    Maximum number of idle threads. Different MPMs deal with this +

    MaxSpareThreads Directive

    Description: Maximum number of idle threads
    Syntax:MaxSpareThreads number
    Default:MaxSpareThreads 10 (Perchild) or 500 (worker)
    Context:server config
    Status:MPM
    Module:worker, perchild
    +

    Maximum number of idle threads. Different MPMs deal with this directive differently. perchild monitors the number of idle threads on a per-child basis. If there are too many idle threads in that child, the server will begin to kill threads within that child.

    - -

    -worker deals with idle threads on a +

    worker deals with idle threads on a server-wide basis. If there are too many idle threads in the server then child processes are killed until the number of idle threads is less than this number.

    - -     -

    -See also: -

    - -
    -

    -MaxThreadsPerChild Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Maximum number of threads per child process
    Syntax: -MaxThreadsPerChild number - -
    Default:MaxThreadsPerChild 64
    Context:server config
    Status:MPM
    Module:worker, perchild
    -
    - - -

    Maximum number of threads per child. For MPMs with a +

    See also

    MaxThreadsPerChild Directive

    Description: Maximum number of threads per child process
    Syntax:MaxThreadsPerChild number
    Default:MaxThreadsPerChild 64
    Context:server config
    Status:MPM
    Module:worker, perchild
    +

    Maximum number of threads per child. For MPMs with a variable number of threads per child, this directive sets the maximum number of threads that will be created in each child process. To increase this value beyond its default, it is necessary to change the value of the compile-time define HARD_THREAD_LIMIT and recompile the server.

    - -     -
    -

    -MinSpareThreads Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Minimum number of idle threads available to handle request -spikes
    Syntax: -MinSpareServers number - -
    Default:MinSpareThreads 5 (Perchild) or 250 (worker)
    Context:server config
    Status:MPM
    Module:worker, perchild
    -
    - - -

    Minimum number of idle threads to handle request spikes. +

    MinSpareThreads Directive

    Description: Minimum number of idle threads available to handle request +spikes
    Syntax:MinSpareServers number
    Default:MinSpareThreads 5 (Perchild) or 250 (worker)
    Context:server config
    Status:MPM
    Module:worker, perchild
    +

    Minimum number of idle threads to handle request spikes. Different MPMs deal with this directive differently. perchild monitors the number of idle threads on a per-child basis. If there aren't enough idle threads in that child, the server will begin to create new threads within that child.

    - -

    -worker deals with idle threads on a +

    worker deals with idle threads on a server-wide basis. If there aren't enough idle threads in the server then child processes are created until the number of idle threads is greater than number.

    - -     -

    -See also: -

    - -
    -

    -NumServers Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Total number of children alive at the same time
    Syntax: -NumServers number - -
    Default:NumServers 2
    Context:server config
    Status:MPM
    Module:perchild
    -
    - - -

    Number of children alive at the same time. MPMs that use +

    See also

    NumServers Directive

    Description: Total number of children alive at the same time
    Syntax:NumServers number
    Default:NumServers 2
    Context:server config
    Status:MPM
    Module:perchild
    +

    Number of children alive at the same time. MPMs that use this directive do not dynamically create new child processes so this number should be large enough to handle the requests for the entire site.

    - -     -
    -

    -PidFile Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the file where the server records the process ID -of the daemon
    Syntax: -PidFile filename - -
    Default:PidFile logs/httpd.pid
    Context:server config
    Status:MPM
    Module:worker, perchilde, prefork, mpm_winnt
    -
    - - -

    The PidFile directive sets the file to +

    PidFile Directive

    Description: Sets the file where the server records the process ID +of the daemon
    Syntax:PidFile filename
    Default:PidFile logs/httpd.pid
    Context:server config
    Status:MPM
    Module:worker, perchilde, prefork, mpm_winnt
    +

    The PidFile directive sets the file to which the server records the process id of the daemon. If the filename does not begin with a slash (/) then it is assumed to be - relative to the ServerRoot.

    + relative to the ServerRoot.

    - -

    It is often useful to be able to send the server a signal, - so that it closes and then reopens its ErrorLog and TransferLog, and +

    It is often useful to be able to send the server a signal, + so that it closes and then reopens its ErrorLog and TransferLog, and re-reads its configuration files. This is done by sending a SIGHUP (kill -1) signal to the process id listed in the PidFile.

    - -

    The PidFile is subject to the same warnings about log file +

    The PidFile is subject to the same warnings about log file placement and security.

    - -     -
    -

    -ScoreBoardFile Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Location of the file used to store coordination data for -the child processes
    Syntax: -ScoreBoardFile file-path - -
    Default:ScoreBoardFile logs/apache_status
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork
    -
    - - -

    The ScoreBoardFile directive is required +

    ScoreBoardFile Directive

    Description: Location of the file used to store coordination data for +the child processes
    Syntax:ScoreBoardFile file-path
    Default:ScoreBoardFile logs/apache_status
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork
    +

    The ScoreBoardFile directive is required on some architectures to place a file that the server will use to communicate between its children and the parent. The easiest way to find out if your architecture requires a scoreboard file is to @@ -855,311 +218,73 @@ the child processes that this file is not used at the same time by more than one invocation of Apache.

    - -

    If you have to use a ScoreBoardFile then +

    If you have to use a ScoreBoardFile then you may see improved speed by placing it on a RAM disk. But be careful that you heed the same warnings about log file placement and security.

    - -     -

    -See also: -

    - -
    -

    -SendBufferSize Directive -

    - - - - -
    - - - - - - - - - - - - - - - - -
    Description: TCP buffer size
    Syntax: -SendBufferSize bytes - -
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    -
    - - -

    The server will set the TCP buffer size to the number of bytes +

    See also

    SendBufferSize Directive

    Description: TCP buffer size
    Syntax:SendBufferSize bytes
    Context:server config
    Status:MPM
    Module:worker, perchild, prefork, mpm_winnt
    +

    The server will set the TCP buffer size to the number of bytes specified. Very useful to increase past standard OS defaults on high speed high latency (i.e., 100ms or so, such as transcontinental fast pipes).

    - -     -
    -

    -ServerLimit Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Upper limit on configurable number of processes
    Syntax: -ServerLimit number - -
    Default:ServerLimit 256 (prefork), ServerLimit 16 (worker)
    Context:server config
    Status:MPM
    Module:worker, prefork
    -
    - - -

    For the prefork MPM, this directive sets the - maximum configured value for MaxClients for the lifetime of the +

    ServerLimit Directive

    Description: Upper limit on configurable number of processes
    Syntax:ServerLimit number
    Default:ServerLimit 256 (prefork), ServerLimit 16 (worker)
    Context:server config
    Status:MPM
    Module:worker, prefork
    +

    For the prefork MPM, this directive sets the + maximum configured value for MaxClients for the lifetime of the Apache process. For the worker MPM, this directive in combination - with ThreadLimit sets - the maximum configured value for MaxClients for the lifetime of the + with ThreadLimit sets + the maximum configured value for MaxClients for the lifetime of the Apache process. Any attempts to change this directive during a - restart will be ignored, but MaxClients can be modified during + restart will be ignored, but MaxClients can be modified during a restart.

    - -

    Special care must be taken when using this directive. If +

    Special care must be taken when using this directive. If ServerLimit is set to a value much higher than necessary, extra, unused shared memory will be allocated. If - both ServerLimit and MaxClients are set to values + both ServerLimit and MaxClients are set to values higher than the system can handle, Apache may not start or the system may become unstable.

    - -

    With the prefork MPM, use this directive only - if you need to set MaxClients higher higher than 256. +

    With the prefork MPM, use this directive only + if you need to set MaxClients higher higher than 256. Do not set the value of this directive any higher than what you - might want to set MaxClients to.

    + might want to set MaxClients to.

    - -

    With the worker MPM, use this directive only - if your MaxClients and - ThreadsPerChild +

    With the worker MPM, use this directive only + if your MaxClients and + ThreadsPerChild settings require more than 16 server processes. Do not set the value of this directive any higher than the number of server - processes required by what you may want for MaxClients and ThreadsPerChild.

    - -     -
    -

    -StartServers Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Number of child server processes created at startup
    Syntax: -StartServers number - -
    Default:StartServers 5
    Context:server config
    Status:MPM
    Module:worker
    -
    - - -

    The StartServers directive sets the + processes required by what you may want for MaxClients and ThreadsPerChild.

    +

    StartServers Directive

    Description: Number of child server processes created at startup
    Syntax:StartServers number
    Default:StartServers 5
    Context:server config
    Status:MPM
    Module:worker
    +

    The StartServers directive sets the number of child server processes created on startup. As the number of processes is dynamically controlled depending on the load, there is usually little reason to adjust this parameter.

    - -     -

    -See also: -

    - -
    -

    -StartThreads Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Nubmer of threads each child creates on startup
    Syntax: -StartThreads number - -
    Default:StartThreads 5
    Context:server config
    Status:MPM
    Module:perchild
    -
    - - -

    Number of threads each child creates on startup. As the +

    See also

    StartThreads Directive

    Description: Nubmer of threads each child creates on startup
    Syntax:StartThreads number
    Default:StartThreads 5
    Context:server config
    Status:MPM
    Module:perchild
    +

    Number of threads each child creates on startup. As the number of threads is dynamically controlled depending on the load, there is usually little reason to adjust this parameter.

    - -     -
    -

    -ThreadLimit Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Sets the upper limit on the configurable number of threads -per child process
    Syntax: -ThreadLimit number - -
    Default:ThreadLimit 64
    Context:server config
    Status:MPM
    Module:worker
    -
    - - -

    This directive sets the maximum configured value for ThreadsPerChild for the lifetime +

    ThreadLimit Directive

    Description: Sets the upper limit on the configurable number of threads +per child process
    Syntax:ThreadLimit number
    Default:ThreadLimit 64
    Context:server config
    Status:MPM
    Module:worker
    +

    This directive sets the maximum configured value for ThreadsPerChild for the lifetime of the Apache process. Any attempts to change this directive - during a restart will be ignored, but ThreadsPerChild can be modified + during a restart will be ignored, but ThreadsPerChild can be modified during a restart up to the value of this directive.

    - -

    Special care must be taken when using this directive. If +

    Special care must be taken when using this directive. If ThreadLimit is set to a value much higher - than ThreadsPerChild, + than ThreadsPerChild, extra unused shared memory will be allocated. If both - ThreadLimit and ThreadsPerChild are set to values + ThreadLimit and ThreadsPerChild are set to values higher than the system can handle, Apache may not start or the system may become unstable.

    - -

    Use this directive only if you need to set ThreadsPerChild higher than 64. Do +

    Use this directive only if you need to set ThreadsPerChild higher than 64. Do not set the value of this directive any higher than what you might - want to set ThreadsPerChild to.

    - -     -
    -

    -ThreadsPerChild Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Number of threads created by each child process
    Syntax: -ThreadsPerChild number - -
    Default:ThreadsPerChild 50
    Context:server config
    Status:MPM
    Module:worker, mpm_winnt
    -
    - - -

    This directive sets the number of threads created by each + want to set ThreadsPerChild to.

    +

    ThreadsPerChild Directive

    Description: Number of threads created by each child process
    Syntax:ThreadsPerChild number
    Default:ThreadsPerChild 50
    Context:server config
    Status:MPM
    Module:worker, mpm_winnt
    +

    This directive sets the number of threads created by each child process. The child creates these threads at startup and never creates more. if using an MPM like mpmt_winnt, where there is only one child process, this number should be high @@ -1167,67 +292,24 @@ per child process like worker, where there are multiple child processes, the total number of threads should be high enough to handle the common load on the server.

    - -     -
    -

    -User Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: The userid under which the server will answer -requests
    Syntax: -User unix-userid - -
    Default:User #-1
    Context:server config, virtual host
    Status:MPM
    Module:worker, perchild, prefork
    -
    - - -

    The User directive sets the userid as +

    User Directive

    Description: The userid under which the server will answer +requests
    Syntax:User unix-userid
    Default:User #-1
    Context:server config, virtual host
    Status:MPM
    Module:worker, perchild, prefork
    +

    The User directive sets the userid as which the server will answer requests. In order to use this directive, the standalone server must be run initially as root. Unix-userid is one of:

    - -
    - -
    A username
    +
    +
    A username
    - -
    Refers to the given user by name.
    +
    Refers to the given user by name.
    - -
    # followed by a user number.
    +
    # followed by a user number.
    - -
    Refers to a user by their number.
    - -
    +
    Refers to a user by their number.
    +
    - -

    The user should have no privileges which result in it being +

    The user should have no privileges which result in it being able to access files which are not intended to be visible to the outside world, and similarly, the user should not be able to execute code which is not meant for httpd requests. It is @@ -1235,41 +317,20 @@ requests running the server. Some admins use user nobody, but this is not always possible or desirable. For example mod_proxy's cache, when enabled, must be - accessible to this user (see CacheRoot).

    + accessible to this user (see CacheRoot).

    - -

    Notes: If you start the server as a non-root user, it will +

    Notes: If you start the server as a non-root user, it will fail to change to the lesser privileged user, and will instead continue to run as that original user. If you do start the server as root, then it is normal for the parent process to remain running as root.

    - -

    Special note: Use of this directive in <VirtualHost> is no longer supported. To +

    Special note: Use of this directive in <VirtualHost> is no longer supported. To configure your server for suexec use - SuexecUserGroup.

    + SuexecUserGroup.

    - -
    - - -
    -

    -Security -

    -

    Don't set User -(or Group) to +

    - -

    Security

    Don't set User +(or Group) to root unless you know exactly what you are doing, and what -the dangers are.

    -
    -
    - - -
    -

    Apache HTTP Server Version 2.0

    -IndexHome - - - +the dangers are.

    +

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/mpm_winnt.html b/docs/manual/mod/mpm_winnt.html index 7b8d24f5e7..618d41a51a 100644 --- a/docs/manual/mod/mpm_winnt.html +++ b/docs/manual/mod/mpm_winnt.html @@ -1,61 +1,11 @@ - - - - - - - Apache MPM pthread - - - - - - -

    Multi-Processing Module mpm_winnt

    - -

    This Multi-Processing Module is optimized for Windows - NT.

    - -

    Status: MPM
    - Source File: mpm_winnt.c
    - Module Identifier: - mpm_winnt_module

    - -

    Summary

    - +mpm_winnt - Apache HTTP Server
    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module mpm_winnt

    Description:This Multi-Processing Module is optimized for Windows + NT.
    Status:MPM
    Module Identifier:mpm_winnt_module

    Summary

    This Multi-Processing Module (MPM) is the default for the Windows NT operating systems. It uses a single control process which launches a single child process which in turn creates threads to handle requests

    - -

    Directives

    - - - - - - +

    Directives

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file diff --git a/docs/manual/mod/prefork.html b/docs/manual/mod/prefork.html index 606c477e25..0db2c66a68 100644 --- a/docs/manual/mod/prefork.html +++ b/docs/manual/mod/prefork.html @@ -1,49 +1,14 @@ - - - - -prefork - Apache HTTP Server - - - -
    -
    -[APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    -
    -

    Apache Module prefork

    - - - - -
    - - - - - - - - - - -
    Description: -Implements a non-threaded, pre-forking web server -
    Status:MPM
    Module Identifier:mpm_prefork_module
    -
    -

    Summary

    - - -

    This Multi-Processing Module (MPM) implements a +-->prefork - Apache HTTP Server

    [APACHE DOCUMENTATION]

    Apache HTTP Server Version 2.0

    Apache Module prefork

    Description:Implements a non-threaded, pre-forking web server
    Status:MPM
    Module Identifier:mpm_prefork_module

    Summary

    +

    This Multi-Processing Module (MPM) implements a non-threaded, pre-forking web server which handles request in a manner very similar to the default behavior of Apache 1.3 on Unix.

    - -

    A single control process is responsible for launching child +

    A single control process is responsible for launching child processes which listen for connections and serve them when they arrive. Apache always tries to maintain several spare or idle server processes, which stand ready to serve incoming @@ -51,25 +16,23 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX child processes to be forked before their requests can be served.

    - -

    The StartServers, - MinSpareServers, - MaxSpareServers, and - MaxClients regulate how +

    The StartServers, + MinSpareServers, + MaxSpareServers, and + MaxClients regulate how the parent process creates children to serve requests. In general, Apache is very self-regulating, so most sites do not need to adjust these directives from their default values. Sites which need to serve more than 256 simultaneous requests may need to - increase MaxClients, - while sites with limited memory may need to decrease MaxClients to keep the server from + increase MaxClients, + while sites with limited memory may need to decrease MaxClients to keep the server from thrashing (swapping memory to disk and back). More information about tuning process creation is provided in the performance hints documentation.

    - -

    While the parent process is usually started as root under Unix +

    While the parent process is usually started as root under Unix in order to bind to port 80, the child processes are launched by - Apache as a less-privileged user. The User and Group directives are used to set + Apache as a less-privileged user. The User and Group directives are used to set the privileges of the Apache child processes. The child processes must be able to read all the content that will be served, but should have as few privileges beyond that as possible. In @@ -77,110 +40,13 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX these directives also set the privileges which will be inherited by CGI scripts.

    - -

    -MaxRequestsPerChild +

    MaxRequestsPerChild controls how frequently the server recycles processes by killing old ones and launching new ones.

    - -     -

    -See also: -

    - -

    Directives

    - -
    -

    -AcceptMutex Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Method that Apache uses to serialize multiple children -accepting requests on network sockets
    Syntax: -AcceptMutex default|method - -
    Default:AcceptMutex default
    Context:server config
    Status:MPM
    Module:prefork
    -
    - - -

    The AcceptMutex directives sets the +

    See also

    Directives

    AcceptMutex Directive

    Description: Method that Apache uses to serialize multiple children +accepting requests on network sockets
    Syntax:AcceptMutex default|method
    Default:AcceptMutex default
    Context:server config
    Status:MPM
    Module:prefork
    +

    The AcceptMutex directives sets the method that Apache uses to serialize multiple children accepting requests on network sockets. Prior to Apache 2.0, the method was selectable only at compile time. The optimal method to use is @@ -188,177 +54,53 @@ accepting requests on network sockets see the performance tuning documentation.

    - -

    If this directive is set to default, then the +

    If this directive is set to default, then the compile-time selected default will be used. Other possible methods are listed below. Note that not all methods are available on all platforms. If a method is specified which is not available, a message will be written to the error log listing the available methods.

    - -
    - -
    -flock -
    +
    +
    flock
    - -
    uses the flock(2) system call to lock the - file defined by the LockFile directive.
    +
    uses the flock(2) system call to lock the + file defined by the LockFile directive.
    - -
    -fcntl -
    +
    fcntl
    - -
    uses the fnctl(2) system call to lock the - file defined by the LockFile directive.
    +
    uses the fnctl(2) system call to lock the + file defined by the LockFile directive.
    - -
    -sysvsem -
    +
    sysvsem
    - -
    uses SySV-style semaphores to implement the mutex.
    +
    uses SySV-style semaphores to implement the mutex.
    - -
    -pthread -
    +
    pthread
    - -
    uses POSIX mutexes as implemented by the POSIX Threads +
    uses POSIX mutexes as implemented by the POSIX Threads (PThreads) specification.
    - -
    - - -
    -

    -MaxSpareServers Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Maximum number of idle child server processes
    Syntax: -MaxSpareServers number -
    -     -
    Default:MaxSpareServers 10
    Context:server config
    Status:MPM
    Module:prefork
    -
    - - -

    The MaxSpareServers directive sets the +

    +

    MaxSpareServers Directive

    Description: Maximum number of idle child server processes
    Syntax:MaxSpareServers number
    Default:MaxSpareServers 10
    Context:server config
    Status:MPM
    Module:prefork
    +

    The MaxSpareServers directive sets the desired maximum number of idle child server processes. An idle process is one which is not handling a request. If there are more than MaxSpareServers idle, then the parent process will kill off the excess processes.

    - -

    Tuning of this parameter should only be necessary on very +

    Tuning of this parameter should only be necessary on very busy sites. Setting this parameter to a large number is almost always a bad idea.

    - -     -

    -See also: -

    - -
    -

    -MinSpareServers Directive -

    - - - - -
    - - - - - - - - - - - - - - - - - - - -
    Description: Minimum number of idle child server processes
    Syntax: -MinSpareServers number - -
    Default:MinSpareServers 5
    Context:server config
    Status:MPM
    Module:prefork
    -
    - - -

    The MinSpareServers directive sets the +

    See also

    MinSpareServers Directive

    Description: Minimum number of idle child server processes
    Syntax:MinSpareServers number
    Default:MinSpareServers 5
    Context:server config
    Status:MPM
    Module:prefork
    +

    The MinSpareServers directive sets the desired minimum number of idle child server processes. An idle process is one which is not handling a request. If there are fewer than MinSpareServers idle, then the parent process creates new children at a maximum rate of 1 per second.

    - -

    Tuning of this parameter should only be necessary on very +

    Tuning of this parameter should only be necessary on very busy sites. Setting this parameter to a large number is almost always a bad idea.

    - -

    This directive has no effect on Microsoft Windows.

    - -     -

    -See also: -

    - -
    -

    Apache HTTP Server Version 2.0

    -IndexHome -
    - - +

    This directive has no effect on Microsoft Windows.

    +

    See also

    Apache HTTP Server Version 2.0

    IndexHome
    \ No newline at end of file -- 2.40.0