Commit 131e0f4a authored by Joshua Slive's avatar Joshua Slive
Browse files

Update the "bind" docs, remove the stuff from "server-wide.html" that 

will now go in the MPMs, and update prefork.html with that documentation.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@87061 13f79535-47bb-0310-9956-ffa450edef68
parent 2bd3ca06

docs/manual/bind.html

+13 −70
Original line number Diff line number Diff line
@@ -14,84 +14,27 @@ 
<!--#include virtual="header.html" -->

<H1 ALIGN="CENTER">Setting which addresses and ports Apache uses</H1>



<HR>



When Apache starts, it connects to some port and address on the

<p>When Apache starts, it connects to some port and address on the

local machine and waits for incoming requests. By default, it

listens to all addresses on the machine, and to the port

as specified by the <TT>Port</TT> directive in the server configuration.

as specified by the <code>Port</code> directive in the server configuration.

However, it can be told to listen to more the one port, or to listen

to only selected addresses, or a combination. This is often combined

with the Virtual Host feature which determines how Apache

responds to different IP addresses, hostnames and ports.<P>



There are two directives used to restrict or specify which addresses

and ports Apache listens to.



<UL>

<LI><A HREF="#bindaddress">BindAddress</A> is used to restrict the server to

  listening to

  a single address, and can be used to permit multiple Apache servers

  on the same machine listening to different IP addresses.

<LI><A HREF="#listen">Listen</A> can be used to make a single Apache server

  listen

  to more than one address and/or port.

</UL>



<H3><A NAME="bindaddress">BindAddress</A></H3>

<A

 HREF="mod/directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> BindAddress <EM>[ * | IP-address 

 | hostname ]</EM><BR>

<A

 HREF="mod/directive-dict.html#Default"

 REL="Help"

><STRONG>Default:</STRONG></A> <CODE>BindAddress *</CODE><BR>

<A

 HREF="mod/directive-dict.html#Context"

 REL="Help"

><STRONG>Context:</STRONG></A> server config<BR>

<A

 HREF="mod/directive-dict.html#Status"

 REL="Help"

><STRONG>Status:</STRONG></A> Core<P>



Makes the server listen to just the specified address. If the argument

is *, the server listens to all addresses. The port listened to

is set with the <TT>Port</TT> directive. Only one BindAddress

should be used.



<H3><A NAME="listen">Listen</A></H3>

<A

 HREF="mod/directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> Listen <EM>[ port | IP-address:port ]</EM><BR>

<A

 HREF="mod/directive-dict.html#Default"

 REL="Help"

><STRONG>Default:</STRONG></A> <CODE>none</CODE><BR>

<A

 HREF="mod/directive-dict.html#Context"

 REL="Help"

><STRONG>Context:</STRONG></A> server config<BR>

<A

 HREF="mod/directive-dict.html#Status"

 REL="Help"

><STRONG>Status:</STRONG></A> Core<P>

responds to different IP addresses, hostnames and ports.</p>



<TT>Listen</TT> can be used instead of <TT>BindAddress</TT> and

<TT>Port</TT>. It tells the server to accept incoming requests on the

specified port or address-and-port combination. If the first format is

used, with a port number only, the server listens to the given port on

all interfaces, instead of the port given by the <TT>Port</TT>

<p>The <code>Listen</code> directive tells the server to accept

incoming requests only on the specified port or address-and-port

combinations. If only a port number is specified in the

<code>Listen</code> directive, the server listens to the given port on

all interfaces, instead of the port given by the <code>Port</code>

directive. If an IP address is given as well as a port, the server

will listen on the given port and interface.  <P> Multiple Listen

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

addresses and ports.</P>



For example, to make the server accept connections on both port

<p>For example, to make the server accept connections on both port

80 and port 8000, use:

<PRE>

   Listen 80
@@ -107,7 +50,7 @@ interfaces and port numbers, use 


<H2>How this works with Virtual Hosts</H2>



BindAddress and Listen do not implement Virtual Hosts. They tell the

<p>Listen does not implement Virtual Hosts.  It only tells the

main server what addresses and ports to listen to.  If no

&lt;VirtualHost&gt; directives are used, the server will behave the

same for all accepted requests. However, &lt;VirtualHost&gt; can be
@@ -122,8 +65,8 @@ not listening to, it cannot be accessed. 
<H2>See also</H2>



See also the documentation on

<a href="mod/mpm_common.html#listen">Listen directive</a>,

<A HREF="vhosts/index.html">Virtual Hosts</A>,

<A HREF="mod/core.html#bindaddress">BindAddress directive</A>,

<A HREF="mod/core.html#port">Port directive</A>,

<A HREF="dns-caveats.html">DNS Issues</A>

and

docs/manual/bind.html.en

