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"?>
6 Copyright 2002-2004 The Apache Software Foundation
8 Licensed under the Apache License, Version 2.0 (the "License");
9 you may not use this file except in compliance with the License.
10 You may obtain a copy of the License at
12 http://www.apache.org/licenses/LICENSE-2.0
14 Unless required by applicable law or agreed to in writing, software
15 distributed under the License is distributed on an "AS IS" BASIS,
16 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 See the License for the specific language governing permissions and
18 limitations under the License.
21 <manualpage metafile="install.xml.meta">
23 <title>Compiling and Installing</title>
27 <p>This document covers compilation and installation of Apache
28 on Unix and Unix-like systems only. For compiling and
29 installation on Windows, see <a
30 href="platform/windows.html">Using Apache with Microsoft
31 Windows</a>. For other platforms, see the <a
32 href="platform/">platform</a> documentation.</p>
34 <p>Apache 2.0's configuration and installation environment has
35 changed completely from Apache 1.3. Apache 1.3 used a custom
36 set of scripts to achieve easy installation. Apache 2.0 now
37 uses <code>libtool</code> and <code>autoconf</code>
38 to create an environment that looks like many other Open Source
41 <p>If you are upgrading from one minor version to the next (for
42 example, 2.0.50 to 2.0.51), please skip down to the <a
43 href="#upgrading">upgrading</a> section.</p>
47 <seealso><a href="programs/configure.html">Configure the source tree</a></seealso>
48 <seealso><a href="invoking.html">Starting Apache</a></seealso>
49 <seealso><a href="stopping.html">Stopping and Restarting</a></seealso>
51 <section id="overview"><title>Overview for the
55 <columnspec><column width=".13"/><column width=".80"/></columnspec>
57 <td><a href="#download">Download</a></td>
59 <td><code>$ lynx http://httpd.apache.org/download.cgi</code>
64 <td><a href="#extract">Extract</a></td>
66 <td><code>$ gzip -d httpd-2_1_<em>NN</em>.tar.gz<br />
67 $ tar xvf httpd-2_1_<em>NN</em>.tar</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 start</code>
103 <p><em>NN</em> must be replaced with the current minor 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 (version 2.7.2 is fine). 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 Usenet newsgroup <a
143 href="news:comp.protocols.time.ntp">comp.protocols.time.ntp</a>
144 and the <a href="http://www.ntp.org">NTP
145 homepage</a> for more details about NTP software and public
148 <dt><a href="http://www.perl.org/">Perl 5</a>
150 <dd>For some of the support scripts like <a
151 href="programs/apxs.html">apxs</a> or <a
152 href="programs/dbmmanage.html">dbmmanage</a> (which are
153 written in Perl) the Perl 5 interpreter is required (versions
154 5.003 or newer are sufficient). If no such interpreter is found by
155 the `<code>configure</code>' script there is no harm. Of course, you
156 still can build and install Apache 2.0. Only those support scripts
157 cannot be used. If you have multiple Perl interpreters
158 installed (perhaps a Perl 4 from the vendor and a Perl 5 from
159 your own), then it is recommended to use the <code>--with-perl</code>
160 option (see below) to make sure the correct one is selected
161 by <code>./configure</code>.</dd>
165 <section id="download"><title>Download</title>
167 <p>Apache can be downloaded from the <a
168 href="http://httpd.apache.org/download.cgi">Apache HTTP Server
169 download site</a> which lists several mirrors. Most users of
170 Apache on unix-like systems will be better off downloading and
171 compiling a source version. The build process (described below) is
172 easy, and it allows you to customize your server to suit your needs.
173 In addition, binary releases are often not up to date with the latest
174 source releases. If you do download a binary, follow the instructions
175 in the <code>INSTALL.bindist</code> file inside the distribution.</p>
177 <p>After downloading, it is important to verify that you have a
178 complete and unmodified version of the Apache HTTP Server. This
179 can be accomplished by testing the downloaded tarball against the
180 PGP signature. Details on how to do this are available on the <a
181 href="http://httpd.apache.org/download.cgi#verify">download
182 page</a> and an extended example is available describing the <a
183 href="http://httpd.apache.org/dev/verification.html">use of
188 <section id="extract"><title>Extract</title>
190 <p>Extracting the source from the Apache HTTPD tarball is a
191 simple matter of uncompressing, and then untarring:</p>
194 $ gzip -d httpd-2_1_<em>NN</em>.tar.gz<br />
195 $ tar xvf httpd-2_1_<em>NN</em>.tar
198 <p>This will create a new directory under the current directory
199 containing the source code for the distribution. You should
200 <code>cd</code> into that directory before proceeding with
201 compiling the server.</p>
204 <section id="configure"><title>Configuring the source tree</title>
206 <p>The next step is to configure the Apache source tree for your
207 particular platform and personal requirements. This is done using
209 href="programs/configure.html">configure</a></code> included in
210 the root directory of the distribution. (Developers downloading
211 the CVS version of the Apache source tree will need to have
212 <code>autoconf</code> and <code>libtool</code> installed and will
213 need to run <code>buildconf</code> before proceeding with the next
214 steps. This is not necessary for official releases.)</p>
216 <p>To configure the source tree using all the default options,
217 simply type <code>./configure</code>. To change the default
218 options, <code>configure</code> accepts a variety of variables
219 and command line options.</p>
221 <p>The most important option is the location <code>--prefix</code>
222 where Apache is to be installed later, because Apache has to be
223 configured for this location to work correctly. More fine-tuned
224 control of the location of files is possible with additional <a
225 href="programs/configure.html#installationdirectories">configure
228 <p>Also at this point, you can specify which <a
229 href="programs/configure.html#optionalfeatures">features</a> you
230 want included in Apache by enabling and disabling <a
231 href="mod/">modules</a>. Apache comes with a <a
232 href="mod/module-dict.html#Status">Base</a> set of modules included by
233 default. Other modules are enabled using the
234 <code>--enable-<var>module</var></code> option, where
235 <var>module</var> is the name of the module with the
236 <code>mod_</code> string removed and with any underscore converted
237 to a dash. You can also choose to compile modules as <a
238 href="dso.html">shared objects (DSOs)</a> -- which can be loaded
239 or unloaded at runtime -- by using the option
240 <code>--enable-<var>module</var>=shared</code>. Similarly, you can
241 disable Base modules with the
242 <code>--disable-<var>module</var></code> option. Be careful when
243 using these options, since <code>configure</code> cannot warn you
244 if the module you specify does not exist; it will simply ignore the
247 <p>In addition, it is sometimes necessary to provide the
248 <code>configure</code> script with extra information about the
249 location of your compiler, libraries, or header files. This is
250 done by passing either environment variables or command line
251 options to <code>configure</code>. For more information, see the
252 <a href="programs/configure.html">configure manual page</a>.</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_rewrite</module> and
258 <module>mod_speling</module> for
259 later loading through the DSO mechanism:</p>
262 $ CC="pgcc" CFLAGS="-O2" \<br />
263 ./configure --prefix=/sw/pkg/apache \<br />
264 --enable-rewrite=shared \<br />
265 --enable-speling=shared
268 <p>When <code>configure</code> is run it will take several minutes to
269 test for the availability of features on your system and build
270 Makefiles which will later be used to compile the server.</p>
272 <p>Details on all the different <code>configure</code> options are
273 available on the <a href="programs/configure.html">configure
277 <section id="compile"><title>Build</title>
279 <p>Now you can build the various parts which form the Apache
280 package by simply running the command:</p>
282 <example>$ make</example>
284 <p>Please be patient here, since a base configuration takes
285 approximately 3 minutes to compile under a Pentium III/Linux
286 2.2 system, but this will vary widely depending on your
287 hardware and the number of modules which you have enabled.</p>
290 <section id="install"><title>Install</title>
292 <p>Now it's time to install the package under the configured
293 installation <em>PREFIX</em> (see <code>--prefix</code> option
294 above) by running:</p>
296 <example>$ make install</example>
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 <a
311 href="./">docs/manual/</a> or consult <a
312 href="http://httpd.apache.org/docs-2.1/"
313 >http://httpd.apache.org/docs-2.1/</a> for the most recent version of
314 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 start</example>
325 <p>and then you should be able to request your first document
326 via 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 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.0.55 to 2.0.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 <code>configure</code> options, run-time configuration, or the
351 module API between minor versions. In most cases you should be able to
352 use an identical <code>configure</code> command line, an identical
353 configuration file, and all of your modules should continue to
354 work. (This is only valid for versions after 2.0.41; earlier
355 versions have incompatible changes.)</p>
357 <p>If you kept the source tree from your last installation,
358 upgrading is even easier. The file <code>config.nice</code> in
359 the root of the old source tree contains the exact
360 <code>configure</code> command line that you used to configure the
361 source tree. Then to upgrade from one version to the next, you
362 need only copy the <code>config.nice</code> file to the source
363 tree of the new version, edit it to make any desired changes, and
367 $ ./config.nice<br />
370 $ <em>PREFIX</em>/bin/apachectl stop<br />
371 $ <em>PREFIX</em>/bin/apachectl 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>