From a75d816777c6f87c9c1107eb8de567d4df83cc34 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Andr=C3=A9=20Malo?= Date: Fri, 18 Oct 2002 02:18:04 +0000 Subject: [PATCH] the MPM module docs: - -> - a little other markup changes git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97258 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mpm_common.html.en | 93 ++++++++++++++------------ docs/manual/mod/mpm_common.xml | 93 ++++++++++++++------------ docs/manual/mod/mpm_netware.html.en | 35 +++++----- docs/manual/mod/mpm_netware.xml | 34 +++++----- docs/manual/mod/perchild.html.en | 15 ++--- docs/manual/mod/perchild.xml | 14 ++-- docs/manual/mod/prefork.html.en | 12 ++-- docs/manual/mod/prefork.xml | 10 +-- docs/manual/mod/quickreference.html.en | 58 ++++++++-------- docs/manual/mod/worker.html.en | 20 +++--- docs/manual/mod/worker.xml | 18 ++--- 11 files changed, 211 insertions(+), 191 deletions(-) diff --git a/docs/manual/mod/mpm_common.html.en b/docs/manual/mod/mpm_common.html.en index d3af19e922a..84451af06a0 100644 --- a/docs/manual/mod/mpm_common.html.en +++ b/docs/manual/mod/mpm_common.html.en @@ -31,7 +31,7 @@ more than one multi-processing module (MPM)top

CoreDumpDirectory Directive

Description: Directory where Apache attempts to switch before dumping core
Syntax: - CoreDumpDirectory directory
Default: + CoreDumpDirectory directory
Default: See usage for the default setting
Context: server config
Status: MPM
Module: @@ -47,7 +47,7 @@ switch before dumping core
top

Group Directive

Description: Group under which the server will answer requests
Syntax: - Group unix-group
Default: + Group unix-group
Default: Group #-1
Context: server config, virtual host
Status: MPM
Module: @@ -55,7 +55,7 @@ requests
Syntax:

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:

+ Unix-group is one of:

A group name
@@ -82,7 +82,7 @@ requests
Syntax:
top

Listen Directive

Description: IP addresses and ports that the server listens to
Syntax: - Listen [IP-address:]portnumber
Context: + Listen [IP-address:]portnumber
Context: server config
Status: MPM
Module: worker, perchild, prefork, mpm_winnt
@@ -106,25 +106,30 @@ listens to
Syntax:

For example, to make the server accept connections on both port 80 and port 8000, use:

-

- Listen 80
- Listen 8000 -

+ +

+ Listen 80
+ Listen 8000 +

+

To make the server accept connections on two specified interfaces and port numbers, use

-

- Listen 192.170.2.1:80
- Listen 192.170.2.5:8000 -

+ +

+ Listen 192.170.2.1:80
+ Listen 192.170.2.5:8000 +

+

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

-

- Listen [fe80::a00:20ff:fea7:ccea]:80 -

+ +

+ Listen [fe80::a00:20ff:fea7:ccea]:80 +

See also

top

ListenBackLog Directive

Description: Maximum length of the queue of pending connections
Syntax: - ListenBacklog backlog
Default: + ListenBacklog backlog
Default: ListenBacklog 511
Context: server config
Status: MPM
Module: @@ -142,7 +147,7 @@ listens to
Syntax: set.

top

LockFile Directive

Description: Location of the accept serialization lock file
Syntax: - LockFile filename
Default: + LockFile filename
Default: LockFile logs/accept.lock
Context: server config
Status: MPM
Module: @@ -156,16 +161,17 @@ listens to
Syntax: disk. The PID of the main server process is automatically appended to the filename.

-

SECURITY: It is best to avoid putting this - file in a world writable directory such as - /var/tmp because someone could create a denial of +

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.

+
top

MaxClients Directive

Description: Maximum number of child processes that will be created to serve requests
Syntax: - MaxClients number
Context: + MaxClients number
Context: server config
Status: MPM
Module: worker, prefork
@@ -194,7 +200,7 @@ to serve requests
Syntax:
top

MaxMemFree Directive

Description: Maximum amount of memory that the main allocator is allowed to hold without calling free()
Syntax: - MaxMemFree number
Context: + MaxMemFree number
Context: server config
Status: MPM
Module: worker, prefork, mpm_netware
@@ -205,7 +211,7 @@ to hold without calling free()
top

MaxRequestsPerChild Directive

Description: Limit on the number of requests that an individual child server will handle during its life
Syntax: - MaxRequestsPerChild number
Default: + MaxRequestsPerChild number
Default: MaxRequestsPerChild 10000
Context: server config
Status: MPM
Module: @@ -228,13 +234,14 @@ will handle during its life

Note:

+

