Description:	This Multi-Processing Module is optimized for BeOS.
Status:	MPM
Module Identifier:	mpm_beos_module
Source File:	beos.c

Description:	Limit on the number of requests that an individual thread +will handle during its life
Syntax:	`MaxRequestsPerThread number`
Default:	`MaxRequestsPerThread 0`
Context:	server config
Status:	MPM
Module:	beos

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

Description:	An experimental variant of the standard `worker` +MPM
Status:	MPM
Module Identifier:	mpm_leader_module
Source File:	leader.c

Apache Module mpm_common

Apache MPM Common Directives

Description:	A collection of directives that are implemented by more than one multi-processing module (MPM)
Status:	MPM

Directives

AcceptMutex
BS2000Account
CoreDumpDirectory
Group
Listen
MaxMemFree
MaxRequestsPerChild
MaxSpareThreads
MaxThreadsPerChild
MinSpareThreads
NumServers
PidFile
ScoreBoardFile
SendBufferSize

AcceptMutex Directive

+ + + + + + + +

Description:	Method that Apache uses to serialize multiple children +accepting requests on network sockets
Syntax:	`AcceptMutex Default\|method`
Default:	`AcceptMutex Default`
Context:	server config
Status:	MPM
Module:	`leader`, `perchild`, `prefork`, `threadpool`, `worker`

The AcceptMutex directives sets the + method that Apache uses to serialize multiple children accepting + requests on network sockets. Prior to Apache 2.0, the method was + selectable only at compile time. The optimal method to use is + highly architecture and platform dependent. For further details, + see the performance tuning + documentation.

+ +

If this directive is set to Default, then the + compile-time selected default will be used. Other possible + methods are listed below. Note that not all methods are + available on all platforms. If a method is specified which is + not available, a message will be written to the error log + listing the available methods.

+ +

flock: uses the flock(2) system call to lock the + file defined by the LockFile directive.
fcntl: uses the fnctl(2) system call to lock the + file defined by the LockFile directive.
posixsem: uses POSIX compatible semaphores to implement the mutex.
pthread: uses POSIX mutexes as implemented by the POSIX Threads + (PThreads) specification.
sysvsem: uses SySV-style semaphores to implement the mutex.

+ +

If you want to find out the compile time chosen default + for your system, you may set your LogLevel to debug. Then the default AcceptMutex will be written into the ErrorLog.

+ +

BS2000Account Directive

+ + + + + + + +

Description:	Define the non-privileged account on BS2000 +machines
Syntax:	`BS2000Account account`
Context:	server config
Status:	MPM
Module:	`perchild`, `prefork`
Compatibility:	Only available for BS2000 machines

The BS2000Account directive is available for + BS2000 hosts only. It must be used to define the account number for + the non-privileged apache server user (which was configured using the + User directive). This is + required by the BS2000 POSIX subsystem (to change the underlying BS2000 + task environment by performing a sub-LOGON) to prevent CGI scripts + from accessing resources of the privileged account which started the + server, usually SYSROOT.

+ +

Note

Only one BS2000Account directive can be used.

+ +

CoreDumpDirectory Directive

@@ -59,9 +138,8 @@ switch before dumping core - +

Default:	`See usage for the default setting`
Context:	server config
Status:	MPM
Module:	`worker`, `perchild`, `prefork`, `mpm_winnt`
Module:	`beos`, `leader`, `mpm_winnt`, `perchild`, `prefork`, `threadpool`, `worker`

This controls the directory to which Apache attempts to switch before dumping core. The default is in the ServerRoot directory, however @@ -78,39 +156,50 @@ switch before dumping core requests Syntax:Group unix-group Default:Group #-1 -Context:server config, virtual host +Context:server config Status:MPM -Module:worker, perchild, prefork +Module:beos, leader, mpmt_os2, perchild, prefork, threadpool, worker +Compatibility:Only valid in global server config since Apache +2.0

The Group directive sets the group under which the server will answer requests. In order to use this - directive, the stand-alone server must be run initially as root. - Unix-group is one of:

+ directive, the server must be run initially as root. 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. Unix-group is one of:

A group name: Refers to the given group by name.
# followed by a group number.
# followed by a group number.: Refers to a group by its number.

+ +

Example

+ Group www-group +

It is recommended that you set up a new group specifically for running the server. Some admins use user nobody, but this is not always possible or desirable.

Group www-group

Security

Don't set Group (or User) to root unless + you know exactly what you are doing, and what the dangers are.

Note: if you start the server as a non-root user, it will - fail to change to the specified group, and will instead - continue to run as the group of the original user.

Special note: Use of this directive in <VirtualHost> is no longer supported. To + configure your server for suexec use + SuexecUserGroup.

Special note: Use of this directive in <VirtualHost> is - no longer supported. To implement the suEXEC wrapper with Apache 2.0, use the - SuexecUserGroup - directive. SECURITY: See User for a discussion of the - security considerations.

Note

Although the Group directive is present + in the beos and mpmt_os2 MPMs, + it is actually a no-op there and only exists for compatibility + reasons.

@@ -121,25 +210,26 @@ listens to Syntax:Listen [IP-address:]portnumber Context:server config Status:MPM -Module:worker, perchild, prefork, mpm_winnt +Module:beos, leader, mpm_netware, mpm_winnt, mpmt_os2, perchild, prefork, threadpool, worker +Compatibility:Required directive since Apache 2.0

The Listen directive instructs Apache to listen to only specific IP addresses or ports; by default it - responds to requests on all IP interfaces. The Listen directive is - now a required directive. If it is not in the config file, the + responds to requests on all IP interfaces. Listen + is now a required directive. If it is not in the config file, the server will fail to start. This is a change from previous versions of Apache.

The Listen directive tells the server to accept incoming - requests on the specified port or address-and-port combination. - If only a port number is specified, the server listens to the - given port on all interfaces. If an IP address is given as well +

