Directives

Request notes

mod_proxy_connect creates the following request notes for + logging using the %{VARNAME}n format in + LogFormat or + ErrorLogFormat: +

proxy-source-port: The local port used for the connection to the backend server.

AllowCONNECT Directive

Description:

Ports that are allowed to CONNECT through the @@ -90,19 +103,6 @@ Port ranges available since Apache 2.3.7 allow connections to the listed ports only.

Request notes

mod_proxy_connect creates the following request notes for - logging using the %{VARNAME}n format in - LogFormat or - ErrorLogFormat: -

proxy-source-port: The local port used for the connection to the backend server.

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_express.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_express.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_express.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_express.html.en Wed Apr 15 17:03:08 2015 @@ -87,6 +87,7 @@

mod_proxy

Comments

ProxyExpressDBMFile Directive

@@ -170,7 +171,6 @@ controls whether the module will be active.

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_fcgi.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_fcgi.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_fcgi.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_fcgi.html.en Wed Apr 15 17:03:08 2015 @@ -56,14 +56,14 @@ large.

Directives

This module provides no - directives.

Directives

This module provides no + directives.

Directives

ProxyFtpDirCharset
ProxyFtpEscapeWildcards
ProxyFtpListOnWildcard

Topics

Why doesn't file type xxx download via FTP?
Why do I get a file listing when I expected a file to be downloaded?

Directives

ProxyFtpDirCharset
ProxyFtpEscapeWildcards
ProxyFtpListOnWildcard

ProxyFtpDirCharset Directive

- - - - - - - -

Description:	Define the character set for proxied FTP listings
Syntax:	`ProxyFtpDirCharset character set`
Default:	`ProxyFtpDirCharset ISO-8859-1`
Context:	server config, virtual host, directory
Status:	Extension
Module:	mod_proxy_ftp
Compatibility:	Available in Apache 2.2.7 and later. Moved from `mod_proxy` in Apache 2.3.5.

The ProxyFtpDirCharset directive defines the - character set to be set for FTP directory listings in HTML generated by - mod_proxy_ftp.

- -

ProxyFtpEscapeWildcards Directive

- - - - - - - - -

Description:	Whether wildcards in requested filenames are escaped when sent to the FTP server
Syntax:	`ProxyFtpEscapeWildcards [on\|off]`
Default:	`on`
Context:	server config, virtual host, directory
Status:	Extension
Module:	mod_proxy_ftp
Compatibility:	Available in Apache 2.3.3 and later

The ProxyFtpEscapeWildcards directive - controls whether wildcard characters ("*?[{~") in requested - filenames are escaped with backslash before sending them to the - FTP server. That is the default behavior, but many FTP servers - don't know about the escaping and try to serve the literal filenames - they were sent, including the backslashes in the names.

Set to "off" to allow downloading files with wildcards - in their names from FTP servers that don't understand wildcard - escaping.

- -

ProxyFtpListOnWildcard Directive

- - - - - - - - -

Description:	Whether wildcards in requested filenames trigger a file listing
Syntax:	`ProxyFtpListOnWildcard [on\|off]`
Default:	`on`
Context:	server config, virtual host, directory
Status:	Extension
Module:	mod_proxy_ftp
Compatibility:	Available in Apache 2.3.3 and later

The ProxyFtpListOnWildcard directive - controls whether wildcard characters ("*?[{~") in requested - filenames cause mod_proxy_ftp to return a listing - of files instead of downloading a file. By default (value on), - they do. Set to "off" to allow downloading files even if they - have wildcard characters in their names.

- -

Why doesn't file type `xxx` download via FTP?

@@ -232,6 +175,63 @@ See the ProxyFtpListOnWildcard directive.

ProxyFtpDirCharset Directive

+ + + + + + + + +

Description:	Define the character set for proxied FTP listings
Syntax:	`ProxyFtpDirCharset character set`
Default:	`ProxyFtpDirCharset ISO-8859-1`
Context:	server config, virtual host, directory
Status:	Extension
Module:	mod_proxy_ftp
Compatibility:	Available in Apache 2.2.7 and later. Moved from `mod_proxy` in Apache 2.3.5.

The ProxyFtpDirCharset directive defines the + character set to be set for FTP directory listings in HTML generated by + mod_proxy_ftp.

+ +

ProxyFtpEscapeWildcards Directive