For KeepAlive requests, only the first request is counted + towards this limit. In effect, it changes the behavior to limit the + number of connections per child.

+
top

MaxSpareThreads Directive

Description: Maximum number of idle threads
Syntax: - MaxSpareThreads number
Context: + MaxSpareThreads number
Context: server config
Status: MPM
Module: mpm_netware, perchild, worker
@@ -259,7 +266,7 @@ will handle during its life
MinSpareThreads
  • StartServers
  • top

    MaxThreadsPerChild Directive

    Description: Maximum number of threads per child process
    Syntax: - MaxThreadsPerChild number
    Default: + MaxThreadsPerChild number
    Default: MaxThreadsPerChild 64
    Context: server config
    Status: MPM
    Module: @@ -273,7 +280,7 @@ will handle during its life
    top

    MinSpareThreads Directive

    Description: Minimum number of idle threads available to handle request spikes
    Syntax: - MinSpareServers number
    Context: + MinSpareServers number
    Context: server config
    Status: MPM
    Module: mpm_netware, perchild, worker
    @@ -299,7 +306,7 @@ spikes
    Syntax:

    See also

    top

    NumServers Directive

    Description: Total number of children alive at the same time
    Syntax: - NumServers number
    Default: + NumServers number
    Default: NumServers 2
    Context: server config
    Status: MPM
    Module: @@ -311,7 +318,7 @@ spikes
    Syntax:
    top

    PidFile Directive

    Description: File where the server records the process ID of the daemon
    Syntax: - PidFile filename
    Default: + PidFile filename
    Default: PidFile logs/httpd.pid
    Context: server config
    Status: MPM
    Module: @@ -322,7 +329,7 @@ of the daemon
    Syntax: relative to the ServerRoot.

    Example

    - PidFile /var/run/apache.pid + PidFile /var/run/apache.pid

    It is often useful to be able to send the server a signal, @@ -336,7 +343,7 @@ of the daemon

    Syntax:
    top

    ScoreBoardFile Directive

    Description: Location of the file used to store coordination data for the child processes
    Syntax: - ScoreBoardFile file-path
    Default: + ScoreBoardFile file-path
    Default: ScoreBoardFile logs/apache_status
    Context: server config
    Status: MPM
    Module: @@ -350,7 +357,7 @@ the child processes
    Syntax Apache to always create the file on the disk.

    Example

    - ScoreBoardFile /var/run/apache_status + ScoreBoardFile /var/run/apache_status

    File-based shared memory is useful for third-party applications @@ -362,7 +369,7 @@ the child processes

    Syntax and security.

    See also

    top

    SendBufferSize Directive

    Description: TCP buffer size
    Syntax: - SendBufferSize bytes
    Context: + SendBufferSize bytes
    Context: server config
    Status: MPM
    Module: worker, perchild, prefork, mpm_winnt
    @@ -372,7 +379,7 @@ the child processes
    Syntax transcontinental fast pipes).

    top

    ServerLimit Directive

    Description: Upper limit on configurable number of processes
    Syntax: - ServerLimit number
    Default: + ServerLimit number
    Default: ServerLimit 256 (prefork), ServerLimit 16 (worker)
    Context: server config
    Status: MPM
    Module: @@ -406,7 +413,7 @@ the child processes
    Syntax processes required by what you may want for MaxClients and ThreadsPerChild.

    top

    StartServers Directive

    Description: Number of child server processes created at startup
    Syntax: - StartServers number
    Default: + StartServers number
    Default: StartServers 5
    Context: server config
    Status: MPM
    Module: @@ -417,7 +424,7 @@ the child processes
    Syntax there is usually little reason to adjust this parameter.

    See also

    top

    StartThreads Directive

    Description: Nubmer of threads created on startup
    Syntax: - StartThreads number
    Context: + StartThreads number
    Context: server config
    Status: MPM
    Module: mpm_netware, perchild
    @@ -438,7 +445,7 @@ the child processes
    Syntax
    top

    ThreadLimit Directive

    Description: Sets the upper limit on the configurable number of threads per child process
    Syntax: - ThreadLimit number
    Context: + ThreadLimit number
    Context: server config
    Status: MPM
    Module: mpm_winnt, worker
    @@ -463,7 +470,7 @@ per child process
    Syntax:
    top

    ThreadsPerChild Directive

    Description: Number of threads created by each child process
    Syntax: - ThreadsPerChild number
    Context: + ThreadsPerChild number
    Context: server config
    Status: MPM
    Module: worker, mpm_winnt
    @@ -483,7 +490,7 @@ per child process
    Syntax:
    top

    User Directive

    Description: The userid under which the server will answer requests
    Syntax: - User unix-userid
    Default: + User unix-userid
    Default: User #-1
    Context: server config, virtual host
    Status: MPM
    Module: @@ -491,7 +498,7 @@ requests
    Syntax:

    The User directive sets the userid as which the server will answer requests. In order to use this directive, the standalone server must be run initially as - root. Unix-userid is one of:

    + root. Unix-userid is one of:

    A username
    diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml index 674af827402..d8efd958515 100644 --- a/docs/manual/mod/mpm_common.xml +++ b/docs/manual/mod/mpm_common.xml @@ -12,7 +12,7 @@ more than one multi-processing module (MPM) CoreDumpDirectory Directory where Apache attempts to switch before dumping core -CoreDumpDirectory directory +CoreDumpDirectory directory See usage for the default setting server config workerperchild @@ -35,7 +35,7 @@ switch before dumping core Group Group under which the server will answer requests -Group unix-group +Group unix-group Group #-1 server configvirtual host @@ -46,7 +46,7 @@ requests

    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:

    + Unix-group is one of:

    A group name
    @@ -79,7 +79,7 @@ requests PidFile File where the server records the process ID of the daemon -PidFile filename +PidFile filename PidFile logs/httpd.pid server config workerperchild @@ -93,7 +93,7 @@ of the daemon relative to the ServerRoot.

    Example - PidFile /var/run/apache.pid + PidFile /var/run/apache.pid

    It is often useful to be able to send the server a signal, @@ -113,7 +113,7 @@ of the daemon Listen IP addresses and ports that the server listens to -Listen [IP-address:]portnumber +Listen [IP-address:]portnumber server config workerperchild preforkmpm_winnt @@ -140,21 +140,26 @@ listens to

    For example, to make the server accept connections on both port 80 and port 8000, use:

    - - Listen 80
    - Listen 8000 -
    + + + Listen 80
    + Listen 8000 +
    +

    To make the server accept connections on two specified interfaces and port numbers, use

    - - Listen 192.170.2.1:80
    - Listen 192.170.2.5:8000 -
    + + + Listen 192.170.2.1:80
    + Listen 192.170.2.5:8000 +
    +

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

    - - Listen [fe80::a00:20ff:fea7:ccea]:80 - + + + Listen [fe80::a00:20ff:fea7:ccea]:80 +
    DNS Issues @@ -165,7 +170,7 @@ listens to ListenBackLog Maximum length of the queue of pending connections -ListenBacklog backlog +ListenBacklog backlog ListenBacklog 511 server config workerperchild @@ -190,7 +195,7 @@ listens to LockFile Location of the accept serialization lock file -LockFile filename +LockFile filename LockFile logs/accept.lock server config workerperchild @@ -206,12 +211,13 @@ listens to disk. The PID of the main server process is automatically appended to the filename.

    -

    SECURITY: It is best to avoid putting this - file in a world writable directory such as - /var/tmp because someone could create a denial of + 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.

    +
    @@ -219,7 +225,7 @@ listens to MaxClients Maximum number of child processes that will be created to serve requests -MaxClients number +MaxClients number server config workerprefork @@ -254,7 +260,7 @@ to serve requests MaxMemFree Maximum amount of memory that the main allocator is allowed to hold without calling free() -MaxMemFree number +MaxMemFree number server config workerprefork mpm_netware @@ -272,7 +278,7 @@ to hold without calling free() MaxRequestsPerChild Limit on the number of requests that an individual child server will handle during its life -MaxRequestsPerChild number +MaxRequestsPerChild number MaxRequestsPerChild 10000 server config workerperchild @@ -298,17 +304,18 @@ will handle during its life the number of processes when the server load reduces. -

    NOTE: For KeepAlive requests, only - the first request is counted towards this limit. In effect, it - changes the behavior to limit the number of - connections per child.

    + Note: +

    For KeepAlive requests, only the first request is counted + towards this limit. In effect, it changes the behavior to limit the + number of connections per child.

    +
    MaxSpareThreads Maximum number of idle threads -MaxSpareThreads number +MaxSpareThreads number server config mpm_netware perchildworker @@ -342,7 +349,7 @@ will handle during its life MaxThreadsPerChild Maximum number of threads per child process -MaxThreadsPerChild number +MaxThreadsPerChild number MaxThreadsPerChild 64 server config workerperchild @@ -362,7 +369,7 @@ will handle during its life MinSpareThreads Minimum number of idle threads available to handle request spikes -MinSpareServers number +MinSpareServers number server config mpm_netware perchildworker @@ -397,7 +404,7 @@ spikes NumServers Total number of children alive at the same time -NumServers number +NumServers number NumServers 2 server config perchild @@ -414,7 +421,7 @@ spikes ScoreBoardFile Location of the file used to store coordination data for the child processes -ScoreBoardFile file-path +ScoreBoardFile file-path ScoreBoardFile logs/apache_status server config workerperchild @@ -430,7 +437,7 @@ the child processes Apache to always create the file on the disk.

    Example - ScoreBoardFile /var/run/apache_status + ScoreBoardFile /var/run/apache_status

    File-based shared memory is useful for third-party applications @@ -448,7 +455,7 @@ the child processes SendBufferSize TCP buffer size -SendBufferSize bytes +SendBufferSize bytes server config workerperchild preforkmpm_winnt @@ -465,7 +472,7 @@ the child processes ServerLimit Upper limit on configurable number of processes -ServerLimit number +ServerLimit number ServerLimit 256 (prefork), ServerLimit 16 (worker) server config workerprefork @@ -513,7 +520,7 @@ the child processes StartServers Number of child server processes created at startup -StartServers number +StartServers number StartServers 5 server config worker @@ -531,7 +538,7 @@ the child processes StartThreads Nubmer of threads created on startup -StartThreads number +StartThreads number server config mpm_netwareperchild @@ -557,7 +564,7 @@ the child processes ThreadLimit Sets the upper limit on the configurable number of threads per child process -ThreadLimit number +ThreadLimit number server config mpm_winntworker @@ -591,7 +598,7 @@ per child process ThreadsPerChild Number of threads created by each child process -ThreadsPerChild number +ThreadsPerChild number server config workermpm_winnt @@ -617,7 +624,7 @@ per child process User The userid under which the server will answer requests -User unix-userid +User unix-userid User #-1 server configvirtual host @@ -628,7 +635,7 @@ requests

    The User directive sets the userid as which the server will answer requests. In order to use this directive, the standalone server must be run initially as - root. Unix-userid is one of:

    + root. Unix-userid is one of:

    A username
    diff --git a/docs/manual/mod/mpm_netware.html.en b/docs/manual/mod/mpm_netware.html.en index d711ffec7f4..0fd4991b0a9 100644 --- a/docs/manual/mod/mpm_netware.html.en +++ b/docs/manual/mod/mpm_netware.html.en @@ -16,33 +16,32 @@

    The main thread is responsible for launching child worker threads which listen for connections and serve them when they - arrive. Apache always tries to maintain several spare + arrive. Apache always tries to maintain several spare or idle worker threads, which stand ready to serve incoming requests. In this way, clients do not need to wait for a new child threads to be spawned before their requests can be served.

    -

    The StartThreads, MinSpareThreads, - MaxSpareThreads, and MaxThreads +

    The StartThreads, + MinSpareThreads, + MaxSpareThreads, and + MaxThreads 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 + 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 + 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 controls how frequently the - server recycles processes by killing old ones and launching new - ones.  On the NetWare OS it is highly recommended that this directive - remain set to 0.  This allows worker threads to continue servicing - requests indefinitely.

    - -

    See also: Setting which addresses and - ports Apache uses.

    +

    MaxRequestsPerChild + controls how frequently the server recycles processes by killing old + ones and launching new ones. On the NetWare OS it is highly + recommended that this directive remain set to 0. This allows worker + threads to continue servicing requests indefinitely.

    top

    MaxThreads Directive

    Description: +

    See also

    top

    MaxThreads Directive

    Description:
    Syntax: - MaxThreads number
    Default: + MaxThreads number
    Default: MaxThreads 250
    Context: server config
    Status: MPM
    Module: @@ -64,7 +65,7 @@ number worker threads allowable.

    top

    ThreadStackSize Directive

    Description:
    Syntax: - ThreadStackSize number
    Default: + ThreadStackSize number
    Default: ThreadStackSize 65536
    Context: server config
    Status: MPM
    Module: diff --git a/docs/manual/mod/mpm_netware.xml b/docs/manual/mod/mpm_netware.xml index 79ddac71dde..5888640e514 100644 --- a/docs/manual/mod/mpm_netware.xml +++ b/docs/manual/mod/mpm_netware.xml @@ -16,35 +16,37 @@

    The main thread is responsible for launching child worker threads which listen for connections and serve them when they - arrive. Apache always tries to maintain several spare + arrive. Apache always tries to maintain several spare or idle worker threads, which stand ready to serve incoming requests. In this way, clients do not need to wait for a new child threads to be spawned before their requests can be served.

    -

    The StartThreads, MinSpareThreads, - MaxSpareThreads, and MaxThreads +

    The StartThreads, + MinSpareThreads, + MaxSpareThreads, and + MaxThreads 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 + 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 + 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 controls how frequently the - server recycles processes by killing old ones and launching new - ones.  On the NetWare OS it is highly recommended that this directive - remain set to 0.  This allows worker threads to continue servicing - requests indefinitely.

    - -

    See also: Setting which addresses and - ports Apache uses.

    +

    MaxRequestsPerChild + controls how frequently the server recycles processes by killing old + ones and launching new ones. On the NetWare OS it is highly + recommended that this directive remain set to 0. This allows worker + threads to continue servicing requests indefinitely.

    +Setting which addresses and + ports Apache uses + Listen @@ -59,7 +61,7 @@ MaxThreads -MaxThreads number +MaxThreads number MaxThreads 250 server config @@ -83,7 +85,7 @@ ThreadStackSize -ThreadStackSize number +ThreadStackSize number ThreadStackSize 65536 server config diff --git a/docs/manual/mod/perchild.html.en b/docs/manual/mod/perchild.html.en index e234b623be7..b18ec2833f1 100644 --- a/docs/manual/mod/perchild.html.en +++ b/docs/manual/mod/perchild.html.en @@ -29,7 +29,7 @@ make it functional. The individual threads then listen for connections and serve them when they arrive.

    -

    Apache always tries to maintain a pool of spare or +

    Apache always tries to maintain a pool of spare or idle server threads, which stand ready to serve incoming requests. In this way, clients do not need to wait for new threads to be created. For each child process, Apache assesses @@ -60,9 +60,6 @@ make it functional. server recycles processes by killing old ones and launching new ones.

    -

    See also: Setting which addresses and - ports Apache uses.

    -

    In addition it adds the extra ability to specify that specific processes should serve requests under different userids. These processes can then be associated with specific @@ -85,9 +82,11 @@ make it functional.

  • SendBufferSize
  • StartThreads
  • User
  • -
    top

    AssignUserId Directive

    Description: +

    See also

    top

    AssignUserId Directive

    Description:
    Syntax: - AssignUserID user_id group_id
    Context: + AssignUserID user_id group_id
    Context: virtual host
    Status: MPM
    Module: perchild
    @@ -96,8 +95,8 @@ the virtual host where this directive appears will be served by the process running with the specified user and group id.

    top

    ChildPerUserId Directive

    Description:
    Syntax: - ChildPerUserID user_id -group_id num_children
    Context: + ChildPerUserID user_id +group_id num_children
    Context: server config
    Status: MPM
    Module: perchild
    diff --git a/docs/manual/mod/perchild.xml b/docs/manual/mod/perchild.xml index 7e0db103b9a..ff26f5396ca 100644 --- a/docs/manual/mod/perchild.xml +++ b/docs/manual/mod/perchild.xml @@ -31,7 +31,7 @@ make it functional. The individual threads then listen for connections and serve them when they arrive.

    -

    Apache always tries to maintain a pool of spare or +

    Apache always tries to maintain a pool of spare or idle server threads, which stand ready to serve incoming requests. In this way, clients do not need to wait for new threads to be created. For each child process, Apache assesses @@ -65,15 +65,15 @@ make it functional. server recycles processes by killing old ones and launching new ones.

    -

    See also: Setting which addresses and - ports Apache uses.

    -

    In addition it adds the extra ability to specify that specific processes should serve requests under different userids. These processes can then be associated with specific virtual hosts.

    +Setting which addresses and + ports Apache uses + CoreDumpDirectory @@ -123,7 +123,7 @@ make it functional. AssignUserId -AssignUserID user_id group_id +AssignUserID user_id group_id virtual host @@ -135,8 +135,8 @@ running with the specified user and group id.

    ChildPerUserId -ChildPerUserID user_id -group_id num_children +ChildPerUserID user_id +group_id num_children server config diff --git a/docs/manual/mod/prefork.html.en b/docs/manual/mod/prefork.html.en index 4976c6686fa..443c7201eba 100644 --- a/docs/manual/mod/prefork.html.en +++ b/docs/manual/mod/prefork.html.en @@ -40,11 +40,11 @@
  • ServerLimit
  • StartServers
  • User
  • -

    Topics

    • How it Works

    See also

    top
    top

    How it Works

    A single control process is responsible for launching child processes which listen for connections and serve them when they - arrive. Apache always tries to maintain several spare + arrive. Apache always tries to maintain several spare or idle server processes, which stand ready to serve incoming requests. In this way, clients do not need to wait for a new child processes to be forked before their requests can be @@ -77,7 +77,7 @@

    top

    AcceptMutex Directive

    Description: Method that Apache uses to serialize multiple children accepting requests on network sockets
    Syntax: - AcceptMutex default|method
    Default: + AcceptMutex default|method
    Default: AcceptMutex default
    Context: server config
    Status: MPM
    Module: @@ -119,7 +119,7 @@ accepting requests on network sockets
    top

    MaxSpareServers Directive

    Description: Maximum number of idle child server processes
    Syntax: - MaxSpareServers number
    Default: + MaxSpareServers number
    Default: MaxSpareServers 10
    Context: server config
    Status: MPM
    Module: @@ -135,7 +135,7 @@ accepting requests on network sockets
    MinSpareServers
  • StartServers
  • top

    MinSpareServers Directive

    Description: Minimum number of idle child server processes
    Syntax: - MinSpareServers number
    Default: + MinSpareServers number
    Default: MinSpareServers 5
    Context: server config
    Status: MPM
    Module: diff --git a/docs/manual/mod/prefork.xml b/docs/manual/mod/prefork.xml index d1dd0a999b6..d4dbf44aafb 100644 --- a/docs/manual/mod/prefork.xml +++ b/docs/manual/mod/prefork.xml @@ -28,10 +28,10 @@ Setting which addresses and ports Apache uses -
    How it Works +
    How it Works

    A single control process is responsible for launching child processes which listen for connections and serve them when they - arrive. Apache always tries to maintain several spare + arrive. Apache always tries to maintain several spare or idle server processes, which stand ready to serve incoming requests. In this way, clients do not need to wait for a new child processes to be forked before their requests can be @@ -127,7 +127,7 @@ AcceptMutex Method that Apache uses to serialize multiple children accepting requests on network sockets -AcceptMutex default|method +AcceptMutex default|method AcceptMutex default server config @@ -175,7 +175,7 @@ accepting requests on network sockets MaxSpareServers Maximum number of idle child server processes -MaxSpareServers number
    +MaxSpareServers number
    MaxSpareServers 10 server config @@ -197,7 +197,7 @@ accepting requests on network sockets MinSpareServers Minimum number of idle child server processes -MinSpareServers number +MinSpareServers number MinSpareServers 5 server config diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en index 2378e271bd8..326bb0b1fc8 100644 --- a/docs/manual/mod/quickreference.html.en +++ b/docs/manual/mod/quickreference.html.en @@ -31,7 +31,7 @@

    EExtension
    XExperimental
    -
    AcceptMutex default|method default sM
    Method that Apache uses to serialize multiple children + @@ -110,7 +110,7 @@ error log - + @@ -187,8 +187,8 @@ NoImp + - + @@ -198,7 +198,7 @@ headers - found - @@ -329,9 +329,9 @@ client - - + @@ -341,22 +341,22 @@ URLs - + - - - - - - - + + + + @@ -364,8 +364,8 @@ files meta information - - + @@ -376,7 +376,7 @@ searching for a matching file with MultiViews hosting - + @@ -385,7 +385,7 @@ directory evaluated. - processes launched by Apache children - @@ -492,12 +492,12 @@ scripts in the scriptlog - + - + - - + + - - - + + @@ -593,7 +593,7 @@ certain events before failing a request -
    AcceptMutex default|method default sM
    Method that Apache uses to serialize multiple children accepting requests on network sockets
    AcceptPathInfo On|Off|Default Default svdhC
    Resources accept trailing pathname information
    AccessFileName filename [filename] ... .htaccess svC
    Name of the distributed configuration file
    Anonymous_NoUserID on|off off dhE
    Sets whether the userID field may be empty
    Anonymous_VerifyEmail on|off off dhE
    Sets whether to check the password field for a correctly formatted email address
    AssignUserID user_id group_idvM
    -
    AssignUserID user_id group_idvM
    -
    AuthBasicAuthoritative on|off on dhB
    Sets whether authorization and authentication are passed to lower level modules
    AuthBasicProvider provider-namedhB
    Sets the authentication provider(s) for this location
    svdhX
    Config
    CharsetSourceEnc charsetsvdhX
    Source charset of files
    CheckSpelling on|off Off svdhE
    Enables the spelling module
    ChildPerUserID user_id -group_id num_childrensM
    -
    ChildPerUserID user_id +group_id num_childrensM
    -
    ContentDigest on|off off svdhC
    Enables the generation of Content-MD5 HTTP Response headers
    CookieDomain domainsvdhE
    The domain to which the tracking cookie applies
    CookieStyle Netscape|Cookie|Cookie2|RFC2109|RFC2965 Netscape svdhE
    Format of the cookie header field
    CookieTracking on|off off svdhE
    Enables tracking cookie
    CoreDumpDirectory directorysM
    Directory where Apache attempts to +
    CoreDumpDirectory directorysM
    Directory where Apache attempts to switch before dumping core
    CustomLog file|pipe format|nickname @@ -262,7 +262,7 @@ filenames
    ForceType MIME-type|nonedhC
    Forces all matching files to be served with the specified MIME content-type
    Group unix-group #-1 svM
    Group under which the server will answer +
    Group unix-group #-1 svM
    Group under which the server will answer requests
    Header set|append|add|unset|echo header [value]svdhE
    Configure HTTP response headers
    LimitRequestLine bytes 8190 sC
    Limit the size of the HTTP request line that will be accepted from the client
    LimitXMLRequestBody number 1000000 svdhC
    Limits the size of an XML-based request body
    Listen [IP-address:]portnumbersM
    IP addresses and ports that the server +
    Listen [IP-address:]portnumbersM
    IP addresses and ports that the server listens to
    ListenBacklog backlogsM
    Maximum length of the queue of pending connections
    ListenBacklog backlogsM
    Maximum length of the queue of pending connections
    LoadFile filename [filename] ...sE
    Link in the named object file or library
    LoadModule module filenamesE
    Links in the object file or library, and adds to the list of active modules
    <LocationMatch regex> ... </Location>svC
    Applies the enclosed directives only to regular-expression matching URLs
    LockFile filename logs/accept.lock sM
    Location of the accept serialization lock file
    LockFile filename logs/accept.lock sM
    Location of the accept serialization lock file
    LogFormat format|nickname [nickname] "%h %l %u %t \"%r\" +svB
    Describes a format for use in a log file
    LogLevel level warn svC
    Controls the verbosity of the ErrorLog
    MaxClients numbersM
    Maximum number of child processes that will be created +
    MaxClients numbersM
    Maximum number of child processes that will be created to serve requests
    MaxKeepAliveRequests number 100 svC
    Number of requests allowed on a persistent connection
    MaxMemFree numbersM
    Maximum amount of memory that the main allocator is allowed +
    MaxMemFree numbersM
    Maximum amount of memory that the main allocator is allowed to hold without calling free()
    MaxRequestsPerChild number 10000 sM
    Limit on the number of requests that an individual child server +
    MaxRequestsPerChild number 10000 sM
    Limit on the number of requests that an individual child server will handle during its life
    MaxSpareServers number
    10 sM
    Maximum number of idle child server processes
    MaxSpareThreads numbersM
    Maximum number of idle threads
    MaxThreads number 250 sM
    -
    MaxThreadsPerChild number 64 sM
    Maximum number of threads per child process
    MaxSpareServers number
    10 sM
    Maximum number of idle child server processes
    MaxSpareThreads numbersM
    Maximum number of idle threads
    MaxThreads number 250 sM
    -
    MaxThreadsPerChild number 64 sM
    Maximum number of threads per child process
    MetaDir directory .web svdhE
    Name of the directory to find CERN-style meta information files
    MetaFiles on|off off svdhE
    Activates CERN meta-file processing
    MimeMagicFile file-pathsvE
    Enable MIME-type determination based on file contents using the specified magic file
    MinSpareServers number 5 sM
    Minimum number of idle child server processes
    MinSpareServers numbersM
    Minimum number of idle threads available to handle request +
    MinSpareServers number 5 sM
    Minimum number of idle child server processes
    MinSpareServers numbersM
    Minimum number of idle threads available to handle request spikes
    MMapFile file-path [file-path] ...sX
    -
    ModMimeUsePathInfo On|OffdB
    Tells mod_mime to treat path_info components as part of the filename
    NoProxy host [host] ...svE
    Hosts, domains, or networks that will be connected to directly
    NumServers number 2 sM
    Total number of children alive at the same time
    NumServers number 2 sM
    Total number of children alive at the same time
    Options [+|-]option [[+|-]option] ... All svdhC
    Configures what features are available in a particular directory
    PassEnv env-variable [env-variable] ...svdhB
    Passes environment variables from the shell
    PidFile filename logs/httpd.pid sM
    File where the server records the process ID +
    PidFile filename logs/httpd.pid sM
    File where the server records the process ID of the daemon
    ProtocolEcho On|OffsvX
    Turn the echo server on or off
    <Proxy wildcard-url> ...</Proxy>svE
    Container for directives applied to proxied @@ -475,7 +475,7 @@ by Apache children
    Satisfy any|all all dhC
    Interaction between host-level access control and user authentication
    ScoreBoardFile file-path logs/apache_status sM
    Location of the file used to store coordination data for +
    ScoreBoardFile file-path logs/apache_status sM
    Location of the file used to store coordination data for the child processes
    Script method cgi-scriptsvdB
    Activates a CGI script for a particular request method.
    ScriptLogLength bytes 10385760 svB
    Size limit of the CGI script logfile
    ScriptSock file-path logs/cgisock svB
    -
    SendBufferSize bytessM
    TCP buffer size
    SendBufferSize bytessM
    TCP buffer size
    ServerAdmin email-addresssvC
    Email address that the server includes in error messages sent to the client
    ServerAlias hostname [hostname] ...vC
    Alternate names for a host used when matching requests to name-virtual hosts
    ServerLimit number 256 (prefork), Serv +sM
    Upper limit on configurable number of processes
    ServerLimit number 256 (prefork), Serv +sM
    Upper limit on configurable number of processes
    ServerName fully-qualified-domain-name[:port]svC
    Hostname and port that the server uses to identify itself
    ServerPath URL-pathvC
    Legacy URL pathname for a name-virtual host that @@ -579,13 +579,13 @@ in the Session Cache
    SSLVerifyClient level none svdhE
    Type of Client Certificate verification
    SSLVerifyDepth number 1 svdhE
    Maximum depth of CA Certificates in Client Certificate verification
    StartServers number 5 sM
    Number of child server processes created at startup
    StartThreads numbersM
    Nubmer of threads created on startup
    StartServers number 5 sM
    Number of child server processes created at startup
    StartThreads numbersM
    Nubmer of threads created on startup
    SuexecUserGroup User GroupsvE
    User and group permissions for CGI programs
    ThreadLimit numbersM
    Sets the upper limit on the configurable number of threads +
    ThreadLimit numbersM
    Sets the upper limit on the configurable number of threads per child process
    ThreadsPerChild numbersM
    Number of threads created by each child process
    ThreadStackSize number 65536 sM
    -
    ThreadsPerChild numbersM
    Number of threads created by each child process
    ThreadStackSize number 65536 sM
    -
    TimeOut number 300 sC
    Amount of time the server will wait for certain events before failing a request
    TransferLog file|pipesvB
    Specifly location of a log file
    UnsetEnv env-variable [env-variable] ...svdhB
    Removes variables from the environment
    UseCanonicalName on|off|dns on svdC
    Configures how the server determines its own name and port
    User unix-userid #-1 svM
    The userid under which the server will answer +
    User unix-userid #-1 svM
    The userid under which the server will answer requests
    UserDir directory-filename public_html svB
    Location of the user-specific directories
    VirtualDocumentRoot interpolated-directory|none none svE
    Dynamically configure the location of the document root diff --git a/docs/manual/mod/worker.html.en b/docs/manual/mod/worker.html.en index 7ddbcbc22be..6c0e85687a6 100644 --- a/docs/manual/mod/worker.html.en +++ b/docs/manual/mod/worker.html.en @@ -42,8 +42,8 @@
  • ThreadLimit
  • ThreadsPerChild
  • User
  • -

    Topics

    • How it Works

    See also

    top
    top

    How it Works

    Each process has a fixed number of threads. The server adjusts to handle load by increasing or decreasing the number of processes.

    @@ -54,7 +54,7 @@ individual threads then listen for connections and serve them when they arrive.

    -

    Apache always tries to maintain a pool of spare or +

    Apache always tries to maintain a pool of spare or idle server threads, which stand ready to serve incoming requests. In this way, clients do not need to wait for a new threads or processes to be created before their requests can be @@ -77,12 +77,14 @@

    A typical configuration of the process-thread controls in the worker MPM could look as follows:

    -
    StartServers         2
    -MaxClients         150
    -MinSpareThreads     25
    -MaxSpareThreads     75
    -ThreadsPerChild     25
    -ServerLimit         16
    +

    + StartServers 2
    + MaxClients 150
    + MinSpareThreads 25
    + MaxSpareThreads 75
    + ThreadsPerChild 25
    + ServerLimit 16 +

    While the parent process is usually started as root under Unix in order to bind to port 80, the child processes and threads are diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml index 73ab404bbbf..f3b73ed2f84 100644 --- a/docs/manual/mod/worker.xml +++ b/docs/manual/mod/worker.xml @@ -28,7 +28,7 @@ Setting which addresses and ports Apache uses -

    How it Works +
    How it Works

    Each process has a fixed number of threads. The server adjusts to handle load by increasing or decreasing the number of processes.

    @@ -40,7 +40,7 @@ individual threads then listen for connections and serve them when they arrive.

    -

    Apache always tries to maintain a pool of spare or +

    Apache always tries to maintain a pool of spare or idle server threads, which stand ready to serve incoming requests. In this way, clients do not need to wait for a new threads or processes to be created before their requests can be @@ -67,12 +67,14 @@

    A typical configuration of the process-thread controls in the worker MPM could look as follows:

    -
    StartServers         2
    -MaxClients         150
    -MinSpareThreads     25
    -MaxSpareThreads     75
    -ThreadsPerChild     25
    -ServerLimit         16
    + + StartServers 2
    + MaxClients 150
    + MinSpareThreads 25
    + MaxSpareThreads 75
    + ThreadsPerChild 25
    + ServerLimit 16 +

    While the parent process is usually started as root under Unix in order to bind to port 80, the child processes and threads are -- 2.47.2