Apache Module mod_include

```

Simple example

Dedicated onerror paths

This module provides a filter which will process files before they are sent to the client. The processing is controlled by specially formatted SGML comments, referred to as elements. These elements allow conditional text, the inclusion of other files or programs, as well as the setting and printing of environment variables.

AddType text/html .shtml AddOutputFilter INCLUDES .shtml

The following directive must be given for the directories containing the shtml files (typically in a

section, but this directive is also valid in .htaccess

For backwards compatibility, the server-parsed

handler also activates the INCLUDES filter. As well, Apache will activate the INCLUDES filter for any document with mime type text/x-server-parsed-html

For more information, see our Tutorial on Server Side Includes.

element attribute=value attribute=value ... -->

The value will often be enclosed in double quotes, but single quotes ('

) are also possible. 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. Note that the leading

The allowed elements are listed in the following table:

| Element | Description | |---|---| | configure output formats | | print variables | | execute external programs | | print size of a file | | print last modification time of a file | | include a file | | print all available variables | | set a value of a variable |

, and will only be available if this module is loaded.mod_cgi

This command controls various aspects of the parsing. The valid attributes are:

element attempts to echo an undefined variable. This overrides any echo

The value is a message that is sent back to the client if an error occurs while parsing the document. This overrides any

The value sets the format to be used when displaying the size of a file. Valid values are bytes

for a count in bytes, or abbrev

for a count in Kb or Mb as appropriate, for example a size of 1024 bytes will be printed as "1K".

library routine when printing dates.

This command prints one of the include variables defined below. If the variable is unset, the result is determined by the

directive. Any dates printed are subject to the currently configured SSIUndefinedEchotimefmt

Specifies whether Apache should strip an encoding from the variable before processing the variable further. The default is none

, then URL decoding (also known as %-encoding; this is appropriate for use within URLs in links, etc.) will be performed. If set to urlencoded

, application/x-www-form-urlencoded compatible encoding (found in query strings) will be stripped. If set to base64

, base64 will be decoded, and if set to entity

, HTML entity encoding will be stripped. Decoding is done prior to any further encoding on the variable. Multiple encodings can be stripped by specifying more than one comma separated encoding. The decoding setting will remain in effect until the next decoding attribute is encountered, or the element ends.

attribute must precede the corresponding var

Specifies how Apache should encode special characters contained in the variable before outputting them. If set to none

, resulting in entity encoding (which is appropriate in the context of a block-level HTML element, e.g. a paragraph of text). This can be changed by adding an encoding

attribute is encountered or the element ends, whichever comes first.

command executes a given shell command or CGI script. It requires

to be present in the server. If mod_cgiOptionsIncludesNOEXEC

is set, this command is completely disabled. The valid attributes are:

The value specifies a (%-encoded) URL-path to the CGI script. If the path does not begin with a slash (/), then it is taken to be relative to the current document. The document referenced by this path is invoked as a CGI script, even if the server would not normally recognize it as such. However, the directory containing the script must be enabled for CGI scripts (with

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

element should be used in preference to include virtualexec cgi

. In particular, if you need to pass additional arguments to a CGI program, using the query string, this cannot be done with exec cgi

is almost always prefered to using either #include virtual#exec cgi

) uses the standard Apache sub-request mechanism to include files or scripts. It is much better tested and maintained.

In addition, on some platforms, like Win32, and on unix when using suexec, you cannot pass arguments to a command in an exec

directive, or otherwise include spaces in the command. Thus, while the following will work under a non-suexec configuration on unix, it will not produce the desired result under Win32, or when running suexec:

so as to refer to a file above the current directory or outside of the document root. Attempting to so will result in the error message: The given path was above the root path

Note that in many cases these two are exactly the same thing. However, the file

attribute doesn't respect URL-space aliases.

This command inserts the text of another document or file into the parsed file. Any included file is subject to the usual access control. If the directory containing the parsed file has Options IncludesNOEXEC

etc.) will be included. Otherwise CGI scripts are invoked as normal using the complete URL given in the command, including any query string.

An attribute defines the location of the document, and may appear more than once in an include element; an inclusion is done for each attribute given to the include command in turn. The valid attributes are:

, nor can it be an absolute path. Therefore, you cannot include files that are outside of the document root, or above the current document in the directory structure. The virtual

The value is a (%-encoded) URL-path. The URL cannot contain a scheme or hostname, only a path and an optional query string. If it does not begin with a slash (/) then it is taken to be relative to the current document.

A URL is constructed from the attribute, and the output the server would return if the URL were accessed by the client is included in the parsed output. Thus included files can be nested.

If the specified URL is a CGI program, the program will be executed and its output inserted in place of the directive in the parsed file. You may include a query string in a CGI url:

directive is correctly configured and valid for this included file, attempts to POST requests to the enclosing HTML document will be passed through to subrequests as POST requests as well. Without the directive, all subrequests are processed as GET requests.KeptBodySize

The value is a (%-encoded) URL-path which is shown should a previous attempt to include a file or virtual attribute failed. To be effective, this attribute must be specified after the file or virtual attributes being covered. If the attempt to include the onerror path fails, or if onerror is not specified, the default error message will be included.

This prints out a plain text listing of all existing variables and their values. Special characters are entity encoded (see the

element for details) before being output. There are no attributes.echo

, URL decoding, application/x-www-form-urlencoded decoding, base64 decoding or HTML entity decoding will be performed respectively. More than one decoding can be specified by separating with commas. The decoding setting will remain in effect until the next decoding attribute is encountered, or the element ends. The decoding

attribute to be effective. Encodings are applied after all decodings have been stripped.

, substitution also occurs in the arguments to conditional operators. You can insert a literal dollar sign into the string using backslash quoting:

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, a la shell substitution:

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

statements are used to put text into the output stream if the original test_condition was false. These elements are optional.

testcondition is a boolean expression which follows the apexpr syntax. The syntax can be changed to be compatible with Apache HTTPD 2.2.x using

element are exported into the request environment and can be accessed with the reqenv

function. As a short-cut, the function name v

The below example will print "from local net" if client IP address belongs to the 10.0.0.0/8 subnet.

See also: Expressions in Apache HTTP Server, for a complete reference and examples. The restricted functions are not available inside mod_include

true if the URL represented by the string is accessible by configuration, false otherwise. This is useful where content on a page is to be hidden from users who are not authorized to view the URL, such as a link to that URL. Note that the URL is only tested for whether access would be granted, not whether the URL exists.

Click here to access private information.

Compare string1 with string2. If string2 has the form /

then it is treated as a regular expression. Regular expressions are implemented by the string2/PCRE engine and have the same syntax as those in perl 5. Note that ==

If you are matching positive (=

), you can capture grouped parts of the regular expression. The captured parts are stored in the special variables $1

. The whole string matched by the regular expression is stored in the special variable $0

" bind more tightly than "&&

" binds most tightly. Thus, the following are equivalent:

share the same priority. So if you want to bind such an operator more tightly, you should use parentheses.

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,

results in string1 string2string1 string2

If the expressions become more complex and slow down processing significantly, you can try to optimize them according to the evaluation rules:

) are short circuited wherever possible. In conclusion with the rule above that means, mod_include

evaluates at first the left expression. If the left result is sufficient to determine the end result, processing stops here. Otherwise it evaluates the right side and computes the end result from both left and right results.$1

).If you want to look how a particular expression is handled, you can recompile

using the modinclude-DDEBUGINCLUDE

compiler option. This inserts for every parsed expression tokenizer information, the parse tree and how it is evaluated into the output sent to the client.

All slashes which are not intended to act as delimiters in your regex must be escaped. This is regardless of their meaning to the regex engine.

directive suppresses this behaviour, and allows the server to generate an ETag

header. This can be used to enable caching of the output. Note that a backend server or dynamic content generator may generate an ETag of its own, ignoring no-etag

will be added to the request notes, and the server is asked not to generate an ETag. Where a server ignores the value of no-etag

and generates an ETag anyway, the ETag will be respected.on

header to be respected if already present, or set if the header is not already present. This can be used to enable caching of the output. SSILastModified

header will be stripped from responses, unless the XBitHack

directive takes precedence over XBitHack

You may want to use this option if you have 2 servers parsing the output of a file each processing different commands (possibly at different times).

The above directive would cause times to be displayed in the format "22:26, June 14, 2002".

XBitHack on|off|full

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. You would not want to use the full option, unless you assure the group-execute bit is unset for every SSI script which might #include

a CGI or otherwise produces different output on each hit (or could potentially change on subsequent requests).

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.4