+ + + + + + + + +

Description:	Whether wildcards in requested filenames are escaped when sent to the FTP server
Syntax:	`ProxyFtpEscapeWildcards [on\|off]`
Default:	`on`
Context:	server config, virtual host, directory
Status:	Extension
Module:	mod_proxy_ftp
Compatibility:	Available in Apache 2.3.3 and later

The ProxyFtpEscapeWildcards directive + controls whether wildcard characters ("*?[{~") in requested + filenames are escaped with backslash before sending them to the + FTP server. That is the default behavior, but many FTP servers + don't know about the escaping and try to serve the literal filenames + they were sent, including the backslashes in the names.

Set to "off" to allow downloading files with wildcards + in their names from FTP servers that don't understand wildcard + escaping.

+ +

ProxyFtpListOnWildcard Directive

+ + + + + + + + +

Description:	Whether wildcards in requested filenames trigger a file listing
Syntax:	`ProxyFtpListOnWildcard [on\|off]`
Default:	`on`
Context:	server config, virtual host, directory
Status:	Extension
Module:	mod_proxy_ftp
Compatibility:	Available in Apache 2.3.3 and later

The ProxyFtpListOnWildcard directive + controls whether wildcard characters ("*?[{~") in requested + filenames cause mod_proxy_ftp to return a listing + of files instead of downloading a file. By default (value on), + they do. Set to "off" to allow downloading files even if they + have wildcard characters in their names.

+ +

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_html.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_html.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_html.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_html.html.en Wed Apr 15 17:03:08 2015 @@ -71,6 +71,7 @@ extensive ProxyHTMLURLMap

Comments

ProxyHTMLBufSize Directive

@@ -425,7 +426,6 @@ If TRUE, or if no condition is defined, in mod_proxy_html 3.x for HTTPD 2.0 and 2.2 is also supported.

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_http.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_http.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_http.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_proxy_http.html.en Wed Apr 15 17:03:08 2015 @@ -51,14 +51,14 @@ large.

Directives

This module provides no - directives.

Topics

Environment Variables
Request notes

Directives

This module provides no + directives.

Directives

Topics

Examples
Environment Variables

Directives

ProxySCGIInternalRedirect
ProxySCGISendfile

Topics

Examples
Environment Variables

Examples

Remember, in order to make the following examples work, you have to + enable mod_proxy and mod_proxy_scgi.

+ +

Simple gateway

ProxyPass /scgi-bin/ scgi://localhost:4000/

+ +

The balanced gateway needs mod_proxy_balancer and + at least one load balancer algorithm module, such as + mod_lbmethod_byrequests, in addition to the proxy + modules listed above. mod_lbmethod_byrequests is the + default, and will be used for this example configuration.

+ +

Balanced gateway

ProxyPass "/scgi-bin/" "balancer://somecluster/"
+<Proxy "balancer://somecluster">
+    BalancerMember "scgi://localhost:4000"
+    BalancerMember "scgi://localhost:4001"
+</Proxy>

Environment Variables

In addition to the configuration directives that control the + behaviour of mod_proxy, an environment + variable may also control the SCGI protocol + provider:

proxy-scgi-pathinfo: By default mod_proxy_scgi will neither create + nor export the PATH_INFO environment variable. This allows + the backend SCGI server to correctly determine SCRIPT_NAME + and Script-URI and be compliant with RFC 3875 section 3.3. + If instead you need mod_proxy_scgi to generate + a "best guess" for PATH_INFO, set this env-var. The + variable must be set before SetEnv + is effective. SetEnvIf can be + used instead: SetEnvIf Request_URI . proxy-scgi-pathinfo +

ProxySCGIInternalRedirect Directive

Description:

Enable or disable internal redirect responses from the @@ -130,48 +172,6 @@ ProxySCGISendfile X-Send-Static -

Examples

Remember, in order to make the following examples work, you have to - enable mod_proxy and mod_proxy_scgi.

- -

Simple gateway

ProxyPass /scgi-bin/ scgi://localhost:4000/

- -

The balanced gateway needs mod_proxy_balancer and - at least one load balancer algorithm module, such as - mod_lbmethod_byrequests, in addition to the proxy - modules listed above. mod_lbmethod_byrequests is the - default, and will be used for this example configuration.

- -

Balanced gateway