+13 −70
Original line number Diff line number Diff line
@@ -14,84 +14,27 @@ 
<!--#include virtual="header.html" -->

<H1 ALIGN="CENTER">Setting which addresses and ports Apache uses</H1>



<HR>



When Apache starts, it connects to some port and address on the

<p>When Apache starts, it connects to some port and address on the

local machine and waits for incoming requests. By default, it

listens to all addresses on the machine, and to the port

as specified by the <TT>Port</TT> directive in the server configuration.

as specified by the <code>Port</code> directive in the server configuration.

However, it can be told to listen to more the one port, or to listen

to only selected addresses, or a combination. This is often combined

with the Virtual Host feature which determines how Apache

responds to different IP addresses, hostnames and ports.<P>



There are two directives used to restrict or specify which addresses

and ports Apache listens to.



<UL>

<LI><A HREF="#bindaddress">BindAddress</A> is used to restrict the server to

  listening to

  a single address, and can be used to permit multiple Apache servers

  on the same machine listening to different IP addresses.

<LI><A HREF="#listen">Listen</A> can be used to make a single Apache server

  listen

  to more than one address and/or port.

</UL>



<H3><A NAME="bindaddress">BindAddress</A></H3>

<A

 HREF="mod/directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> BindAddress <EM>[ * | IP-address 

 | hostname ]</EM><BR>

<A

 HREF="mod/directive-dict.html#Default"

 REL="Help"

><STRONG>Default:</STRONG></A> <CODE>BindAddress *</CODE><BR>

<A

 HREF="mod/directive-dict.html#Context"

 REL="Help"

><STRONG>Context:</STRONG></A> server config<BR>

<A

 HREF="mod/directive-dict.html#Status"

 REL="Help"

><STRONG>Status:</STRONG></A> Core<P>



Makes the server listen to just the specified address. If the argument

is *, the server listens to all addresses. The port listened to

is set with the <TT>Port</TT> directive. Only one BindAddress

should be used.



<H3><A NAME="listen">Listen</A></H3>

<A

 HREF="mod/directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> Listen <EM>[ port | IP-address:port ]</EM><BR>

<A

 HREF="mod/directive-dict.html#Default"

 REL="Help"

><STRONG>Default:</STRONG></A> <CODE>none</CODE><BR>

<A

 HREF="mod/directive-dict.html#Context"

 REL="Help"

><STRONG>Context:</STRONG></A> server config<BR>

<A

 HREF="mod/directive-dict.html#Status"

 REL="Help"

><STRONG>Status:</STRONG></A> Core<P>

responds to different IP addresses, hostnames and ports.</p>



<TT>Listen</TT> can be used instead of <TT>BindAddress</TT> and

<TT>Port</TT>. It tells the server to accept incoming requests on the

specified port or address-and-port combination. If the first format is

used, with a port number only, the server listens to the given port on

all interfaces, instead of the port given by the <TT>Port</TT>

<p>The <code>Listen</code> directive tells the server to accept

incoming requests only on the specified port or address-and-port

combinations. If only a port number is specified in the

<code>Listen</code> directive, the server listens to the given port on

all interfaces, instead of the port given by the <code>Port</code>

directive. If an IP address is given as well as a port, the server

will listen on the given port and interface.  <P> Multiple Listen

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

addresses and ports.</P>



For example, to make the server accept connections on both port

<p>For example, to make the server accept connections on both port

80 and port 8000, use:

<PRE>

   Listen 80
@@ -107,7 +50,7 @@ interfaces and port numbers, use 


<H2>How this works with Virtual Hosts</H2>



BindAddress and Listen do not implement Virtual Hosts. They tell the

<p>Listen does not implement Virtual Hosts.  It only tells the

main server what addresses and ports to listen to.  If no

&lt;VirtualHost&gt; directives are used, the server will behave the

same for all accepted requests. However, &lt;VirtualHost&gt; can be
@@ -122,8 +65,8 @@ not listening to, it cannot be accessed. 
<H2>See also</H2>



See also the documentation on

<a href="mod/mpm_common.html#listen">Listen directive</a>,

<A HREF="vhosts/index.html">Virtual Hosts</A>,

<A HREF="mod/core.html#bindaddress">BindAddress directive</A>,

<A HREF="mod/core.html#port">Port directive</A>,

<A HREF="dns-caveats.html">DNS Issues</A>

and

docs/manual/mod/mpm_common.html

+6 −7
Original line number Diff line number Diff line
@@ -212,16 +212,15 @@ Listen [<EM>IP address</EM>:]<EM>port number</EM><BR> 
><STRONG>Module:</STRONG></A> dexter, mpmt_pthread, perchild, prefork, mpm_winnt</p>





<P>The Listen directive instructs Apache to listen to more than one IP

address or port; by default it responds to requests on all IP

<P>The Listen directive instructs Apache to listen to only specific IP