The Listen directive tells the server to + accept incoming requests on the specified port or address-and-port + combination. If only a port number is specified, the server listens to + the given port on all interfaces. If an IP address is given as well as a port, the server will listen on the given port and interface.

Multiple Listen directives may be used to specify a number - of addresses and ports to listen to. The server will respond to - requests from any of the listed addresses and ports.

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:

@@ -167,8 +257,8 @@ listens to

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.

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.

Description:	Maximum amount of memory that the main allocator is allowed to hold without calling free()
Syntax:	`MaxMemFree number`
Syntax:	`MaxMemFree KBytes`
Default:	`MaxMemFree 0`
Context:	server config
Status:	MPM
Module:	`worker`, `prefork`, `mpm_netware`
Module:	`beos`, `leader`, `mpm_netware`, `prefork`, `threadpool`, `worker`

Description:	Maximum number of idle threads
Syntax:	`MaxSpareThreads number`
Default:	`See usage for details`
Context:	server config
Status:	MPM
Module:	`mpm_netware`, `perchild`, `worker`
Module:	`beos`, `leader`, `mpm_netware`, `mpmt_os2`, `perchild`, `threadpool`, `worker`

Description:	Total number of children alive at the same time
Syntax:	`NumServers number`
Default:	`NumServers 2`
Context:	server config
Status:	MPM
Module:	`perchild`

Description:	TCP buffer size
Syntax:	`SendBufferSize bytes`
Default:	`SendBufferSize 0`
Context:	server config
Status:	MPM
Module:	`worker`, `perchild`, `prefork`, `mpm_winnt`
Module:	`beos`, `leader`, `mpm_netware`, `mpm_winnt`, `mpmt_os2`, `perchild`, `prefork`, `threadpool`, `worker`

Description:	Upper limit on configurable number of processes
Syntax:	`ServerLimit number`
Default:	`ServerLimit 256 (prefork), ServerLimit 16 (worker)`
Default:	`See usage for details`
Context:	server config
Status:	MPM
Module:	`worker`, `prefork`
Module:	`leader`, `perchild`, `prefork`, `threadpool`, `worker`

Description:	Number of child server processes created at startup
Syntax:	`StartServers number`
Default:	`StartServers 5`
Default:	`See usage for details`
Context:	server config
Status:	MPM
Module:	`worker`
Module:	`leader`, `mpmt_os2`, `prefork`, `threadpool`, `worker`

Description:	Nubmer of threads created on startup
Description:	Number of threads created on startup
Syntax:	`StartThreads number`
Default:	`See usage for details`
Context:	server config
Status:	MPM
Module:	`mpm_netware`, `perchild`
Module:	`beos`, `mpm_netware`, `perchild`

Description:	Number of threads created by each child process
Syntax:	`ThreadsPerChild number`
Default:	`See usage for details`
Context:	server config
Status:	MPM
Module:	`worker`, `mpm_winnt`
Module:	`leader`, `mpm_winnt`, `threadpool`, `worker`

Apache Module mpm_netware

Apache MPM netware

@@ -46,12 +46,9 @@ regulate how the main thread creates worker threads 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 250 simultaneous - requests may need to increase MaxThreads, while - sites with limited memory may need to decrease - MaxThreads to keep the server from thrashing - (spawning and terminating idle threads). More information about - tuning process creation is provided in the performance hints + values. Sites with limited memory may need to decrease MaxThreads to keep the server from + thrashing (spawning and terminating idle threads). More information + about tuning process creation is provided in the performance hints documentation.

MaxRequestsPerChild @@ -83,21 +80,27 @@

MaxThreads Directive

Description:	Multi-Processing Module implementing an exclusively threaded web server optimized for Novell NetWare
Status:	MPM

- + - +

Description:
Description:	Set the maximum number of worker threads
Syntax:	`MaxThreads number`
Default:	`MaxThreads 250`
Default:	`MaxThreads 2048`
Context:	server config
Status:	MPM
Module:	mpm_netware

The MaxThreads directive sets the desired maximum - number worker threads allowable.

The MaxThreads directive sets the desired + maximum number worker threads allowable. The default value is + also the compiled in hard limit. Therefore it can only be lowered, + for example:

+ +

+ MaxThreads 512 +

ThreadStackSize Directive

- + diff --git a/docs/manual/mod/mpm_winnt.html.en b/docs/manual/mod/mpm_winnt.html.en index 253cc59e6a..f6e25aee2d 100644 --- a/docs/manual/mod/mpm_winnt.html.en +++ b/docs/manual/mod/mpm_winnt.html.en @@ -19,9 +19,9 @@

Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module mpm_winnt

Apache MPM winnt

Description:
Description:	Determine the stack size for each thread
Syntax:	`ThreadStackSize number`
Default:	`ThreadStackSize 65536`
Context:	server config

+NT.

Description:	This Multi-Processing Module is optimized for Windows - NT.
Status:	MPM
Module Identifier:	mpm_winnt_module
Source File:	mpm_winnt.c

@@ -39,6 +39,7 @@

diff --git a/docs/manual/mod/mpmt_os2.html.en b/docs/manual/mod/mpmt_os2.html.en new file mode 100644 index 0000000000..3b72aacd92 --- /dev/null +++ b/docs/manual/mod/mpmt_os2.html.en @@ -0,0 +1,67 @@ + + + +mpmt_os2 - Apache HTTP Server + + + + + + +

+Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache MPM os2

+ + + +

Description:	Hybrid multi-process, multi-threaded MPM for OS/2
Status:	MPM
Module Identifier:	mpm_mpmt_os2_module
Source File:	mpmt_os2.c

Summary

+ +

The Server consists of a main, parent process and a small, static + number of child processes.

+ +

The parent process's job is to manage the child processes. This + involves spawning children as required to ensure there are always + StartServers processes + accepting connections.

+ +

Each child process consists of a a pool of worker threads and a + main thread that accepts connections and passes them to the workers via + a work queue. The worker thread pool is dynamic, managed by a + maintenance thread so that the number of idle threads is kept between + MinSpareThreads and + MaxSpareThreads.