ProxyPass "/scgi-bin/" "balancer://somecluster/"
-<Proxy "balancer://somecluster">
-    BalancerMember "scgi://localhost:4000"
-    BalancerMember "scgi://localhost:4001"
-</Proxy>

Environment Variables

In addition to the configuration directives that control the - behaviour of mod_proxy, an environment - variable may also control the SCGI protocol - provider:

proxy-scgi-pathinfo: By default mod_proxy_scgi will neither create - nor export the PATH_INFO environment variable. This allows - the backend SCGI server to correctly determine SCRIPT_NAME - and Script-URI and be compliant with RFC 3875 section 3.3. - If instead you need mod_proxy_scgi to generate - a "best guess" for PATH_INFO, set this env-var. The - variable must be set before SetEnv - is effective. SetEnvIf can be - used instead: SetEnvIf Request_URI . proxy-scgi-pathinfo -

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reflector.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reflector.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reflector.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reflector.html.en Wed Apr 15 17:03:08 2015 @@ -40,30 +40,14 @@ the request into a response. This module can be used to turn an output filter into an HTTP service.

Directives

Topics

Examples

Directives

ReflectorHeader

Topics

Examples

Comments

ReflectorHeader Directive

- - - - - - - -

Description:	Reflect an input header to the output headers
Syntax:	`ReflectorHeader inputheader [outputheader]`
Context:	server config, virtual host, directory, .htaccess
Override:	Options
Status:	Base
Module:	mod_reflector

This directive controls the reflection of request headers to the response. - The first argument is the name of the request header to copy. If the optional - second argument is specified, it will be used as the name of the response - header, otherwise the original request header name will be used.

- -

Comments

Examples

@@ -90,6 +74,22 @@

ReflectorHeader Directive

+ + + + + + + +

Description:	Reflect an input header to the output headers
Syntax:	`ReflectorHeader inputheader [outputheader]`
Context:	server config, virtual host, directory, .htaccess
Override:	Options
Status:	Base
Module:	mod_reflector

This directive controls the reflection of request headers to the response. + The first argument is the name of the request header to copy. If the optional + second argument is specified, it will be used as the name of the response + header, otherwise the original request header name will be used.

+ +

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_remoteip.html.en Wed Apr 15 17:03:08 2015 @@ -58,7 +58,10 @@ via the request headers. it is trivial for the remote useragent to impersonate another useragent.

Directives

Topics

Remote IP Processing

Directives

RemoteIPHeader
RemoteIPInternalProxy
RemoteIPTrustedProxy
RemoteIPTrustedProxyList

Topics

Remote IP Processing

Remote IP Processing

+ +

Apache by default identifies the useragent with the connection's + client_ip value, and the connection remote_host and remote_logname are + derived from this value. These fields play a role in authentication, + authorization and logging and other purposes by other loadable + modules.

+ +

mod_remoteip overrides the client IP of the connection with the + advertised useragent IP as provided by a proxy or load balancer, for + the duration of the request. A load balancer might establish a long + lived keepalive connection with the server, and each request will + have the correct useragent IP, even though the underlying client IP + address of the load balancer remains unchanged.

+ +

When multiple, comma delimited useragent IP addresses are listed in the + header value, they are processed in Right-to-Left order. Processing + halts when a given useragent IP address is not trusted to present the + preceding IP address. The header field is updated to this remaining + list of unconfirmed IP addresses, or if all IP addresses were trusted, + this header is removed from the request altogether.

+ +

In overriding the client IP, the module stores the list of intermediate + hosts in a remoteip-proxy-ip-list note, which mod_log_config + can record using the %{remoteip-proxy-ip-list}n format token. + If the administrator needs to store this as an additional header, this + same value can also be recording as a header using the directive + RemoteIPProxiesHeader.

+ +

IPv4-over-IPv6 Mapped Addresses

+ As with httpd in general, any IPv4-over-IPv6 mapped addresses are recorded + in their IPv4 representation.

+ +

Internal (Private) Addresses

+ All internal addresses 10/8, 172.16/12, 192.168/16, 169.254/16 and 127/8 + blocks (and IPv6 addresses outside of the public 2000::/3 block) are only + evaluated by mod_remoteip when RemoteIPInternalProxy + internal (intranet) proxies are registered.

+ +

RemoteIPHeader Directive

