1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE manualpage SYSTEM "./style/manualpage.dtd">
3 <?xml-stylesheet type="text/xsl" href="./style/manual.en.xsl"?>
4 <!-- $LastChangedRevision$ -->
7 Licensed to the Apache Software Foundation (ASF) under one or more
8 contributor license agreements. See the NOTICE file distributed with
9 this work for additional information regarding copyright ownership.
10 The ASF licenses this file to You under the Apache License, Version 2.0
11 (the "License"); you may not use this file except in compliance with
12 the License. You may obtain a copy of the License at
14 http://www.apache.org/licenses/LICENSE-2.0
16 Unless required by applicable law or agreed to in writing, software
17 distributed under the License is distributed on an "AS IS" BASIS,
18 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 See the License for the specific language governing permissions and
20 limitations under the License.
23 <manualpage metafile="bind.xml.meta">
25 <title>Binding to Addresses and Ports</title>
28 <p>Configuring Apache HTTP Server to listen on specific addresses and ports.</p>
31 <seealso><a href="vhosts/">Virtual Hosts</a></seealso>
32 <seealso><a href="dns-caveats.html">DNS Issues</a></seealso>
34 <section id="overview">
35 <title>Overview</title>
40 <module>mpm_common</module>
43 <directive module="core" type="section">VirtualHost</directive>
44 <directive module="mpm_common">Listen</directive>
49 <p>When httpd starts, it binds to some port and address on
50 the local machine and waits for incoming requests. By default,
51 it listens to all addresses on the machine. However, it may need to
52 be told to listen on specific ports, or only on selected
53 addresses, or a combination of both. This is often combined with the
54 <a href="vhosts.html">Virtual Host</a> feature, which determines how
55 <code>httpd</code> responds to different IP addresses, hostnames and
58 <p>The <directive module="mpm_common">Listen</directive>
59 directive tells the server to accept
60 incoming requests only on the specified port(s) or
61 address-and-port combinations. If only a port number is
62 specified in the <directive module="mpm_common">Listen</directive>
63 directive, the server listens to the given port on all interfaces.
64 If an IP address is given as well as a port, the server will listen
65 on the given port and interface. Multiple <directive
66 module="mpm_common">Listen</directive> directives may be used to
67 specify a number of addresses and ports to listen on. The
68 server will respond to requests from any of the listed
69 addresses and ports.</p>
71 <p>For example, to make the server accept connections on both
72 port 80 and port 8000, on all interfaces, use:</p>
79 <p>To make the server accept connections on port 80 for one interface,
80 and port 8000 on another, use</p>
83 Listen 192.0.2.1:80<br />
87 <p>IPv6 addresses must be enclosed in square brackets, as in the
88 following example:</p>
91 Listen [2001:db8::a00:20ff:fea7:ccea]:80
94 <note type="warning"><p>Overlapping <directive
95 module="mpm_common">Listen</directive> directives will result in a
96 fatal error which will prevent the server from starting up.</p>
99 (48)Address already in use: make_sock: could not bind to address [::]:80
106 <title>Special IPv6 Considerations</title>
108 <p>A growing number of platforms implement IPv6, and
109 <glossary>APR</glossary> supports IPv6 on most of these platforms,
110 allowing httpd to allocate IPv6 sockets, and to handle requests sent
113 <p>One complicating factor for httpd administrators is whether or
114 not an IPv6 socket can handle both IPv4 connections and IPv6
115 connections. Handling IPv4 connections with an IPv6 socket uses
116 IPv4-mapped IPv6 addresses, which are allowed by default on most
117 platforms, but are disallowed by default on FreeBSD, NetBSD, and
118 OpenBSD, in order to match the system-wide policy on those
119 platforms. On systems where it is disallowed by default, a
120 special <program>configure</program> parameter can change this behavior
123 <p>On the other hand, on some platforms, such as Linux and Tru64, the
124 <strong>only</strong> way to handle both IPv6 and IPv4 is to use
125 mapped addresses. If you want <code>httpd</code> to handle IPv4 and IPv6 connections
126 with a minimum of sockets, which requires using IPv4-mapped IPv6
127 addresses, specify the <code>--enable-v4-mapped</code> <program>
128 configure</program> option.</p>
130 <p><code>--enable-v4-mapped</code> is the default on all platforms except
131 FreeBSD, NetBSD, and OpenBSD, so this is probably how your httpd was
134 <p>If you want httpd to handle IPv4 connections only, regardless of
135 what your platform and APR will support, specify an IPv4 address on all
136 <directive module="mpm_common">Listen</directive> directives, as in the
137 following examples:</p>
140 Listen 0.0.0.0:80<br />
144 <p>If your platform supports it and you want httpd to handle IPv4 and
145 IPv6 connections on separate sockets (i.e., to disable IPv4-mapped
146 addresses), specify the <code>--disable-v4-mapped</code> <program>
147 configure</program> option. <code>--disable-v4-mapped</code> is the
148 default on FreeBSD, NetBSD, and OpenBSD.</p>
151 <section id="protocol">
152 <title>Specifying the protocol with Listen</title>
153 <p>The optional second <var>protocol</var> argument of
154 <directive module="mpm_common">Listen</directive>
155 is not required for most
156 configurations. If not specified, <code>https</code> is the default for
157 port 443 and <code>http</code> the default for all other ports. The
158 protocol is used to determine which module should handle a request, and
159 to apply protocol specific optimizations with the
160 <directive module="core">AcceptFilter</directive> directive.</p>
162 <p>You only need to set the protocol if you are running on non-standard
163 ports. For example, running an <code>https</code> site on port 8443:</p>
166 Listen 192.170.2.1:8443 https
170 <section id="virtualhost">
171 <title>How This Works With Virtual Hosts</title>
174 module="mpm_common">Listen</directive> directive does not implement
175 Virtual Hosts - it only tells the
176 main server what addresses and ports to listen on. If no
177 <directive module="core" type="section">VirtualHost</directive>
178 directives are used, the server will behave
179 in the same way for all accepted requests. However,
180 <directive module="core" type="section">VirtualHost</directive>
181 can be used to specify a different behavior
182 for one or more of the addresses or ports. To implement a
183 VirtualHost, the server must first be told to listen to the
184 address and port to be used. Then a
185 <directive module="core" type="section">VirtualHost</directive> section
186 should be created for the specified address and port to set the
187 behavior of this virtual host. Note that if the
188 <directive module="core" type="section">VirtualHost</directive>
189 is set for an address and port that the
190 server is not listening to, it cannot be accessed.</p>