Directives

Apache Module perchild

- +

Apache MPM perchild

Description:	Multi-Processing Module allowing for daemon processes - serving requests to be assigned a variety of different - userids

Description:	Multi-Processing Module allowing for daemon processes serving +requests to be assigned a variety of different userids
Status:	MPM
Module Identifier:	mpm_perchild_module
Source File:	perchild.c

Summary

-This MPM does not currently work on most platforms. Work is ongoing to -make it functional. -

+ This MPM does not currently work on most platforms. Work is ongoing + to make it functional. +

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.

- +

Directives

Topics

How it works

How it works

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

@@ -58,7 +92,7 @@ make it functional. 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 + that will be created (NumServers) by the maximum number of threads created in each process (MaxThreadsPerChild).

@@ -77,70 +111,142 @@ make it functional. server recycles processes by killing old ones and launching new ones.

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.

Working with different user-IDs

The perchild MPM adds the extra ability to + specify that particular processes should serve requests under + different user-IDs. These user-IDs can then be associated with + specific virtual hosts. You have to use one ChildPerUserID directive for + every user/group combination you want to be run. Then you can tie + particular virtual hosts to that user and group IDs.

+ +

The following example runs 7 child processes. Two of them are run + under user1/group1. The next four are run + under user2/group2 and the remaining + process uses the User and Group + of the main server:

+ +

Global config

+ NumServers 7 + ChildPerUserID user1 group1 2 + ChildPerUserID user2 group2 4 +

+ +

Using unbalanced numbers of processes as above is useful, if the + particular virtual hosts produce different load. The assignment to + the virtual hosts is easily done as in the example below. In + conclusion with the example above the following assumes, that + server2 has to serve about twice of the hits of + server1.

+ +

Example

+ NameVirtualHost * + + <VirtualHost *> + + ServerName fallbackhost + # no assignment; use fallback + + </VirtualHost> + + <VirtualHost *> + + ServerName server1 + AssignUserID user1 group1 + + </VirtualHost> + + <VirtualHost *> + + ServerName server2 + AssignUserID user2 group2 + + </VirtualHost> +

Directives

AssignUserId Directive

AssignUserID Directive

- - + +

Description:
Syntax:	`AssignUserID user_id group_id`
Description:	Tie a virtual host to a user and group ID
Syntax:	`AssignUserID user-id group-id`
Context:	virtual host
Status:	MPM
Module:	perchild

Tie a virtual host to a specific child process. Requests addressed to -the virtual host where this directive appears will be served by the process -running with the specified user and group id.

Tie a virtual host to a specific user/group combination. Requests + addressed to the virtual host where this directive appears will be + served by a process running with the specified user and group ID.

+ +

The user and group ID has to be assigned to a number of children + in the global server config using the ChildPerUserID directive. See the section above for a + configuration example.

+ +

ChildPerUserID Directive

+ + + + + + +

Description:	Specify user ID and group ID for a number of child +processes
Syntax:	`ChildPerUserID user-id group-id +num-children`
Context:	server config
Status:	MPM
Module:	perchild

Specify a user ID and group ID for a number of child processes. + The third argument, num-children, is the number of child + processes to start with the specified user and group. It does + not represent a specific child number. In order to use this + directive, the server must be run initially as root. + If you start the server as a non-root user, it will fail to change + to the lesser privileged user.

+ +

If the total number of child processes, found by totaling all of the + third arguments to all ChildPerUserID directives + in the config file, is less than NumServers, then all remaining children will inherit the + User and Group settings from the main server. + See the section above for a configuration + example.

+ +

Security

Don't set user-id (or group-id) to + root unless you know exactly what you are doing, and + what the dangers are.

+ +

MaxThreadsPerChild Directive

+ + + + + + + +

Description:	Maximum number of threads per child process
Syntax:	`MaxThreadsPerChild number`
Default:	`MaxThreadsPerChild 64`
Context:	server config
Status:	MPM
Module:	perchild

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 ThreadLimit directive and stop and + re-start the server.

ChildPerUserId Directive

NumServers Directive

- - + + +

Description:
Syntax:	`ChildPerUserID user_id -group_id num_children`
Description:	Total number of children alive at the same time
Syntax:	`NumServers number`
Default:	`NumServers 2`
Context:	server config
Status:	MPM
Module:	perchild

Specify a user id and group id for a number of child processes. The third -argument, num_children, is the number of child processes to start with the -specified user and group. It does not represent a specific -child number. If the total number of child processes, found by totaling all of -the third arguments to all ChildPerUserId directives in the config file, is -less than NumServers, then all -remaining children will inherit the User and Group settings from the main server

The NumServers directive determines the number + of children alive at the same time. This number should be large enough to + handle the requests for the entire site. To increase this value beyond the + value of 8, it is necessary to change the value of the + ServerLimit directive and stop + and re-start the server. See the section above for a configuration example.

diff --git a/docs/manual/mod/prefork.html.en b/docs/manual/mod/prefork.html.en index d14c50dcd9..5781a455a2 100644 --- a/docs/manual/mod/prefork.html.en +++ b/docs/manual/mod/prefork.html.en @@ -19,7 +19,7 @@

Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache Module prefork

Apache MPM prefork

@@ -39,11 +39,11 @@ handle as many simultaneous requests as you expect to receive, but small enough to assure that there is enough physical RAM for all processes.

Directives

AcceptMutex Directive

Description:	Implements a non-threaded, pre-forking web server
Status:	MPM
Module Identifier:	mpm_prefork_module

- - - - - - -

Description:	Method that Apache uses to serialize multiple children -accepting requests on network sockets
Syntax:	`AcceptMutex default\|method`
Default:	`AcceptMutex default`
Context:	server config
Status:	MPM
Module:	prefork

The AcceptMutex directives sets the - method that Apache uses to serialize multiple children accepting - requests on network sockets. Prior to Apache 2.0, the method was - selectable only at compile time. The optimal method to use is - highly architecture and platform dependent. For further details, - see the performance tuning - documentation.

