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 Apache
30 on Unix and Unix-like systems only. For compiling and
31 installation on Windows, see <a
32 href="platform/windows.html">Using Apache 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</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:</p>
120 <dd>Make sure you have at least 50 MB of temporary free disk
121 space available. After installation Apache occupies
122 approximately 10 MB of disk space. The actual disk space
123 requirements will vary considerably based on your chosen
124 configuration options and any third-party modules.</dd>
126 <dt>ANSI-C Compiler and Build System</dt>
127 <dd>Make sure you have an ANSI-C compiler installed. The <a
128 href="http://www.gnu.org/software/gcc/gcc.html">GNU C
129 compiler (GCC)</a> from the <a
130 href="http://www.gnu.org/">Free Software Foundation (FSF)</a>
131 is recommended. If you don't have GCC
132 then at least make sure your vendor's compiler is ANSI
133 compliant. In addition, your <code>PATH</code> must contain
134 basic build tools such as <code>make</code>.</dd>
136 <dt>Accurate time keeping</dt>
137 <dd>Elements of the HTTP protocol are expressed as the time of
138 day. So, it's time to investigate setting some time
139 synchronization facility on your system. Usually the
140 <code>ntpdate</code> or <code>xntpd</code> programs are used for
141 this purpose which are based on the Network Time Protocol (NTP).
142 See the <a href="http://www.ntp.org">NTP
143 homepage</a> for more details about NTP software and public
146 <dt><a href="http://www.perl.org/">Perl 5</a>
148 <dd>For some of the support scripts like <program>
149 apxs</program> or <program>dbmmanage</program> (which are
150 written in Perl) the Perl 5 interpreter is required (versions
151 5.003 or newer are sufficient). If you have multiple Perl
152 interpreters (for example, a systemwide install of Perl 4, and
153 your own install of Perl 5), you are advised to use the
154 <code>--with-perl</code> option (see below) to make sure the
155 correct one is used by <program>configure</program>.
156 If no Perl 5 interpreter is found by the
157 <program>configure</program> script, you will not be able to use
158 the affected support scripts. Of course, you will still be able to
159 build and use Apache httpd.</dd>
163 <section id="download"><title>Download</title>
165 <p>The Apache HTTP Server can be downloaded from the <a
166 href="http://httpd.apache.org/download.cgi">Apache HTTP Server
167 download site</a>, which lists several mirrors. Most users of
168 Apache on unix-like systems will be better off downloading and
169 compiling a source version. The build process (described below) is
170 easy, and it allows you to customize your server to suit your needs.
171 In addition, binary releases are often not up to date with the latest
172 source releases. If you do download a binary, follow the instructions
173 in the <code>INSTALL.bindist</code> file inside the distribution.</p>
175 <p>After downloading, it is important to verify that you have a
176 complete and unmodified version of the Apache HTTP Server. This
177 can be accomplished by testing the downloaded tarball against the
178 PGP signature. Details on how to do this are available on the <a
179 href="http://httpd.apache.org/download.cgi#verify">download
180 page</a> and an extended example is available describing the <a
181 href="http://httpd.apache.org/dev/verification.html">use of
186 <section id="extract"><title>Extract</title>
188 <p>Extracting the source from the Apache HTTPD tarball is a
189 simple matter of uncompressing, and then untarring:</p>
192 $ gzip -d httpd-<em>NN</em>.tar.gz<br />
193 $ tar xvf httpd-<em>NN</em>.tar
196 <p>This will create a new directory under the current directory
197 containing the source code for the distribution. You should
198 <code>cd</code> into that directory before proceeding with
199 compiling the server.</p>
202 <section id="configure"><title>Configuring the source tree</title>
204 <p>The next step is to configure the Apache source tree for your
205 particular platform and personal requirements. This is done using
206 the script <program>configure</program> included in
207 the root directory of the distribution. (Developers downloading
208 an unreleased version of the Apache source tree will need to have
209 <code>autoconf</code> and <code>libtool</code> installed and will
210 need to run <code>buildconf</code> before proceeding with the next
211 steps. This is not necessary for official releases.)</p>
213 <p>To configure the source tree using all the default options,
214 simply type <code>./configure</code>. To change the default
215 options, <program>configure</program> accepts a variety of variables
216 and command line options.</p>
218 <p>The most important option is the location <code>--prefix</code>
219 where Apache is to be installed later, because Apache has to be
220 configured for this location to work correctly. More fine-tuned
221 control of the location of files is possible with additional <a
222 href="programs/configure.html#installationdirectories">configure
225 <p>Also at this point, you can specify which <a
226 href="programs/configure.html#optionalfeatures">features</a> you
227 want included in Apache by enabling and disabling <a
228 href="mod/">modules</a>. Apache comes with a <a
229 href="mod/module-dict.html#Status">Base</a> set of modules included by
230 default. Other modules are enabled using the
231 <code>--enable-<var>module</var></code> option, where
232 <var>module</var> is the name of the module with the
233 <code>mod_</code> string removed and with any underscore converted
234 to a dash. You can also choose to compile modules as <a
235 href="dso.html">shared objects (DSOs)</a> -- which can be loaded
236 or unloaded at runtime -- by using the option
237 <code>--enable-<var>module</var>=shared</code>. Similarly, you can
238 disable Base modules with the
239 <code>--disable-<var>module</var></code> option. Be careful when
240 using these options, since <program>configure</program> cannot warn you
241 if the module you specify does not exist; it will simply ignore the
244 <p>In addition, it is sometimes necessary to provide the
245 <program>configure</program> script with extra information about the
246 location of your compiler, libraries, or header files. This is
247 done by passing either environment variables or command line
248 options to <program>configure</program>. For more information, see the
249 <program>configure</program> manual page.</p>
251 <p>For a short impression of what possibilities you have, here
252 is a typical example which compiles Apache for the installation
253 tree <code>/sw/pkg/apache</code> with a particular compiler and flags
254 plus the two additional modules <module>mod_rewrite</module> and
255 <module>mod_speling</module> for
256 later loading through the DSO mechanism:</p>
259 $ CC="pgcc" CFLAGS="-O2" \<br />
260 ./configure --prefix=/sw/pkg/apache \<br />
261 --enable-rewrite=shared \<br />
262 --enable-speling=shared
265 <p>When <program>configure</program> is run it will take several minutes to
266 test for the availability of features on your system and build
267 Makefiles which will later be used to compile the server.</p>
269 <p>Details on all the different <program>configure</program> options are
270 available on the <program>configure</program> manual page.</p>
273 <section id="compile"><title>Build</title>
275 <p>Now you can build the various parts which form the Apache
276 package by simply running the command:</p>
278 <example>$ make</example>
280 <p>Please be patient here, since a base configuration takes
281 several minutes to compile and the time will vary widely
282 depending on your hardware and the number of modules that you
286 <section id="install"><title>Install</title>
288 <p>Now it's time to install the package under the configured
289 installation <em>PREFIX</em> (see <code>--prefix</code> option
290 above) by running:</p>
292 <example>$ make install</example>
294 <p>This step will typically require root privileges, since
295 <em>PREFIX</em> is usually a directory with restricted write
298 <p>If you are upgrading, the installation will not overwrite
299 your configuration files or documents.</p>
302 <section id="customize"><title>Customize</title>
304 <p>Next, you can customize your Apache HTTP server by editing
305 the <a href="configuring.html">configuration files</a> under
306 <code><em>PREFIX</em>/conf/</code>.</p>
308 <example>$ vi <em>PREFIX</em>/conf/httpd.conf</example>
310 <p>Have a look at the Apache manual under
311 <code><em>PREFIX</em>/docs/manual/</code> or consult <a
312 href="http://httpd.apache.org/docs/&httpd.docs;/"
313 >http://httpd.apache.org/docs/&httpd.docs;/</a> for the most recent
314 version of this manual and a complete reference of available <a
315 href="mod/directives.html">configuration directives</a>.</p>
318 <section id="test"><title>Test</title>
320 <p>Now you can <a href="invoking.html">start</a> your Apache
321 HTTP server by immediately running:</p>
323 <example>$ <em>PREFIX</em>/bin/apachectl -k start</example>
325 <p>You should then be able to request your first document
326 via the URL <code>http://localhost/</code>. The web page you see is located
327 under the <directive module="core">DocumentRoot</directive>,
328 which will usually be <code><em>PREFIX</em>/htdocs/</code>.
329 Then <a href="stopping.html">stop</a> the server again by
332 <example>$ <em>PREFIX</em>/bin/apachectl -k stop</example>
334 <section id="upgrading"><title>Upgrading</title>
336 <p>The first step in upgrading is to read the release announcement
337 and the file <code>CHANGES</code> in the source distribution to
338 find any changes that may affect your site. When changing between
339 major releases (for example, from 1.3 to 2.0 or from 2.0 to 2.2),
340 there will likely be major differences in the compile-time and
341 run-time configuration that will require manual adjustments. All
342 modules will also need to be upgraded to accomodate changes in the
345 <p>Upgrading from one minor version to the next (for example, from
346 2.2.55 to 2.2.57) is easier. The <code>make install</code>
347 process will not overwrite any of your existing documents, log
348 files, or configuration files. In addition, the developers make
349 every effort to avoid incompatible changes in the
350 <program>configure</program> options, run-time configuration, or the
351 module API between minor versions. In most cases you should be able to
352 use an identical <program>configure</program> command line, an identical
353 configuration file, and all of your modules should continue to
356 <p>To upgrade across minor versions, start by finding the file
357 <code>config.nice</code> in the <code>build</code> directory of
358 your installed server or at the root of the source tree for your
359 old install. This will contain the exact
360 <program>configure</program> command line that you used to
361 configure the source tree. Then to upgrade from one version to
362 the next, you need only copy the <code>config.nice</code> file to
363 the source tree of the new version, edit it to make any desired
364 changes, and then run:</p>
367 $ ./config.nice<br />
370 $ <em>PREFIX</em>/bin/apachectl -k graceful-stop<br />
371 $ <em>PREFIX</em>/bin/apachectl -k start<br />
374 <note type="warning">You should always test any new version in your
375 environment before putting it into production. For example, you
376 can install and run the new version along side the old one by
377 using a different <code>--prefix</code> and a
378 different port (by adjusting the <directive
379 module="mpm_common">Listen</directive> directive) to test for any
380 incompatibilities before doing the final upgrade.</note>
382 <p>You can pass additional arguments to <code>config.nice</code>,
383 which will be appended to your original <program>configure</program>
387 $ ./config.nice --prefix=/home/test/apache --with-port=90