-These configuration parameters control the core Apache features, and are -always available. -
-AccessFileName .htaccess- -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
-<Directory />
-AllowOverride None
-</Directory>
-- -
See Also: -AllowOverride
-AddDefaultCharset Off
-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 META tag. A setting
-of AddDefaultCharset Off disables this functionality.
-AddDefaultCharset On enables Apache's internal
-default charset of iso-8859-1 as required by the
-directive. You can also specify an alternate charset to be used;
-e.g. AddDefaultCharset utf-8.
-
- -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.
AllowOverride All- -
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
-.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 directive
-which has the .htaccess Context is allowed in .htaccess
-files.
The directive-type can be one of the following groupings -of directives.
-- -
See Also: -AccessFileName
-- -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 work.
-
-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 work.
- -The server comes with a built-in list of active modules. This -directive clears the list. It is assumed that the list will then be -re-populated using the AddModule directive.
ContentDigest off
-
-This directive enables the generation of Content-MD5 headers
-as defined in RFC1864 respectively RFC2068.
- -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 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 -since the message digest is computed on every request -(the values are not cached).
-
-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 text/html- -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 document, so in
-the event of an unknown type it uses the DefaultType. For
-example:
-
DefaultType image/gif- -<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 in a directory -context may be used. Directory is either the full path to a directory, -or a wild-card string. In a wild-card string, `?' matches any single character, -and `*' matches any sequences of characters. As of Apache 1.3, you -may 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 -behaviour of Unix shells. -Example: -
- <Directory /usr/local/httpd/htdocs> - Options Indexes FollowSymLinks - </Directory> -- -
Apache 1.2 and above:
-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.
-
-If multiple (non-regular expression) directory sections match the -directory (or its parents) containing -a document, then the directives are applied in the order of shortest match -first, interspersed with the directives from the -.htaccess files. For example, with -
-<Directory />
-AllowOverride None
-</Directory>
-<Directory /home/*>
-AllowOverride FileInfo
-</Directory>/home/web/dir/doc.html the
-steps are:
-
-
--Regular expression directory sections are handled slightly differently -by Apache 1.2 and 1.3. In Apache 1.2 they are interspersed with the normal -directory sections and applied in the order they appear in the configuration -file. They are applied only once, and apply when the shortest match -possible occurs. In Apache 1.3 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$>
-... directives here ...
-</Directory>
-/home/abc/public_html/abc/index.html. The server
-considers each of /, /home, /home/abc,
-/home/abc/public_html, and /home/abc/public_html/abc
-in that order. In Apache 1.2, when
-/home/abc is considered, the regular expression will match
-and be applied. In Apache 1.3 the regular expression isn't considered
-at all at that point in the tree. It 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 <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 - -
- <Directory /> - Order Deny,Allow - Deny from All - </Directory> --
- -and then override this for directories you want accessible. -See the -Security Tips -page for more details. - -
- -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 Directory, -Location and Files sections work for an explanation of how these -different sections are combined when a request is received - -
<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 takes as an -argument a regular expression. For example:
- -
- <DirectoryMatch "^/www/.*/[0-9]{3}">
-
-
-would match directories in /www/ that consisted of three numbers.
- -See Also:
-<Directory> for a description of how
-regular expressions are mixed in with normal <Directory>s.
-
-See also: How Directory,
-Location and Files sections work for an explanation of how these
-different sections are combined when a request is received
-
-
DocumentRoot
-/usr/local/apache/htdocs- -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/webhttp://www.my.host.com/index.html refers
-to /usr/web/index.html.
-
-There appears to be a bug in mod_dir which causes problems when the -DocumentRoot has a trailing slash (i.e., "DocumentRoot /usr/web/") so -please avoid that. - -
- -In the event of a problem or error, Apache can be configured to do -one of four things, - -
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 -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 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 document ends up being on the
-same server. This has several implications, the most important being
-that the client will not receive the original error status code, but
-instead will receive a redirect status code. This in turn can confuse
-web robots and other clients which try to determine if a URL is valid
-using the status code. In addition, if you use a remote URL in an
-ErrorDocument 401, the client will not 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.
-
-
-
Prior to version 2.0, messages were indicated by prefixing them -with a single unmatched double quote character. - -
See Also: documentation of customizable -responses.
ErrorLog logs/error_log (Unix)ErrorLog logs/error.log
- (Windows and OS/2)- -The error log directive sets the name of the file to which the server will log -any errors it encounters. If the filename does not begin with a slash (/) -then it is assumed to be relative to the ServerRoot. -If the filename begins with a pipe (|) then it is assumed to be a command to -spawn to handle the error log. - -
Apache 1.3 and above:
-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 -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: LogLevel -
- -
The <Files> directive provides for access control by
-filename. It is comparable to the <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 that
-<Files> can be nested inside <Directory>
-sections to restrict the portion of the filesystem they
-apply to.
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. - -
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: How Directory, -Location and Files sections work for an explanation of how these -different sections are combined when a request is received - -
- -
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: How Directory, -Location and Files sections work for an explanation of how these -different sections are combined when a request is received - -HostNameLookups offdouble available only in
-Apache
-1.3 and above.on prior to
-Apache 1.3.
-
-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 lookup is then
-performed on that result. At least one of the ip addresses in the forward
-lookup must match the original address. (In "tcpwrappers" terminology
-this is called PARANOID.)
-
-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 set HostnameLookups double. For example, if only
-HostnameLookups on and a request is made to an object that
-is protected by hostname restrictions, regardless of whether the
-double-reverse fails or not, CGIs will still be passed the single-reverse
-result in REMOTE_HOST.
-
-The default for this directive was previously on in
-versions of Apache prior to 1.3. It was changed to 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. Heavily loaded sites should leave this directive
-off, since DNS lookups can take considerable 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 off
-
-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. Boolean is either
-on or off.
- -The information should not be trusted in any way except for rudimentary usage -tracking.
- -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. -
- -
- -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 of two forms: - -
!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
-httpd command line via -Dparameter-, at the
-time the server was started.
-
-
<IfDefine> sections are nest-able, which can be used to implement -simple multiple-parameter tests. - -Example: - -
- $ httpd -DReverseProxy ... - - # httpd.conf - <IfDefine ReverseProxy> - LoadModule rewrite_module modules/mod_rewrite.so - LoadModule proxy_module modules/libproxy.so - </IfDefine> -- -
- -
- -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 of two forms: - -
In the former case, the directives between the start and end markers -are only processed if the module named module name is compiled -in to Apache. The second format reverses the test, and only processes -the directives if module name is not compiled in. - -
The module name argument is a module name as given as the file
-name of the module, at the time it was compiled. For example,
-mod_rewrite.c.
-
-
<IfModule> sections are nest-able, which can be used to implement -simple multiple-module tests. - -
-This directive allows inclusion of other configuration files from within the -server configuration files. - -
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.
-
-
KeepAlive On- -
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 almost 50% speedup in
-latency times for HTML documents with 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 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 advance. This implies that -dynamic content such as CGI output, SSI pages, and server-generated -directory listings will generally not use Keep-Alive connections to -HTTP/1.0 clients. For HTTP/1.1 clients, persistent connections are -the default 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 MaxKeepAliveRequests.
- -KeepAliveTimeout 15- -
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.
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.
-
-Access controls are normally effective for all access
-methods, and this is the usual desired behaviour. In the
-general case, access control directives should not be placed within a
-<limit> section.
-
-
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> bracket will have no effect. The -following 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>- -<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 both -standard and nonstandard/unrecognized methods. See the documentation for -<Limit> for more details. - -
LimitRequestBody 0- -
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 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 request exceeds that limit, -the server will return an error response instead of servicing the request. -The size of a normal request message body will vary greatly depending -on the nature of the resource and the methods allowed on that resource. -CGI scripts typically use the message body for passing form information -to the server. Implementations of the PUT method will require a value -at least as large as any representation that the server wishes -to accept for that resource. -
- -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 100- -
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 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 client request might include. The number of request header fields -used by a client rarely exceeds 20, but this may vary among different -client implementations, often depending upon the extent to which a user -has configured their browser to support detailed content negotiation. -Optional HTTP extensions are often expressed using request header fields. -
- -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 8190
-
-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 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 large enough to hold any one header field from a normal client -request. The size of a normal request header field will vary greatly -among different client implementations, often depending upon the extent -to which a user has configured their browser to support detailed -content negotiation. -
- -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 8190
-
-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 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 HTTP method, URI, and protocol version, the -LimitRequestLine directive places a restriction on the length of a -request-URI allowed for a request on the server. A server needs this -value to be large enough to 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 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 1000000Limit (in bytes) on maximum size of an XML-based request body.
- -- -
The <Location> directive provides for access control by
-URL. It is similar to the <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.
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 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 any -single character, and `*' matches any sequences of characters. - -
Apache 1.2 and above:
-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
-"/special/data". In Apache 1.3 and above, a new directive
-<LocationMatch> exists which
-behaves identical to the regex version of
-<Location>.
-
-
The Location functionality is especially useful when
-combined with the 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> -- -
Apache 1.3 and above note about / (slash): The slash
-character has special
-meaning depending on where in a URL it appears. People may be used
-to its behaviour 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 version of <Location> require you
-to explicitly specify multiple slashes if that is your intention.
-For example, <LocationMatch ^/abc> would match the
-request URL /abc but not the request URL //abc.
-The (non-regex) <Location> directive behaves
-similarly when used for proxy requests. But when (non-regex)
-<Location> is used for non-proxy requests it 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: How Directory, -Location and Files sections work for an explanation of how these -different sections are combined when a request is received - -
- -
The <LocationMatch> directive provides for access control by -URL, in an identical manner to <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" or -"/special/data".
- -See also: How Directory, -Location and Files sections work for an explanation of how these -different sections are combined when a request is received - -LogLevel errorLogLevel 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 - | Description - |
|---|---|
| Example - | |
emerg
- | Emergencies - system is unusable. - |
| "Child cannot open lock file. Exiting" - | |
alert
- | Action must be taken immediately. - |
| "getpwuid: couldn't determine user name from uid" - | |
crit
- | Critical Conditions. - |
| "socket: Failed to get a socket, exiting child" - | |
error
- | Error conditions. - |
| "Premature end of script headers" - | |
warn
- | Warning conditions. - |
| "child process 1234 did not exit, sending another SIGHUP" - | |
notice
- | Normal but significant condition. - |
| "httpd: caught SIGBUS, attempting to dump core in ..." - | |
info
- | Informational. - |
| "Server seems busy, (you may need to increase StartServers, or - Min/MaxSpareServers)..." - | |
debug
- | Debug-level messages - |
| "Opening config file ..." - |
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 recommended.
-
MaxKeepAliveRequests 100The MaxKeepAliveRequests directive limits the number of requests
-allowed per connection when 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.
- -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. - -
NameVirtualHost 111.22.33.44- -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. - -
NameVirtualHost 111.22.33.44:8080- -The Options directive controls which server features are available in -a particular directory. -
-option can be set to None, in which case none of
-the extra features are enabled, or one or more of the following:
-
<Directory>
-sections.
-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 - symbol, the options are
-merged. Any options preceded by a + are added to the options
-currently in force, and any options preceded by a - are removed from
-the options currently in force. - -For example, without any + and - symbols: - -
-<Directory /web/docs>
-Options Indexes FollowSymLinks
-</Directory>
-<Directory /web/docs/spec>
-Options Includes
-</Directory>
-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>
-FollowSymLinks and Includes
-are set for the /web/docs/spec directory.
-
-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 All.
-
Port 80
-
-Number is a number from 0 to 65535; some port numbers
-(especially below
-1024) are reserved for particular protocols. See /etc/services
-for a list of some defined ports; the standard port for the http protocol
-is 80.
- -The Port directive has two behaviors, the first of which is necessary for -NCSA backwards compatibility (and which is confusing in the context of -Apache).
- -
:number then Port has no effect on what address the server
-listens at.
-
-SERVER_PORT environment variable (for
-CGI and SSI),
-and is used when the server must generate a URL that refers to itself
-(for example when creating an external redirect to itself). This
-behaviour is modified by
-UseCanonicalName.
-- -The primary behaviour of Port should be considered to be similar to that of -the ServerName directive. The ServerName -and Port together specify what you consider to be the canonical -address of the server. -(See also UseCanonicalName.)
- -Port 80 is one of Unix's special ports. All ports numbered below 1024 -are reserved for system use, i.e., regular (non-root) users -cannot make use of them; instead they can only use higher port -numbers. To use port 80, you must start the server from the root -account. After binding to the port and before accepting requests, -Apache will change to a low privileged user as set by the User directive.
- -If you cannot use port 80, choose any other unused port. Non-root users -will have to choose a port number higher than 1023, such as 8000.
- -SECURITY: if you do start the server as root, be sure not to set User to root. If you run the server as -root whilst handling connections, your site may be open to a major -security attack.
- -This directive selects which authenticated users can access a directory. -The allowed syntaxes are: -
-Only the named users can access the directory.
-
-Only users in the named groups can access the directory.
-
-All valid users can access the directory. -
-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
-Require statement into a <Limit> section-
See also Satisfy and mod_access. -
- -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 be set to the maximum allowed by the operating system -configuration. Raising the maximum resource limit requires that the server -is running as root, or in the initial startup phase.
- -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 process.
- -See also RLimitMEM or -RLimitNPROC.
- -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 be set to the maximum allowed by the operating system -configuration. Raising the maximum resource limit requires that the -server is running as root, or in the initial startup phase.
- -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 process.
- -See also RLimitCPU or -RLimitNPROC.
-
-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 be set to the maximum allowed by the operating system
-configuration. Raising the maximum resource limit requires that the server
-is running as root, or in the initial startup phase.
- -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.
- -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 RLimitMEM or -RLimitCPU. - -
-
-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 the
-default behavior ("all") is to require that the client passes the
-address access restriction and enters a valid username and
-password. With the "any" option the client will be granted access if
-they either pass the host restriction or enter a 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.
-
-See also Require and -mod_access. - -
ScriptInterpreterSource script
-- -This directive is used to control how Apache 1.3.5 and later 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. -
- -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- -The ServerAlias directive sets the alternate names for a host, for use -with -name-based virtual hosts. - -
See also: -Apache Virtual Host documentation - -
- -The ServerName directive sets the hostname of the server; this is -used when creating redirection URLs. If it is not specified, then the -server attempts to deduce it from its own IP address; however this may -not work reliably, or may not return the preferred hostname. For example: -
ServerName www.example.comsimple.example.com.
-
-If you are using name-based
-virtual hosts, the ServerName inside a
-<VirtualHost>
-section specifies what hostname must appear in the request's
-Host: header to match this virtual host.
- -
See Also:
-DNS Issues
-Apache virtual host documentation
-UseCanonicalName
-NameVirtualHost
-ServerAlias
-
- -The ServerPath directive sets the legacy URL pathname for a host, for -use with name-based virtual hosts. - -
See also: -Apache Virtual Host documentation - -
ServerRoot /usr/local/apache
-
-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 the -d option to httpd.
-See also the security tips -for information on how to properly set permissions on the ServerRoot.
- -
ServerSignature Off
-
-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 such a footer line is that in a chain
-of proxies, the user often has no possibility to tell which of the
-chained servers actually produced a returned error message.
-The Off 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, and
-the EMail setting additionally creates a "mailto:"
-reference to the ServerAdmin of the
-referenced document.
-
-
ServerTokens FullProductOnly keyword is
- only available in versions later than 1.3.12
-
--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]
- ServerTokens Min[imal]
- ServerTokens OS
- ServerTokens Full (or not specified)
- -This setting applies to the entire server, and cannot be enabled or -disabled on a virtualhost-by-virtualhost basis. -
- -Syntax: SetInputFilter filter
-[filter] ...
-Default: none
-Context: directory
-Status: core
The SetInputFilter directive sets the filters
-which will process client requests when they are received by the
-server.
The order of the arguments determines the order in which the -filters will process the content.
- -See also the Filters documentation.
- - -Syntax: SetOutputFilter filter
-[filter] ...
-Default: none
-Context: directory
-Status: core
The SetOutputFilter directive sets the filters which
-will process responses from the server before they are sent to the
-client. For example, the following configuration will process
-all files in the /www/data/ directory for
-server-side includes.
-<Directory /www/data/>
- SetOutputFilter INCLUDES
-</Directory>
-The order of the arguments determines the order in which the -filters will process the content.
- -See also the Filters documentation.
- -TimeOut 300- -The TimeOut directive currently defines the amount of time Apache will -wait for three things: - -
UseCanonicalName on
-
-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 (and in all versions prior to
-1.3) Apache will use the ServerName and Port directives 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
-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
-implement name based virtual
-hosts, and are available with the same clients. The CGI variables
-SERVER_NAME and SERVER_PORT will be constructed
-from the client supplied values as well.
-
-
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 http://www/splat,
-without the trailing slash then Apache will redirect them to
-http://www.domain.com/splat/. If you have authentication
-enabled, this will cause the user to have to reauthenticate twice (once
-for www and once again for www.domain.com).
-But if UseCanonicalName is set off, then Apache will redirect
-to http://www/splat/.
-
-
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 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: -ServerName, -Port - -
- -<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 used. -When the server receives a request for a document on a particular virtual -host, it uses the configuration directives enclosed in the <VirtualHost> -section. Addr can be -
Example: -
-
-<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>
-
-
-Each VirtualHost 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 not have multiple network interfaces,
-then this can be 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 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 matched.
-If unspecified then it defaults to the same port as the most recent
-Port 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 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 affect what addresses Apache listens on. You may -need to ensure that Apache is listening on the correct addresses using -Listen. - -
See also:
-Apache Virtual Host documentation
-See also:
-Warnings about DNS and Apache
-See also:
-Setting which addresses and ports Apache uses
-See also: How Directory,
-Location and Files sections work for an explanation of how these
-different sections are combined when a request is received
-
- Each Apache configuration directive is described using a common format - that looks like this: -
-- Each of the directive's attributes, complete with possible values - where possible, are described in this document. -
- -- This indicates the format of the directive as it would appear in a - configuration file. This syntax is extremely directive-specific, - and is described in detail in the directive's definition. - Generally, the directive name is followed by a series of one or - more arguments. Optional arguments are enclosed in square brackets. - Where an argument can take on more than one possible value, possible - values are separated by a vertical bar. Literal text is presented - in the default font, while argument-types for which substitution - is necessary are emphasized. Directives which can take a variable - number of arguments will end in "..." indicating that the last - argument is repeated. -
- -- If the directive has a default value (i.e., if you omit it - from your configuration entirely, the Apache Web server will behave as - though you set it to a particular value), it is described here. If - there is no default value, this section should say - "None". -
- -- This indicates where in the server's configuration files the directive - is legal. It's a comma-separated list of one or more of the following - values: -
--
--
--
--
-- The directive is only allowed within the designated context; - if you try to use it elsewhere, you'll get a configuration error that - will either prevent the server from handling requests in that context - correctly, or will keep the server from operating at all -- - i.e., the server won't even start. -
-- The valid locations for the directive are actually the result of a - Boolean OR of all of the listed contexts. In other words, a directive - that is marked as being valid in "server config, - .htaccess" can be used in the httpd.conf file - and in .htaccess files, but not within any - <Directory> or <VirtualHost> containers. -
- -- This directive attribute indicates which configuration override must - be active in order for the directive to be processed when it appears - in a .htaccess file. If the directive's - context - doesn't permit it to appear in .htaccess files, this - attribute should say "Not applicable". -
-- Overrides are activated by the - AllowOverride - directive, and apply to a particular scope (such as a directory) and - all descendants, unless further modified by other - AllowOverride directives at lower levels. The - documentation for that directive also lists the possible override - names available. -
- -- This indicates how tightly bound into the Apache Web server the - directive is; in other words, you may need to recompile the server - with an enhanced set of modules in order to gain access to the - directive and its functionality. Possible values for this attribute - are: -
--
--
--
--
--
-- This quite simply lists the name of the source module which defines - the directive. -
- -- If the directive wasn't part of the original Apache version 1 - distribution, the version in which it was introduced should be listed - here. If the directive has the same name as one from the NCSA HTTPd - server, any inconsistencies in behaviour between the two should also - be mentioned. Otherwise, this attribute should say "No - compatibility issues." -
- - - diff --git a/docs/manual/mod/directive-dict.html.en b/docs/manual/mod/directive-dict.html.en deleted file mode 100644 index 8b2f6679fb..0000000000 --- a/docs/manual/mod/directive-dict.html.en +++ /dev/null @@ -1,283 +0,0 @@ - - - -- Each Apache configuration directive is described using a common format - that looks like this: -
-- Each of the directive's attributes, complete with possible values - where possible, are described in this document. -
- -- This indicates the format of the directive as it would appear in a - configuration file. This syntax is extremely directive-specific, - and is described in detail in the directive's definition. - Generally, the directive name is followed by a series of one or - more arguments. Optional arguments are enclosed in square brackets. - Where an argument can take on more than one possible value, possible - values are separated by a vertical bar. Literal text is presented - in the default font, while argument-types for which substitution - is necessary are emphasized. Directives which can take a variable - number of arguments will end in "..." indicating that the last - argument is repeated. -
- -- If the directive has a default value (i.e., if you omit it - from your configuration entirely, the Apache Web server will behave as - though you set it to a particular value), it is described here. If - there is no default value, this section should say - "None". -
- -- This indicates where in the server's configuration files the directive - is legal. It's a comma-separated list of one or more of the following - values: -
--
--
--
--
-- The directive is only allowed within the designated context; - if you try to use it elsewhere, you'll get a configuration error that - will either prevent the server from handling requests in that context - correctly, or will keep the server from operating at all -- - i.e., the server won't even start. -
-- The valid locations for the directive are actually the result of a - Boolean OR of all of the listed contexts. In other words, a directive - that is marked as being valid in "server config, - .htaccess" can be used in the httpd.conf file - and in .htaccess files, but not within any - <Directory> or <VirtualHost> containers. -
- -- This directive attribute indicates which configuration override must - be active in order for the directive to be processed when it appears - in a .htaccess file. If the directive's - context - doesn't permit it to appear in .htaccess files, this - attribute should say "Not applicable". -
-- Overrides are activated by the - AllowOverride - directive, and apply to a particular scope (such as a directory) and - all descendants, unless further modified by other - AllowOverride directives at lower levels. The - documentation for that directive also lists the possible override - names available. -
- -- This indicates how tightly bound into the Apache Web server the - directive is; in other words, you may need to recompile the server - with an enhanced set of modules in order to gain access to the - directive and its functionality. Possible values for this attribute - are: -
--
--
--
--
--
-- This quite simply lists the name of the source module which defines - the directive. -
- -- If the directive wasn't part of the original Apache version 1 - distribution, the version in which it was introduced should be listed - here. If the directive has the same name as one from the NCSA HTTPd - server, any inconsistencies in behaviour between the two should also - be mentioned. Otherwise, this attribute should say "No - compatibility issues." -
- - - diff --git a/docs/manual/mod/directives.html b/docs/manual/mod/directives.html deleted file mode 100644 index 40ec1b3cdd..0000000000 --- a/docs/manual/mod/directives.html +++ /dev/null @@ -1,246 +0,0 @@ - - - --Each Apache directive available in the standard Apache distribution is -listed here. They are described using a consistent format, and there is -a dictionary -of the terms used in their descriptions available. -
-
-
diff --git a/docs/manual/mod/header.html b/docs/manual/mod/header.html
deleted file mode 100644
index 9bc11593a3..0000000000
--- a/docs/manual/mod/header.html
+++ /dev/null
@@ -1,6 +0,0 @@
-![[APACHE DOCUMENTATION]](../images/sub.gif)
- -Below is a list of all of the modules that come as part of the Apache -distribution. See also the list of modules sorted alphabetically and the complete -alphabetical list of all Apache -directives. -
- --Below is a list of all of the modules that come as part of the Apache -distribution. See also the list of modules sorted by type and the complete -alphabetical list of all Apache -directives. - -
- --This module provides access control based on client hostname, IP -address, or other characteristics of the client request. -
- -Status: Base
-
-Source File: mod_access.c
-
-Module Identifier: access_module
-
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 specify which clients are or are not allowed access to the
-server, while the Order directive sets the
-default access state, and configures how the Allow
-and Deny directives interact with each other.
Both host-based access restrictions and password-based -authentication may be implemented simultaneously. In -that case, the Satisfy directive -is used to determine how the two sets of restrictions -interact.
- -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 Satisfy - and Require. - -
-
-Syntax: Allow from
- all|host|env=variablename
- [host|env=variablename] ...
-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 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 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:
Allow from
-apache.orgfoo.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 directive.Allow from 10.1.2.3Allow from 10.1Allow from 10.1.0.0/255.255.0.0Allow
-from 10.1.0.0/16Note that the last three examples above match exactly the -same set of hosts.
- -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=variablename is specified, then
-the request is allowed access if the environment variable
-variablename exists. The server provides the ability to set
-environment variables in a flexible way based on characteristics of
-the client request using the directives provided by mod_setenvif. Therefore, this directive
-can be used to allow access based on such factors as the clients
-User-Agent (browser type), Referer, or other
-HTTP request header fields.
-Example: -
-- --SetEnvIf User-Agent ^KnockKnock/2.0 let_me_in -<Directory /docroot> - Order Deny,Allow - Deny from all - Allow from env=let_me_in -</Directory> -
In this case, browsers with a user-agent string beginning with -KnockKnock/2.0 will be allowed access, and all others will be -denied.
--See also Deny, Order -and SetEnvIf. -
-
-
-Syntax: Deny from
- all|host|env=variablename
- [host|env=variablename] ...
-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.
See also Allow, Order -and SetEnvIf.
-
-
-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 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 directive will be
-allowed access to the server.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.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.
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 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 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, the Allow from
-apache.org will be evaluated last and will override the
-Deny from foo.apache.org. All hosts not in the
-apache.org domain will also be allowed access because the
-default state will change to allow.
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 on the default access state.
-For example,
-<Directory /www>
- Order Allow,Deny
-</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
-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 .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.
See also: Deny and Allow. - - - diff --git a/docs/manual/mod/mod_actions.html b/docs/manual/mod/mod_actions.html deleted file mode 100644 index 21f503db74..0000000000 --- a/docs/manual/mod/mod_actions.html +++ /dev/null @@ -1,140 +0,0 @@ - - -
-This module provides for executing CGI scripts based on media type or -request method. -
- -Status: Base
-
-Source File: mod_actions.c
-
-Module Identifier: actions_module
-
-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 you run CGI scripts whenever a particular method is -used in a request. This makes it much easier to execute scripts that -process files. -
- -
-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. -
-
-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 PUTand -Script puthave two entirely different effects. -
-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 will only be called if there are
-query arguments present (e.g., foo.html?hi). Otherwise, the request
-will proceed normally.
-
-Examples: -
-- # For <ISINDEX>-style searching - Script GET /cgi-bin/search - # A CGI PUT handler - Script PUT /~bob/put.cgi -- - - - diff --git a/docs/manual/mod/mod_alias.html b/docs/manual/mod/mod_alias.html deleted file mode 100644 index aa180f338b..0000000000 --- a/docs/manual/mod/mod_alias.html +++ /dev/null @@ -1,415 +0,0 @@ - - - -
-This module provides for mapping different parts of the -host filesystem in the document tree, and for URL redirection. -
- -Status: Base
-
-Source File: mod_alias.c
-
-Module Identifier: alias_module
-
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
-map between URLs and filesystem paths. This allows for content which
-is not directly under the DocumentRoot to be
-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 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 manipulating
-URLs is contained in the mod_rewrite module.
-
-
-
-
-Syntax: Alias url-path directory-filename
-Context: server config, virtual host
-Status: Base
-Module: mod_alias
-
-The Alias directive allows documents to be stored in the local filesystem -other than under the DocumentRoot. -URLs with a (%-decoded) path beginning with url-path will be -mapped to local files beginning with directory-filename. -
-Example: -
-Alias /image /ftp/pub/image-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 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 the destination of aliases. Aliasing occurs
-before <Directory> sections are checked, so only
-the destination of aliases are affected. (Note however
-<Location>
-sections are run through once before aliases are performed, so they
-will apply.)
-
-See also ScriptAlias. -
-
-Syntax: AliasMatch regex directory-filename
-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,
-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 -- - -
-
-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: -
-Redirect /service
-http://foo2.bar.com/service-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 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. -
--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: -
-
-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).
-
-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, -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 -- - -
-
-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.
-
-
-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.
-
-
-Syntax: ScriptAlias url-path directory-filename
-
-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. -URLs with a (%-decoded) path beginning with url-path will be -mapped to scripts beginning with directory-filename. -
-Example: -
-ScriptAlias /cgi-bin/ /web/cgi-bin/-A request for http://myserver/cgi-bin/foo would cause the server to -run the script /web/cgi-bin/foo. -
- -
-Syntax: ScriptAliasMatch
- regex directory-filename
-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,
-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 -- - - - - diff --git a/docs/manual/mod/mod_asis.html b/docs/manual/mod/mod_asis.html deleted file mode 100644 index 64b1298242..0000000000 --- a/docs/manual/mod/mod_asis.html +++ /dev/null @@ -1,91 +0,0 @@ - - - -
This module provides for sending files which contain their own -HTTP headers. - -
Status: Base
-
-Source File: mod_asis.c
-
-Module Identifier: asis_module
-
This module provides the handler send-as-is wich
-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, -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 file with
-the mime type httpd/send-as-is.
-
-
This module provides no directives. - -
In the server configuration file, associate files with the
-send-as-is handler e.g.
-
AddHandler send-as-is asis.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 is -so as to tell the client that a file has redirected. -
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>
-</HEAD>
-<BODY>
-<H1>Fred's exceptionally wonderful page has moved to
-<A HREF="http://xyz.abc.com/foo/bar.html">Joe's</A> site.
-</H1>
-</BODY>
-</HTML>
-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. - - - - diff --git a/docs/manual/mod/mod_auth.html b/docs/manual/mod/mod_auth.html deleted file mode 100644 index 04508d4468..0000000000 --- a/docs/manual/mod/mod_auth.html +++ /dev/null @@ -1,246 +0,0 @@ - - -
-This module provides for user authentication using text files. - -
Status: Base
-
-Source File: mod_auth.c
-
-Module Identifier: auth_module
-
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 and mod_auth_db. HTTP Digest Authentication -is provided by mod_auth_digest. - - -
See also: require -and satisfy.
- -- -The AuthGroupFile directive sets the name of a textual file containing the list -of user groups for user authentication. Filename 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. -
-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- -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.
- -See also AuthName, -AuthType and -AuthUserFile.
- -The AuthUserFile directive sets the name of a textual file containing -the list of users and passwords for user -authentication. Filename 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. -
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 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
-
-
--htpasswd -c Filename username
- Create a password file 'Filename' with 'username' - as the initial ID. It will prompt for the password. -htpasswd Filename username2
- Adds or modifies in password file 'Filename' the 'username'. -
Note that -searching large text files is very inefficient; -AuthDBMUserFile should be -used instead. -
- -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.
- -See also AuthName, -AuthType and -AuthGroupFile.
-
AuthAuthoritative on
-
-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
-modules.c files) if there is no userID or
-rule matching the supplied userID. If there is a userID and/or
-rule specified; the usual 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 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 database
-modules; such as mod_auth_db.c, mod_auth_dbm.c,
-mod_auth_msql.c, and mod_auth_anon.c. 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.
-
-
- -Default: 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 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 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. - -
-See also AuthName, -AuthType and -AuthGroupFile.
- - - - - diff --git a/docs/manual/mod/mod_auth_anon.html b/docs/manual/mod/mod_auth_anon.html deleted file mode 100644 index d5f28d6db8..0000000000 --- a/docs/manual/mod/mod_auth_anon.html +++ /dev/null @@ -1,322 +0,0 @@ - - -
-Status: Extension
-
-Source File: mod_auth_anon.c
-
-Module Identifier: anon_auth_module
-
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 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.
- -Anonymous_NoUserId)
-Anonymous_MustGiveEmail)
-Anonymous_VerifyEmail)
-anonymous guest www test welcome
-and comparison is not case sensitive.
-Anonymous_LogEmail)
--Excerpt of access.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
-# directive must be specified, or use
-# Anonymous_Authoritative for public access.
-# In the .htaccess for the public directory, add:
-<Files *>
-Order Deny,Allow
-Allow from all
-
-Require valid-user
-</Files>
-
- - 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 case-IN-sensitive.
-
- I strongly suggest that the magic username 'anonymous'
- is always one of the allowed userIDs.
-
- Example:
-
- Anonymous anonymous "Not Registered" 'I don\'t know'
-
- 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 off
-
- 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, access is denied.
-
- 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 on- - When set 'on', the default, the 'password' entered (which hopefully - contains a sensible email address) is logged in the error log. -
Anonymous_MustGiveEmail on- - Specifies whether the user must specify an email - address as the password. This prohibits blank passwords. -
Anonymous_NoUserID off- - 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. - -
Anonymous_VerifyEmail off
-
- 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).
-
-
-
-
-
-
-
diff --git a/docs/manual/mod/mod_auth_db.html b/docs/manual/mod/mod_auth_db.html
deleted file mode 100644
index 4d57738dcd..0000000000
--- a/docs/manual/mod/mod_auth_db.html
+++ /dev/null
@@ -1,250 +0,0 @@
-
-
-
This module provides for user authentication using Berkeley DB -files.
- -Status: Extension
-
-Source File: mod_auth_db.c
-
-Module Identifier: db_auth_module
-
This module provides an alternative to DBM files for those systems which support -DB and not DBM. It is only available in Apache 1.1 and later.
- -On some BSD systems (e.g., FreeBSD and NetBSD) dbm is -automatically mapped to Berkeley DB. You can use either mod_auth_dbm or mod_auth_db. The latter -makes it more obvious that it's Berkeley DB. On other platforms where -you want to use the DB library you usually have to install it -first. See http://www.sleepycat.com/ for the -distribution. The interface this module uses is the one from DB -version 1.85 and 1.86, but DB version 2.x can also be used when -compatibility mode is enabled.
- -See also: satisfy and -require.
- -- -The AuthDBGroupFile directive sets the name of a DB file containing the list -of user groups for user authentication. Filename is the absolute path -to the group file.
- -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 AuthDBGroupFile 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 -AuthDBGroupFile unless otherwise protected.
- -Combining Group and Password DB 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 deal with writing to and locking -a single DBM file. This can be accomplished by first setting the group -and password files to point to the same DB file:
- -
-AuthDBGroupFile /www/userbase
-AuthDBUserFile /www/userbase
-- -
-Unix Crypt-ed Password : List of Groups [ : (ignored) ]
-- -See also AuthName, -AuthType and -AuthDBUserFile.
- -The AuthDBUserFile directive sets the name of a DB file containing the list -of users and passwords for user authentication. Filename is the -absolute path to the user file.
- -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 AuthDBUserFile 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 -AuthDBUserFile.
- -Important compatibility note: The implementation of "dbmopen" in the -apache modules reads the string length of the hashed values from the -DB data structures, rather than relying upon the string being -NULL-appended. Some applications, such as the Netscape web server, -rely upon the string being NULL-appended, so if you are having trouble -using DB files interchangeably between applications this may be a -part of the problem.
- -
A perl script called -href="../programs/dbmmanage.html">dbmmanage is included with -Apache. This program can be used to create and update DB format -password files for use with this module.
- -See also AuthName, -AuthType and -AuthDBGroupFile.-
AuthDBAuthoritative on
-
-Setting the AuthDBAuthoritative directive explicitly to 'off'
-allows for both authentication and authorization to be passed on
-to lower level modules (as defined in the Configuration
-and modules.c file if there is no userID or
-rule matching the supplied userID. If there is a userID
-and/or rule specified; the usual 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 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 basic auth
-modules; such as mod_auth.c.
-Whereas this DB 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 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 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. - -
-See also AuthName, -AuthType and -AuthDBGroupFile.
- - - - - diff --git a/docs/manual/mod/mod_auth_dbm.html b/docs/manual/mod/mod_auth_dbm.html deleted file mode 100644 index 43cd444aa6..0000000000 --- a/docs/manual/mod/mod_auth_dbm.html +++ /dev/null @@ -1,242 +0,0 @@ - - -
-This module provides for user authentication using DBM files.
- -Status: Extension
-
-Source File: mod_auth_dbm.c
-
-Module Identifier: dbm_auth_module
-
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 and the Berkely DB password files -provided by mod_auth_db.
- -See also: Satisfy and -Require. -
- -The AuthDBMGroupFile directive sets the name of a DBM file containing the list -of user groups for user authentication. Filename is the absolute path -to the group file.
- -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 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 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 deal with writing to and locking -a single DBM file. This can be accomplished by first setting the group -and password files to point to the same DBM:
- -
-AuthDBMGroupFile /www/userbase
-AuthDBMUserFile /www/userbase
-- -
-Unix Crypt-ed Password : List of Groups [ : (ignored) ]
-- -See also AuthName, -AuthType and -AuthDBMUserFile.
- -The AuthDBMUserFile directive sets the name of a DBM file containing the list -of users and passwords for user authentication. Filename is the -absolute path to the user file.
- -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 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 "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 the Netscape web server, -rely upon the string being NULL-appended, so if you are having trouble -using DBM files interchangeably between applications this may be a -part of the problem.
- -
A perl script called -href="../programs/dbmmanage.html">dbmmanage is included with -Apache. This program can be used to create and update DBM format -password files for use with this module.
- -See also AuthName, -AuthType and -AuthDBMGroupFile.- -
AuthDBMAuthoritative on
-
-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 modules.c file if there is no userID or
-rule matching the supplied userID. If there is a userID
-and/or rule specified; the usual 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 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 basic auth
-modules; such as mod_auth.c.
-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 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 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. - -
-See also AuthName, -AuthType and -AuthDBMGroupFile.
- - - - - diff --git a/docs/manual/mod/mod_auth_digest.html b/docs/manual/mod/mod_auth_digest.html deleted file mode 100644 index 5cda2a778b..0000000000 --- a/docs/manual/mod/mod_auth_digest.html +++ /dev/null @@ -1,412 +0,0 @@ - - -
-This module provides for user authentication using MD5 Digest -Authentication.
- -Status: Experimental
-
-Source File: mod_auth_digest.c
-
-Module Identifier: digest_auth_module
-
This is an updated version of mod_digest. However, it has not been -extensively tested and is therefore marked experimental. If you use -this module, you must make sure to not use mod_digest -(because they share some of the same configuration directives). - -
See also: Require and -Satisfy. - -
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" - AuthDigestDomain /private/ http://mirror.my.dom/private2/ - AuthDigestFile /web/auth/.digest_pw - Require valid-user - </Location> -- -
Note: MD5 authentication provides a more secure -password system than Basic authentication, but only works with supporting -browsers. As of this writing (July 1999), the only major browsers which -support digest authentication are Internet Explorer 5.0 and -Amaya. Therefore, we do not -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. - - -
The AuthDigestFile directive sets the name of a textual file containing -the list of users and encoded passwords for digest authentication. -Filename is the absolute path to the user file. - -
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. - -
The AuthDigestGroupFile directive sets the name of a textual file -containing the list of groups and their members (user names). -Filename is the absolute path to the group file. - -
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 anneSecurity: 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. - -
AuthDigestQop authThe 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 is also computed and checked); none will cause the -module to use the old RFC-2069 digest algorithm (which does not include -integrity checking). Both auth and auth-int may be -specified, in which the case the browser will choose which of 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 yet. - -
AuthDigestNonceLifetime 300The 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 greater than 0 then it specifies the amount of
-time for which the nonce is valid; this should probably never be set
-to less than 10 seconds. If seconds is less than 0 then
-the nonce never expires.
-
-
-
-
AuthDigestNonceFormat ???Not implemented yet. - - -
AuthDigestNcCheck OffNot implemented yet. - - -
AuthDigestAlgorithm MD5The AuthDigestAlgorithm directive selects the algorithm used to calculate -the challenge and response hashes. - -
MD5-sess is not correctly implemented yet. - - -
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 URIs "below" these are also protected by the same -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 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 server. Apart from increasing the size of the request, it may also -have a detrimental effect on performance if "AuthDigestNcCheck" is on. - -
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. - - - - - - diff --git a/docs/manual/mod/mod_autoindex.html b/docs/manual/mod/mod_autoindex.html deleted file mode 100644 index fa6c224e71..0000000000 --- a/docs/manual/mod/mod_autoindex.html +++ /dev/null @@ -1,900 +0,0 @@ - - -
-Status: Base
-
-Source File: mod_autoindex.c
-
-Module Identifier: autoindex_module
-
index.html.
-The DirectoryIndex directive sets
-the name of this file.
-This is controlled by mod_dir.
-
-mod_autoindex.
--If -FancyIndexing -is enabled, or the FancyIndexing keyword is present on 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. -
--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". -
- - -See also: Options and DirectoryIndex.
- -
-
-This sets 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. String is enclosed in double quotes
-("). This alternate text is displayed if the client is
-image-incapable or has image loading disabled.
-
-
-
-This sets 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 quotes
-("). This alternate text is displayed if the client is
-image-incapable or has image loading disabled.
-
-
-
-This 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 quotes
-("). This alternate text is displayed if the client is
-image-incapable or has image loading disabled.
-
-
-
-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
-
-The description field is 23 bytes wide. 7 more bytes may be
-added if the directory is covered by an
-IndexOptions SuppressSize, and 19 bytes may be
-added if IndexOptions SuppressLastModified is
-in effect. The widest this column can be is therefore 49 bytes.
-
-As of Apache 1.3.10, the -DescriptionWidth -IndexOptions keyword allows you to adjust this width -to any arbitrary size. --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. - -
- -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, ^^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 *~
-- -This sets the icon to display next to files with -MIME-encoding 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-encoding is a wildcard expression matching required the -content-encoding. Examples: -
-AddIconByEncoding /icons/compress.xbm x-compress
-- -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 required the mime types. -Examples: -
-AddIconByType (IMG,/icons/image.xbm) image/*
-- -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
--The FancyIndexing directive sets the FancyIndexing option for a directory. -The IndexOptions directive should be used in -preference. -
-- Note that in versions of Apache prior to 1.3.2, the - FancyIndexing and - IndexOptions directives will override each other. You - should use IndexOptions FancyIndexing in preference - to the standalone FancyIndexing directive. - As of Apache 1.3.2, a standalone FancyIndexing directive - is combined with any IndexOptions directive already - specified for the current scope. --
-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. -
-Apache 1.3.6 and earlier: -The module first attempts to include filename-.html-as an HTML document, otherwise it will try to include filename as -plain text. Filename is treated as a filesystem path relative -to the directory being indexed. In no case is SSI processing done. -Example: --when indexing the directoryHeaderName HEADER/web, the server will first look for -the HTML file/web/HEADER.htmland include it if found, otherwise -it will include the plain text file/web/HEADER, if it exists. -
Apache versions after 1.3.6: -Filename is treated as a URI path relative to the one used -to access the directory being indexed, and must resolve to a document -with a major content type of "text" (e.g., -text/html, text/plain, etc.). -This means that 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: --- AddType text/html .cgi --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 will be processed for server-side includes (see the -mod_include documentation). -
-See also ReadmeName. -
-
-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 to the list, rather than the replacing the list
-of ignored files. By default, the list contains `.'. Example:
-
-IndexIgnore README .htaccess *~
-- -The IndexOptions directive specifies the behavior of the directory indexing. -Option can be one of -
- Note that in versions of Apache prior to 1.3.2, the - FancyIndexing and - IndexOptions directives will override each other. You - should use IndexOptions FancyIndexing in preference - to the standalone FancyIndexing directive. - As of Apache 1.3.2, a standalone FancyIndexing directive - is combined with any IndexOptions directive already - specified for the current scope. --
- -If the number starts with a zero, then it is considered to be a - fraction: --foo-1.7 -foo-1.7.2 -foo-1.7.12 -foo-1.8.2 -foo-1.8.2a -foo-1.12 -
--foo-1.001 -foo-1.002 -foo-1.030 -foo-1.04 -
-There are some noticeable differences in the behaviour of this -directive in recent (post-1.3.0) versions of Apache. -
--The default is that no options are enabled. If multiple IndexOptions -could apply to a directory, then the most specific one is taken complete; -the options are not merged. For example: -
-then only-<Directory /web/docs> - IndexOptions FancyIndexing -</Directory> -<Directory /web/docs/spec> - IndexOptions ScanHTMLTitles -</Directory> -
ScanHTMLTitles will be set for the /web/docs/spec
-directory.
-
--Apache 1.3.3 introduced some significant changes in the handling of -IndexOptions directives. In particular, -
-IndexOptions FancyIndexing ScanHTMLTitles.
- -Whenever a '+' or '-' prefixed keyword is encountered, it is applied -to the current IndexOptions settings (which may have been -inherited from an upper-level directory). However, whenever an unprefixed -keyword is processed, it clears all inherited options and any incremental -settings encountered so far. Consider the following example: -
-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 either '+' or '-' prefixes.
-
-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 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, Date, Size, or -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 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. -
- --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. -
--The filename argument is treated as a stub filename -in Apache 1.3.6 and earlier, and as a relative URI in later versions. -Details of how it is handled may be found under the description of -the HeaderName directive, which uses the -same mechanism and changed at the same time as ReadmeName. --
See also HeaderName.
- - - - - diff --git a/docs/manual/mod/mod_cern_meta.html b/docs/manual/mod/mod_cern_meta.html deleted file mode 100644 index e210c7558e..0000000000 --- a/docs/manual/mod/mod_cern_meta.html +++ /dev/null @@ -1,169 +0,0 @@ - - -
-This module provides for CERN httpd metafile semantics.
- -Status: Extension
-
-Source File: mod_cern_meta.c
-
-Module Identifier: cern_meta_module
-
-Compatibility: Available in Apache 1.1 and later.
-
More information on the -CERN metafile semantics is available. - -
MetaFiles off- -Turns on/off Meta file processing on a per-directory basis. This option was introduced in Apache 1.3. - -
MetaDir .web
-
-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.
-
-
MetaSuffix .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.
-
-
- - - - - diff --git a/docs/manual/mod/mod_cgi.html b/docs/manual/mod/mod_cgi.html deleted file mode 100644 index 6571305e43..0000000000 --- a/docs/manual/mod/mod_cgi.html +++ /dev/null @@ -1,242 +0,0 @@ - - -
-This module provides for execution of CGI scripts.
- -Status: Base
-
-Source File: mod_cgi.c
-
-Module Identifier: cgi_module
-
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 directory.
-
-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 variable.
-
-
See also: Options, ScriptAlias, AddType and AddHandler. - -
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.
-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.
-- -
- %% [time] request-line - %% HTTP-status CGI-script-filename -- -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 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) - %response - All headers output by the CGI script - %stdout - CGI standard output - %stderr - CGI standard error -- -(The %stdout and %stderr parts may be missing if the script did not -output -anything on standard output or standard error). - -
- -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 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 your main logs directory, do NOT -change the 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 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.
- -- -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. - -
- -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. - - - - - diff --git a/docs/manual/mod/mod_charset_lite.html b/docs/manual/mod/mod_charset_lite.html deleted file mode 100644 index 42a8774cc8..0000000000 --- a/docs/manual/mod/mod_charset_lite.html +++ /dev/null @@ -1,285 +0,0 @@ - - -
-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
-
- 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 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 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.
-
This module will only work if APACHE_XLATE is defined
- at compile time.
- This module provides a small subset of configuration mechanisms
- implemented by Russian Apache and its associated mod_charset.
-
- 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 -- -
- If the translation rules don't make sense for the content, translation - can fail in various ways, including: -
- -
- 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. -
- -
- Syntax: CharsetDefault charset
-
- Default: None
-
- Context: directory, virtual host
-
- Override: FileInfo
-
- Status: Experimental
-
- Module: mod_charset_lite
-
-
-
- The CharsetDefault directive specifies the charset that
- content in the associated container should be translated to.
-
- 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> -- -
- -
- 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 be one of
-
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 DBGLVL_ constants near the
- beginning of mod_charset_lite.c.
- 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.
- This module provides Distributed Authoring and Versioning -(WebDAV) functionality.
- -Status: Extension -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 -server.
- -
-To enable mod_dav, add the following to a container in your httpd.conf file:
-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 (Any web-server writeable filename, without an extension)
-
-
-
-
-Dav offUse 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
- |
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 0When 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 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 (like 600 seconds) to reduce the chance
-of the client losing the lock due to network latency.
|
-Example: - <Location /MSWord>
- |
DavDepthInfinity offUse 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.
This module provides for "trailing slash" redirects and serving -directory index files.
- -Status: Base
-
-Source File: mod_dir.c
-
-Module Identifier: dir_module
-
index.html.
-The DirectoryIndex directive sets
-the name of this file.
-This is controlled by mod_dir.
-mod_autoindex.
-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/.
-
-
DirectoryIndex index.html
-
-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 directory.
-
- -Example: -
-DirectoryIndex index.html
-http://myserver/docs/ would return
-http://myserver/docs/index.html if it 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/cgi-bin/index.pl to be executed
-if neither index.html or index.txt existed in
-a directory.- - - - - diff --git a/docs/manual/mod/mod_env.html b/docs/manual/mod/mod_env.html deleted file mode 100644 index 3d6d610fe9..0000000000 --- a/docs/manual/mod/mod_env.html +++ /dev/null @@ -1,159 +0,0 @@ - - -
-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.
-
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.
- -- -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 -- -
- -Sets an environment variable, which is then passed on to CGI -scripts and SSI pages. Example: -
- SetEnv SPECIAL_PATH /foo/bin -- -
- -Removes one or more environment variables from those passed on to -CGI scripts and SSI pages. Example: -
- UnsetEnv LD_LIBRARY_PATH -- - - - - diff --git a/docs/manual/mod/mod_example.html b/docs/manual/mod/mod_example.html deleted file mode 100644 index 79d3a8751f..0000000000 --- a/docs/manual/mod/mod_example.html +++ /dev/null @@ -1,201 +0,0 @@ - - - -
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. -- -
- This module illustrates many of - the aspects of the - Apache 1.2 API - and, when used, demonstrates the manner in which module callbacks are - triggered by the server. -
- -Status: Extension
-
-Source File: mod_example.c
-
-Module Identifier: example_module
-
-Compatibility: Available in Apache 1.2 and later.
-
- The files in the src/modules/example directory under the
- Apache distribution directory tree are provided as an example to those
- that wish to write modules that use the Apache API.
-
- The main file is mod_example.c, which illustrates all
- the different callback mechanisms and call syntaxes. By no means does
- an add-on module need to include routines for all of the callbacks -
- quite the contrary!
-
- The example module is an actual working module. If you link it into - your server, enable the "example-handler" handler for a location, and - then browse to that location, you will see a display of - some of the tracing the example module did as the various callbacks - were made. -
--
- To include the example module in your server, follow the steps below: -
-src/Configuration file. If there isn't one, add
- it; it should look like this:
- - AddModule modules/example/mod_example.o --
src/Configure script
- ("cd src; ./Configure"). This will
- build the Makefile for the server itself, and update the
- src/modules/Makefile for any additional modules you
- have requested from beneath that subdirectory.
- src
- directory).
- - To add another module of your own: -
-- To activate the example module, include a block similar to the - following in your srm.conf file: -
-- <Location /example-info> - SetHandler example-handler - </Location> --
- As an alternative, you can put the following into a - .htaccess - file and then request the file "test.example" from that - location: -
-- AddHandler example-handler .example --
- After reloading/restarting your server, you should be able to browse - to this location and see the brief display mentioned earlier. -
- -
- Syntax: Example
-
- Default: None
-
- Context: server config, virtual host, directory,
- .htaccess
-
- Override: Options
-
- Status: Extension
-
- Module: mod_example
-
- Compatibility: Example is only
- available in Apache 1.2 and later.
-
- The Example directive just sets a demonstration flag which the - example module's content handler displays. It takes no arguments. If you - browse to an URL to which the example content-handler applies, you will get - a display of the routines within the module and how and in what order they - were called to service the document request. The effect of this directive - one can observe under the point "Example directive declared - here: YES/NO". -
- - - diff --git a/docs/manual/mod/mod_expires.html b/docs/manual/mod/mod_expires.html deleted file mode 100644 index c80b194ae0..0000000000 --- a/docs/manual/mod/mod_expires.html +++ /dev/null @@ -1,350 +0,0 @@ - - - -
- This module provides for the generation of Expires HTTP
- headers according to user-specified criteria.
-
Status: Extension
-
-Source File: mod_expires.c
-
-Module Identifier: expires_module
-
-Compatibility: Available in Apache 1.2 and later.
-
- This module controls the setting of the Expires HTTP
- header in server responses. The expiration date can set to be
- relative to either the time the source file was last modified, or to
- the time of the client access.
-
- The Expires HTTP header is an instruction to the client
- about the document's validity and persistence. If cached, the document
- may be fetched from the cache rather than from the source until this
- time has passed. After that, the cache copy is considered
- "expired" and invalid, and a new copy must be obtained from
- the source.
-
-
- The - ExpiresDefault - and - ExpiresByType - directives can also be defined in a more readable syntax of the form: -
-ExpiresDefault "<base> [plus] {<num> <type>}*"
-
- ExpiresByType type/encoding "<base> [plus]
- {<num> <type>}*"
- - where <base> is one of: -
- -- The 'plus' keyword is optional. <num> should be an - integer value [acceptable to atoi()], and <type> - is one of: -
- -- For example, any of the following directives can be used to make - documents expire 1 month after being accessed, by default: -
-ExpiresDefault "access plus 1 month"
-
- ExpiresDefault "access plus 4 weeks"
-
- ExpiresDefault "access plus 30 days"
- - The expiry time can be fine-tuned by adding several '<num> - <type>' clauses: -
-ExpiresByType text/html "access plus 1 month 15 days 2 hours"
-
- ExpiresByType image/gif "modification plus 5 hours 3 minutes"
- - Note that if you use a modification date based setting, the Expires - header will not be added to content that does - not come from a file on disk. This is due to the fact that there is - no modification time for such content. - -
- Syntax: ExpiresActive on|off
-
- Context: server config, virtual host, directory,
- .htaccess
-
- Override: Indexes
-
- Status: Extension
-
- Module: mod_expires
-
- This directive enables or disables the generation of the
- Expires header for the document realm in question. (That
- is, if found in an .htaccess file, for instance, it
- applies only to documents generated from that directory.) If set to
- Off, no Expires header will be
- generated for any document in the realm (unless overridden at a lower
- level, such as an .htaccess file overriding a server
- config file). If set to On, the header will be
- added to served documents according to the criteria defined by the
- ExpiresByType
- and
- ExpiresDefault
- directives (q.v.).
-
- Note that this directive does not guarantee that an
- Expires header will be generated. If the criteria aren't
- met, no header will be sent, and the effect will be as though this
- directive wasn't even specified.
-
- Syntax: ExpiresByType MIME-type
- <code>seconds
-
- Context: server config, virtual host, directory,
- .htaccess
-
- Override: Indexes
-
- Status: Extension
-
- Module: mod_expires
-
- This directive defines the value of the Expires header
- generated for documents of the specified type (e.g.,
- text/html). The second argument sets the number of
- seconds that will be added to a base time to construct the expiration
- date.
-
- The base time is either the last modification time of the file, or the
- time of the client's access to the document. Which should be used is
- specified by the <code> field;
- M means that the file's last modification time should
- be used as the base time, and A means the client's
- access time should be used.
-
- The difference in effect is subtle. If M is used, all current - copies of the document in all caches will expire at the same time, - which can be good for something like a weekly notice that's always - found at the same URL. If A is used, the date of expiration - is different for each client; this can be good for image files that - don't change very often, particularly for a set of related documents - that all refer to the same images (i.e., the images will be - accessed repeatedly within a relatively short timespan). -
-- Example: -
--
- ExpiresActive On # enable expirations - ExpiresByType image/gif A2592000 # expire GIF images after a month - # in the client's cache - ExpiresByType text/html M604800 # HTML documents are good for a - # week from the time they were - # changed, period -- -
- Note that this directive only has effect if ExpiresActive
- On has been specified. It overrides, for the specified MIME
- type only, any expiration date set by the
- ExpiresDefault
- directive.
-
- You can also specify the expiration time calculation using an - alternate syntax, - described later in this document. -
-
- Syntax: ExpiresDefault <code>seconds
-
- Context: server config, virtual host, directory,
- .htaccess
-
- Override: Indexes
-
- Status: Extension
-
- Module: mod_expires
-
- This directive sets the default algorithm for calculating the - expiration time for all documents in the affected realm. It can be - overridden on a type-by-type basis by the - ExpiresByType - directive. See the description of that directive for details about - the syntax of the argument, and the - alternate syntax - description as well. -
- - - - diff --git a/docs/manual/mod/mod_ext_filter.html b/docs/manual/mod/mod_ext_filter.html deleted file mode 100644 index d6f663fdc3..0000000000 --- a/docs/manual/mod/mod_ext_filter.html +++ /dev/null @@ -1,292 +0,0 @@ - - - -This module provides the ability to pass the response body - through an external program before delivering to the client.
- -Status: Experimental
-
-Source File: mod_ext_filter.c
-
-Module Identifier: ext_filter_module
- This is an experimental module and should be used with
- care. Test your mod_ext_filter configuration carefully to
- ensure that it performs the desired function. You may wish to review
- XXX for background on the Apache filtering model.
-
- mod_ext_filter presents a simple and familiar programming
- model for filters. With this module, a program which reads from stdin and
- writes to stdout (i.e., a Unix-style filter command) can be a filter for
- Apache. This filtering mechanism is much slower than using a filter which
- is specially written for the Apache API and runs inside of the Apache
- server process, but it does have the following benefits:
-
- Even when the performance characteristics are not suitable for production
- use, mod_ext_filter can be used as a prototype environment
- for filters.
-
- # mod_ext_filter directive to define a filter to HTML-ize text/c files - # using the external program /usr/bin/enscript, with the type of the - # result set to text/html - ExtFilterDefine c-to-html mode=output intype=text/c outtype=text/html \ - cmd="/usr/bin/enscript --color -W html -Ec -o - -" - - <Directory "/export/home/trawick/apacheinst/htdocs/c"> - - # core directive to cause the new filter to be run on output - SetOutputFilter c-to-heml - - # mod_mime directive to set the type of .c files to text/c - AddType text/c .c - - # mod_ext_filter directive to set the debug level just high - # enough to see a log message per request showing the configuration - # in force - ExtFilterOptions DebugLevel=1 - - </Directory> -- -
- # mod_ext_filter directive to define the external filter - ExtFilterDefine gzip mode=output cmd=/bin/gzip - - <Location /gzipped> - - # core directive to cause the gzip filter to be run on output - SetOutputFilter gzip - - # mod_header directive to add "Content-Encoding: gzip" header field - Header set Content-Encoding gzip - - </Location> -- -
- # mod_ext_filter directive to define a filter which runs everything - # through cat; cat doesn't modify anything; it just introduces extra - # pathlength and consumes more resources - ExtFilterDefine slowdown mode=output cmd=/bin/cat preservescontentlength - - <Location /> - - # core directive to cause the slowdown filter to be run several times on - # output - SetOutputFilter slowdown slowdown slowdown - - </Location> -- -
- Syntax: ExtFilterDefine filtername parameters
-
- Default: None
-
- Context: server
-
- Override: none
-
- Status: Experimental
-
- Module: mod_ext_filter
-
-
- The ExtFilterDefine directive defines the characteristics of
- an external filter, including the program to run and its arguments.
-
- filtername specifies the name of the filter being defined. This name - can then be used in SetOutputFilter directives. It must be unique among all - registered filters. At the present time, no error is reported by the - register-filter API, so a problem with duplicate names isn't reported to the - user. -
- -- Subsequent parameters can appear in any order and define the external command - to run and certain other characteristics. The only required parameter is - cmd=. These parameters are: -
- -intype= is specified,
- the filter will be disabled for documents of other types.
-
- Syntax: ExtFilterOptions option
- [option] ...
-
- Default: DebugLevel=0 NoLogStderr
-
- Context: directory
-
- Override: none
-
- Status: Experimental
-
- Module: mod_ext_filter
-
-
- The ExtFilterOptions directive specifies special processing
- options for mod_ext_filter. Option can be one of
-
mod_ext_filter. By default, no
- debug 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 DBGLVL_
- constants near the beginning of mod_ext_filter.c.
- - Note: The core directive LogLevel should be used to cause debug messages - to be stored in the Apache error log. -
- ExtFilterOptions LogStderr DebugLevel=0 -- - Messages written to the filter's standard error will be stored in the Apache - error log. No debug messages will be generated by -
mod_ext_filter.
-
- - - - - diff --git a/docs/manual/mod/mod_file_cache.html b/docs/manual/mod/mod_file_cache.html deleted file mode 100644 index 8e8b34325b..0000000000 --- a/docs/manual/mod/mod_file_cache.html +++ /dev/null @@ -1,268 +0,0 @@ - - -
-- This module should be used with care. You can easily create a - broken site using mod_file_cache, so read this document - carefully. -
- -- Caching frequently requested files that change very - infrequently is a technique for reducing server load. mod_file_cache - provides two techniques for caching frequently requested - static files. - Through configuration directives, you can direct mod_file_cache - to either open then mmap()a file, or to pre-open a file and save - the file's open file handle. Both techniques reduce server - load when processing requests for these files by doing part of the - work (specifically, the file I/O) for serving the file when the server - is started rather than during each request. -
- -
- mod_file_cache is not compiled into the server by
- default. To use mod_file_cache you have to enable the
- following line in the server build Configuration file:
-
- AddModule modules/experimental/mod_file_cache.o -- - -
- Notice: You cannot use this for speeding up CGI programs or other files - which are served by special content handlers. It can only be used for - regular files which are usually served by the Apache core content handler. -
- -- This module is an extension of and borrows heavily from the - mod_mmap_static module in Apache 1.3. -
-
- mod_file_cache caches a list of statically configured
- files via MMapFile or CacheFile directives
- in the main server configuration.
-
- Not all platforms support both directives. For - example, Apache on Windows does not currently support the MMapStatic - directive, while other platforms, like AIX, support both. You will - receive an error message in the server error log if you attempt to - use an unsupported directive. If given an unsupported directive, the - server will start but the file will not be cached. On platforms that - support both directives, you should experiment with both to see - which works best for you. -
- -MmapFile Directive
- The MmapFile directive of mod_file_cache
- maps a list of statically configured files into memory through the
- system call mmap(). This system call is available on
- most modern Unix derivates, but not on all. There are sometimes
- system-specific limits on the size and number of files that can be
- mmap()d, experimentation is probably the easiest way to find out.
-
- This mmap()ing is done once at server start or restart, only. So whenever
- one of the mapped files changes on the filesystem you have to
- restart the server (see the Stopping and
- Restarting documentation). To reiterate that point: if the
- files are modified in place without restarting the server
- you may end up serving requests that are completely bogus. You
- should update files by unlinking the old copy and putting a new
- copy in place. Most tools such as rdist and
- mv do this. The reason why this modules doesn't take
- care of changes to the files is that this check would need an extra
- stat() every time which is a waste and against the
- intent of I/O reduction.
-
CacheFile Directive
- The CacheFile directive of mod_file_cache
- opens an active handle or file descriptor to the
- file (or files) listed in the configuration directive and places
- these open file handles in the cache. When the file is requested,
- the server retrieves the handle from the cache and passes it to the
- sendfile() (or TransmitFile() on Windows), socket API.
-
- Insert more details about sendfile API... -
-
- This file handle caching is done once at server start or restart,
- only. So whenever one of the cached files changes on the filesystem
- you have to restart the server (see the Stopping and Restarting documentation).
- To reiterate that point: if the files are modified in
- place without restarting the server you may end up serving
- requests that are completely bogus. You should update files by
- unlinking the old copy and putting a new copy in place. Most tools
- such as rdist and mv do this.
-
- Syntax: MMapFile filename [filename] ...
-
- Default: None
-
- Context: server-config
-
- Override: Not applicable
-
- Status: Experimental
-
- Module: mod_file_cache
-
- Compatibility: Only in Apache 1.3 (via
- mod_mmap_statis) or later.
-
-
- The MMapFile directive maps one or more files (given as
- whitespace separated arguments) into memory at server startup time. They
- are automatically unmapped on a server shutdown. When the files have changed
- on the filesystem at least a HUP or USR1 signal should be send to the server
- to re-mmap them.
-
- Be careful with the filename arguments: They have to literally
- match the filesystem path Apache's URL-to-filename translation handlers
- create. We cannot compare inodes or other stuff to match paths through
- symbolic links etc. because that again would cost extra stat()
- system calls which is not acceptable. This module may or may not work
- with filenames rewritten by mod_alias or
- mod_rewrite.
-
- MMapFile /usr/local/apache/htdocs/index.html -- -
- Syntax: CacheFile filename [filename] ...
-
- Default: None
-
- Context: server-config
-
- Override: Not applicable
-
- Status: Experimental
-
- Module: mod_file_cache
-
- Compatibility: Only available in Apache 2.0 or later.
-
-
- The CacheFile directive opens handles to one or more
- files (given as whitespace separated arguments) and places these
- handles into the cache at server startup time. Handles to cached
- files are automatically closed on a server shutdown. When the files
- have changed on the filesystem, the server should be restarted to
- to re-cache them.
-
- Be careful with the filename arguments: They have to literally
- match the filesystem path Apache's URL-to-filename translation handlers
- create. We cannot compare inodes or other stuff to match paths through
- symbolic links etc. because that again would cost extra stat()
- system calls which is not acceptable. This module may or may not work
- with filenames rewritten by mod_alias or
- mod_rewrite.
-
- CacheFile /usr/local/apache/htdocs/index.html -- -
- Note: don't bother asking for a for a directive which - recursively caches all the files in a directory. Try this - instead... - See the Include directive, and consider this command: -
- find /www/htdocs -type f -print \ - | sed -e 's/.*/mmapfile &/' > /www/conf/mmap.conf -- - - - diff --git a/docs/manual/mod/mod_headers.html b/docs/manual/mod/mod_headers.html deleted file mode 100644 index da1d7e19bc..0000000000 --- a/docs/manual/mod/mod_headers.html +++ /dev/null @@ -1,147 +0,0 @@ - - - -
This module provides for the customization of HTTP -response headers.
- -Status: Extension
-
-Source File: mod_headers.c
-
-Module Identifier: headers_module
-
-Compatibility: Available in Apache 1.2 and later.
-
- -This directive can replace, merge or remove HTTP response headers. The -action it performs is determined by the first argument. This can be one -of the following values: - -
-The Header directives are processed in the following order: -
-Header append Author "John P. Doe" -Header unset Author -- -This way round, the Author header is not set. If reversed, the Author -header is set to "John P. Doe". -
- -The Header directives are processed just before the response is sent -by its handler. These means that some headers that are added just -before the response is sent cannot be unset or overridden. This -includes headers such as "Date" and "Server". -
- - - - diff --git a/docs/manual/mod/mod_imap.html b/docs/manual/mod/mod_imap.html deleted file mode 100644 index d8e6719feb..0000000000 --- a/docs/manual/mod/mod_imap.html +++ /dev/null @@ -1,349 +0,0 @@ - - -
-This module provides for server-side imagemap processing.
- -Status: Base
-
-Source File: mod_imap.c
-
-Module Identifier: imap_module
-
-Compatibility: Available in Apache 1.1 and later.
-
This module processes .map files, thereby replacing
-the functionality of the imagemap CGI program. Any
-directory or document type configured to use the handler
-imap-file (using either AddHandler or SetHandler) will be
-processed by this module.
The following directive will
-activate files ending with .map as imagemap files:
-
-
AddHandler imap-file mapAddType application/x-httpd-imap map- -
base.
-imagemap.conf file.
---The directive is one ofdirective value [x,y ...]
-directive value "Menu text" [x,y ...]
-directive value x,y ... "Menu text"
-
base, default,
-poly, circle, rect, or
-point. The value is an absolute or relative URL, or one
-of the special values listed below. The coordinates are
-x,y pairs separated by whitespace. The quoted text is
-used as the text of the link if a imagemap menu is generated. Lines
-beginning with '#' are comments.
-
-base Directive
-<BASE HREF="value">. The
- non-absolute URLs of the map-file are taken relative to this value.
- The base directive overrides ImapBase as set in a
- .htaccess file or in the server configuration files. In the absence
- of an ImapBase configuration directive, base defaults to
- http://server_name/. base_uri is synonymous with base. Note that
- a trailing slash on the URL is significant.
--
default Directive
-poly, circle or rect
- directives, and there are no point directives. Defaults
- to nocontent in the absence of an ImapDefault
- configuration setting, causing a status code of 204 No
- Content to be returned. The client should keep the same
- page displayed.
--
poly Directive
--
circle
--
rect Directive
--
point Directive
-default will not be followed if a
- point directive is present and valid coordinates are
- given.
-base value. base itself will not resolved according to the current
- value. A statement base mailto: will work properly, though.
--
map
- -
menu
- map.
--
referer
- http://servername/ if no Referer:
- header was present.
--
nocontent
- 204 No Content,
- telling the client to keep the same page displayed. Valid for
- all but base.
--
error
- 500 Server Error. Valid for all but
- base, but sort of silly for anything but
- default.
-0,0 200,200
- 0,0, it is as if
- no coordinate had been selected.
-"Menu Text"
- <a HREF="http://foo.com/">Menu text</a><a HREF="http://foo.com/">http://foo.com</a>
-#Comments are printed in a 'formatted' or 'semiformatted' menu.
-#And can contain html tags. <hr>
-base referer
-poly map "Could I have a menu, please?" 0,0 0,10 10,10 10,0
-rect .. 0,0 77,27 "the directory of the referer"
-circle http://www.inetnebr.com/lincoln/feedback/ 195,0 305,27
-rect another_file "in same directory as referer" 306,0 419,27
-point http://www.zyzzyva.com/ 100,100
-point http://www.tripod.com/ 200,200
-rect mailto:nate@tripod.com 100,150 200,0 "Bugs?"
-- -
-<A HREF="/maps/imagemap1.map">
-<IMG ISMAP SRC="/images/imagemap1.gif">
-</A>
-- - -
- -The ImapMenu directive determines the action taken if an imagemap file -is called without valid coordinates. -
none
- none, no menu is generated, and the default
- action is performed.
- formatted
- formatted menu is the simplest menu. Comments
- in the imagemap file are ignored. A level one header is
- printed, then an hrule, then the links each on a separate line.
- The menu has a consistent, plain look close to that of
- a directory listing.
- semiformatted
- semiformatted menu, comments are printed
- where they occur in the imagemap file. Blank lines are turned
- into HTML breaks. No header or hrule is printed, but otherwise
- the menu is the same as a formatted menu.
- unformatted
-
-
-
-The ImapDefault directive sets the default default used in
-the imagemap files. Its value is overridden by a default
-directive within the imagemap file. If not present, the
-default action is nocontent, which means
-that a 204 No Content is sent to the client. In this
-case, the client should continue to display the original page.
-
-
-
-The ImapBase directive sets the default base used in
-the imagemap files. Its value is overridden by a base
-directive within the imagemap file. If not present, the
-base defaults to http://servername/.
-
-
-
-
-
-
-
diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html
deleted file mode 100644
index b296e77c66..0000000000
--- a/docs/manual/mod/mod_include.html
+++ /dev/null
@@ -1,469 +0,0 @@
-
-
-
This module provides for server-parsed html documents.
- -Status: Base
-
-Source File: mod_include.c
-
-Module Identifier: includes_module
-
This module provides a handler which will process files before they -are sent to the client. The processing is controlled by specially -formated SGML comments, referred to as elements. These -elements allow conditional text, the inclusion other files or -programs, as well as the setting and printing of environment -variables.
- -See also: Options -and AddHandler.
- - -Server Side Includes are implemented by the INCLUDES
-filter. If documents containing
-server-side include directives are given the extension .shtml, the
-following directives will make Apache parse them and assign the
-resulting document the mime type of text/html:
-
-AddType text/html .shtml
-<FilesMatch "\.shtml[.$]">
- SetOutputFilter INCLUDES
-</FilesMatch>
-The following directive must be given for the directories containing
-the shtml files (typically in a <Directory> section,
-but this directive is also valid .htaccess files if AllowOverride
-Options is set):
-Options +Includes
-Alternatively the XBitHack
-directive can be used to parse normal (text/html) files,
-based on file permissions.
For backwards compatibility, documents with mime type
-text/x-server-parsed-html or
-text/x-server-parsed-html3 will also be parsed
-(and the resulting output given the mime type text/html)
-as will documents with the handler server-parsed.
-
-
- -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. --<!--#element attribute=value attribute=value ... ---> -
-The allowed elements are:
- -
bytes for a count in bytes, or
-abbrev for a count in Kb or Mb as appropriate.
-strftime(3) library
-routine when printing dates.
-(none).
-Any dates printed are subject to the currently configured timefmt.
-
-Attributes:
-echo element,
-the default is set to "entity", resulting in entity encoding (which
-is appropriate in the context of a block-level HTML element, eg.
-a paragraph of text). This can be changed by adding an
-encoding attribute, which will remain in effect until
-the next encoding attribute is encountered or the
-element ends, whichever comes first. Note that the
-encoding attribute must precede the corresponding
-var attribute to be effective, and that only special
-characters as defined in the ISO-8859-1 character encoding will be
-encoded. This encoding process may not have the desired result if
-a different character encoding is in use.
-Apache 1.3.12 and above; previous versions do no encoding.
-
--The CGI script is given the PATH_INFO and query string (QUERY_STRING) of the -original request from the client; these cannot be specified in the URL path. -The include variables will be available to the script in addition to the -standard CGI environment.
-If the script returns a Location: header instead of output, then this -will be translated into an HTML anchor.
-The include virtual element should be used in preference to
-exec cgi.
-
/bin/sh.
-The include variables are available to the command.
-sizefmt format specification. Attributes:
-timefmt format specification. The attributes are
-the same as for the fsize command.
-
-- -An attribute defines the location of the document; the inclusion is done for -each attribute given to the include command. The valid attributes are: -
../, nor can it be an
-absolute path. The virtual attribute should always be used
-in preference to this one.
-echo element for details) before being
- output. No attributes.
-<!--#printenv -->
-<!--#set var="category" value="help" -->
-echo command, for if and
-elif, and to any program invoked by the document.
-
-- -
Variable substitution is done within quoted strings in most cases - where they may reasonably occur as an argument to an SSI directive. - This includes the - config, - exec, - flastmod, - fsize, - include, and - set - directives, as well 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: - -
- <!--#set var="Zed" value="${REMOTE_HOST}_${REQUEST_METHOD}" -->
-
-
-This will result in the Zed variable being set to - "X_Y" if REMOTE_HOST is - "X" and REQUEST_METHOD is - "Y". - -
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 - <!--#endif --> -- -
- <!--#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 evaluated and if the result is true, then the text until
- the next elif, else.
- or endif element is included in the
- output stream.
-
-
The elif or else
- statements are be used the put text into the output stream
- if the original test_condition was false. These elements
- are optional.
-
-
The endif element ends the
- if element and is required.
-
-
test_condition is one of the following: - -
"=" 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)" --> -- -
Anything that's not recognized as a variable or an operator is - treated as a string. Strings can also be quoted: 'string'. - Unquoted strings can't contain whitespace (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 -- -
- -
XBitHack off
-
-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 the following values:
-
on but also test the group-execute bit. If it
-is set, then set the Last-modified date of the returned file to be the
-last modified time of the file. If it is not set, then no last-modified date
-is sent. Setting this bit allows clients and proxies to cache the result of
-the request.
-Note: you would not want to use this, for example, when you
-#include a CGI that produces different output on each hit
-(or potentially depends on the hit).
-
- - - - - diff --git a/docs/manual/mod/mod_info.html b/docs/manual/mod/mod_info.html deleted file mode 100644 index 3fe67d3ce2..0000000000 --- a/docs/manual/mod/mod_info.html +++ /dev/null @@ -1,127 +0,0 @@ - - -
-This module provides a comprehensive overview of the server -configuration including all installed modules and directives in the -configuration files.
- -Status: Extension
-
-Source File: mod_info.c
-
-Module Identifier: info_module
-
-Compatibility: Available in Apache 1.1 and later.
-
-To configure it, add the following to your access.conf file.
-
-
-<Location /server-info> -SetHandler server-info -</Location> -- -You may wish to add a -<Limit> -clause inside the -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
-
- - 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 else the directive settings will not be listed. -- -- It should also be noted that if mod_info 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. -
- -
- -This allows the content of string to be shown as -HTML interpreted, -Additional Information for the module module-name. -Example: -
-- - - - diff --git a/docs/manual/mod/mod_isapi.html b/docs/manual/mod/mod_isapi.html deleted file mode 100644 index a81ad4d258..0000000000 --- a/docs/manual/mod/mod_isapi.html +++ /dev/null @@ -1,376 +0,0 @@ - - - --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>' --
This module supports ISAPI Extensions within Apache for Windows.
- -Status: Base
-
-Source File: mod_isapi.c
-
-Module Identifier: isapi_module
-
-Compatibility: WIN32 only
-
This module implements the Internet Server extension API. It allows - Internet Server extensions (e.g. ISAPI .dll modules) to be - served by Apache for Windows, subject to the noted restrictions.
- -ISAPI extension modules (.dll files) are written by third parties. The - Apache Group does not author these modules, so we provide no support for - them. Please contact the ISAPI's author directly if you are experiencing - problems running their ISAPI extention. Please do not - post such problems to Apache's lists or bug reporting pages.
- -In the server configuration file, use the AddHandler directive to
- associate ISAPI files with the isapi-isa handler, and map
- it to the with their file extensions. To enable any .dll file to be
- processed as an ISAPI extention, edit the httpd.conf file and add the
- following line:
- AddHandler isapi-isa .dll -- -
There is no capability within the Apache server to leave a requested - module loaded. However, you may preload and keep a specific module loaded - by using the following syntax in your httpd.conf: - -
- ISAPICacheFile c:/WebWork/Scripts/ISAPI/mytest.dll -- -
Whether or not you have preloaded an ISAPI extension, all ISAPI
- extensions are governed by the same permissions and restrictions
- as CGI scripts. That is, Options ExecCGI must be set for
- the directory that contains the ISAPI .dll file.
Review the Additional Notes and the - Programmer's Journal for additional details and - clarification of the specific ISAPI support offered by mod_isapi.
- -Apache's ISAPI implementation conforms to all of the ISAPI 2.0
- specification, except for some "Microsoft-specific" extensions dealing
- with asynchronous I/O. Apache's I/O model does not allow asynchronous
- reading and writing in a manner that the ISAPI could access. If an ISA
- tries to access unsupported features, including async I/O, a message is
- placed in the error log to help with debugging. Since these messages
- can become a flood, the directive ISAPILogNotSupported Off
- exists to quiet this noise.
Some servers, like Microsoft IIS, load the ISAPI extension into the server - and keep it loaded until memory usage is too high, or unless configuration - options are specified. Apache currently loads and unloads the ISAPI - extension each time it is requested, unless the ISAPICacheFile directive - is specified. This is inefficient, but Apache's memory model makes this - the most effective method. Many ISAPI modules are subtly incompatible - with the Apache server, and unloading these modules helps to ensure the - stability of the server.
- -Also, remember that while Apache supports ISAPI Extensions, it - does not support ISAPI Filters. Support for filters may - be added at a later date, but no support is planned at this time.
- -If you are programming Apache 2.0 mod_isapi modules, you must limit your - calls to ServerSupportFunction to the following directives:
- -Apache returns FALSE to any unsupported call to ServerSupportFunction, and - sets the GetLastError value to ERROR_INVALID_PARAMETER.
- -ReadClient retrieves the request body exceeding the initial buffer - (defined by ISAPIReadAheadBuffer). Based on the ISAPIReadAheadBuffer - setting (number of bytes to buffer prior to calling the ISAPI handler) - shorter requests are sent complete to the extension when it is invoked. - If the request is longer, the ISAPI extension must use ReadClient to - retrieve the remaining request body.
- -WriteClient is supported, but only with the HSE_IO_SYNC flag or - no option flag (value of 0). Any other WriteClient request will - be rejected with a return value of FALSE, and a GetLastError - value of ERROR_INVALID_PARAMETER.
- -GetServerVariable is supported, although extended server variables do not - exist (as defined by other servers.) All the usual Apache CGI environment - variables are available from GetServerVariable, as well as the ALL_HTTP - and ALL_RAW values.
- -Apache 2.0 mod_isapi supports additional features introduced in later - versions of the ISAPI specification, as well as limited emulation of - async I/O and the TransmitFile semantics. Apache also supports preloading - ISAPI .dlls for performance, neither of which were not available under - Apache 1.3 mod_isapi.
- -- - Specifies a space-separated list of file names to be loaded - when the Apache server is launched, and remain loaded until - the server is shut down. This directive may be repeated - for every ISAPI .dll file desired. The full path name of - each file should be specified. -
-
- - - Defines the maximum size of the Read Ahead Buffer sent to - ISAPI extentions when they are initally invoked. All - remaining data must be retrieved using the ReadClient - callback; some ISAPI extensions may not support the - ReadClient function. Refer questions to the ISAPI extention's - author. -
-
- - Logs all requests for unsupported features from ISAPI extentions - in the server error log. While this should be turned off once - all desired ISAPI modules are functioning, it defaults to on - to help administrators track down problems. -
-
- - Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extentions - to the server error log. -
-
- - Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extentions - to the query field (appended to the CustomLog %q component). -
- - - - diff --git a/docs/manual/mod/mod_log_config.html b/docs/manual/mod/mod_log_config.html deleted file mode 100644 index c007eb7281..0000000000 --- a/docs/manual/mod/mod_log_config.html +++ /dev/null @@ -1,476 +0,0 @@ - - -
--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: config_log_module
-
This module provides for flexible logging of client requests. Logs -are written in a customizable format, and may be written directly to a -file, or to an external program. Conditional logging is provided so -that individual requests may be included or excluded from the logs -based on characteristics of the request.
- -
-Three directives are provided by this module: TransferLog
-to create a log file, LogFormat to set a custom format,
-and CustomLog to define a log file and format in one step.
-The TransferLog and CustomLog directives can
-be used multiple times in each server to cause each request to be
-logged to multiple files.
-
Unless told otherwise with LogFormat, the log files
-created by TransferLog will be in standard "Common Log
-Format" (CLF). The contents of each line in a CLF file are explained
-below. Alternatively, the log file can be customized (and if multiple
-log files are used, each can have a different format). Custom formats
-are set with LogFormat and CustomLog.
The Common Log Format (CLF) file contains a separate line for each -request. A line is composed of several tokens separated by spaces:
- --host ident authuser date request status bytes --If a token does not have a value then it is represented by a hyphen (-). -The meanings and values of these tokens are as follows: -
date = [day/month/year:hour:minute:second zone]
-day = 2*digit
-month = 3*letter
-year = 4*digit
-hour = 2*digit
-minute = 2*digit
-second = 2*digit
-zone = (`+' | `-') 4*digit").
-The format argument to the LogFormat and
-CustomLog directives is a string. This string is logged
-to the log file for each request. It can contain literal characters
-copied into the log files and the c-type control characters "\n" and
-"\t" to represent new-lines and tabs. Literal quotes and back-slashes
-should be escaped with back-slashes.
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.
-%...c: 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.
-%...{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.
-%...v: The canonical ServerName of the server serving the request.
-%...V: The server name according to the UseCanonicalName setting.
-
-
-The "..." can be nothing at all (e.g., "%h %u %r %s
-%b"), or it can indicate conditions for inclusion of the item
-(which will cause it to be replaced with "-" if the condition is not
-met). The forms of condition are a list of HTTP status codes, which
-may or may not be preceded by "!". Thus, "%400,501{User-agent}i" logs
-User-agent: on 400 errors and 501 errors (Bad Request, Not
-Implemented) only; "%!200,304,302{Referer}i" logs Referer: on all
-requests which did not return some sort of normal
-status.
Note that there is no escaping performed on the strings from -%...r, %...i and %...o. This is mainly to comply with the requirements -of the Common Log Format. This implies that clients can insert -control characters into the log, so care should be taken when dealing -with raw log files.
- -Some commonly used log format strings are:
- -"%h %l %u %t \"%r\" %>s %b""%v %h %l %u %t \"%r\" %>s %b""%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"""%{Referer}i -> %U""%{User-agent}i"Note that the canonical ServerName and Port of the server serving the request are
-used for %v and %p 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.
The TransferLog and CustomLog directives can
-be given more than once to log requests to multiple log files. Unless
-the conditional form of CustomLog is used, each
-request will be logged to all the log files defined by either of these
-directives.
If a <VirtualHost> section does not contain any -TransferLog or CustomLog directives, the -logs defined for the main server will be used. If it does -contain one or more of these directives, requests serviced by -this virtual host will only be logged in the log files defined -within its definition, not in any of the main server's log files. -See the examples below.
- -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.
- -The access log file typically grows 1MB or more for each 10,000 -requests. It will probably be necessary to move or delete the log -file on a regular basis. This cannot be done while the server is -still running, because Apache will continue writing to the old log -file. Instead, the server must be restarted after the log file is moved or -deleted so that it will open a new log.
- -A typical scenario is:
- -- mv access_log access_log.old - apachectl graceful - # wait for all requests to the old server to complete - # before doing anything with access_log.old -- -
Alternatively, log files can be rotated automatically be writing -them through a pipe to a program designed for that purpose such -as rotatelogs.
- -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.
- -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.
The first argument, which specifies the location to which the -logs will be written, can take on one of the following two -types of values:
- -|", followed by the path to a
-program to receive the log information on its standard input.
-Security: if a program is used, then it will be run
-under the user who started httpd. This will be root if the server was
-started by root; be sure that the program is secure.The second argument specifies what will be written to the -log file. It can specify either a nickname -defined by a previous LogFormat -directive, or it can be an explicit format string -as described in the log formats section.
- -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" -- -
The third argument is optional and allows the decision on whether
-or not to log a particular request to be based on the presence or
-absence of a particular variable in the server environment. If the
-specified environment variable is set for
-the request (or is not set, in the case of a
-'env=!name' clause), then the request will be
-logged.
Environment variables can be set on a per-request 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 - CustomLog nongif-requests.log common env=!gif-image -- -
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
This directive specifies the format of the access log file.
- -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 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 below.
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 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.
-
Syntax: TransferLog file|pipe
-Default: none
-Context: server config, virtual host
-Status: Base
-Module: mod_log_config
This directive has exactly the same arguments and effect as 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 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\""
- TransferLog logs/access_log
-
-
-
-
-
-
diff --git a/docs/manual/mod/mod_mime.html b/docs/manual/mod/mod_mime.html
deleted file mode 100644
index 341c8bd4d4..0000000000
--- a/docs/manual/mod/mod_mime.html
+++ /dev/null
@@ -1,616 +0,0 @@
-
-
-
-This module provides for determining the types of files -from the filename and for association of handlers with files.
- -Status: Base
-
-Source File: mod_mime.c
-
-Module Identifier: mime_module
-
- -The directives AddCharset, AddEncoding, AddHandler, AddLanguage and AddType -are all used to map file extensions onto the meta-information for that -file. Respectively they set the character set, content-encoding, -handler, content-language, and MIME-type (content-type) of documents. -The directive TypesConfig is used to -specify a file which also maps extensions onto MIME types. The -directives ForceType and SetHandler are used to associated all the files -in a given location (e.g., a particular directory) onto a -particular MIME type or handler. - -
-
-Note that changing the type or encoding of a file does not change the
-value of the Last-Modified header. Thus, previously cached
-copies may still be used by a client or proxy, with the previous headers.
-
-
See also: MimeMagicFile.
- -welcome.html.fr maps onto content type text/html and
-language French then the file welcome.fr.html will map
-onto exactly the same information. The only exception to this is if an
-extension is given which Apache does not know how to handle. In this
-case it will "forget" about any information it obtained from
-extensions to the left of the unknown extension. So, for example, if
-the extensions fr and html are mapped to the appropriate language and
-type but extension xxx is not assigned to anything, then the file
-welcome.fr.xxx.html will be associated with content-type
-text/html but no language.
-
-
-
-If more than one extension is given which maps onto the same type of
-meta-information, then the one to the right will be used. For example,
-if ".gif" maps to the MIME-type image/gif and ".html" maps to the
-MIME-type text/html, then the file welcome.gif.html will
-be associated with the MIME-type "text/html".
-
-
-
-Care should be taken when a file with multiple extensions gets
-associated with both a MIME-type and a handler. This will usually
-result in the request being by the module associated with the
-handler. For example, if the .imap extension is mapped to
-the handler "imap-file" (from mod_imap) and the .html
-extension is mapped to the MIME-type "text/html", then the file
-world.imap.html will be associated with both the
-"imap-file" handler and "text/html" MIME-type. When it is processed,
-the "imap-file" handler will be used, and so it will be treated as a
-mod_imap imagemap file.
-
-
-The AddCharset directive maps the given filename extensions to the -specified content charset. charset is the MIME charset -parameter of filenames containing extension. This mapping is -added to any already in force, overriding any mappings that already -exist for the same extension. -
--Example: -
- AddLanguage ja .ja - AddCharset EUC-JP .euc - AddCharset ISO-2022-JP .jis - AddCharset SHIFT_JIS .sjis -- -
-Then the document xxxx.ja.jis will be treated as being a
-Japanese document whose charset is ISO-2022-JP (as will the document
-xxxx.jis.ja). The AddCharset directive is useful for both
-to inform the client about the character encoding of the document so
-that the document can be interpreted and displayed appropriately, and
-for content negotiation, where
-the server returns one from several documents based on the client's
-charset preference.
-
The extension argument is case-insensitive, and can -be specified with or without a leading dot.
- --See also: mod_negotiation -
- -- -The AddEncoding directive maps the given filename extensions to the -specified encoding type. MIME-enc is the MIME encoding to use -for documents containing the extension. This mapping is added -to any already in force, overriding any mappings that already exist -for the same extension. - -Example: -
-AddEncoding x-gzip .gz
-AddEncoding x-compress .Z
-
-
-Old clients expect x-gzip and x-compress,
-however the standard dictates that they're equivalent to gzip
-and compress respectively. Apache does content encoding
-comparisons by ignoring any leading x-. When responding
-with an encoding Apache will use whatever form (i.e., x-foo
-or foo) the client requested. If the client didn't
-specifically request a particular form Apache will use the form given by
-the AddEncoding directive. To make this long story short,
-you should always use x-gzip and x-compress
-for these two specific encodings. More recent encodings, such as
-deflate should be specified without the x-.
-
-
The extension argument is case-insensitive, and can -be specified with or without a leading dot.
- -- -See also: Files with -multiple extensions - -
AddHandler maps the filename extensions extension to the
-handler handler-name. This
-mapping is added to any already in force, overriding any mappings that
-already exist for the same extension.
-
-For example, to activate CGI scripts
-with the file extension ".cgi", you might use:
-
- AddHandler cgi-script .cgi -- -
Once that has been put into your srm.conf or httpd.conf file, any
-file containing the ".cgi" extension will be treated as a
-CGI program.
The extension argument is case-insensitive, and can -be specified with or without a leading dot.
- -- -See also: Files with -multiple extensions - -
-The AddLanguage directive maps the given filename extensions to the -specified content language. MIME-lang is the MIME language of -filenames containing extension. This mapping is added to any -already in force, overriding any mappings that already exist for the -same extension. -
--Example:
-AddEncoding x-compress .Z
AddLanguage en .en
AddLanguage fr
-.fr
-Then the document xxxx.en.Z will be treated as being a
-compressed English document (as will the document
-xxxx.Z.en). Although the content language is reported to
-the client, the browser is unlikely to use this information. The
-AddLanguage directive is more useful for
-content negotiation, where
-the server returns one from several documents based on the client's
-language preference.
-
-If multiple language assignments are made for the same extension, -the last one encountered is the one that is used. That is, for the -case of: -
-- AddLanguage en .en - AddLanguage en-uk .en - AddLanguage en-us .en --
-documents with the extension ".en" would be treated as
-being "en-us".
-
The extension argument is case-insensitive, and can -be specified with or without a leading dot.
- -
-See also: Files with
-multiple extensions
-
-See also: mod_negotiation
-
-
-The AddType directive maps the given filename extensions onto the
-specified content type. MIME-enc is the MIME type to use for
-filenames containing extension. This mapping is added to any
-already in force, overriding any mappings that already exist for the
-same extension. This directive can be used to add mappings
-not listed in the MIME types file (see the TypesConfig directive).
-
-Example:
-
-AddType image/gif .gif
--Note that, unlike the NCSA httpd, this directive cannot be used to set the -type of particular files.
- -
The extension argument is case-insensitive, and can -be specified with or without a leading dot.
- -- -See also: Files with -multiple extensions - -
<Directory> container) that don't have an explicit
-language extension (such as .fr or .de as
-configured by AddLanguage) should be considered to be in
-the specified MIME-lang language. This allows entire
-directories to be marked as containing Dutch content, for instance,
-without having to rename each file. Note that unlike using extensions
-to specify languages, DefaultLanguage can only specify a
-single language.
-
-- -If no DefaultLanguage directive is in force, and a file -does not have any language extensions as configured by -AddLanguage, then that file will be considered to have no -language attribute. - -
-
-See also: mod_negotiation
-
-See also: Files with
-multiple extensions
-
-
When placed into an .htaccess file or a
-<Directory> or <Location> section,
-this directive forces all matching files to be served
-as the content type given by media 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 this will override any filename extensions that might determine -the media type.
-The RemoveHandler directive removes any
-handler associations for files with the given extensions.
-This allows .htaccess files in subdirectories to undo
-any associations inherited from parent directories or the server
-config files. An example of its use might be:
-
/foo/.htaccess:AddHandler server-parsed .html/foo/bar/.htaccess:RemoveHandler .html-This has the effect of returning .html files in the -/foo/bar directory to being treated as normal -files, rather than as candidates for parsing (see the -mod_include module). -
-The extension argument is case-insensitive, and can -be specified with or without a leading dot.
- -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 status
-report whenever a URL of http://servername/status was
-called, you might put the following into access.conf:
-
- <Location /status> - SetHandler server-status - </Location> --
TypesConfig conf/MIME.types- -The TypesConfig directive sets the location of the MIME types configuration -file. Filename is relative to the -ServerRoot. This file sets the default list of -mappings from filename extensions to content types; changing this file is not -recommended. Use the AddType directive instead. The -file contains lines in the format of the arguments to an AddType command: -
MIME-type extension extension ...-The extensions are lower-cased. Blank lines, and lines beginning with a hash -character (`#') are ignored.
- - - - - diff --git a/docs/manual/mod/mod_mime_magic.html b/docs/manual/mod/mod_mime_magic.html deleted file mode 100644 index cffa5dec46..0000000000 --- a/docs/manual/mod/mod_mime_magic.html +++ /dev/null @@ -1,289 +0,0 @@ - - -
-
- This module provides for determining the MIME type of a file by - looking at a few bytes of its contents.
- -Status: Extension
-
-Source File: mod_mime_magic.c
-
-Module Identifier: mime_magic_module
-
This module determines the MIME type of files in the same way the - Unix file(1) command works: it looks at the first few bytes of - the file. It is intended as a "second line of defense" for cases - that mod_mime can't resolve. To assure - that mod_mime gets first try at determining a file's MIME type, - be sure to list mod_mime_magic before mod_mime - in the configuration. - -
This module is derived from a free version of the
- file(1) command for Unix, which uses "magic numbers"
- and other hints from a file's contents to figure out what the
- contents are. This module is active only if the magic file is
- specified by the MimeMagicFile directive.
-
-
-
-
- The contents of the file are plain ASCII text in 4-5 columns. - Blank lines are allowed but ignored. - Commented lines use a hash mark "#". - The remaining lines are parsed for the following columns: -
| Column | -Description | -||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | -byte number to begin checking from
- - ">" indicates a dependency upon the previous non-">" line |
- ||||||||||||||||||||||
| 2 | -type of data to match
-
|
- ||||||||||||||||||||||
| 3 | -contents of data to match | -||||||||||||||||||||||
| 4 | -MIME type if matched | -||||||||||||||||||||||
| 5 | -MIME encoding if matched (optional) | -
- For example, the following magic file lines - would recognize some audio formats. - -
-# Sun/NeXT audio data -0 string .snd ->12 belong 1 audio/basic ->12 belong 2 audio/basic ->12 belong 3 audio/basic ->12 belong 4 audio/basic ->12 belong 5 audio/basic ->12 belong 6 audio/basic ->12 belong 7 audio/basic ->12 belong 23 audio/x-adpcm -- - Or these would recognize the difference between "*.doc" files containing - Microsoft Word or FrameMaker documents. (These are incompatible file - formats which use the same file suffix.) - -
-# Frame -0 string \<MakerFile application/x-frame -0 string \<MIFFile application/x-frame -0 string \<MakerDictionary application/x-frame -0 string \<MakerScreenFon application/x-frame -0 string \<MML application/x-frame -0 string \<Book application/x-frame -0 string \<Maker application/x-frame - -# MS-Word -0 string \376\067\0\043 application/msword -0 string \320\317\021\340\241\261 application/msword -0 string \333\245-\0\0\0 application/msword -- - An optional MIME encoding can be included as a fifth column. - For example, this can recognize gzipped files and set the encoding - for them. - -
-# gzip (GNU zip, not to be confused with [Info-ZIP/PKWARE] zip archiver) -0 string \037\213 application/octet-stream x-gzip -- -
- However, an effort was made to improve the performance of the original - file(1) code to make it fit in a busy web server. - It was designed for a server where there are thousands of users who - publish their own documents. - This is probably very common on intranets. - Many times, it's helpful - if the server can make more intelligent decisions about a file's - contents than the file name allows - ...even if just to reduce the "why doesn't my page work" calls - when users improperly name their own files. - You have to decide if the extra work suits your environment. -
- When compiling an Apache server, this module should be at or near the - top of the list of modules in the Configuration file. The modules are - listed in increasing priority so that will mean this one is used only - as a last resort, just like it was designed to. - -
-/* - * mod_mime_magic: MIME type lookup via file magic numbers - * Copyright (c) 1996-1997 Cisco Systems, Inc. - * - * This software was submitted by Cisco Systems to the Apache Group in July - * 1997. Future revisions and derivatives of this source code must - * acknowledge Cisco Systems as the original contributor of this module. - * All other licensing and usage conditions are those of the Apache Group. - * - * Some of this code is derived from the free version of the file command - * originally posted to comp.sources.unix. Copyright info for that program - * is included below as required. - * --------------------------------------------------------------------------- - * - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin. - * - * This software is not subject to any license of the American Telephone and - * Telegraph Company or of the Regents of the University of California. - * - * Permission is granted to anyone to use this software for any purpose on any - * computer system, and to alter it and redistribute it freely, subject to - * the following restrictions: - * - * 1. The author is not responsible for the consequences of use of this - * software, no matter how awful, even if they arise from flaws in it. - * - * 2. The origin of this software must not be misrepresented, either by - * explicit claim or by omission. Since few users ever read sources, credits - * must appear in the documentation. - * - * 3. Altered versions must be plainly marked as such, and must not be - * misrepresented as being the original software. Since few users ever read - * sources, credits must appear in the documentation. - * - * 4. This notice may not be removed or altered. - * ------------------------------------------------------------------------- - * - * For compliance with Mr Darwin's terms: this has been very significantly - * modified from the free "file" command. - * - all-in-one file for compilation convenience when moving from one - * version of Apache to the next. - * - Memory allocation is done through the Apache API's pool structure. - * - All functions have had necessary Apache API request or server - * structures passed to them where necessary to call other Apache API - * routines. (i.e., usually for logging, files, or memory allocation in - * itself or a called function.) - * - struct magic has been converted from an array to a single-ended linked - * list because it only grows one record at a time, it's only accessed - * sequentially, and the Apache API has no equivalent of realloc(). - * - Functions have been changed to get their parameters from the server - * configuration instead of globals. (It should be reentrant now but has - * not been tested in a threaded environment.) - * - Places where it used to print results to stdout now saves them in a - * list where they're used to set the MIME type in the Apache request - * record. - * - Command-line flags have been removed since they will never be used here. - * - */ -- -
- Syntax: MimeMagicFile magic-file-name
-
- Default: none
-
- Context: server config, virtual host
-
- Status: Extension
-
- Module: mod_mime_magic
-
-
- The MimeMagicFile directive can be used to enable this module,
- the default file is distributed at conf/magic.
- Non-rooted paths are relative to the ServerRoot. Virtual hosts
- will use the same file as the main server unless a more specific setting
- is used, in which case the more specific setting overrides the main server's
- file.
-
- - - diff --git a/docs/manual/mod/mod_mmap_static.html b/docs/manual/mod/mod_mmap_static.html deleted file mode 100644 index 5a9749c439..0000000000 --- a/docs/manual/mod/mod_mmap_static.html +++ /dev/null @@ -1,152 +0,0 @@ - - -
-- This module provides mmap()ing of a statically configured list - of frequently requested but not changed files. - -
Status: Experimental
-
-Source File: mod_mmap_static.c
-
-Module Identifier: mmap_static_module
-
- This is an experimental module and should be used with
- care. You can easily create a broken site using this module, read this
- document carefully.
- mod_mmap_static maps a list of statically configured files (via
- MMapFile directives in the main server configuration) into
- memory through the system call mmap(). This system
- call is available on most modern Unix derivates, but not on all. There
- are sometimes system-specific limits on the size and number of files that
- can be mmap()d, experimentation is probably the easiest way to find out.
-
- This mmap()ing is done once at server start or restart, only. So whenever
- one of the mapped files changes on the filesystem you have to
- restart the server by at least sending it a HUP or USR1 signal (see the
- Stopping and Restarting documentation). To
- reiterate that point: if the files are modified in place without
- restarting the server you may end up serving requests that are completely
- bogus. You should update files by unlinking the old copy and putting a new
- copy in place. Most tools such as rdist and mv do
- this. The reason why this modules doesn't take care of changes to the files
- is that this check would need an extra stat() every time which
- is a waste and against the intent of I/O reduction.
-
- Syntax: MMapFile filename
- [filename] ...
-
- Default: None
-
- Context: server-config
-
- Override: Not applicable
-
- Status: Experimental
-
- Module: mod_mmap_static
-
- Compatibility: Only available in Apache 1.3 or later
-
-
- The MMapFile directive maps one or more files (given as
- whitespace separated arguments) into memory at server startup time. They
- are automatically unmapped on a server shutdown. When the files have changed
- on the filesystem at least a HUP or USR1 signal should be send to the server
- to re-mmap them.
-
- Be careful with the filename arguments: They have to literally
- match the filesystem path Apache's URL-to-filename translation handlers
- create. We cannot compare inodes or other stuff to match paths through
- symbolic links etc. because that again would cost extra stat()
- system calls which is not acceptable. This module may or may not work
- with filenames rewritten by mod_alias or
- mod_rewrite... it is an experiment after all.
-
- Notice: You cannot use this for speeding up CGI programs or other files - which are served by special content handlers. It can only be used for - regular files which are usually served by the Apache core content handler. -
- - Example: - -- MMapFile /usr/local/apache/htdocs/index.html -- -
- Note: don't bother asking for a for a MMapDir
- directive which
- recursively maps all the files in a directory. Use Unix the way it was
- meant to be used. For example, see the
- Include directive, and consider this command:
-
- find /www/htdocs -type f -print \ - | sed -e 's/.*/mmapfile &/' > /www/conf/mmap.conf -- - - - diff --git a/docs/manual/mod/mod_negotiation.html b/docs/manual/mod/mod_negotiation.html deleted file mode 100644 index d53bb52c87..0000000000 --- a/docs/manual/mod/mod_negotiation.html +++ /dev/null @@ -1,223 +0,0 @@ - - - -
This module provides for content negotiation.
- -Status: Base
-
-Source File: mod_negotiation.c
-
-Module Identifier: negotiation_module
-
type-map)
-which explicitly lists the files containing the variants.
-x-compress for compress'd
-files, and x-gzip for gzip'd files. The x- prefix
-is ignored for encoding comparisons.
-en, meaning English.
-name=value. Common parameters
-include:
-text/html this defaults to 2, otherwise 0.
-Content-Type: image/jpeg; qs=0.8/some/dir/foo and
-/some/dir/foo does not exist, then the server reads the
-directory looking for all files named foo.*, and effectively
-fakes up a type map which names all those files, assigning them the same media
-types and content-encodings it would have if the client had asked for
-one of them by name. It then chooses the best match to the client's
-requirements, and returns that document.- - - -
CacheNegotiatedDocs off- -
If set, this directive allows content-negotiated documents to be -cached by proxy servers. This could mean that clients behind those -proxys could retrieve versions of the documents that are not the best -match for their abilities, but it will make caching more -efficient. - -
This directive only applies to requests which come from HTTP/1.0 browsers. -HTTP/1.1 provides much better control over the caching of negotiated -documents, and this directive has no effect in responses to -HTTP/1.1 requests. - -
Prior to version 2.0, CacheNegotiatedDocs did not take an argument; -it was turned on by the presence of the directive by itself. - -
- -The LanguagePriority sets the precedence of language variants for the case -where the client does not express a preference, when handling a -MultiViews request. The list of MIME-lang are in order of decreasing -preference. Example: - -
LanguagePriority en fr defoo.html, where foo.html.fr
-and foo.html.de both existed, but the browser did not express
-a language preference, then foo.html.fr would be returned.- -
- -Note that this directive only has an effect if a 'best' language -cannot be determined by any other means. Correctly implemented -HTTP/1.1 requests will mean this directive has no effect. - -
- -See also: -DefaultLanguage and -AddLanguage - - - - - - diff --git a/docs/manual/mod/mod_proxy.html b/docs/manual/mod/mod_proxy.html deleted file mode 100644 index 61e8216519..0000000000 --- a/docs/manual/mod/mod_proxy.html +++ /dev/null @@ -1,26 +0,0 @@ - - -
-Note: -Mod_proxy has been moved out of the httpd-2.0 tree, but is available -elsewhere <insert location> for building with the httpd-2.0 source -distribution. -- - - - - diff --git a/docs/manual/mod/mod_rewrite.html b/docs/manual/mod/mod_rewrite.html deleted file mode 100644 index 812e755ccc..0000000000 --- a/docs/manual/mod/mod_rewrite.html +++ /dev/null @@ -1,1928 +0,0 @@ - - - - - - -
- - -- - - diff --git a/docs/manual/mod/mod_setenvif.html b/docs/manual/mod/mod_setenvif.html deleted file mode 100644 index 34ee26ce61..0000000000 --- a/docs/manual/mod/mod_setenvif.html +++ /dev/null @@ -1,422 +0,0 @@ - - - -
-Module mod_rewrite
- -
URL Rewriting EngineThis module provides a rule-based rewriting engine to rewrite requested -URLs on the fly.
- -Status: Extension -
- - -
-Source File: mod_rewrite.c -
-Module Identifier: rewrite_module -
-Compatibility: Available in Apache 1.2 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 --- -Welcome to mod_rewrite, the Swiss Army Knife of URL manipulation! - ----`` -Despite the tons of examples and docs, mod_rewrite -is voodoo. Damned cool voodoo, but still voodoo. -'' ----- Brian Moore-
-bem@news.cmc.net --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 -provide a really flexible and powerful URL manipulation mechanism. The URL -manipulations can depend on various tests, for instance server variables, -environment variables, HTTP headers, time stamps and even external database -lookups in various formats can be used to achieve a really granular URL -matching. - -
-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 parts on result. -The rewritten result can lead to internal sub-processing, external request -redirection or even to an internal proxy throughput. - --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 1996
-and gifted exclusively to the The Apache Group in July 1997 by - --
-- -Ralf S. Engelschall
-rse@engelschall.com
-www.engelschall.com--
- -Table Of Contents
- --Internal Processing -
--Configuration Directives -
-
-Miscellaneous - - -- RewriteEngine -
- RewriteOptions -
- RewriteLog -
- RewriteLogLevel -
- RewriteLock -
- RewriteMap -
- RewriteBase -
- RewriteCond -
- RewriteRule -
-
- -- - -Internal 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
- --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 used after the HTTP request has been read but before any authorization -starts and the Fixup hook which is triggered after the authorization phases -and after the per-directory config files (
.htaccess) have been -read, but before the content handler is activated. - --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 steps later when the final data directories are -found, the per-directory configuration directives of mod_rewrite are triggered -in the Fixup phase. In both situations mod_rewrite rewrites URLs either to new -URLs or to filenames, although there is no obvious distinction between them. -This is a usage of the API which was not intended to be this way when the API -was designed, but as of Apache 1.x this is the only way mod_rewrite can -operate. To make this point more clear remember the following two points: - -
-
- -- 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 processing more clear. But this point has no - drawbacks for the user, it is just a fact which should be - remembered: Apache does more in the URL-to-filename hook than the - API intends for it. -
-
- Unbelievably mod_rewrite provides URL manipulations in per-directory - context, i.e., within
.htaccessfiles, - although these are reached a very long time after the URLs have - been translated to filenames. It has to be this way because -.htaccessfiles live in the filesystem, so processing - has already reached this stage. In other words: According to the - API phases at this time it is too late for any URL manipulations. - To overcome this chicken and egg problem mod_rewrite uses a trick: - When you manipulate a URL/filename in per-directory context - mod_rewrite first rewrites the filename back to its corresponding - URL (which is usually impossible, but see theRewriteBase- directive below for the trick to achieve this) and then initiates - a new internal sub-request with the new URL. This restarts - processing of the API phases. -- Again mod_rewrite tries hard to make this complicated step totally - transparent to the user, but you should remember here: While URL - manipulations in per-server context are really fast and efficient, - per-directory rewrites are slow and inefficient due to this chicken and - egg problem. But on the other hand this is the only way mod_rewrite can - provide (locally restricted) URL manipulations to the average user. -
-Don't forget these two points! - -
Ruleset Processing
- -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 kernel for per-directory context). Then the URL rewriting engine is -started with the contained ruleset (one or more rules together with their -conditions). The operation of the URL rewriting engine itself is exactly the -same for both configuration contexts. Only the final result processing is -different. - --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 -(
RewriteRuledirectives) and when a particular rule matches it -optionally loops through existing corresponding conditions -(RewriteConddirectives). 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. - --
-- --
-- -- - --Figure 1: The control flow through the rewriting ruleset - --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 for corresponding rule conditions. If none are present, it just -substitutes the URL with a new value which is constructed from the string -Substitution and goes on with its rule-looping. But if conditions -exist, it starts an inner loop for processing them in the order that -they are listed. For conditions the logic is different: we don't match a -pattern against the current URL. Instead we first create a string -TestString by expanding variables, back-references, map lookups, -etc. and then we try to match CondPattern against it. If the -pattern doesn't match, the complete set of conditions and the corresponding -rule fails. If the pattern matches, then the next condition is processed -until no more conditions are available. If all conditions match, processing -is continued with the substitution of the URL with Substitution. - -
Regex Back-Reference Availability
- -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$Nand%N(see below). These -are available for creating the strings Substitution and -TestString. Figure 2 shows to which locations the back-references are -transfered for expansion. - --
-- --
-- -- - --Figure 2: The back-reference flow through a rule - --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. - -
-
- -- - -Configuration Directives
--
- -RewriteEngine
-Syntax: - RewriteEngine on|off
-Default: -RewriteEngine off
-Context: - server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2
- --The
RewriteEnginedirective enables or disables the runtime -rewriting engine. If it is set tooffthis module does no runtime -processing at all. It does not even update theSCRIPT_URx-environment variables. - --Use this directive to disable the module instead of commenting out -all the
RewriteRuledirectives! - --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. - --
-- -
RewriteOptions
-Syntax: RewriteOptions Option
-Default: None
-Context: server config, virtual host, directory, - .htaccess
-Override: FileInfo
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2
- --The
RewriteOptionsdirective sets some special options for the -current per-server or per-directory configuration. The Option -strings can be one of the following: - --
- -- '
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 -.htaccessconfiguration are inherited. --
-- -
RewriteLog
-Syntax: RewriteLog Filename
-Default: None
-Context: server config, virtual host
-Override: Not applicable
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2
- --The
RewriteLogdirective 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. - --
-
- -- -Note: 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 logfile it still creates the logfile -output internally. This will slow down the server with no advantage -to the administrator! -To disable logging either remove or comment out the -RewriteLogdirective or useRewriteLogLevel 0! --
-
- -- -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: -
-- --RewriteLog "/usr/local/var/apache/logs/rewrite.log" ---
-- -
RewriteLogLevel
-Syntax: RewriteLogLevel Level
-Default:RewriteLogLevel 0-
-Context: server config, virtual host
-Override: Not applicable
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2
- --The
RewriteLogLeveldirective 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 Level to 0. -This disables all rewrite action logs. - -
-
-
- - -- -Notice: 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: -
-- --RewriteLogLevel 3 ---
-- -
RewriteLock
-Syntax: RewriteLock Filename
-Default: None
-Context: server config
-Override: Not applicable
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.3
- --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. - -
-
-- -
RewriteMap
-Syntax: RewriteMap MapName - MapType:MapSource
-Default: not used per default
-Context: server config, virtual host
-Override: Not applicable
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2 (partially), Apache 1.3
- --The
RewriteMapdirective 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 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: - -
-- -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. - -${MapName:LookupKey -}
-${MapName:LookupKey -|DefaultValue}--The following combinations for MapType and MapSource -can be used: - -
-
- -The- Standard Plain Text
- MapType:txt, MapSource: Unix filesystem path to valid regular - file -- This is the standard rewriting map feature where the MapSource is - a plain ASCII file containing either blank lines, comment lines (starting - with a '#' character) or pairs like the following - one per line. - -
- MatchingKey SubstValue -- -- Example: -
-
-
- -- -
-
- -- -
- Randomized Plain Text
- MapType:rnd, MapSource: Unix filesystem path to valid regular - file -- This is identical to the Standard Plain Text variant above but with a - special - post-processing feature: After looking up a value it is parsed according - to contained ``
|'' characters which have the meaning of - ``or''. - In other words they indicate a set of alternatives from which the actual - returned value is chosen randomly. Although this sounds crazy and useless, - it - was actually designed for load balancing in a reverse proxy situation where - the looked up values are server names. - Example: --
-
- -- -
-
- -- -
- Hash File
- MapType:dbm, MapSource: Unix filesystem path to valid - regular file -- Here the source is a binary NDBM format file containing the same contents - as a Plain Text format file, but in a special representation - which is optimized for really fast lookups. You can create such a file with - any NDBM tool or with the following Perl script: -
-
-
-- -#!/path/to/bin/perl -## -## txt2dbm -- convert txt map to dbm format -## - -($txtmap, $dbmmap) = @ARGV; -open(TXT, "<$txtmap"); -dbmopen(%DB, $dbmmap, 0644); -while (<TXT>) { - next if (m|^s*#.*| or m|^s*$|); - $DB{$1} = $2 if (m|^\s*(\S+)\s+(\S+)$|); -} -dbmclose(%DB); -close(TXT)-
-
-- -
- Internal Function
- MapType:int, MapSource: Internal Apache function -- Here the source is an internal Apache function. Currently you cannot - create your own, but the following functions already exists: -
-
-- toupper:
- Converts the looked up key to all upper case. -- tolower:
- Converts the looked up key to all lower case. -- escape:
- Translates special characters in the looked up key to hex-encodings. -- unescape:
- Translates hex-encodings in the looked up key back to special characters. --
- External Rewriting Program
- MapType:prg, MapSource: Unix filesystem path to valid - regular file -- Here the source is a program, not a map file. To create it you - can use the language of your choice, but the result has to be a - executable (i.e., either object-code or a script with the - magic cookie trick '
#!/path/to/interpreter' as the - first line). -- This program is started once at startup of the Apache servers and then - communicates with the rewriting engine over its
stdinand -stdoutfile-handles. For each map-function lookup it will - receive the key to lookup as a newline-terminated string on -stdin. It then has to give back the looked-up value as a - newline-terminated string onstdoutor the four-character - string ``NULL'' if it fails (i.e., there is no - corresponding value - for the given key). A trivial program which will implement a 1:1 map - (i.e., key == value) could be: --
-
-- -#!/usr/bin/perl -$| = 1; -while (<STDIN>) { - # ...put here any transformations or lookups... - print $_; -} -- But be very careful:
--
-- ``Keep it simple, stupid'' (KISS), because - if this program hangs it will hang the Apache server - when the rule occurs. -
- Avoid one common mistake: never do buffered I/O on
stdout! - This will cause a deadloop! Hence the ``$|=1'' in the - above example... -- 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. -
RewriteMapdirective can occur more than once. For each -mapping-function use oneRewriteMapdirective to declare its -rewriting mapfile. While you cannot declare a map in -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 looked-up -keys are cached in-core -until the mtimeof 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! --
-- -
RewriteBase
-Syntax: RewriteBase BaseURL
-Default: default is the physical directory path -
-Context: directory, .htaccess
-Override: FileInfo
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2
- --The
RewriteBasedirective explicitly sets the base URL for -per-directory rewrites. As you will see below,RewriteRulecan be -used in per-directory config files (.htaccess). There it will act -locally, i.e., the local directory prefix is stripped at this stage of -processing and your rewriting rules act only on the remainder. At the end -it is automatically added back to the path. - --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 filepath itself. But at most websites URLs are -NOT directly related to physical filename paths, so this -assumption will usually be wrong! There you have to use the -
RewriteBasedirective to specify the correct URL-prefix. - --
-
- -- -Notice: If your webserver's URLs are not -directly related to physical file paths, you have to use - RewriteBasein every -.htaccessfiles where you want to useRewriteRule-directives. --Example: - -
- Assume the following per-directory config file: - -- - --
-
- -- -In the above example, a request to
/xyz/oldstuff.html-gets correctly -rewritten to the physical file/abc/def/newstuff.html. - --
-
- -- - -Note - For Apache hackers:
-The following list gives detailed information about the internal -processing steps: - --
-Request: - /xyz/oldstuff.html - -Internal Processing: - /xyz/oldstuff.html -> /abc/def/oldstuff.html (per-server Alias) - /abc/def/oldstuff.html -> /abc/def/newstuff.html (per-dir RewriteRule) - /abc/def/newstuff.html -> /xyz/newstuff.html (per-dir RewriteBase) - /xyz/newstuff.html -> /abc/def/newstuff.html (per-server Alias) - -Result: - /abc/def/newstuff.html -- -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 has to be re-injected into the Apache -kernel! BUT: While this seems like a serious overhead, it really isn't, because -this re-injection happens fully 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
-Syntax: RewriteCond TestString - CondPattern
-Default: None
-Context: server config, virtual host, directory, - .htaccess
-Override: FileInfo
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2 (partially), Apache 1.3
- --The
RewriteConddirective defines a rule condition. Precede a -RewriteRuledirective with one or moreRewriteCond-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 following -expanded constructs in addition to plain text: - -
-
- -- RewriteRule backreferences: These are backreferences of - the form - -
-- -(0 <= N <= 9) which provide access to the grouped parts (parenthesis!) -of the pattern from the corresponding$N-RewriteRuledirective (the -one following the current bunch ofRewriteConddirectives). - --
- RewriteCond backreferences: These are backreferences of -the form - -
-- -(1 <= N <= 9) which provide access to the grouped parts (parentheses!) of -the pattern from the last matched%N-RewriteConddirective in the -current bunch of conditions. - --
- RewriteMap expansions: These are expansions of the form - -
-- -See the documentation for RewriteMap for more details. - -${mapname:key|default}--
- Server-Variables: These are variables - of the form - -
-- -where NAME_OF_VARIABLE can be a string -taken from the following list: - -%{NAME_OF_VARIABLE}--
-
- -- --HTTP headers: - -- -HTTP_USER_AGENT
-HTTP_REFERER
-HTTP_COOKIE
-HTTP_FORWARDED
-HTTP_HOST
-HTTP_PROXY_CONNECTION
-HTTP_ACCEPT
- --connection & request: - -- -REMOTE_ADDR
-REMOTE_HOST
-REMOTE_USER
-REMOTE_IDENT
-REQUEST_METHOD
-SCRIPT_FILENAME
-PATH_INFO
-QUERY_STRING
-AUTH_TYPE
- -- - --server internals: - -- -DOCUMENT_ROOT
-SERVER_ADMIN
-SERVER_NAME
-SERVER_ADDR
-SERVER_PORT
-SERVER_PROTOCOL
-SERVER_SOFTWARE
- --system stuff: - -- -TIME_YEAR
-TIME_MON
-TIME_DAY
-TIME_HOUR
-TIME_MIN
-TIME_SEC
-TIME_WDAY
-TIME
- --specials: -- -API_VERSION
-THE_REQUEST
-REQUEST_URI
-REQUEST_FILENAME
-IS_SUBREQ
- --
-
- -- - - Notice: These variables all correspond to -the similarly named HTTP MIME-headers, C variables of the Apache -server or
- -struct tmfields of the Unix system. Most -are documented elsewhere in the Manual or in the CGI specification. -Those that are special to mod_rewrite include:-
- -- -
IS_SUBREQ- 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- 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 corresponds to the -version of Apache in use (in the release version of Apache 1.3.14, for -instance, it is 19990320:10), but is mainly of interest to module -authors.
- -- -
THE_REQUEST- 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- The resource requested in the HTTP request line. (In the -example above, this would be "/index.html".)
- -- -
REQUEST_FILENAME- The full local filesystem path to the file or script -matching the request.
--Special Notes: - -
-
- -- The variables SCRIPT_FILENAME and REQUEST_FILENAME contain the same -value, i.e., the value of the
filenamefield of -the internal -request_recstructure of the Apache server. The first name is -just the -commonly known CGI variable name while the second is the consistent -counterpart to REQUEST_URI (which contains the value of theuri-field ofrequest_rec). - --
- 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) viagetenv()-from the Apache server process. - --
- 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:''. - --
- 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 variable for rewriting -which is actually set later in an API phase and thus is not available at the -current stage. For instance when you want to rewrite according to the -REMOTE_USERvariable from within the per-server context -(httpd.conffile) you have to use%{LA-U:REMOTE_USER}-because this variable is set by the authorization phases which come -after the URL translation phase where mod_rewrite operates. On the -other hand, because mod_rewrite implements its per-directory context -(.htaccessfile) via the Fixup phase of the API and because the -authorization phases come before this phase, you just can use -%{REMOTE_USER}there. - --
- 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. --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 standard -Extended Regular Expression with some additions: - -
-
- -- You can prefix the pattern string with a '
!' character -(exclamation mark) to specify a non-matching pattern. - --
- -There are some special variants of CondPatterns. Instead of real -regular expression strings you can also use one of the following: -
-
-
-- '<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 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 equal)
-Treats the CondPattern as a plain string and compares it -lexically to TestString. True if -TestString is lexically equal to CondPattern, i.e the -two strings are exactly equal (character by character). -If CondPattern is just "" (two quotation marks) this -compares TestString to the empty string. --
- '-d' (is directory)
-Treats the TestString as a pathname and -tests if it exists and is a directory. --
- '-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 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 link)
-Treats the TestString as a pathname and -tests if it exists and is a symbolic link. --
- '-F' (is existing file via subrequest)
-Checks if TestString is a valid file 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 servers performance! --
- '-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: -All of these tests can also be prefixed by an exclamation mark ('!') -to negate their meaning. - -Additionally you can set special flags for CondPattern by appending - -
-- -as the third argument to the[flags]-RewriteConddirective. Flags -is a comma-separated list of the following flags: - --
- -- '
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 expanded - TestString and the CondPattern. - This flag is effective only for comparisons between - 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: --
- Without this flag you would have to write the cond/rule three times. --RewriteCond %{REMOTE_HOST} ^host1.* [OR] -RewriteCond %{REMOTE_HOST} ^host2.* [OR] -RewriteCond %{REMOTE_HOST} ^host3.* -RewriteRule ...some special stuff for any of these hosts... --Example: -
- -To rewrite the Homepage of a site according to the ``- -User-Agent:'' -header of the request, you can use the following: - -- -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 you -get the min homepage, which contains no images, no tables, etc. If you -use any other browser you get the standard homepage. --RewriteCond %{HTTP_USER_AGENT} ^Mozilla.* -RewriteRule ^/$ /homepage.max.html [L] - -RewriteCond %{HTTP_USER_AGENT} ^Lynx.* -RewriteRule ^/$ /homepage.min.html [L] - -RewriteRule ^/$ /homepage.std.html [L] --
-- -
RewriteRule
-Syntax: RewriteRule Pattern Substitution
-Default: None
-Context: server config, virtual host, directory, .htaccess
-Override: FileInfo
-Status: Extension
-Module: mod_rewrite.c
-Compatibility: Apache 1.2 (partially), Apache 1.3
- --The
RewriteRuledirective 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 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 ``current'' means the value of the URL when this rule gets -applied. This may not be the originally requested URL, because no -longer existingany number of rules may already have matched and made -alterations to it. - -
-Some hints about the syntax of regular expressions: - -
-
-
- -- -- --Text: --.Any single character -[chars]Character class: One of chars -[^chars]Character class: None of chars - text1|text2 Alternative: text1 or text2 - -Quantifiers: -?0 or 1 of the preceding text -*0 or N of the preceding text (N > 0) -+1 or N of the preceding text (N > 1) - -Grouping: -(text)Grouping of text - (either to set the borders of an alternative or - for making backreferences where the Nth group can - be used on the RHS of a RewriteRule with$N) - -Anchors: -^Start of line anchor -$End of line anchor - -Escaping: -\char escape that particular char - (for instance to specify the chars ".[]()" etc.) --For more information about regular expressions either have a look at your -local regex(3) manpage or its
src/regex/regex.3copy in the -Apache 1.3 distribution. If you are interested in more detailed -information about regular expressions and their variants (POSIX regex, Perl -regex, etc.) have a look at the following dedicated book on this topic: - --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 ('
!') 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 -pattern''. This can be used for exceptional cases, where it is easier to -match the negative pattern, or as a last default rule. - --
-
- -- -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 pattern does NOT match, there are no contents for the groups. In -consequence, if negated patterns are used, you cannot use $Nin the -substitution string! --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 - -
-
- -Back-references are- back-references
$Nto the RewriteRule pattern -- back-references
%Nto the last matched RewriteCond pattern -- server-variables as in rule condition test-strings (
%{VARNAME}) -- mapping-function calls (
${mapname:key|default}) -$N (N=0..9) identifiers which -will be replaced by the contents of the Nth group of the matched -Pattern. The server-variables are the same as for the -TestString of aRewriteConddirective. The -mapping-functions come from theRewriteMapdirective and are -explained there. These three types of variables are expanded in the order of -the above list. - --As already mentioned above, all the rewriting rules are applied to the -Substitution (in the order of definition in the config file). The -URL is completely replaced by the Substitution and the -rewriting process goes on until there are no more rules unless explicitly -terminated by a
Lflag - see below. - --There is a special substitution string named '
-' which means: -NO substitution! Sounds silly? No, it is useful to provide rewriting -rules which only match some URLs but do no substitution, e.g., in -conjunction with the C (chain) flag to be able to have more than one -pattern to be applied before a substitution occurs. - --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 -QUERY_STRING. When you want to erase an existing query string, end the -substitution string with just the question mark. - -
-
-
- -- -Note: There is a special feature: When you prefix a substitution -field with http://thishost[:thisport] then -mod_rewrite automatically strips it out. This auto-reduction on -implicit external redirect URLs is a useful and important feature when -used in 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: An unconditional external redirect to your own server will -not work with the prefix http://thishostbecause 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 Substitution by appending - -
-- -as the third argument to the[flags]-RewriteRuledirective. Flags is a -comma-separated list of the following flags: - --
- -- '
redirect|R[=code]' (force redirect)
- Prefix Substitution - withhttp://thishost[:thisport]/(which makes the new URL a URI) to - force a external redirection. If no code is given a HTTP response - of 302 (MOVED TEMPORARILY) is used. If you want to use other response - codes in the range 300-400 just specify them as a number or use - one of the following symbolic names:temp(default),permanent, -seeother. - Use it for rules which should - canonicalize the URL and give it back to the client, e.g., translate - ``/~'' into ``/u/'' or always append a slash to -/u/user, etc.
-- 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
http://thishost[:thisport]/, rewriting 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 to be forbidden)
- This forces the current URL to be forbidden, i.e., it immediately sends - back a HTTP response of 403 (FORBIDDEN). Use this flag in conjunction with - appropriate RewriteConds to conditionally block some URLs. --
- '
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 forced as a proxy - request and immediately (i.e., rewriting rule processing stops here) put - through the proxy module. You have to make - sure that the substitution string is a valid URI (e.g., typically starting - withhttp://hostname) which can be handled by the - Apache proxy module. If not you get an error from the proxy module. Use - this flag to achieve a more powerful implementation of the ProxyPass directive, to map some - remote stuff into the namespace of the local server. -- Notice: To use this functionality make sure you have the proxy module - compiled into your Apache server program. If you don't know please check - whether
mod_proxy.cis part of the ``httpd -l'' - output. If yes, this functionality is available to mod_rewrite. If not, - then you first have to rebuild the ``httpd'' program with - mod_proxy enabled. --
- '
last|L' (last rule)
- Stop the rewriting process here and - don't apply any more rewriting rules. This corresponds to the Perl -lastcommand or thebreakcommand from the C - language. Use this flag to prevent the currently rewritten URL from being - rewritten further by following rules. For - example, use it to rewrite the root-path URL ('/') to a real - one, e.g., '/e/www/'. --
- '
next|N' (next round)
- Re-run the rewriting process (starting again with the first rewriting - rule). Here the URL to match is again not the original URL but the URL - from the last rewriting rule. This corresponds to the Perl -nextcommand or thecontinuecommand 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! --
- '
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, etc.). This has the following - effect: if a rule matches, then processing continues as usual, i.e., the - flag has no effect. If the rule does not match, then all following - chained rules are skipped. For instance, use it to remove the - ``.www'' part inside a per-directory rule set 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 MIME-type. For - instance, this can be used to simulate themod_alias- directiveScriptAliaswhich internally forces all files inside - the mapped directory to have a MIME type of - ``application/x-httpd-cgi''. --
- '
nosubreq|NS' (used only if no internal sub-request)
- This flag forces the rewriting engine to skip a rewriting rule if the - current request is an internal sub-request. For instance, sub-requests - occur internally in Apache whenmod_includetries to find out - information about possible directory default files (index.xxx). - On sub-requests it is not always useful and even sometimes causes a failure to - if the complete set of rules are applied. Use this flag to exclude some rules.
-- 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' (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' (query string - append)
- This flag forces the rewriting engine to append a query - string part in the substitution string to the existing one instead of - replacing it. Use this when you want to add more data to the query string - via a rewrite rule. --
- '
passthrough|PT' (pass through to next handler)
- This flag forces the rewriting engine to set theurifield - of the internalrequest_recstructure to the value - of thefilenamefield. This flag is just a hack to be able - to post-process the output ofRewriteRuledirectives by -Alias,ScriptAlias,Redirect, etc. directives - from other URI-to-filename translators. A trivial example to show the - semantics: - If you want to rewrite/abcto/defvia the rewriting - engine ofmod_rewriteand then/defto/ghi- withmod_alias: -- RewriteRule ^/abc(.*) /def$1 [PT] - Alias /def /ghi -- If you omit thePTflag thenmod_rewrite- will do its job fine, i.e., it rewritesuri=/abc/...to -filename=/def/...as a full API-compliant URI-to-filename - translator should do. Thenmod_aliascomes and tries to do a - URI-to-filename transition which will not work. -- Note: You have to use this flag if you want to intermix directives - of different modules which contain URL-to-filename translators. The - typical example is the use of
mod_aliasand -mod_rewrite.. --
-
-- - - Note - 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 next rule(s))
- This flag forces the rewriting engine to skip the next num rules - in sequence when the current rule matches. Use this to make pseudo - if-then-else constructs: The last rule of the then-clause becomes -skip=Nwhere N is the number of rules in the 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 be set to the - value VAL, where VAL can contain regexp backreferences -$Nand%Nwhich will be expanded. You can use this flag - more than once to set more than one variable. The variables can be later - dereferenced in many situations, but usually from - within XSSI (via<!--#echo var="VAR"-->) or CGI (e.g. -$ENV{'VAR'}). Additionally you can dereference it in a - following RewriteCond pattern via%{ENV:VAR}. Use this to strip - but remember information from URLs. --
-
- -- -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 -directory!) is automatically removed for the pattern matching and -automatically added after the substitution has been done. This feature is -essential for many sorts of rewriting, because without this prefix stripping -you have to match the parent directory which is not always possible. - -There is one exception: If a substitution string starts with -``
http://'' then the directory prefix will not be added and an -external redirect or proxy throughput (if flag P is used!) is forced! --
-
- -- -Note: To enable the rewriting engine for per-directory configuration files -you need to set `` RewriteEngine On'' in these files and -``Options FollowSymLinks'' must be enabled. If your administrator has -disabled override ofFollowSymLinksfor 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 meanings: - -
-Inside per-server configuration (
httpd.conf)
-for request ``GET /somepath/pathinfo'':
- --
-
- -- -- --Given Rule Resulting Substitution ----------------------------------------------- ---------------------------------- -^/somepath(.*) otherpath$1 not supported, because invalid! - -^/somepath(.*) otherpath$1 [R] not supported, because invalid! - -^/somepath(.*) otherpath$1 [P] not supported, because invalid! ----------------------------------------------- ---------------------------------- -^/somepath(.*) /otherpath$1 /otherpath/pathinfo - -^/somepath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo - via external redirection - -^/somepath(.*) /otherpath$1 [P] not supported, because silly! ----------------------------------------------- ---------------------------------- -^/somepath(.*) http://thishost/otherpath$1 /otherpath/pathinfo - -^/somepath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo - via external redirection - -^/somepath(.*) http://thishost/otherpath$1 [P] not supported, because silly! ----------------------------------------------- ---------------------------------- -^/somepath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo - via external redirection - -^/somepath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo - via external redirection - (the [R] flag is redundant) - -^/somepath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo - via internal proxy ---Inside per-directory configuration for
/somepath
-(i.e., file.htaccessin dir/physical/path/to/somepathcontaining -RewriteBase /somepath)
for -request ``GET /somepath/localpath/pathinfo'':
- --
-
- -- -- --Given Rule Resulting Substitution ----------------------------------------------- ---------------------------------- -^localpath(.*) otherpath$1 /somepath/otherpath/pathinfo - -^localpath(.*) otherpath$1 [R] http://thishost/somepath/otherpath/pathinfo - via external redirection - -^localpath(.*) otherpath$1 [P] not supported, because silly! ----------------------------------------------- ---------------------------------- -^localpath(.*) /otherpath$1 /otherpath/pathinfo - -^localpath(.*) /otherpath$1 [R] http://thishost/otherpath/pathinfo - via external redirection - -^localpath(.*) /otherpath$1 [P] not supported, because silly! ----------------------------------------------- ---------------------------------- -^localpath(.*) http://thishost/otherpath$1 /otherpath/pathinfo - -^localpath(.*) http://thishost/otherpath$1 [R] http://thishost/otherpath/pathinfo - via external redirection - -^localpath(.*) http://thishost/otherpath$1 [P] not supported, because silly! ----------------------------------------------- ---------------------------------- -^localpath(.*) http://otherhost/otherpath$1 http://otherhost/otherpath/pathinfo - via external redirection - -^localpath(.*) http://otherhost/otherpath$1 [R] http://otherhost/otherpath/pathinfo - via external redirection - (the [R] flag is redundant) - -^localpath(.*) http://otherhost/otherpath$1 [P] http://otherhost/otherpath/pathinfo - via internal proxy ---Example: -
-
-We want to rewrite URLs of the form -- ---into -/Language -/~Realname -/.../File ---/u/Username -/.../File -.Language --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 ---
- -- - -Miscellaneous
--
- -Environment Variables
- -This module keeps track of two additional (non-standard) CGI/SSI environment -variables namedSCRIPT_URLandSCRIPT_URI. These contain -the logical Web-view to the current resource, while the standard CGI/SSI -variablesSCRIPT_NAMEandSCRIPT_FILENAMEcontain the -physical System-view. - --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: - -
-- --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
- -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. - - -
- This module provides the ability to set environment variables based - upon attributes of the request. -
- -Status: Base
-
-Source File: mod_setenvif.c
-
-Module Identifier: setenvif_module
-
-Compatibility: Available in Apache 1.3 and later.
-
- 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
- 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 -
For additional information, we proved a document on - Environment Variables in Apache.
- -
- Syntax: BrowserMatch regex
- envar[=value] [envar[=value]] ...
-
- Default: none
-
- 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 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 - egrep-style regex). The rest of the arguments give the - names of variables to set, and optionally values to which they should - be set. These take the form of -
-- 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 string matches more than one entry, they will - be merged. Entries are processed in the order in which they appear, - and later entries can override earlier ones. -
-- 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 - case-sensitive. For case-INsensitive matching, see - the - BrowserMatchNoCase - directive. -
-- The BrowserMatch and BrowserMatchNoCase - directives are special cases of 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 -- -
- Syntax: BrowserMatchNoCase regex
- envar[=value] [envar[=value]] ...
-
- Default: none
-
- 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 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 BrowserMatchNoCase - directives are special cases of 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 -- -
- Syntax: SetEnvIf attribute regex
- envar[=value] [envar[=value]] ...
-
- Default: none
-
- 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 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: -
-- 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 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.
-
![[Needs graphics capability to display]](../images/mod_rewrite_fig1.gif)
![[Needs graphics capability to display]](../images/mod_rewrite_fig2.gif)
- 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.
-
- - Example: -
-- SetEnvIf Request_URI "\.gif$" object_is_image=gif - SetEnvIf Request_URI "\.jpg$" object_is_image=jpg - SetEnvIf Request_URI "\.xbm$" object_is_image=xbm - : - SetEnvIf Referer www\.mydomain\.com intra_site_referral - : - SetEnvIf object_is_image xbm XBIT_PROCESSING=1 --
- 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. -
- -
- Syntax: SetEnvIfNoCase attribute regex
- envar[=value] [envar[=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, 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 to be set to - "apache" if the HTTP request header field - Host: was included and contained Apache.Org, - apache.org, or any other combination. -
- - - - diff --git a/docs/manual/mod/mod_so.html b/docs/manual/mod/mod_so.html deleted file mode 100644 index 5850c7b2a8..0000000000 --- a/docs/manual/mod/mod_so.html +++ /dev/null @@ -1,192 +0,0 @@ - - - -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.
-
On selected operating systems this module can be used to 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 files -(usually with .so extension), on Windows this may either -the .so or .dll extension. This module is -only available in Apache 1.3 and up. - -
In previous releases, the functionality of this module was provided -for Unix by mod_dld, and for Windows by mod_dll. On Windows, mod_dll -was used in beta release 1.3b1 through 1.3b5. mod_so combines these -two modules into a single module for all operating systems. - -
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.
- -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 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.
- -The Apache module API is unchanged between the Unix and Windows - versions. Many modules will run on Windows with no or little change - from Unix, although others rely on aspects of the Unix architecture - which are not present in Windows, and will not work.
- -When a module does work, it can be added to the server in one of two
- ways. As with Unix, it can be compiled into the server. Because Apache
- for Windows does not have the Configure program of Apache
- for Unix, the module's source file must be added to the ApacheCore
- project file, and its symbols must be added to the
- os\win32\modules.c file.
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
- directive. These module DLLs can be distributed and run on any Apache
- for Windows installation, without recompilation of the server.
To create a module DLL, a small change is necessary to the module's
- source file: The module record must be exported from the DLL (which
- will be created later; see below). To do this, 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. Also, if you are
- familiar with .DEF files, you can export the module
- record with that method instead.
Now, create a DLL containing your module. You will need to link this - against the libhttpd.lib export library that is created when the - libhttpd.dll shared library is compiled. You may also have to change - the compiler settings to ensure that the Apache header files are - correctly located. You can find this library in your server root's - modules directory. It is best to grab an existing module .dsp file - from the tree to assure the build environment is configured correctly, - or alternately compare the compiler and link options to your .dsp.
- -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.
- -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 and absolute path or relative to ServerRoot.
-
-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 in the module documentation. Example:
-
-LoadModule status_module modules/mod_status.so
-loads the named module from the modules subdirectory of the - ServerRoot.
- - - - - - diff --git a/docs/manual/mod/mod_speling.html b/docs/manual/mod/mod_speling.html deleted file mode 100644 index cc294cdcee..0000000000 --- a/docs/manual/mod/mod_speling.html +++ /dev/null @@ -1,137 +0,0 @@ - - -
-- 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.
-
- Requests to documents sometimes cannot be served by the core apache - server because the request was misspelled or miscapitalized. This - module addresses this problem by trying to find a matching document, - even after all other modules gave up. It does its work by comparing - each document name in the requested directory against the requested - document name without regard to case, and allowing - up to one misspelling (character insertion / omission - / transposition or wrong character). A list is built with all document - names which were matched using this strategy. -
-- If, after scanning the directory, -
CheckSpelling Off- This directive enables or disables the spelling module. When enabled, - keep in mind that -
-http://my.host/~apahce/), just file names or
- directory names.
- 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. -- -
This module provides information on server activity and -performance.
- -Status: Base
-
-Source File: mod_status.c
-
-Module Identifier: status_module
-
-Compatibility: Available in Apache 1.1 and later.
-
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: -
access.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 to access the
-page http://your.server.name/server-status
-
-Note that mod_status will only work when you are running Apache in -standalone mode and not -inetd mode. - -
http://your.server.name/server-status?refresh=N to refresh the
-page every N seconds.
-http://your.server.name/server-status?auto. This is useful
-when automatically run, see the Perl program in the /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 Off-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. -
--This setting applies to the entire server, and cannot be enabled or -disabled on a virtualhost-by-virtualhost basis. -
- - - - diff --git a/docs/manual/mod/mod_unique_id.html b/docs/manual/mod/mod_unique_id.html deleted file mode 100644 index 9ee0d7adc4..0000000000 --- a/docs/manual/mod/mod_unique_id.html +++ /dev/null @@ -1,205 +0,0 @@ - - - -This module provides an environment variable with a unique identifier -for each request.
- -Status: Extension
-
-Source File: mod_unique_id.c
-
-Module Identifier: unique_id_module
-
-Compatibility: Available in Apache 1.3 and later.
-
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 machines. The environment variable
-UNIQUE_ID is set to the identifier for each request.
-Unique identifiers are useful for various reasons which are beyond the
-scope of this document.
This module has no directives.
- - --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 requests in its lifetime. For the -purpose of this discussion, 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 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 universe", and with certain assumptions we'll -show that in this universe we can generate unique identifiers for each -request, without extensive communication between machines in the cluster. - -
-The machines in your cluster should satisfy these requirements. -(Even if you have only one machine you should synchronize its clock -with NTP.) - -
-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 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 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 quadruple ( ip_addr, pid, time_stamp, -counter ) is sufficient to enumerate 65536 requests per second per -httpd 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 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 a unique identifier is -generated, the time stamp used is the time the request arrived at the -web server. The counter is incremented every time an identifier is -generated (and allowed to roll over). - -
-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 reused within the same second, it does not -destroy the uniqueness of our quadruple. That is, we assume the system -does not spawn 65536 processes in a one second interval (it may even 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 -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 that we can get pid and time stamp reuse. -The choice of initializer for the counter is intended to help defeat this. -Note that we really want a random number to initialize the counter, -but there aren't any readily available numbers on most systems (i.e., you -can't use rand() because you need to seed the generator, and can't seed -it with the time because time, at least at one second resolution, has -repeated itself). This is not a perfect defense. - -
-How good a defense is it? Well 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 that it will require a number of children which -depends on how many concurrent clients you have. But we'll be pessimistic -and suppose that a single child is able to serve 500 requests per second. -There are 1000 possible starting counter values such that two sequences -of 500 requests overlap. So there is a 1.5% chance that if time (at one -second resolution) repeats itself this child will repeat a counter value, -and uniqueness will be broken. This was a very pessimistic example, -and with real world values it's even less likely to occur. If your -system is 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 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 be true -- they should be configured to -assume that the motherboard clock is on UTC and compensate appropriately. -But even still, if you're running NTP then your UTC time will be correct -very shortly after reboot. - -
-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 base64 encoding, producing 19 characters.
-The MIME base64 alphabet is actually [A-Za-z0-9+/] however
-+ and / need to be specially encoded in URLs,
-which makes them less desirable. All values are encoded in network
-byte ordering so that the encoding is comparable across architectures of
-different byte ordering. The actual ordering of the encoding is: time
-stamp, IP address, pid, counter. This ordering has a purpose, but it
-should be emphasized that applications should not dissect the encoding.
-Applications should treat the entire encoded UNIQUE_ID as an
-opaque token, which can be compared against other UNIQUE_IDs
-for equality only.
-
-
-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, and can otherwise use the same alphabet and
-bit length. Since the time stamps are essentially an increasing sequence,
-it's sufficient to have a flag second in which all machines in the
-cluster stop serving and request, and stop using the old encoding format.
-Afterwards they can resume requests and begin issuing the new encodings.
-
-
-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 identifiers can be made longer as required. -Essentially no communication is required between machines in the cluster -(only NTP synchronization is required, which is low overhead), and no -communication between httpd processes is required (the communication is -implicit in the pid value assigned by the kernel). In very specific -situations the identifier can be 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). - - - - diff --git a/docs/manual/mod/mod_userdir.html b/docs/manual/mod/mod_userdir.html deleted file mode 100644 index 98894962c8..0000000000 --- a/docs/manual/mod/mod_userdir.html +++ /dev/null @@ -1,139 +0,0 @@ - - -
-This module provides for user-specific directories.
- -Status: Base
-
-Source File: mod_userdir.c
-
-Module Identifier: userdir_module
-
UserDir public_htmlUserDir
-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.- -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: -
-
-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 specification. A request for
-http://www.foo.com/~bob/one/two.html will be translated to:
-
-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: -
-UserDir http://www.foo.com/users -> http://www.foo.com/users/bob/one/two.html -UserDir http://www.foo.com/*/usr -> http://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> - directive and the - Security Tips - page for more information. - -- - - - - diff --git a/docs/manual/mod/mod_usertrack.html b/docs/manual/mod/mod_usertrack.html deleted file mode 100644 index a98875113e..0000000000 --- a/docs/manual/mod/mod_usertrack.html +++ /dev/null @@ -1,224 +0,0 @@ - - - -
This module uses cookies to provide for a clickstream log of user -activity on a site.
- -Status: Extension
-
-Source File: mod_usertrack.c
-
-Module Identifier: usertrack_module
-
-Compatibility: Known as mod_cookies prior to
-Apache 1.3.
-
Previous releases of Apache have included a module which generates a -'clickstream' log of user activity on a site using cookies. This was -called the "cookies" module, mod_cookies. In Apache 1.2 and later this -module has been renamed the "user tracking" module, -mod_usertrack. This module has been simplified and new directives -added.
- -Previously, the cookies module (now the user tracking module) did its -own logging, using the CookieLog directive. In this release, -this module does no logging at all. Instead, a configurable log -format file should be used to log user click-streams. This is possible -because the logging module allows multiple log files. The cookie itself is -logged by using the text %{cookie}n -in the log file format. For example: -
-CustomLog logs/clickstream "%{cookie}n %r %t"
-
-
-For backward compatibility the configurable log module implements the
-old CookieLog directive, but this should be upgraded to the
-above CustomLog directive.
-
-- -
-From: "Christian Allen" <christian@sane.com> -Subject: Re: Apache Y2K bug in mod_usertrack.c -Date: Tue, 30 Jun 1998 11:41:56 -0400 - -Did some work with cookies and dug up some info that might be useful. - -True, Netscape claims that the correct format NOW is four digit dates, and -four digit dates do in fact work... for Netscape 4.x (Communicator), that -is. However, 3.x and below do NOT accept them. It seems that Netscape -originally had a 2-digit standard, and then with all of the Y2K hype and -probably a few complaints, changed to a four digit date for Communicator. -Fortunately, 4.x also understands the 2-digit format, and so the best way to -ensure that your expiration date is legible to the client's browser is to -use 2-digit dates. - -However, this does not limit expiration dates to the year 2000; if you use -an expiration year of "13", for example, it is interpreted as 2013, NOT -1913! In fact, you can use an expiration year of up to "37", and it will be -understood as "2037" by both MSIE and Netscape versions 3.x and up (not sure -about versions previous to those). Not sure why Netscape used that -particular year as its cut-off point, but my guess is that it was in respect -to UNIX's 2038 problem. Netscape/MSIE 4.x seem to be able to understand -2-digit years beyond that, at least until "50" for sure (I think they -understand up until about "70", but not for sure). - -Summary: Mozilla 3.x and up understands two digit dates up until "37" -(2037). Mozilla 4.x understands up until at least "50" (2050) in 2-digit -form, but also understands 4-digit years, which can probably reach up until -9999. Your best bet for sending a long-life cookie is to send it for some -time late in the year "37". -- -
- -When used, this directive sets an expiry time on the cookie generated -by the usertrack module. The expiry-period can be given either -as a number of seconds, or in the format such as "2 weeks 3 days 7 -hours". Valid denominations are: years, months, weeks, hours, minutes -and seconds. If the expiry time is in any format other than one -number indicating the number of seconds, it must be enclosed by -double quotes. - -
If this directive is not used, cookies last only for the current -browser session.
- -
-This directive allows you to change the name of the cookie this module
-uses for its tracking purposes. By default the cookie is named
-"Apache".
-
-You must specify a valid cookie name; results are unpredictable if -you use a name containing unusual characters. Valid characters -include A-Z, a-z, 0-9, "_", and "-". -
- -- -When the user track module is compiled in, and "CookieTracking on" is -set, Apache will start sending a user-tracking cookie for all new -requests. This directive can be used to turn this behavior on or off -on a per-server or per-directory basis. By default, compiling -mod_usertrack will not activate cookies. - - - - - - diff --git a/docs/manual/mod/mod_vhost_alias.html b/docs/manual/mod/mod_vhost_alias.html deleted file mode 100644 index 8051209073..0000000000 --- a/docs/manual/mod/mod_vhost_alias.html +++ /dev/null @@ -1,345 +0,0 @@ - - -
--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.
-
This module creates dynamically configured virtual hosts, by
-allowing the IP address and/or the Host: header of the
-HTTP request to be used as part of the pathname to determine what
-files to serve. This allows for easy use of a huge number of virtual
-hosts with similar configurations.
See also: UseCanonicalName.
- - -
-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
-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:
-
%%
- %
- %p
- %N.M
-
-N and M are used to specify substrings of
-the name. N selects from the dot-separated components of
-the name, and M selects characters within whatever
-N has selected. M is optional and defaults
-to zero if it isn't present; the dot must be present if and only if
-M is present. The interpretation is as follows:
-
0
- 1
- 2
- -1
- -2
- 2+
- -2+
- 1+ and -1+
- 0
-N or M is greater than the number of
-parts available a single underscore is interpolated.
-
-
--For simple name-based virtual hosts you might use the following -directives in your server configuration file: -
- UseCanonicalName Off - VirtualDocumentRoot /usr/local/apache/vhosts/%0 --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 - VirtualDocumentRoot /usr/local/apache/vhosts/%3+/%2.1/%2.2/%2.3/%2 --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:
-- 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:
-- 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.
-
-
--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 - VirtualScriptAliasIP /usr/local/apache/vhosts/%1/%2/%3/%4/cgi-bin --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 if
-the IP address of www.example.com were 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.
-
-
-
-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
http://www.example.isp.com/directory/file.html
-will be satisfied by the file
-/usr/local/apache/vhosts/example.isp/directory/file.html.
-
-
-
-The LogFormat directives
-%V and %A are useful in conjunction with
-this module.
-
-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.
-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.
-
-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 directive,
-except that it uses the IP address of the server end of the connection
-instead of the server name.
-
-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.
-The VirtualScriptAlias directive allows you to determine
-where Apache will find CGI scripts in a similar manner to
-VirtualDocumentRoot
-does for other documents. It matches requests for URIs starting
-/cgi-bin/, much like
-ScriptAlias /cgi-bin/
-would.
-
-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.
-The VirtualScriptAliasIP directive is like the
-VirtualScriptAlias directive,
-except that it uses the IP address of the server end of the connection
-instead of the server name.
-
-
-
-
-
diff --git a/docs/manual/mod/module-dict.html b/docs/manual/mod/module-dict.html
deleted file mode 100644
index 7d99828e81..0000000000
--- a/docs/manual/mod/module-dict.html
+++ /dev/null
@@ -1,144 +0,0 @@
-
-
-
- - Each Apache module is described using a common format that looks - like this: -
-- Each of the attributes, complete with values where possible, are - described in this document. -
- -- This indicates how tightly bound into the Apache Web server the - module is; in other words, you may need to recompile the server in - order to gain access to the module and its functionality. Possible - values for this attribute are: -
--
--
--
--
--
-
- This quite simply lists the name of the source file which contains
- the code for the module. This is also the name used by the <IfModule>
- directive.
-
- This is a string which identifies the module for use in the LoadModule directive when - dynamically loading modules. In particular, it is the name - of the external variable of type module in the source file. -
- -- If the module was not part of the original Apache version 2 - distribution, the version in which it was introduced should be listed - here. -
- - - diff --git a/docs/manual/mod/module-dict.html.en b/docs/manual/mod/module-dict.html.en deleted file mode 100644 index 7d99828e81..0000000000 --- a/docs/manual/mod/module-dict.html.en +++ /dev/null @@ -1,144 +0,0 @@ - - - -- Each Apache module is described using a common format that looks - like this: -
-- Each of the attributes, complete with values where possible, are - described in this document. -
- -- This indicates how tightly bound into the Apache Web server the - module is; in other words, you may need to recompile the server in - order to gain access to the module and its functionality. Possible - values for this attribute are: -
--
--
--
--
--
-
- This quite simply lists the name of the source file which contains
- the code for the module. This is also the name used by the <IfModule>
- directive.
-
- This is a string which identifies the module for use in the LoadModule directive when - dynamically loading modules. In particular, it is the name - of the external variable of type module in the source file. -
- -- If the module was not part of the original Apache version 2 - distribution, the version in which it was introduced should be listed - here. -
- - - diff --git a/docs/manual/mod/mpm_common.html b/docs/manual/mod/mpm_common.html deleted file mode 100644 index 3ac8d0122a..0000000000 --- a/docs/manual/mod/mpm_common.html +++ /dev/null @@ -1,774 +0,0 @@ - - - -This file documents directives that are implemented by more -than one multi-processing module (MPM). -
- -Syntax:
- ConnectionStatus on|off
-Default:
- ConnectionStatus on
-Context: server config
-Status: MPM
-Module: perchild
Whether or not to maintain status information on current -connections. If this is off then mod_status will not work properly.
- -Syntax: CoreDumpDirectory directory
-Default: the same location as ServerRoot
-Context: server config
-Status: MPM
-Module: threaded, perchild, prefork, mpm_winnt
This controls the directory to which Apache attempts to switch -before dumping core. The default is in the 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.
Syntax: Group unix-group
-Default: Group #-1
-Context: server config, virtual host
-Status: MPM
-Module: threaded, perchild, prefork
nobody, but this is not always
-possible or desirable.- -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> requires a -properly configured suEXEC wrapper. -When used inside a <VirtualHost> in this manner, only the group -that CGIs are run as is affected. Non-CGI requests are still processed -as the group specified in the main Group directive.
- -SECURITY: See User for a discussion of the security -considerations.
Syntax: PidFile filename
-Default: PidFile logs/httpd.pid
-Context: server config
-Status: MPM
-Module: threaded, perchild, 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.
- -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 placement and -security.
- -Syntax:
-Listen [IP-address:]port number
-Context: server config
-Status: MPM
-Module: threaded, 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, but only on the port given by the Port directive.
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, -instead of the port given by the Port directive. If an IP -address is given as well as a port, the server will listen on the -given port and interface.
- -Note that you may still require a Port directive so -that URLs that Apache generates that point to your server still -work.
- -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 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 -- -
See Also:
-DNS Issues
-See Also:
-Setting which addresses and ports Apache uses
-See Also:
-Known Bugs
-
Syntax: ListenBacklog backlog
-Default: ListenBacklog 511
-Context: server config
-Status: MPM
-Module: threaded, 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 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. -
Syntax: LockFile filename
-Default: LockFile logs/accept.lock
-Context: server config
-Status: MPM
-Module: threaded, 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 reason for changing it is if
-the logs directory is NFS mounted, since the lockfile
-must be stored on a local disk. The PID of the main
-server process is automatically appended to the filename.
- -
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.
Syntax: MaxClients number
-Default: MaxClients 8 (with threads)
-MaxClients 256 (no threads)
-Context: server config
-Status: MPM
-Module: threaded, 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, you must
-edit the HARD_SERVER_LIMIT entry in
-mpm_default.h and recompile.
-
-
Any connection attempts over the MaxClients limit will normally -be queued, 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 number -of simultaneous requests that can be served is obtained from the value -of this directive multiplied by ThreadsPerChild.
- -Syntax: MaxRequestsPerChild number
-Default: MaxRequestsPerChild 10000
-Context: server config
-Status: MPM
-Module: threaded, prefork, perchild, 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 non-zero limit has two beneficial effects: -
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. - -
Syntax: MaxSpareThreads number
-Default: MaxSpareThreads 10 (Perchild) or 500 (threaded)
-Context: server config
-Status: core
-Module: threaded, perchild
Maximum number of idle threads. Different MPMs deal with this directive -differently. Perchild monitor 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.
-threaded 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 MinSpareThreads and -StartServers. - -
Syntax: MaxThreadsPerChild number
-Default: MaxThreadsPerChild 64
-Context: server config
-Status: core
-Module: threaded, 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.
Syntax: MinSpareServers number
-Default: MaxSpareThreads 5 (Perchild) or 250 (threaded)
-Context: server config
-Status: core
-Module: threaded, perchild
Minimum number of idle threads to handle request spikes. Different MPMs -deal with this directive differently. Perchild monitor 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. -
-threaded 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 MaxSpareThreads and -StartServers.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.
- -Syntax: ScoreBoardFile filename
-Default: ScoreBoardFile logs/apache_status
-
-Context: server config
-Status: MPM
-
-Module: threaded, 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 run Apache and see if it creates the file named -by the directive. If your architecture requires it then you must ensure -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 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: -Stopping and Restarting Apache
- - -Syntax: SendBufferSize bytes
-Context: server config
-Status: MPM
-Module: threaded, perchild, prefork, mpm_winnt
Syntax: StartServers number
-Default: StartServers 5
-Context: server config
-Status: MPM
-Module: threaded, prefork
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 MinSpareThreads and -MaxSpareThreads.
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.
- -Syntax: ThreadsPerChild number
-Default: ThreadsPerChild 50
-Context: server config
-Status: MPM
-Module: threaded, 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 enough to handle the entire load of the server. -If using an MPM like threaded, where there are multiple child processes, -the total number of threads should be high enough to handle the common load -on the server.
- -Syntax: User unix-userid
-Default: User #-1
-Context: server config, virtual host
-Status: core
-Module: threaded, perchild, prefork
nobody, but this is not always possible or desirable.
-For example mod_proxy's cache, when enabled, must be accessible to this user
-(see mod_proxy's CacheRoot
-directive).- -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> requires a -properly configured suEXEC wrapper. -When used inside a <VirtualHost> in this manner, only the user -that CGIs are run as is affected. Non-CGI requests are still processed -with the user specified in the main User directive.
-
-SECURITY: Don't set User (or Group) to
-root unless you know exactly what you are doing, and what the
-dangers are.
- - - - diff --git a/docs/manual/mod/mpm_winnt.html b/docs/manual/mod/mpm_winnt.html deleted file mode 100644 index f4a90f03cf..0000000000 --- a/docs/manual/mod/mpm_winnt.html +++ /dev/null @@ -1,59 +0,0 @@ - - -
--This Multi-Processing Module is optimized for Windows NT. -
- -Status: MPM
-
-Source File: mpm_winnt.c
-
-Module Identifier: mpm_winnt_module
-
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
- - --This Multi-Processing Module allows for daemon processes serving requests -to be assigned a variety of different userids. -
- -Status: MPM
-
-Source File: perchild.c
-
-Module Identifier: mpm_perchild_module
-
This Multi-Processing Module (MPM) implements a hybrid -multi-process, multi-threaded web server. A fixed number of processes -create threads to handle requests. Fluctuations in load are handled -by increasing or decreasing the number of threads in each process.
- -A single control process launches the number of child processes
-indicated by the NumServers directive at server startup.
-Each child process creates threads as specified in the
-StartThreads directive. The individual threads then
-listen for connections and serve them when they arrive.
Apache always tries to maintain a pool of spare or idle
-server threads, which stand ready to serve incoming requests. In this
-way, clients do not need to wait for new threads to be created. For
-each child process, Apache assesses the number of idle threads and
-creates or destroys threads to keep this number within the boundaries
-specified by MinSpareThreads and
-MaxSpareThreads. Since this process is very
-self-regulating, it is rarely necessary to modify these directives
-from their default values. The maximum number of clients that may be
-served simultaneously is determined by multiplying the number
-of server processes that will be created (NumServers) by
-the maximum number of threads created in each process
-(MaxThreadsPerChild).
While the parent process is usually started as root under Unix in
-order to bind to port 80, the child processes and threads are launched
-by 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 addition, unless suexec is used, these directives also set
-the privileges which will be inherited by CGI scripts.
MaxRequestsPerChild controls how frequently the server
-recycles processes by killing old ones and launching new ones.
See also: Setting which addresses and ports -Apache uses.
- -In addition it adds the extra ability to specify that specific processes -should serve requests under different userids. These processes can -then be associated with specific virtual hosts.
- - - - -Syntax:
-Default:
-Context: server config
-Status: MPM
-Module: perchild
Tie a virtual host to a specific child process.
- -Syntax:
-Default:
-Context: server config
-Status: MPM
-Module: perchild
Specify a User and Group for a specific child process.
- - - - - - - - - diff --git a/docs/manual/mod/prefork.html b/docs/manual/mod/prefork.html deleted file mode 100644 index 26372a9ed5..0000000000 --- a/docs/manual/mod/prefork.html +++ /dev/null @@ -1,171 +0,0 @@ - - - --This Multi-Processing Module implements a non-threaded, pre-forking -web server. -
- -Status: MPM
-
-Source File: prefork.c
-
-Module Identifier: mpm_prefork_module
-
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 -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 requests. -In this way, clients do not need to wait for a new child processes to -be forked before their requests can be served.
- -The StartServers, MinSpareServers,
-MaxSpareServers, and MaxServers 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 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
-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 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 addition, unless suexec is used,
-these directives also set the privileges which will be inherited
-by CGI scripts.
MaxRequestsPerChild controls how frequently the server
-recycles processes by killing old ones and launching new ones.
See also: Setting which addresses and ports -Apache uses.
- -MaxSpareServers 10- -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 busy sites. -Setting this parameter to a large number is almost always a bad idea.
- -
- -See also MinSpareServers and -StartServers.
MinSpareServers 5- -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 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 MaxSpareServers and -StartServers. - - - - - diff --git a/docs/manual/mod/threaded.html b/docs/manual/mod/threaded.html deleted file mode 100644 index 0d00ff7cab..0000000000 --- a/docs/manual/mod/threaded.html +++ /dev/null @@ -1,105 +0,0 @@ - - -
--This Multi-Processing Module implements a hybrid multi-threaded -multi-process web server. -
- -Status: MPM
-
-Source File: threaded.c
-
-Module Identifier: mpm_threaded_module
-
This Multi-Processing Module (MPM) is the default for most unix-like -operating systems. It implements a hybrid -multi-process multi-threaded server. Each process has a fixed number -of threads. The server adjusts to handle load by increasing or -decreasing the number of processes.
- -A single control process is responsible for launching child
-processes. Each child process creates a fixed number of threads as
-specified in the ThreadsPerChild directive.
-The individual threads then listen for connections and
-serve them when they arrive.
Apache always tries to maintain a pool of spare or idle
-server threads, which stand ready to serve incoming requests. In this
-way, clients do not need to wait for a new threads or processes to be
-created before their requests can be served. Apache assesses the
-total number of idle threads in all processes, and forks or kills
-processes to keep this number within the boundaries specified by
-MinSpareThreads and MaxSpareThreads.
-Since this process is very self-regulating, it is rarely necessary to
-modify these directives from their default values. The maximum
-number of clients that may be served simultaneously is determined
-by multiplying the maximum number of server processes that
-will be created (MaxClients) by the number of threads
-created in each process (ThreadsPerChild).
While the parent process is usually started as root under Unix in
-order to bind to port 80, the child processes and threads are launched
-by 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 addition, unless suexec is used, these directives also set
-the privileges which will be inherited by CGI scripts.
MaxRequestsPerChild controls how frequently the server
-recycles processes by killing old ones and launching new ones.
See also: Setting which addresses and ports -Apache uses.
- - -