- -

If this directive is set to default, then the - compile-time selected default will be used. Other possible - methods are listed below. Note that not all methods are - available on all platforms. If a method is specified which is - not available, a message will be written to the error log - listing the available methods.

- -

flock: uses the flock(2) system call to lock the - file defined by the LockFile directive.
fcntl: uses the fnctl(2) system call to lock the - file defined by the LockFile directive.
sysvsem: uses SySV-style semaphores to implement the mutex.
pthread: uses POSIX mutexes as implemented by the POSIX Threads - (PThreads) specification.

- -

MaxSpareServers Directive

@@ -166,12 +118,14 @@ accepting requests on network sockets

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.

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

+ always a bad idea. If you are trying to set the value lower than + MinSpareServers, Apache + will automatically adjust it to MinSpareServers + 1.

Description:	Maximum number of idle child server processes

Tuning of this parameter should only be necessary on very busy sites. Setting this parameter to a large number is almost diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 28e5aa2f3f..2f6edfbf27 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -50,7 +50,7 @@

Description:	Minimum number of idle child server processes
Syntax:	`MinSpareServers number`
Default:	`MinSpareServers 5`
Default:	`MinSpareServers 5`
Context:	server config
Status:	MPM
Module:	prefork

- @@ -121,7 +121,7 @@ error log - + - - - + + + - - + - - - + - - - - + - - - - - - + - - - - - - + - - - - + + + - - + - - - - - - - + + + + + + - - - - - + + + + - - - - - - - - + + + + - - - - - - - + + - - + - - - - + - - - + + - - - - - - - + - - + - - - - + - - - - - - + - - - - + + - - - + - - - - - + + + - - - + - - - - - - - + - - - + + - - - - - - + + + - - - + + - - + + meta information - + @@ -435,7 +440,7 @@ a matching file with MultiViews hosting - + @@ -554,12 +559,12 @@ in the scriptlog - + - + - - + + - + @@ -655,7 +660,7 @@ certain events before failing a request ... -

AcceptMutex default|method default s M

Method that Apache uses to serialize multiple children +

AcceptMutex Default|method Default s M

Method that Apache uses to serialize multiple children accepting requests on network sockets

AcceptPathInfo On|Off|Default Default svdh C

Resources accept trailing pathname information

AccessFileName filename [filename] ... .htaccess sv C

Name of the distributed configuration file

Anonymous_NoUserID On|Off Off dh E

Sets whether the userID field may be empty

Anonymous_VerifyEmail On|Off Off dh E

Sets whether to check the password field for a correctly formatted email address

AssignUserID user_id group_id v M

AssignUserID user-id group-id v M

Tie a virtual host to a user and group ID

AuthBasicAuthoritative On|Off On dh B

Sets whether authorization and authentication are passed to lower level modules

AuthBasicProvider On|Off|provider-name @@ -187,222 +187,227 @@ modules

BrowserMatchNoCase regex [!]env-variable[=value] [[!]env-variable[=value]] ... svdh B

Sets environment variables conditional on User-Agent without respect to case

CacheDefaultExpire seconds 3600 (one hour) sv X

The default duration to cache a document when no expiry date is specified.

CacheDirLength length 2 sv X

The number of characters in subdirectory names

CacheDirLevels levels 3 sv X

The number of levels of subdirectories in the +

BS2000Account account s M

Define the non-privileged account on BS2000 +machines

CacheDefaultExpire seconds 3600 (one hour) sv X

The default duration to cache a document when no expiry date is specified.

CacheDirLength length 2 sv X

The number of characters in subdirectory names

CacheDirLevels levels 3 sv X

The number of levels of subdirectories in the cache.

CacheDisable url-string sv X

Disable caching of specified URLs

CacheEnable cache_type url-string sv X

Enable caching of specified URLs using a specified storage +

CacheDisable url-string sv X

Disable caching of specified URLs

CacheEnable cache_type url-string sv X

Enable caching of specified URLs using a specified storage manager

CacheExpiryCheck On|Off On sv X

Indicates if the cache observes Expires dates when seeking +

CacheExpiryCheck On|Off On sv X

Indicates if the cache observes Expires dates when seeking files

CacheFile file-path [file-path] ... s X

Cache a list of file handles at startup time

CacheForceCompletion Percentage 60 sv X

Percentage of document served, after which the server +

CacheFile file-path [file-path] ... s X

Cache a list of file handles at startup time

CacheForceCompletion Percentage 60 sv X

Percentage of document served, after which the server will complete caching the file even if the request is cancelled.

CacheGcClean hours url-string ? sv X

The time to retain unchanged cached files that match a +

CacheGcClean hours url-string ? sv X

The time to retain unchanged cached files that match a URL

CacheGcDaily time ? sv X

The recurring time each day for garbage collection to be run. +

CacheGcDaily time ? sv X

The recurring time each day for garbage collection to be run. (24 hour clock)

CacheGcInterval hours sv X

The interval between garbage collection attempts.

CacheGcMemUsage KBytes ? sv X

The maximum kilobytes of memory used for garbage +

CacheGcInterval hours sv X

The interval between garbage collection attempts.

CacheGcMemUsage KBytes ? sv X

The maximum kilobytes of memory used for garbage collection

CacheGcUnused hours url-string ? sv X

The time to retain unreferenced cached files that match a +

CacheGcUnused hours url-string ? sv X

The time to retain unreferenced cached files that match a URL.

CacheIgnoreCacheControl On|Off Off sv X

Ignore the fact that the client requested the content not be +

CacheIgnoreCacheControl On|Off Off sv X

Ignore the fact that the client requested the content not be cached.

CacheIgnoreNoLastMod On|Off Off sv X

Ignore the fact that a response has no Last Modified +

CacheIgnoreNoLastMod On|Off Off sv X

Ignore the fact that a response has no Last Modified header.

CacheLastModifiedFactor float 0.1 sv X