@@ -223,48 +265,6 @@ RemoteIPTrustedProxyList conf/trusted-pr

Remote IP Processing

- -

Apache by default identifies the useragent with the connection's - client_ip value, and the connection remote_host and remote_logname are - derived from this value. These fields play a role in authentication, - authorization and logging and other purposes by other loadable - modules.

- -

mod_remoteip overrides the client IP of the connection with the - advertised useragent IP as provided by a proxy or load balancer, for - the duration of the request. A load balancer might establish a long - lived keepalive connection with the server, and each request will - have the correct useragent IP, even though the underlying client IP - address of the load balancer remains unchanged.

- -

When multiple, comma delimited useragent IP addresses are listed in the - header value, they are processed in Right-to-Left order. Processing - halts when a given useragent IP address is not trusted to present the - preceding IP address. The header field is updated to this remaining - list of unconfirmed IP addresses, or if all IP addresses were trusted, - this header is removed from the request altogether.

- -

In overriding the client IP, the module stores the list of intermediate - hosts in a remoteip-proxy-ip-list note, which mod_log_config - can record using the %{remoteip-proxy-ip-list}n format token. - If the administrator needs to store this as an additional header, this - same value can also be recording as a header using the directive - RemoteIPProxiesHeader.

- -

IPv4-over-IPv6 Mapped Addresses

- As with httpd in general, any IPv4-over-IPv6 mapped addresses are recorded - in their IPv4 representation.

- -

Internal (Private) Addresses

- All internal addresses 10/8, 172.16/12, 192.168/16, 169.254/16 and 127/8 - blocks (and IPv6 addresses outside of the public 2000::/3 block) are only - evaluated by mod_remoteip when RemoteIPInternalProxy - internal (intranet) proxies are registered.

- -

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reqtimeout.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reqtimeout.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reqtimeout.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_reqtimeout.html.en Wed Apr 15 17:03:08 2015 @@ -34,14 +34,59 @@

Description:	Declare the header field which should be parsed for useragent IP addresses
Source File:	mod_reqtimeout.c
Compatibility:	Available in Apache HTTPD 2.2.15 and later

Directives

Topics

Examples

Directives

RequestReadTimeout

Topics

Examples

Comments

Comments

Examples

+ +

+ Allow 10 seconds to receive the request including the headers and + 30 seconds for receiving the request body: + +
```
RequestReadTimeout header=10 body=30
```
+ +
+ Allow at least 10 seconds to receive the request body. + If the client sends data, increase the timeout by 1 second for every + 1000 bytes received, with no upper limit for the timeout (except for + the limit given indirectly by + LimitRequestBody): + +
```
RequestReadTimeout body=10,MinRate=1000
```
+ +
+ Allow at least 10 seconds to receive the request including the headers. + If the client sends data, increase the timeout by 1 second for every + 500 bytes received. But do not allow more than 30 seconds for the + request including the headers: + +
```
RequestReadTimeout header=10-30,MinRate=500
```
+ +
+ Usually, a server should have both header and body timeouts configured. + If a common configuration is used for http and https virtual hosts, the + timeouts should not be set too low: + +
```
RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
```
+ +

RequestReadTimeout Directive

@@ -125,51 +170,6 @@ version 2.3.14 and earlier. -

Examples

- -

- Allow 10 seconds to receive the request including the headers and - 30 seconds for receiving the request body: - -
```
RequestReadTimeout header=10 body=30
```
- -
- Allow at least 10 seconds to receive the request body. - If the client sends data, increase the timeout by 1 second for every - 1000 bytes received, with no upper limit for the timeout (except for - the limit given indirectly by - LimitRequestBody): - -
```
RequestReadTimeout body=10,MinRate=1000
```
- -
- Allow at least 10 seconds to receive the request including the headers. - If the client sends data, increase the timeout by 1 second for every - 500 bytes received. But do not allow more than 30 seconds for the - request including the headers: - -
```
RequestReadTimeout header=10-30,MinRate=500
```
- -
- Usually, a server should have both header and body timeouts configured. - If a common configuration is used for http and https virtual hosts, the - timeouts should not be set too low: - -
```
RequestReadTimeout header=20-40,MinRate=500 body=20,MinRate=500
```
- -

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_request.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_request.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_request.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_request.html.en Wed Apr 15 17:03:08 2015 @@ -39,6 +39,7 @@