addresses or ports; by default it responds to requests on all IP

interfaces, but only on the port given by the <CODE><A

HREF="#port">Port</A></CODE> directive.</P>

HREF="core.html#port">Port</A></CODE> directive.</P>



<TT>Listen</TT> can be used instead of <TT><A

HREF="#bindaddress">BindAddress</A></TT> and <TT>Port</TT>. It tells

<p>The Listen directive tells

the server to accept incoming requests on the specified port or

address-and-port combination. If the first format is used, with a port

number only, the server listens to the given port on all interfaces,

address-and-port combination. If only a port number is specified,

the server listens to the given port on all interfaces,

instead of the port given by the <TT>Port</TT> directive. If an IP

address is given as well as a port, the server will listen on the

given port and interface.  <P>

docs/manual/mod/prefork.html

+44 −8
Original line number Diff line number Diff line
@@ -16,7 +16,8 @@ 


<H1 ALIGN="CENTER">Multi-Processing Module prefork</H1>

<P>

This Multi-Processing Module implements a pre-forking web server.

This Multi-Processing Module implements a non-threaded, pre-forking

web server.

</P>



<P><A
@@ -37,10 +38,45 @@ REL="Help" 


<H2>Summary</H2>



<p>This Multi-Processing Module (MPM) implements a pre-forking

non-threaded web server which handles request in a manner

very similar to the default behavior of Apache 1.3 on Unix.</p>



<p>This Multi-Processing Module (MPM) implements a non-threaded,

pre-forking web server which handles request in a manner very similar

to the default behavior of Apache 1.3 on Unix.</p>



<p>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 <em>spare</em> or

idle server processes, which stand ready to serve incoming requests.

In this way, clients do not need to wait for a new child processes to

be forked before their requests can be served.</p>



<p>The <code>StartServers</code>, <code>MinSpareServers</code>,

<code>MaxSpareServers</code>, and <code>MaxServers</code> regulate how

the parent process creates children to serve requests.  In general,

Apache is very self-regulating, so most sites do not need to adjust

these directives from their default values.  Sites which need to serve

more than 256 simultaneous requests may need to increase

<code>MaxClients</code>, while sites with limited memory may need to

decrease <code>MaxClients</code> to keep the server from thrashing

(swapping memory to disk and back).  More information about tuning

process creation is provided in the <a

href="../misc/perf-tuning.html">performance hints</a> documentation.</p>



<p>While the parent process is usually started as root under Unix

in order to bind to port 80, the child processes are launched

by Apache as a less-privileged user.  The <code>User</code> and

<code>Group</code> directives are used to set the privileges

of the Apache child processes.  The child processes must

be able to read all the content that will be served, but

should have as few privileges beyond that as possible.

In addition, unless <a href="../suexec.html">suexec</a> is used,

these directives also set the privileges which will be inherited

by CGI scripts.</p>



<p><code>MaxRequestsPerChild</code> controls how frequently the server

recycles processes by killing old ones and launching new ones.</p>



<p>See also: <a href="../bind.html">Setting which addresses and ports

Apache uses</a>.</p>



<H2>Directives</H2>

<UL>
@@ -52,8 +88,8 @@ very similar to the default behavior of Apache 1.3 on Unix.</p> 
<li><a href="mpm_common.html#lockfile">LockFile</a></li>

<li><a href="mpm_common.html#maxclients">MaxClients</a></li>

<li><a href="mpm_common.html#maxrequestsperchild">MaxRequestsPerChild</a></li>

<li><a href="#maxsparethreads">MaxSpareServers</a></li>

<li><a href="#minsparethreads">MinSpareServers</a></li>

<li><a href="#maxspareservers">MaxSpareServers</a></li>

<li><a href="#minspareservers">MinSpareServers</a></li>

<li><a href="mpm_common.html#scoreboardfile">ScoreBoardFile</a></li>

<li><a href="mpm_common.html#sendbuffersize">SendBufferSize</a></li>

<li><a href="mpm_common.html#startservers">StartServers</a></li>
@@ -127,7 +163,7 @@ This directive has no effect on Microsoft Windows. 
<P>



See also <A HREF="#maxspareservers">MaxSpareServers</A> and

<A HREF="mpm_common.html#startservers">StartServers</A>.<P><HR>

<A HREF="mpm_common.html#startservers">StartServers</A>.





<!--#include virtual="footer.html" -->

docs/manual/server-wide.html

+0 −104
Original line number Diff line number Diff line
@@ -22,8 +22,6 @@ the basic operations of the server.</p> 
<ul>

<li><a href="#identification">Server Identification</a></li>

<li><a href="#locations">File Locations</a></li>

<li><a href="#process">Process Creation</a></li>

<li><a href="#network">Network Configuration</a></li>

<li><a href="#resource">Limiting Resource Usage</a></li>