The factor used to compute an expiry date based on the +

CacheLastModifiedFactor float 0.1 sv X

The factor used to compute an expiry date based on the LastModified date.

CacheMaxExpire seconds 86400 (one day) sv X

The maximum time in seconds to cache a document

CacheMaxFileSize bytes 1000000 sv X

The maximum size (in bytes) of a document to be placed in the +

CacheMaxExpire seconds 86400 (one day) sv X

The maximum time in seconds to cache a document

CacheMaxFileSize bytes 1000000 sv X

The maximum size (in bytes) of a document to be placed in the cache

CacheMinFileSize bytes 1 sv X

The minimum size (in bytes) of a document to be placed in the +

CacheMinFileSize bytes 1 sv X

The minimum size (in bytes) of a document to be placed in the cache

CacheNegotiatedDocs On|Off Off sv B

Allows content-negotiated documents to be +

CacheNegotiatedDocs On|Off Off sv B

Allows content-negotiated documents to be cached by proxy servers

CacheRoot directory sv X

The directory root under which cache files are +

CacheRoot directory sv X

The directory root under which cache files are stored

CacheSize KBytes 1000000 sv X

The maximum amount of disk space that will be used by the +

CacheSize KBytes 1000000 sv X

The maximum amount of disk space that will be used by the cache in KBytes

CacheTimeMargin ? ? sv X

The minimum time margin to cache a document

CGIMapExtension cgi-path .extension dh C

Technique for locating the interpreter for CGI +

CacheTimeMargin ? ? sv X

The minimum time margin to cache a document

CGIMapExtension cgi-path .extension dh C

Technique for locating the interpreter for CGI scripts

CharsetDefault charset svdh X

Charset to translate into

CharsetOptions option [option] ... DebugLevel=0 NoImpl + svdh X

Configures charset translation behavior

CharsetSourceEnc charset svdh X

Source charset of files

CheckSpelling on|off Off svdh E

Enables the spelling +

CharsetDefault charset svdh X

Charset to translate into

CharsetOptions option [option] ... DebugLevel=0 NoImpl + svdh X

Configures charset translation behavior

CharsetSourceEnc charset svdh X

Source charset of files

CheckSpelling on|off Off svdh E

Enables the spelling module

ChildPerUserID user_id -group_id num_children s M

ContentDigest On|Off Off svdh C

Enables the generation of Content-MD5 HTTP Response +

ChildPerUserID user-id group-id +num-children s M

Specify user ID and group ID for a number of child +processes

ContentDigest On|Off Off svdh C

Enables the generation of Content-MD5 HTTP Response headers

CookieDomain domain svdh E

The domain to which the tracking cookie applies

CookieExpires expiry-period svdh E

Expiry time for the tracking cookie

CookieLog filename sv B

Sets filename for the logging of cookies

CookieName token Apache svdh E

Name of the tracking cookie

CookieStyle - Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape svdh E

Format of the cookie header field

CookieTracking on|off off svdh E

Enables tracking cookie

CoreDumpDirectory directory s M

Directory where Apache attempts to +

CookieDomain domain svdh E

The domain to which the tracking cookie applies

CookieExpires expiry-period svdh E

Expiry time for the tracking cookie

CookieLog filename sv B

Sets filename for the logging of cookies

CookieName token Apache svdh E

Name of the tracking cookie

CookieStyle + Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape svdh E

Format of the cookie header field

CookieTracking on|off off svdh E

Enables tracking cookie

CoreDumpDirectory directory s M

Directory where Apache attempts to switch before dumping core

CustomLog file|pipe +

CustomLog file|pipe format|nickname -[env=[!]environment-variable] sv B

Sets filename and format of log file

Dav On|Off|provider-name Off d E

Enable WebDAV HTTP methods

DavDepthInfinity on|off off svd E

Allow PROPFIND, Depth: Infinity requests

DavLockDB file-path sv E

Location of the DAV lock database

DavMinTimeout seconds 0 svd E

Minimum amount of time the server holds a lock on +[env=[!]environment-variable] sv B

Sets filename and format of log file

Dav On|Off|provider-name Off d E

Enable WebDAV HTTP methods

DavDepthInfinity on|off off svd E

Allow PROPFIND, Depth: Infinity requests

DavLockDB file-path sv E

Location of the DAV lock database

DavMinTimeout seconds 0 svd E

Minimum amount of time the server holds a lock on a DAV resource

DefaultIcon url-path svdh B

Icon to display for files when no specific icon is +

DefaultIcon url-path svdh B

Icon to display for files when no specific icon is configured

DefaultLanguage MIME-lang svdh B

Sets all files in the given scope to the specified +

DefaultLanguage MIME-lang svdh B

Sets all files in the given scope to the specified language

DefaultType MIME-type text/plain svdh C

MIME content-type that will be sent if the +

DefaultType MIME-type text/plain svdh C

MIME content-type that will be sent if the server cannot determine a type in any other way

DeflateBufferSize value 8096 sv E

Fragment size to be compressed at one time by zlib

DeflateFilterNote notename sv E

Places the compression ratio in a note for logging

DeflateMemLevel value 9 sv E

How much memory should be used by zlib for compression

DeflateWindowSize value 15 sv E

Zlib compression window size

Deny from all|host|env=env-variable -[host|env=env-variable] ... dh B

Controls which hosts are denied access to the +

DeflateBufferSize value 8096 sv E

Fragment size to be compressed at one time by zlib

DeflateFilterNote notename sv E

Places the compression ratio in a note for logging

DeflateMemLevel value 9 sv E

How much memory should be used by zlib for compression

DeflateWindowSize value 15 sv E

Zlib compression window size

Deny from all|host|env=env-variable +[host|env=env-variable] ... dh B

Controls which hosts are denied access to the server

<Directory directory-path> -... </Directory> sv C

Enclose a group of directives that apply only to the +

<Directory directory-path> +... </Directory> sv C

Enclose a group of directives that apply only to the named file-system directory and sub-directories