KeptBodySize

Comments

KeptBodySize Directive

@@ -95,7 +96,6 @@ mod_include.

mod_auth_form documentation

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_rewrite.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_rewrite.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_rewrite.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_rewrite.html.en Wed Apr 15 17:03:08 2015 @@ -54,7 +54,10 @@ URLs on the fly

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

Directives

Topics

Logging

Directives

RewriteBase
RewriteCond
RewriteOptions
RewriteRule

Topics

Logging

Comments

Comments

Logging

+ +

mod_rewrite offers detailed logging of its actions + at the trace1 to trace8 log levels. The + log level can be set specifically for mod_rewrite + using the LogLevel directive: Up to + level debug, no actions are logged, while trace8 + means that practically all actions are logged.

+ +

+ Using a high trace log level for mod_rewrite + will slow down your Apache HTTP Server dramatically! Use a log + level higher than trace2 only for debugging! +

+ +

Example

LogLevel alert rewrite:trace3

+ +

RewriteLog

Those familiar with earlier versions of + mod_rewrite will no doubt be looking for the + RewriteLog and RewriteLogLevel + directives. This functionality has been completely replaced by the + new per-module logging configuration mentioned above. +

+ +

To get just the mod_rewrite-specific log + messages, pipe the log file through grep:

+ tail -f error_log|fgrep '[rewrite:' +

+ +

RewriteBase Directive

@@ -1422,42 +1458,6 @@ redirection -

Logging

- -

mod_rewrite offers detailed logging of its actions - at the trace1 to trace8 log levels. The - log level can be set specifically for mod_rewrite - using the LogLevel directive: Up to - level debug, no actions are logged, while trace8 - means that practically all actions are logged.

- -

- Using a high trace log level for mod_rewrite - will slow down your Apache HTTP Server dramatically! Use a log - level higher than trace2 only for debugging! -

- -

Example

LogLevel alert rewrite:trace3

- -

RewriteLog

Those familiar with earlier versions of - mod_rewrite will no doubt be looking for the - RewriteLog and RewriteLogLevel - directives. This functionality has been completely replaced by the - new per-module logging configuration mentioned above. -

- -

To get just the mod_rewrite-specific log - messages, pipe the log file through grep:

- tail -f error_log|fgrep '[rewrite:' -

- -

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_sed.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_sed.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_sed.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_sed.html.en Wed Apr 15 17:03:08 2015 @@ -62,44 +62,16 @@ string or regular expression search and the author's blog.

Directives

Topics

Sample Configuration
Sed Commands

Directives

InputSed
OutputSed

Topics

Sample Configuration
Sed Commands

Comments

InputSed Directive

- - - - - -

Description:	Sed command to filter request data (typically `POST` data)
Syntax:	`InputSed sed-command`
Context:	directory, .htaccess
Status:	Experimental
Module:	mod_sed

The InputSed directive specifies the sed command - to execute on the request data e.g., POST data. -

- -

OutputSed Directive

- - - - - - -

Description:	Sed command for filtering response content
Syntax:	`OutputSed sed-command`
Context:	directory, .htaccess
Status:	Experimental
Module:	mod_sed

The OutputSed directive specifies the sed - command to execute on the response. -

- -

Comments

Sample Configuration

@@ -145,6 +117,34 @@ page.

Swap the contents of the hold buffer and the current line.

InputSed Directive

+ + + + + + +

Description:	Sed command to filter request data (typically `POST` data)
Syntax:	`InputSed sed-command`
Context:	directory, .htaccess
Status:	Experimental
Module:	mod_sed

The InputSed directive specifies the sed command + to execute on the request data e.g., POST data. +

+ +

OutputSed Directive

+ + + + + + +

Description:	Sed command for filtering response content
Syntax:	`OutputSed sed-command`
Context:	directory, .htaccess
Status:	Experimental
Module:	mod_sed

The OutputSed directive specifies the sed + command to execute on the response. +

+ +

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session.html.en Wed Apr 15 17:03:08 2015 @@ -61,16 +61,7 @@ environment variables and HTTP headers, as appropriate.

Directives

Session
SessionEnv
SessionExclude
SessionHeader
SessionInclude
SessionMaxAge

Topics

What is a session?
Who can use a session?
Cookie Privacy
Session Support for Authentication
Integrating Sessions with External Applications