</ul>
@@ -81,108 +79,6 @@ which are writable by non-root users. See the <a 
href="misc/security_tips.html">security tips</a> documentation for

more details.</p>



<hr>



<h2><a name="process">Process Creation</a></h2>



<table border="1">

<tr><td valign="top">

<strong>Related Directives</strong><br><br>



<a href="mod/core.html#bs2000account">BS2000Account</a><br>

<a href="mod/core.html#group">Group</a><br>

<a href="mod/core.html#maxclients">MaxClients</a><br>

<a href="mod/core.html#maxrequestsperchild">MaxRequestsPerChild</a><br>

<a href="mod/core.html#maxspareservers">MaxSpareServers</a><br>

<a href="mod/core.html#minspareservers">MinSpareServers</a><br>

<a href="mod/core.html#servertype">ServerType</a><br>

<a href="mod/core.html#startservers">StartServers</a><br>

<a href="mod/core.html#threadsperchild">ThreadsPerChild</a><br>

<a href="mod/core.html#user">User</a><br>

</td></tr></table>



<p>When <code>ServerType</code> is set to its recommended value of

<code>Standalone</code>, Apache 1.3 for Unix is a pre-forking web

server.  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 <em>spare</em> or

idle server processes, which stand ready to serve incoming requests.

In this way, clients do not need to wait for a new child processes to

be forked before their requests can be served.</p>



<p>The <code>StartServers</code>, <code>MinSpareServers</code>,

<code>MaxSpareServers</code>, and <code>MaxServers</code> regulate how

the parent process creates children to serve requests.  In general,

Apache is very self-regulating, so most sites do not need to adjust

these directives from their default values.  Sites which need to serve

more than 256 simultaneous requests may need to increase

<code>MaxClients</code>, while sites with limited memory may need to

decrease <code>MaxClients</code> to keep the server from thrashing

(swapping memory to disk and back).  More information about tuning

process creation is provided in the <a

href="misc/perf-tuning.html">performance hints</a> documentation.</p>



<p>While the parent process is usually started as root under Unix

in order to bind to port 80, the child processes are launched

by Apache as a less-privileged user.  The <code>User</code> and

<code>Group</code> directives are used to set the privileges

of the Apache child processes.  The child processes must

be able to read all the content that will be served, but

should have as few privileges beyond that as possible.

In addition, unless <a href="suexec.html">suexec</a> is used,

these directives also set the privileges which will be inherited

by CGI scripts.</p>



<p><code>MaxRequestsPerChild</code> controls how frequently the server

recycles processes by killing old ones and launching new ones.</p>



<p>Under Windows, Apache launches one control process and one

child process.  The child process creates multiple threads to

serve requests.  The number of threads is controlled by the

<code>ThreadsPerChild</code> directive.</p>



<hr>



<h2><a name="network">Network Configuration</a></h2>



<table border="1">

<tr><td valign="top">

<strong>Related Directives</strong><br><br>



<a href="mod/core.html#bindaddress">BindAddress</a><br>

<a href="mod/core.html#keepalive">KeepAlive</a><br>

<a href="mod/core.html#keepalivetimeout">KeepAliveTimeout</a><br>

<a href="mod/core.html#listen">Listen</a><br>

<a href="mod/core.html#listenbacklog">ListenBackLog</a><br>

<a href="mod/core.html#maxkeepaliverequests">MaxKeepAliveRequests</a><br>

<a href="mod/core.html#port">Port</a><br>

<a href="mod/core.html#sendbuffersize">SendBufferSize</a><br>

<a href="mod/core.html#timeOut">TimeOut</a><br>

</td></tr></table>



<p>When Apache starts, it connects to some port and address on the

local machine and waits for incoming requests. By default, it listens

to all addresses on the machine, and to the port as specified by the

<code>Port</code> directive in the server configuration.  However, it

can be told to listen to more than one port, to listen to only

selected addresses, or a combination. This is often combined with the

<a href="vhosts/">Virtual Host</a> feature which determines how Apache

responds to different IP addresses, hostnames and ports.</p>



<p>There are two directives used to restrict or specify which addresses

and ports Apache listens to.  The <code>BindAddress</code> directive

is used to restrict the server to listening to a single IP address.

The <code>Listen</code> directive can be used to specify multiple

IP addresses and/or Ports to which Apache will listen.</p>



<p>The <code>ListenBackLog</code>, <code>SendBufferSize</code>, and

<code>TimeOut</code> directives are used to adjust how Apache

interacts with the network.</p>



<p>The <code>KeepAlive</code>, <code>KeepAliveTimeout</code>, 

and <code>MaxKeepAliveRequests</code> directives are used to

configure how Apache handles persistent connections.</p>



<hr>

<h2><a name="resource">Limiting Resource Usage</a></h2>

<table border="1">