DirectoryIndex - local-url [local-url] ... index.html svdh B

List of resources to look for when the client requests +

DirectoryIndex + local-url [local-url] ... index.html svdh B

List of resources to look for when the client requests a directory

<DirectoryMatch regex> -... </DirectoryMatch> sv C

Enclose directives that apply to +

<DirectoryMatch regex> +... </DirectoryMatch> sv C

Enclose directives that apply to file-system directories matching a regular expression and their subdirectories

DocumentRoot directory-path /usr/local/apache/h + sv C

Directory that forms the main document tree visible +

DocumentRoot directory-path /usr/local/apache/h + sv C

Directory that forms the main document tree visible from the web

EnableMMAP On|Off On svdh C

Use memory-mapping to read files during delivery

EnableSendfile On|Off On svdh C

Use the kernel sendfile support to deliver files to the client

ErrorDocument error-code document svdh C

What the server will return to the client +

EnableMMAP On|Off On svdh C

Use memory-mapping to read files during delivery

EnableSendfile On|Off On svdh C

Use the kernel sendfile support to deliver files to the client

ErrorDocument error-code document svdh C

What the server will return to the client in case of an error

ErrorLog file-path|syslog[:facility] logs/error_log (Uni + sv C

Location where the server will log errors

Example svdh X

Demonstration directive to illustrate the Apache module +

ErrorLog file-path|syslog[:facility] logs/error_log (Uni + sv C

Location where the server will log errors

Example svdh X

Demonstration directive to illustrate the Apache module API

ExpiresActive On|Off svdh E

Enables generation of Expires +

ExpiresActive On|Off svdh E

Enables generation of Expires headers

ExpiresByType MIME-type -<code>seconds svdh E

Value of the Expires header configured +

ExpiresByType MIME-type +<code>seconds svdh E

Value of the Expires header configured by MIME type

ExpiresDefault <code>seconds svdh E

Default algorithm for calculating expiration time

ExtendedStatus On|Off Off s B

Keep track of extended status information for each +

ExpiresDefault <code>seconds svdh E

Default algorithm for calculating expiration time

ExtendedStatus On|Off Off s B

Keep track of extended status information for each request

ExtFilterDefine filtername parameters s E

Define an external filter

ExtFilterOptions option [option] ... DebugLevel=0 NoLogS + d E

Configure mod_ext_filter options

FileETag component ... INode MTime Size svdh C

File attributes used to create the ETag +

ExtFilterDefine filtername parameters s E

Define an external filter

ExtFilterOptions option [option] ... DebugLevel=0 NoLogS + d E

Configure mod_ext_filter options

FileETag component ... INode MTime Size svdh C

File attributes used to create the ETag HTTP response header

<Files filename> ... </Files> svdh C

Contains directives that apply to matched +

<Files filename> ... </Files> svdh C

Contains directives that apply to matched filenames

<FilesMatch regex> ... </FilesMatch> svdh C

Contains directives that apply to regular-expression matched +

<FilesMatch regex> ... </FilesMatch> svdh C

Contains directives that apply to regular-expression matched filenames

ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdh B

Action to take if a single acceptable document is not +

ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback] Prefer svdh B

Action to take if a single acceptable document is not found

ForceType MIME-type|none dh C

Forces all matching files to be served with the specified +

ForceType MIME-type|none dh C

Forces all matching files to be served with the specified MIME content-type

Group unix-group #-1 sv M

Group under which the server will answer +

Group unix-group #-1 s M

Group under which the server will answer requests

Header set|append|add|unset|echo header -[value [env=[!]variable]] svdh E

Configure HTTP response headers

HeaderName filename svdh B

Name of the file that will be inserted at the top +

Header set|append|add|unset|echo header +[value [env=[!]variable]] svdh E

Configure HTTP response headers

HeaderName filename svdh B

Name of the file that will be inserted at the top of the index listing

HostnameLookups On|Off|Double Off svd C

Enables DNS lookups on client IP addresses

IdentityCheck On|Off Off svd C

Enables logging of the RFC1413 identity of the remote +

HostnameLookups On|Off|Double Off svd C

Enables DNS lookups on client IP addresses

IdentityCheck On|Off Off svd C

Enables logging of the RFC1413 identity of the remote user

<IfDefine [!]parameter-name> ... - </IfDefine> svdh C

Encloses directives that will be processed only +

<IfDefine [!]parameter-name> ... + </IfDefine> svdh C

Encloses directives that will be processed only if a test is true at startup

<IfModule [!]module-name> ... - </IfModule> svdh C

Encloses directives that are processed conditional on the +

<IfModule [!]module-name> ... + </IfModule> svdh C

Encloses directives that are processed conditional on the presence or absence of a specific module

ImapBase map|referer|URL http://servername/ svdh B

Default base for imagemap files

ImapDefault error|nocontent|map|referer|URL nocontent svdh B

Default action when an imagemap is called with coordinates +

ImapBase map|referer|URL http://servername/ svdh B

Default base for imagemap files

ImapDefault error|nocontent|map|referer|URL nocontent svdh B

Default action when an imagemap is called with coordinates that are not explicitly mapped

ImapMenu none|formatted|semiformatted|unformatted svdh B

Action if no coordinates are given when calling +

ImapMenu none|formatted|semiformatted|unformatted svdh B

Action if no coordinates are given when calling an imagemap

Include file-path|directory-path svd C

Includes other configuration files from within +

Include file-path|directory-path svd C

Includes other configuration files from within the server configuration files

IndexIgnore file [file] ... svdh B

Adds to the list of files to hide when listing +

IndexIgnore file [file] ... svdh B

Adds to the list of files to hide when listing a directory

IndexOptions [+|-]option [[+|-]option] -... svdh B

Various configuration settings for directory +

IndexOptions [+|-]option [[+|-]option] +... svdh B

Various configuration settings for directory indexing

IndexOrderDefault Ascending|Descending -Name|Date|Size|Description Ascending Name svdh B

Sets the default ordering of the directory index

ISAPIAppendLogToErrors on|off off svdh B

Record HSE_APPEND_LOG_PARAMETER requests from +

IndexOrderDefault Ascending|Descending +Name|Date|Size|Description Ascending Name svdh B

Sets the default ordering of the directory index

ISAPIAppendLogToErrors on|off off svdh B

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the error log

ISAPIAppendLogToQuery on|off on svdh B

Record HSE_APPEND_LOG_PARAMETER requests from +

ISAPIAppendLogToQuery on|off on svdh B

Record HSE_APPEND_LOG_PARAMETER requests from ISAPI extensions to the query field

ISAPICacheFile file-path [file-path] -... sv B

ISAPI .dll files to be loaded at startup

ISAPIFakeAsync on|off off svdh B

Fake asynchronous support for ISAPI callbacks

ISAPILogNotSupported on|off off svdh B

Log unsupported feature requests from ISAPI +

ISAPICacheFile file-path [file-path] +... sv B

ISAPI .dll files to be loaded at startup

ISAPIFakeAsync on|off off svdh B

Fake asynchronous support for ISAPI callbacks

ISAPILogNotSupported on|off off svdh B

Log unsupported feature requests from ISAPI extensions

ISAPIReadAheadBuffer size 49152 svdh B

Size of the Read Ahead Buffer sent to ISAPI +

ISAPIReadAheadBuffer size 49152 svdh B

Size of the Read Ahead Buffer sent to ISAPI extensions

KeepAlive On|Off On sv C

Enables HTTP persistent connections

KeepAliveTimeout seconds 15 sv C

Amount of time the server will wait for subsequent +

KeepAlive On|Off On sv C

Enables HTTP persistent connections

KeepAliveTimeout seconds 15 sv C

Amount of time the server will wait for subsequent requests on a persistent connection

LanguagePriority MIME-lang [MIME-lang] -... svdh B

The precendence of language variants for cases where +

LanguagePriority MIME-lang [MIME-lang] +... svdh B

The precendence of language variants for cases where the client does not express a preference

LDAPCacheEntries number 1024 s X

Maximum number of entires in the primary LDAP cache

LDAPCacheTTL seconds 600 s X

Time that cached items remain valid

LDAPCertDBPath directory-path s X

Directory containing certificates for SSL support

LDAPOpCacheEntries number 1024 s X

Number of entries used to cache LDAP compare +

LDAPCacheEntries number 1024 s X

Maximum number of entires in the primary LDAP cache

LDAPCacheTTL seconds 600 s X

Time that cached items remain valid

LDAPCertDBPath directory-path s X

Directory containing certificates for SSL support

LDAPOpCacheEntries number 1024 s X

Number of entries used to cache LDAP compare operations

LDAPOpCacheTTL seconds 600 s X

Time that entries in the operation cache remain +

LDAPOpCacheTTL seconds 600 s X

Time that entries in the operation cache remain valid

LDAPSharedCacheSize bytes 102400 s X

Size in bytes of the shared-memory cache

<Limit method [method] ... > ... - </Limit> svdh C

Restrict enclosed access controls to only certain HTTP +

LDAPSharedCacheSize bytes 102400 s X

Size in bytes of the shared-memory cache

<Limit method [method] ... > ... + </Limit> svdh C

Restrict enclosed access controls to only certain HTTP methods

<LimitExcept method [method] ... > ... - </LimitExcept> svdh C

Restrict access controls to all HTTP methods +

<LimitExcept method [method] ... > ... + </LimitExcept> svdh C

Restrict access controls to all HTTP methods except the named ones

LimitRequestBody bytes 0 svdh C

Restricts the total size of the HTTP request body sent +

LimitRequestBody bytes 0 svdh C

Restricts the total size of the HTTP request body sent from the client

LimitRequestFields number 100 s C

Limits the number of HTTP request header fields that +

LimitRequestFields number 100 s C

Limits the number of HTTP request header fields that will be accepted from the client

LimitRequestFieldsize bytes s C

Limits the size of the HTTP request header allowed from the +

LimitRequestFieldsize bytes s C

Limits the size of the HTTP request header allowed from the client

LimitRequestLine bytes 8190 s C

Limit the size of the HTTP request line that will be accepted +

LimitRequestLine bytes 8190 s C

Limit the size of the HTTP request line that will be accepted from the client

LimitXMLRequestBody number 1000000 svdh C

Limits the size of an XML-based request body

Listen [IP-address:]portnumber s M

IP addresses and ports that the server +

LimitXMLRequestBody number 1000000 svdh C

Limits the size of an XML-based request body

Listen [IP-address:]portnumber s M

IP addresses and ports that the server listens to

ListenBacklog backlog s M

Maximum length of the queue of pending connections

LoadFile filename [filename] ... s E

Link in the named object file or library

LoadModule module filename s E

Links in the object file or library, and adds to the list +

ListenBacklog backlog s M

Maximum length of the queue of pending connections

LoadFile filename [filename] ... s E

Link in the named object file or library

LoadModule module filename s E

Links in the object file or library, and adds to the list of active modules

<Location - URL-path|URL> ... </Location> sv C

Applies the enclosed directives only to matching +

<Location + URL-path|URL> ... </Location> sv C

Applies the enclosed directives only to matching URLs

<LocationMatch - regex> ... </LocationMatch> sv C

Applies the enclosed directives only to regular-expression +

<LocationMatch + regex> ... </LocationMatch> sv C

Applies the enclosed directives only to regular-expression matching URLs

LockFile filename logs/accept.lock s M

Location of the accept serialization lock file

LogFormat format|nickname -[nickname] "%h %l %u %t \"%r\" + sv B

Describes a format for use in a log file

LogLevel level warn sv C

Controls the verbosity of the ErrorLog

MaxClients number s M

Maximum number of child processes that will be created +

LockFile filename logs/accept.lock s M

Location of the accept serialization lock file

LogFormat format|nickname +[nickname] "%h %l %u %t \"%r\" + sv B

Describes a format for use in a log file

LogLevel level warn sv C

Controls the verbosity of the ErrorLog

MaxClients number s M

Maximum number of child processes that will be created to serve requests

MaxKeepAliveRequests number 100 sv C

Number of requests allowed on a persistent +

MaxKeepAliveRequests number 100 sv C

Number of requests allowed on a persistent connection

MaxMemFree number s M

Maximum amount of memory that the main allocator is allowed -to hold without calling free()

MaxRequestsPerChild number 10000 s M

Limit on the number of requests that an individual child server +

MaxMemFree KBytes 0 s M

Maximum amount of memory that the main allocator is allowed +to hold without calling free()

MaxRequestsPerChild number 10000 s M

Limit on the number of requests that an individual child server +will handle during its life

MaxRequestsPerThread number 0 s M

Limit on the number of requests that an individual thread will handle during its life

MaxSpareServers number 10 s M

Maximum number of idle child server processes

MaxSpareThreads number s M

Maximum number of idle threads

MaxThreads number 250 s M

MaxThreadsPerChild number 64 s M

Maximum number of threads per child process

MaxThreads number 2048 s M

Set the maximum number of worker threads

MaxThreadsPerChild number 64 s M

Maximum number of threads per child process

MCacheMaxObjectCount value 1009 s X

The maximum number of objects allowed to be placed in the cache

MCacheMaxObjectSize bytes 10000 s X

The maximum size (in bytes) of a document allowed in the @@ -422,7 +427,7 @@ files

MimeMagicFile file-path sv E

Enable MIME-type determination based on file contents using the specified magic file

MinSpareServers number 5 s M

Minimum number of idle child server processes

MinSpareServers number 5 s M

Minimum number of idle child server processes

MinSpareThreads number s M

Minimum number of idle threads available to handle request spikes

MMapFile file-path [file-path] ... s X

Map a list of files into memory at startup time

NoProxy host [host] ... sv E

Hosts, domains, or networks that will be connected to directly

NumServers number 2 s M

Total number of children alive at the same time

NumServers number 2 s M

Total number of children alive at the same time

Options [+|-]option [[+|-]option] ... All svdh C

Configures what features are available in a particular directory

ScriptLogLength bytes 10385760 sv B

Size limit of the CGI script logfile

ScriptSock file-path logs/cgisock sv B

The name of the socket to use for communication with the cgi daemon

SendBufferSize bytes s M

TCP buffer size

SendBufferSize bytes 0 s M

TCP buffer size

ServerAdmin email-address sv C

Email address that the server includes in error messages sent to the client

ServerAlias hostname [hostname] ... v C

Alternate names for a host used when matching requests to name-virtual hosts

ServerLimit number 256 (prefork), Serv + s M

Upper limit on configurable number of processes

ServerLimit number s M

Upper limit on configurable number of processes

ServerName fully-qualified-domain-name[:port] sv C

Hostname and port that the server uses to identify itself

ServerPath URL-path v C

Legacy URL pathname for a name-based virtual host that @@ -640,13 +645,13 @@ in the Session Cache

SSLVerifyClient level none svdh E

Type of Client Certificate verification

SSLVerifyDepth number 1 svdh E

Maximum depth of CA Certificates in Client Certificate verification

StartServers number 5 s M

Number of child server processes created at startup

StartThreads number s M

Nubmer of threads created on startup

StartServers number s M

Number of child server processes created at startup

StartThreads number s M

Number of threads created on startup

SuexecUserGroup User Group sv E

User and group permissions for CGI programs

ThreadLimit number s M

Sets the upper limit on the configurable number of threads per child process

ThreadsPerChild number s M

Number of threads created by each child process

ThreadStackSize number 65536 s M

Determine the stack size for each thread

TimeOut number 300 s C

Amount of time the server will wait for certain events before failing a request

TransferLog file|pipe sv B

Specifly location of a log file

svdh B

Removes variables from the environment

UseCanonicalName On|Off|DNS On svd C

Configures how the server determines its own name and port

User unix-userid #-1 sv M

The userid under which the server will answer +

User unix-userid #-1 s M

The userid under which the server will answer requests

UserDir directory-filename public_html sv B

Location of the user-specific directories

VirtualDocumentRoot interpolated-directory|none none sv E

Dynamically configure the location of the document root diff --git a/docs/manual/mod/threadpool.html.en b/docs/manual/mod/threadpool.html.en new file mode 100644 index 0000000000..8015733f94 --- /dev/null +++ b/docs/manual/mod/threadpool.html.en @@ -0,0 +1,74 @@ + + + +threadpool - Apache HTTP Server + + + + + + +

+Apache > HTTP Server > Documentation > Version 2.1 > Modules

Apache MPM threadpool

+ + + +

Description:	Yet another experimental variant of the standard +`worker` MPM
Status:	MPM
Module Identifier:	mpm_threadpool_module
Source File:	threadpool.c

Summary

+ +

Warning

This MPM is a developer playground and highly experimental, so it + may or may not work as expected.

+ +

This is an experimental variant of the standard worker MPM. + Rather than queuing connections like the worker MPM, the + threadpool MPM queues idle worker threads and + hands each accepted connection to the next available worker.

+ +

The threadpool MPM can't match the performance of + the worker MPM in benchmark testing. As of 2.0.39, + some of the key load-throtting concepts from the threadpool MPM have been incorporated into the worker MPM. The threadpool code is useful + primarily as a research platform. For general-purpose use and for any + production environments, use worker instead.

Directives

+ +

+ + \ No newline at end of file diff --git a/docs/manual/mod/worker.html.en b/docs/manual/mod/worker.html.en index 6c718e98cd..11e8f8c71e 100644 --- a/docs/manual/mod/worker.html.en +++ b/docs/manual/mod/worker.html.en @@ -19,7 +19,7 @@

Apache > HTTP Server > Documentation > Version 2.1 > Modules