Directives

Session
SessionEnv
SessionExclude
SessionHeader
SessionInclude
SessionMaxAge

Session Directive

- - - - - - - - -

Description:	Enables a session for the current directory or location
Syntax:	`Session On\|Off`
Default:	`Session Off`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The Session directive enables a session for the - directory or location container. Further directives control where the - session will be stored and how privacy is maintained.

- -

SessionEnv Directive

- - - - - - - - -

Description:	Control whether the contents of the session are written to the -`HTTP_SESSION` environment variable
Syntax:	`SessionEnv On\|Off`
Default:	`SessionEnv Off`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

If set to On, the SessionEnv directive - causes the contents of the session to be written to a CGI environment - variable called HTTP_SESSION.

- -

The string is written in the URL query format, for example:

- -

- key1=foo&key3=bar -

- - -

SessionExclude Directive

- - - - - - - -

Description:	Define URL prefixes for which a session is ignored
Syntax:	`SessionExclude path`
Default:	`none`
Context:	server config, virtual host, directory, .htaccess
Status:	Extension
Module:	mod_session

The SessionExclude directive allows sessions to - be disabled relative to URL prefixes only. This can be used to make a - website more efficient, by targeting a more precise URL space for which - a session should be maintained. By default, all URLs within the directory - or location are included in the session. The - SessionExclude directive takes - precedence over the - SessionInclude directive.

- -

Warning

This directive has a similar purpose to the path attribute - in HTTP cookies, but should not be confused with this attribute. This - directive does not set the path attribute, which must be - configured separately.

- -

SessionHeader Directive

- - - - - - - - -

Description:	Import session updates from a given HTTP response header
Syntax:	`SessionHeader header`
Default:	`none`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The SessionHeader directive defines the name of an - HTTP response header which, if present, will be parsed and written to the - current session.

- -

The header value is expected to be in the URL query format, for example:

- -

- key1=foo&key2=&key3=bar -

- -

Where a key is set to the empty string, that key will be removed from the - session.

- - -

SessionInclude Directive

- - - - - - - - -

Description:	Define URL prefixes for which a session is valid
Syntax:	`SessionInclude path`
Default:	`all URLs`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The SessionInclude directive allows sessions to - be made valid for specific URL prefixes only. This can be used to make a - website more efficient, by targeting a more precise URL space for which - a session should be maintained. By default, all URLs within the directory - or location are included in the session.

- -

Warning

- -

SessionMaxAge Directive

- - - - - - - - -

Description:	Define a maximum age in seconds for a session
Syntax:	`SessionMaxAge maxage`
Default:	`SessionMaxAge 0`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The SessionMaxAge directive defines a time limit - for which a session will remain valid. When a session is saved, this time - limit is reset and an existing session can be continued. If a session - becomes older than this limit without a request to the server to refresh - the session, the session will time out and be removed. Where a session is - used to stored user login details, this has the effect of logging the user - out automatically after the given time.

- -

Setting the maxage to zero disables session expiry.

- -

What is a session?

At the core of the session interface is a table of key and value pairs @@ -481,6 +343,144 @@ AuthName realm

Session Directive

+ + + + + + + + +

Description:	Enables a session for the current directory or location
Syntax:	`Session On\|Off`
Default:	`Session Off`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The Session directive enables a session for the + directory or location container. Further directives control where the + session will be stored and how privacy is maintained.

+ +

SessionEnv Directive

+ + + + + + + + +

Description:	Control whether the contents of the session are written to the +`HTTP_SESSION` environment variable
Syntax:	`SessionEnv On\|Off`
Default:	`SessionEnv Off`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

If set to On, the SessionEnv directive + causes the contents of the session to be written to a CGI environment + variable called HTTP_SESSION.

+ +

The string is written in the URL query format, for example:

+ +

+ key1=foo&key3=bar +

+ + +

SessionExclude Directive

+ + + + + + + +

Description:	Define URL prefixes for which a session is ignored
Syntax:	`SessionExclude path`
Default:	`none`
Context:	server config, virtual host, directory, .htaccess
Status:	Extension
Module:	mod_session

The SessionExclude directive allows sessions to + be disabled relative to URL prefixes only. This can be used to make a + website more efficient, by targeting a more precise URL space for which + a session should be maintained. By default, all URLs within the directory + or location are included in the session. The + SessionExclude directive takes + precedence over the + SessionInclude directive.

