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="install.xml.meta">
25 <title>Compiling and Installing</title>
29 <p>This document covers compilation and installation of the Apache HTTP Server
30 on Unix and Unix-like systems only. For compiling and
31 installation on Windows, see <a
32 href="platform/windows.html">Using Apache HTTP Server with Microsoft
33 Windows</a>. For other platforms, see the <a
34 href="platform/">platform</a> documentation.</p>
36 <p>Apache httpd uses <code>libtool</code> and <code>autoconf</code>
37 to create a build environment that looks like many other Open Source
40 <p>If you are upgrading from one minor version to the next (for
41 example, 2.2.50 to 2.2.51), please skip down to the <a
42 href="#upgrading">upgrading</a> section.</p>
46 <seealso><a href="programs/configure.html">Configure the source tree</a></seealso>
47 <seealso><a href="invoking.html">Starting Apache httpd</a></seealso>
48 <seealso><a href="stopping.html">Stopping and Restarting</a></seealso>
50 <section id="overview"><title>Overview for the
54 <columnspec><column width=".13"/><column width=".80"/></columnspec>
56 <td><a href="#download">Download</a></td>
58 <td><code>$ lynx http://httpd.apache.org/download.cgi</code>
63 <td><a href="#extract">Extract</a></td>
65 <td><code>$ gzip -d httpd-<em>NN</em>.tar.gz<br />
66 $ tar xvf httpd-<em>NN</em>.tar<br />
67 $ cd httpd-<em>NN</em></code></td>
71 <td><a href="#configure">Configure</a></td>
73 <td><code>$ ./configure --prefix=<em>PREFIX</em></code>
78 <td><a href="#compile">Compile</a></td>
80 <td><code>$ make</code> </td>
84 <td><a href="#install">Install</a></td>
86 <td><code>$ make install</code> </td>
90 <td><a href="#customize">Customize</a></td>
92 <td><code>$ vi <em>PREFIX</em>/conf/httpd.conf</code> </td>
96 <td><a href="#test">Test</a></td>
98 <td><code>$ <em>PREFIX</em>/bin/apachectl -k start</code>
103 <p><em>NN</em> must be replaced with the current version
104 number, and <em>PREFIX</em> must be replaced with the
105 filesystem path under which the server should be installed. If
106 <em>PREFIX</em> is not specified, it defaults to
107 <code>/usr/local/apache2</code>.</p>
109 <p>Each section of the compilation and installation process is
110 described in more detail below, beginning with the requirements
111 for compiling and installing Apache httpd.</p>
114 <section id="requirements"><title>Requirements</title>
116 <p>The following requirements exist for building Apache httpd:</p>
120 <dd>Make sure you have at least 50 MB of temporary free disk
121 space available. After installation the server occupies
122 approximately 10 MB of disk space. The actual disk space
123 requirements will vary considerably based on your chosen
124 configuration options, any third-party modules, and, of course,
125 the size of the web site or sites that you have on the server.</dd>
127 <dt>ANSI-C Compiler and Build System</dt>
128 <dd>Make sure you have an ANSI-C compiler installed. The <a
129 href="http://gcc.gnu.org/">GNU C
130 compiler (GCC)</a> from the <a
131 href="http://www.gnu.org/">Free Software Foundation (FSF)</a>
132 is recommended. If you don't have GCC
133 then at least make sure your vendor's compiler is ANSI
134 compliant. In addition, your <code>PATH</code> must contain
135 basic build tools such as <code>make</code>.</dd>
137 <dt>Accurate time keeping</dt>
138 <dd>Elements of the HTTP protocol are expressed as the time of
139 day. So, it's time to investigate setting some time
140 synchronization facility on your system. Usually the
141 <code>ntpdate</code> or <code>xntpd</code> programs are used for
142 this purpose which are based on the Network Time Protocol (NTP).
143 See the <a href="http://www.ntp.org">NTP
144 homepage</a> for more details about NTP software and public
147 <dt><a href="http://www.perl.org/">Perl 5</a>
149 <dd>For some of the support scripts like <program>
150 apxs</program> or <program>dbmmanage</program> (which are
151 written in Perl) the Perl 5 interpreter is required (versions
152 5.003 or newer are sufficient). If you have multiple Perl
153 interpreters (for example, a systemwide install of Perl 4, and
154 your own install of Perl 5), you are advised to use the
155 <code>--with-perl</code> option (see below) to make sure the
156 correct one is used by <program>configure</program>.
157 If no Perl 5 interpreter is found by the
158 <program>configure</program> script, you will not be able to use
159 the affected support scripts. Of course, you will still be able to
160 build and use Apache httpd.</dd>
164 <section id="download"><title>Download</title>
166 <p>The Apache HTTP Server can be downloaded from the <a
167 href="http://httpd.apache.org/download.cgi">Apache HTTP Server
168 download site</a>, which lists several mirrors. Most users of
169 Apache on unix-like systems will be better off downloading and
170 compiling a source version. The build process (described below) is
171 easy, and it allows you to customize your server to suit your needs.
172 In addition, binary releases are often not up to date with the latest
173 source releases. If you do download a binary, follow the instructions
174 in the <code>INSTALL.bindist</code> file inside the distribution.</p>
176 <p>After downloading, it is important to verify that you have a
177 complete and unmodified version of the Apache HTTP Server. This
178 can be accomplished by testing the downloaded tarball against the
179 PGP signature. Details on how to do this are available on the <a
180 href="http://httpd.apache.org/download.cgi#verify">download
181 page</a> and an extended example is available describing the <a
182 href="http://httpd.apache.org/dev/verification.html">use of
187 <section id="extract"><title>Extract</title>
189 <p>Extracting the source from the Apache HTTP Server tarball is a
190 simple matter of uncompressing, and then untarring:</p>
193 $ gzip -d httpd-<em>NN</em>.tar.gz<br />
194 $ tar xvf httpd-<em>NN</em>.tar
197 <p>This will create a new directory under the current directory
198 containing the source code for the distribution. You should
199 <code>cd</code> into that directory before proceeding with
200 compiling the server.</p>
203 <section id="configure"><title>Configuring the source tree</title>
205 <p>The next step is to configure the Apache source tree for your
206 particular platform and personal requirements. This is done using
207 the script <program>configure</program> included in
208 the root directory of the distribution. (Developers downloading
209 an unreleased version of the Apache source tree will need to have
210 <code>autoconf</code> and <code>libtool</code> installed and will
211 need to run <code>buildconf</code> before proceeding with the next
212 steps. This is not necessary for official releases.)</p>
214 <p>To configure the source tree using all the default options,
215 simply type <code>./configure</code>. To change the default
216 options, <program>configure</program> accepts a variety of variables
217 and command line options.</p>
219 <p>The most important option is the location <code>--prefix</code>
220 where Apache is to be installed later, because Apache has to be
221 configured for this location to work correctly. More fine-tuned
222 control of the location of files is possible with additional <a
223 href="programs/configure.html#installationdirectories">configure
226 <p>Also at this point, you can specify which <a
227 href="programs/configure.html#optionalfeatures">features</a> you
228 want included in Apache by enabling and disabling <a
229 href="mod/">modules</a>. Apache comes with a wide range of modules
230 included by default. They will be compiled as
231 <a href="dso.html">shared objects (DSOs)</a> which can be loaded
232 or unloaded at runtime.
233 You can also choose to compile modules statically by using the option
234 <code>--enable-<var>module</var>=static</code>.</p>
236 <p>Additional modules are enabled using the
237 <code>--enable-<var>module</var></code> option, where
238 <var>module</var> is the name of the module with the
239 <code>mod_</code> string removed and with any underscore converted
240 to a dash. Similarly, you can disable modules with the
241 <code>--disable-<var>module</var></code> option. Be careful when
242 using these options, since <program>configure</program> cannot warn you
243 if the module you specify does not exist; it will simply ignore the
246 <p>In addition, it is sometimes necessary to provide the
247 <program>configure</program> script with extra information about the
248 location of your compiler, libraries, or header files. This is
249 done by passing either environment variables or command line
250 options to <program>configure</program>. For more information, see the
251 <program>configure</program> manual page. Or invoke
252 <program>configure</program> using the <code>--help</code> option.</p>
254 <p>For a short impression of what possibilities you have, here
255 is a typical example which compiles Apache for the installation
256 tree <code>/sw/pkg/apache</code> with a particular compiler and flags
257 plus the two additional modules <module>mod_ldap</module> and
258 <module>mod_lua</module>:</p>
261 $ CC="pgcc" CFLAGS="-O2" \<br />
262 ./configure --prefix=/sw/pkg/apache \<br />
263 --enable-ldap=shared \<br />
267 <p>When <program>configure</program> is run it will take several minutes to
268 test for the availability of features on your system and build
269 Makefiles which will later be used to compile the server.</p>
271 <p>Details on all the different <program>configure</program> options are
272 available on the <program>configure</program> manual page.</p>
275 <section id="compile"><title>Build</title>
277 <p>Now you can build the various parts which form the Apache
278 package by simply running the command:</p>
280 <example>$ make</example>
282 <p>Please be patient here, since a base configuration takes
283 several minutes to compile and the time will vary widely
284 depending on your hardware and the number of modules that you
288 <section id="install"><title>Install</title>
290 <p>Now it's time to install the package under the configured
291 installation <em>PREFIX</em> (see <code>--prefix</code> option
292 above) by running:</p>
294 <example>$ make install</example>
296 <p>This step will typically require root privileges, since
297 <em>PREFIX</em> is usually a directory with restricted write
300 <p>If you are upgrading, the installation will not overwrite
301 your configuration files or documents.</p>
304 <section id="customize"><title>Customize</title>
306 <p>Next, you can customize your Apache HTTP server by editing
307 the <a href="configuring.html">configuration files</a> under
308 <code><em>PREFIX</em>/conf/</code>.</p>
310 <example>$ vi <em>PREFIX</em>/conf/httpd.conf</example>
312 <p>Have a look at the Apache manual under
313 <code><em>PREFIX</em>/docs/manual/</code> or consult <a
314 href="http://httpd.apache.org/docs/&httpd.docs;/"
315 >http://httpd.apache.org/docs/&httpd.docs;/</a> for the most recent
316 version of this manual and a complete reference of available <a
317 href="mod/directives.html">configuration directives</a>.</p>
320 <section id="test"><title>Test</title>
322 <p>Now you can <a href="invoking.html">start</a> your Apache
323 HTTP server by immediately running:</p>
325 <example>$ <em>PREFIX</em>/bin/apachectl -k start</example>
327 <p>You should then be able to request your first document
328 via the URL <code>http://localhost/</code>. The web page you see is located
329 under the <directive module="core">DocumentRoot</directive>,
330 which will usually be <code><em>PREFIX</em>/htdocs/</code>.
331 Then <a href="stopping.html">stop</a> the server again by
334 <example>$ <em>PREFIX</em>/bin/apachectl -k stop</example>
336 <section id="upgrading"><title>Upgrading</title>
338 <p>The first step in upgrading is to read the release announcement
339 and the file <code>CHANGES</code> in the source distribution to
340 find any changes that may affect your site. When changing between
341 major releases (for example, from 2.0 to 2.2 or from 2.2 to 2.3),
342 there will likely be major differences in the compile-time and
343 run-time configuration that will require manual adjustments. All
344 modules will also need to be upgraded to accomodate changes in the
347 <p>Upgrading from one minor version to the next (for example, from
348 2.2.55 to 2.2.57) is easier. The <code>make install</code>
349 process will not overwrite any of your existing documents, log
350 files, or configuration files. In addition, the developers make
351 every effort to avoid incompatible changes in the
352 <program>configure</program> options, run-time configuration, or the
353 module API between minor versions. In most cases you should be able to
354 use an identical <program>configure</program> command line, an identical
355 configuration file, and all of your modules should continue to
358 <p>To upgrade across minor versions, start by finding the file
359 <code>config.nice</code> in the <code>build</code> directory of
360 your installed server or at the root of the source tree for your
361 old install. This will contain the exact
362 <program>configure</program> command line that you used to
363 configure the source tree. Then to upgrade from one version to
364 the next, you need only copy the <code>config.nice</code> file to
365 the source tree of the new version, edit it to make any desired
366 changes, and then run:</p>
369 $ ./config.nice<br />
372 $ <em>PREFIX</em>/bin/apachectl -k graceful-stop<br />
373 $ <em>PREFIX</em>/bin/apachectl -k start<br />
376 <note type="warning">You should always test any new version in your
377 environment before putting it into production. For example, you
378 can install and run the new version along side the old one by
379 using a different <code>--prefix</code> and a
380 different port (by adjusting the <directive
381 module="mpm_common">Listen</directive> directive) to test for any
382 incompatibilities before doing the final upgrade.</note>
384 <p>You can pass additional arguments to <code>config.nice</code>,
385 which will be appended to your original <program>configure</program>
389 $ ./config.nice --prefix=/home/test/apache --with-port=90
392 <section id="thirdp"><title>Third-party packages</title>
394 <p>A large number of third parties provide their own packaged
395 distributions of the Apache HTTP Server for installation on
396 particular platforms. This includes the various Linux distributions,
397 various third-party Windows packages, Mac OS X, Solaris, and many
400 <p>Our software license not only permits, but encourages, this kind
401 of redistribution. However, it does result in a situation where the
402 configuration layout and defaults on your installation of the server
403 may differ from what is stated in the documentation. While
404 unfortunate, this situation is not likely to change any time
408 href="http://wiki.apache.org/httpd/DistrosDefaultLayout">description
409 of these third-party distrubutions</a> is maintained in the HTTP
410 Server wiki, and should reflect the current state of these
411 third-party distributions. However, you will need to familiarize
412 yourself with your particular platform's package management and
413 installation procedures.</p>