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 <!-- $Revision: 1.30 $ -->
7 Copyright 2002-2004 The Apache Software Foundation
9 Licensed under the Apache License, Version 2.0 (the "License");
10 you may not use this file except in compliance with the License.
11 You may obtain a copy of the License at
13 http://www.apache.org/licenses/LICENSE-2.0
15 Unless required by applicable law or agreed to in writing, software
16 distributed under the License is distributed on an "AS IS" BASIS,
17 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 See the License for the specific language governing permissions and
19 limitations under the License.
22 <manualpage metafile="install.xml.meta">
24 <title>Compiling and Installing</title>
28 <p>This document covers compilation and installation of Apache
29 on Unix and Unix-like systems only. For compiling and
30 installation on Windows, see <a
31 href="platform/windows.html">Using Apache with Microsoft
32 Windows</a>. For other platforms, see the <a
33 href="platform/">platform</a> documentation.</p>
35 <p>Apache 2.0's configuration and installation environment has
36 changed completely from Apache 1.3. Apache 1.3 used a custom
37 set of scripts to achieve easy installation. Apache 2.0 now
38 uses <code>libtool</code> and <code>autoconf</code>
39 to create an environment that looks like many other Open Source
42 <p>If you are upgrading from one minor version to the next (for
43 example, 2.0.50 to 2.0.51), please skip down to the <a
44 href="#upgrading">upgrading</a> section.</p>
48 <seealso><a href="programs/configure.html">Configure the source tree</a></seealso>
49 <seealso><a href="invoking.html">Starting Apache</a></seealso>
50 <seealso><a href="stopping.html">Stopping and Restarting</a></seealso>
52 <section id="overview"><title>Overview for the
56 <columnspec><column width=".13"/><column width=".80"/></columnspec>
58 <td><a href="#download">Download</a></td>
60 <td><code>$ lynx http://httpd.apache.org/download.cgi</code>
65 <td><a href="#extract">Extract</a></td>
67 <td><code>$ gzip -d httpd-2_1_<em>NN</em>.tar.gz<br />
68 $ tar xvf httpd-2_1_<em>NN</em>.tar</code> </td>
72 <td><a href="#configure">Configure</a></td>
74 <td><code>$ ./configure --prefix=<em>PREFIX</em></code>
79 <td><a href="#compile">Compile</a></td>
81 <td><code>$ make</code> </td>
85 <td><a href="#install">Install</a></td>
87 <td><code>$ make install</code> </td>
91 <td><a href="#customize">Customize</a></td>
93 <td><code>$ vi <em>PREFIX</em>/conf/httpd.conf</code> </td>
97 <td><a href="#test">Test</a></td>
99 <td><code>$ <em>PREFIX</em>/bin/apachectl start</code>
104 <p><em>NN</em> must be replaced with the current minor version
105 number, and <em>PREFIX</em> must be replaced with the
106 filesystem path under which the server should be installed. If
107 <em>PREFIX</em> is not specified, it defaults to
108 <code>/usr/local/apache2</code>.</p>
110 <p>Each section of the compilation and installation process is
111 described in more detail below, beginning with the requirements
112 for compiling and installing Apache HTTPD.</p>
115 <section id="requirements"><title>Requirements</title>
117 <p>The following requirements exist for building Apache:</p>
121 <dd>Make sure you have at least 50 MB of temporary free disk
122 space available. After installation Apache occupies
123 approximately 10 MB of disk space. The actual disk space
124 requirements will vary considerably based on your chosen
125 configuration options and any third-party modules.</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://www.gnu.org/software/gcc/gcc.html">GNU C
130 compiler (GCC)</a> from the <a
131 href="http://www.gnu.org/">Free Software Foundation (FSF)</a>
132 is recommended (version 2.7.2 is fine). 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 Usenet newsgroup <a
144 href="news:comp.protocols.time.ntp">comp.protocols.time.ntp</a>
145 and the <a href="http://www.ntp.org">NTP
146 homepage</a> for more details about NTP software and public
149 <dt><a href="http://www.perl.org/">Perl 5</a>
151 <dd>For some of the support scripts like <a
152 href="programs/apxs.html">apxs</a> or <a
153 href="programs/dbmmanage.html">dbmmanage</a> (which are
154 written in Perl) the Perl 5 interpreter is required (versions
155 5.003 or newer are sufficient). If no such interpreter is found by
156 the `<code>configure</code>' script there is no harm. Of course, you
157 still can build and install Apache 2.0. Only those support scripts
158 cannot be used. If you have multiple Perl interpreters
159 installed (perhaps a Perl 4 from the vendor and a Perl 5 from
160 your own), then it is recommended to use the <code>--with-perl</code>
161 option (see below) to make sure the correct one is selected
162 by <code>./configure</code>.</dd>
166 <section id="download"><title>Download</title>
168 <p>Apache can be downloaded from the <a
169 href="http://httpd.apache.org/download.cgi">Apache HTTP Server
170 download site</a> which lists several mirrors. Most users of
171 Apache on unix-like systems will be better off downloading and
172 compiling a source version. The build process (described below) is
173 easy, and it allows you to customize your server to suit your needs.
174 In addition, binary releases are often not up to date with the latest
175 source releases. If you do download a binary, follow the instructions
176 in the <code>INSTALL.bindist</code> file inside the distribution.</p>
178 <p>After downloading, it is important to verify that you have a
179 complete and unmodified version of the Apache HTTP Server. This
180 can be accomplished by testing the downloaded tarball against the
181 PGP signature. Details on how to do this are available on the <a
182 href="http://httpd.apache.org/download.cgi#verify">download
183 page</a> and an extended example is available describing the <a
184 href="http://httpd.apache.org/dev/verification.html">use of
189 <section id="extract"><title>Extract</title>
191 <p>Extracting the source from the Apache HTTPD tarball is a
192 simple matter of uncompressing, and then untarring:</p>
195 $ gzip -d httpd-2_1_<em>NN</em>.tar.gz<br />
196 $ tar xvf httpd-2_1_<em>NN</em>.tar
199 <p>This will create a new directory under the current directory
200 containing the source code for the distribution. You should
201 <code>cd</code> into that directory before proceeding with
202 compiling the server.</p>
205 <section id="configure"><title>Configuring the source tree</title>
207 <p>The next step is to configure the Apache source tree for your
208 particular platform and personal requirements. This is done using
210 href="programs/configure.html">configure</a></code> included in
211 the root directory of the distribution. (Developers downloading
212 the CVS version of the Apache source tree will need to have
213 <code>autoconf</code> and <code>libtool</code> installed and will
214 need to run <code>buildconf</code> before proceeding with the next
215 steps. This is not necessary for official releases.)</p>
217 <p>To configure the source tree using all the default options,
218 simply type <code>./configure</code>. To change the default
219 options, <code>configure</code> accepts a variety of variables
220 and command line options.</p>
222 <p>The most important option is the location <code>--prefix</code>
223 where Apache is to be installed later, because Apache has to be
224 configured for this location to work correctly. More fine-tuned
225 control of the location of files is possible with additional <a
226 href="programs/configure.html#installationdirectories">configure
229 <p>Also at this point, you can specify which <a
230 href="programs/configure.html#optionalfeatures">features</a> you
231 want included in Apache by enabling and disabling <a
232 href="mod/">modules</a>. Apache comes with a <a
233 href="mod/module-dict.html#Status">Base</a> set of modules included by
234 default. Other modules are enabled using the
235 <code>--enable-<var>module</var></code> option, where
236 <var>module</var> is the name of the module with the
237 <code>mod_</code> string removed and with any underscore converted
238 to a dash. You can also choose to compile modules as <a
239 href="dso.html">shared objects (DSOs)</a> -- which can be loaded
240 or unloaded at runtime -- by using the option
241 <code>--enable-<var>module</var>=shared</code>. Similarly, you can
242 disable Base modules with the
243 <code>--disable-<var>module</var></code> option. Be careful when
244 using these options, since <code>configure</code> cannot warn you
245 if the module you specify does not exist; it will simply ignore the
248 <p>In addition, it is sometimes necessary to provide the
249 <code>configure</code> script with extra information about the
250 location of your compiler, libraries, or header files. This is
251 done by passing either environment variables or command line
252 options to <code>configure</code>. For more information, see the
253 <a href="programs/configure.html">configure manual page</a>.</p>
255 <p>For a short impression of what possibilities you have, here
256 is a typical example which compiles Apache for the installation
257 tree <code>/sw/pkg/apache</code> with a particular compiler and flags
258 plus the two additional modules <module>mod_rewrite</module> and
259 <module>mod_speling</module> for
260 later loading through the DSO mechanism:</p>
263 $ CC="pgcc" CFLAGS="-O2" \<br />
264 ./configure --prefix=/sw/pkg/apache \<br />
265 --enable-rewrite=shared \<br />
266 --enable-speling=shared
269 <p>When <code>configure</code> is run it will take several minutes to
270 test for the availability of features on your system and build
271 Makefiles which will later be used to compile the server.</p>
273 <p>Details on all the different <code>configure</code> options are
274 available on the <a href="programs/configure.html">configure
278 <section id="compile"><title>Build</title>
280 <p>Now you can build the various parts which form the Apache
281 package by simply running the command:</p>
283 <example>$ make</example>
285 <p>Please be patient here, since a base configuration takes
286 approximately 3 minutes to compile under a Pentium III/Linux
287 2.2 system, but this will vary widely depending on your
288 hardware and the number of modules which you have enabled.</p>
291 <section id="install"><title>Install</title>
293 <p>Now it's time to install the package under the configured
294 installation <em>PREFIX</em> (see <code>--prefix</code> option
295 above) by running:</p>
297 <example>$ make install</example>
299 <p>If you are upgrading, the installation will not overwrite
300 your configuration files or documents.</p>
303 <section id="customize"><title>Customize</title>
305 <p>Next, you can customize your Apache HTTP server by editing
306 the <a href="configuring.html">configuration files</a> under
307 <code><em>PREFIX</em>/conf/</code>.</p>
309 <example>$ vi <em>PREFIX</em>/conf/httpd.conf</example>
311 <p>Have a look at the Apache manual under <a
312 href="./">docs/manual/</a> or consult <a
313 href="http://httpd.apache.org/docs-2.1/"
314 >http://httpd.apache.org/docs-2.1/</a> for the most recent version of
315 this manual and a complete reference of available <a
316 href="mod/directives.html">configuration directives</a>.</p>
319 <section id="test"><title>Test</title>
321 <p>Now you can <a href="invoking.html">start</a> your Apache
322 HTTP server by immediately running:</p>
324 <example>$ <em>PREFIX</em>/bin/apachectl start</example>
326 <p>and then you should be able to request your first document
327 via URL <code>http://localhost/</code>. The web page you see is located
328 under the <directive module="core">DocumentRoot</directive>
329 which will usually be <code><em>PREFIX</em>/htdocs/</code>.
330 Then <a href="stopping.html">stop</a> the server again by
333 <example>$ <em>PREFIX</em>/bin/apachectl stop</example>
335 <section id="upgrading"><title>Upgrading</title>
337 <p>The first step in upgrading is to read the release announcement
338 and the file <code>CHANGES</code> in the source distribution to
339 find any changes that may affect your site. When changing between
340 major releases (for example, from 1.3 to 2.0 or from 2.0 to 2.2),
341 there will likely be major differences in the compile-time and
342 run-time configuration that will require manual adjustments. All
343 modules will also need to be upgraded to accomodate changes in the
346 <p>Upgrading from one minor version to the next (for example, from
347 2.0.55 to 2.0.57) is easier. The <code>make install</code>
348 process will not overwrite any of your existing documents, log
349 files, or configuration files. In addition, the developers make
350 every effort to avoid incompatible changes in the
351 <code>configure</code> options, run-time configuration, or the
352 module API between minor versions. In most cases you should be able to
353 use an identical <code>configure</code> command line, an identical
354 configuration file, and all of your modules should continue to
355 work. (This is only valid for versions after 2.0.41; earlier
356 versions have incompatible changes.)</p>
358 <p>If you kept the source tree from your last installation,
359 upgrading is even easier. The file <code>config.nice</code> in
360 the root of the old source tree contains the exact
361 <code>configure</code> command line that you used to configure the
362 source tree. Then to upgrade from one version to the next, you
363 need only copy the <code>config.nice</code> file to the source
364 tree of the new version, edit it to make any desired changes, and
368 $ ./config.nice<br />
371 $ <em>PREFIX</em>/bin/apachectl stop<br />
372 $ <em>PREFIX</em>/bin/apachectl start<br />
375 <note type="warning">You should always test any new version in your
376 environment before putting it into production. For example, you
377 can install and run the new version along side the old one by
378 using a different <code>--prefix</code> and a
379 different port (by adjusting the <directive
380 module="mpm_common">Listen</directive> directive) to test for any
381 incompatibilities before doing the final upgrade.</note>