+ +

Warning

This directive has a similar purpose to the path attribute + in HTTP cookies, but should not be confused with this attribute. This + directive does not set the path attribute, which must be + configured separately.

+ +

SessionHeader Directive

+ + + + + + + + +

Description:	Import session updates from a given HTTP response header
Syntax:	`SessionHeader header`
Default:	`none`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The SessionHeader directive defines the name of an + HTTP response header which, if present, will be parsed and written to the + current session.

+ +

The header value is expected to be in the URL query format, for example:

+ +

+ key1=foo&key2=&key3=bar +

+ +

Where a key is set to the empty string, that key will be removed from the + session.

+ + +

SessionInclude Directive

+ + + + + + + + +

Description:	Define URL prefixes for which a session is valid
Syntax:	`SessionInclude path`
Default:	`all URLs`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The SessionInclude directive allows sessions to + be made valid for specific URL prefixes only. This can be used to make a + website more efficient, by targeting a more precise URL space for which + a session should be maintained. By default, all URLs within the directory + or location are included in the session.

+ +

Warning

+ +

SessionMaxAge Directive

+ + + + + + + + +

Description:	Define a maximum age in seconds for a session
Syntax:	`SessionMaxAge maxage`
Default:	`SessionMaxAge 0`
Context:	server config, virtual host, directory, .htaccess
Override:	AuthConfig
Status:	Extension
Module:	mod_session

The SessionMaxAge directive defines a time limit + for which a session will remain valid. When a session is saved, this time + limit is reset and an existing session can be continued. If a session + becomes older than this limit without a request to the server to refresh + the session, the session will time out and be removed. Where a session is + used to stored user login details, this has the effect of logging the user + out automatically after the given time.

+ +

Setting the maxage to zero disables session expiry.

+ +

Available Languages: en | Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session_cookie.html.en URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session_cookie.html.en?rev=1673873&r1=1673872&r2=1673873&view=diff ============================================================================== --- httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session_cookie.html.en (original) +++ httpd/httpd/branches/2.4.x/docs/manual/mod/mod_session_cookie.html.en Wed Apr 15 17:03:08 2015 @@ -58,22 +58,41 @@ the mod_session module.

Directives

Topics

Basic Examples

Directives

SessionCookieName
SessionCookieName2
SessionCookieRemove

Topics

Basic Examples

Basic Examples

+ +

To create a simple session and store it in a cookie called + session, configure the session as follows:

+ +

Browser based session

Session On
+SessionCookieName session path=/

+ +

For more examples on how the session can be configured to be read + from and written to by a CGI application, see the + mod_session examples section.

+ +

For documentation on how the session can be used to store username + and password details, see the mod_auth_form module.

+ +

SessionCookieName Directive

@@ -145,25 +164,6 @@ SessionCookieName2 session path=/private -

Basic Examples

- -

To create a simple session and store it in a cookie called - session, configure the session as follows:

- -

Browser based session

Session On
-SessionCookieName session path=/

- -

For more examples on how the session can be configured to be read - from and written to by a CGI application, see the - mod_session examples section.

- -

For documentation on how the session can be used to store username - and password details, see the mod_auth_form module.

- -

Available Languages: en |

Description:	Name and attributes for the RFC2109 cookie storing the session

Directives

Topics

Topics

See also

Directives

See also

Directives

Topics

Topics

See also

Directives

See also

Directives

Topics

Directives

Topics

See also

See also

Directives

Topics

Topics

See also

Directives

See also

Directives

Topics

Topics

See also

Directives

See also

Directives

Topics

Topics

See also

Directives

See also

Directives

Topics

Directives

Topics

See also

See also

Simple gateway

Balanced gateway

Simple gateway

Balanced gateway

Directives

Topics

Directives

Topics

Directives

Topics

Directives

Topics

See also

See also

IPv4-over-IPv6 Mapped Addresses

Internal (Private) Addresses

IPv4-over-IPv6 Mapped Addresses

Internal (Private) Addresses

Directives

Topics

Directives

Topics

Directives

Topics

Directives

Topics

Example

RewriteLog

Example

RewriteLog

Directives

Topics

Directives

Topics

Directives

Topics

Topics

See also