1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>Compiling and Installing - Apache HTTP Server Version 2.5</title>
11 <link href="./style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="./style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <link href="./style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="./style/css/prettify.css" />
14 <script src="./style/scripts/prettify.min.js" type="text/javascript">
17 <link href="./images/favicon.ico" rel="shortcut icon" /></head>
18 <body id="manual-page"><div id="page-header">
19 <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p>
20 <p class="apache">Apache HTTP Server Version 2.5</p>
21 <img alt="" src="./images/feather.png" /></div>
22 <div class="up"><a href="./"><img title="<-" alt="<-" src="./images/left.gif" /></a></div>
24 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="./">Version 2.5</a></div><div id="page-content"><div id="preamble"><h1>Compiling and Installing</h1>
26 <p><span>Available Languages: </span><a href="./de/install.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
27 <a href="./en/install.html" title="English"> en </a> |
28 <a href="./es/install.html" hreflang="es" rel="alternate" title="Español"> es </a> |
29 <a href="./fr/install.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
30 <a href="./ja/install.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
31 <a href="./ko/install.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
32 <a href="./tr/install.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
36 <p>This document covers compilation and installation of the Apache HTTP Server
37 on Unix and Unix-like systems only. For compiling and
38 installation on Windows, see <a href="platform/windows.html">Using Apache HTTP Server with Microsoft
39 Windows</a> and <a href="platform/win_compiling.html">Compiling Apache for Microsoft Windows</a>.
40 For other platforms, see the <a href="platform/">platform</a> documentation.</p>
42 <p>Apache httpd uses <code>libtool</code> and <code>autoconf</code>
43 to create a build environment that looks like many other Open Source
46 <p>If you are upgrading from one minor version to the next (for
47 example, 2.4.8 to 2.4.9), please skip down to the <a href="#upgrading">upgrading</a> section.</p>
50 <div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#overview">Overview for the
52 <li><img alt="" src="./images/down.gif" /> <a href="#requirements">Requirements</a></li>
53 <li><img alt="" src="./images/down.gif" /> <a href="#download">Download</a></li>
54 <li><img alt="" src="./images/down.gif" /> <a href="#extract">Extract</a></li>
55 <li><img alt="" src="./images/down.gif" /> <a href="#configure">Configuring the source tree</a></li>
56 <li><img alt="" src="./images/down.gif" /> <a href="#compile">Build</a></li>
57 <li><img alt="" src="./images/down.gif" /> <a href="#install">Install</a></li>
58 <li><img alt="" src="./images/down.gif" /> <a href="#customize">Customize</a></li>
59 <li><img alt="" src="./images/down.gif" /> <a href="#test">Test</a></li>
60 <li><img alt="" src="./images/down.gif" /> <a href="#upgrading">Upgrading</a></li>
61 <li><img alt="" src="./images/down.gif" /> <a href="#thirdp">Third-party packages</a></li>
62 </ul><h3>See also</h3><ul class="seealso"><li><a href="programs/configure.html">Configure the source tree</a></li><li><a href="invoking.html">Starting Apache httpd</a></li><li><a href="stopping.html">Stopping and Restarting</a></li><li><a href="#comments_section">Comments</a></li></ul></div>
63 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
65 <h2><a name="overview" id="overview">Overview for the
71 <td><a href="#download">Download</a></td>
73 <td><code>$ lynx http://httpd.apache.org/download.cgi</code>
78 <td><a href="#extract">Extract</a></td>
80 <td><code>$ gzip -d httpd-<em>NN</em>.tar.gz<br />
81 $ tar xvf httpd-<em>NN</em>.tar<br />
82 $ cd httpd-<em>NN</em></code></td>
86 <td><a href="#configure">Configure</a></td>
88 <td><code>$ ./configure --prefix=<em>PREFIX</em></code>
93 <td><a href="#compile">Compile</a></td>
95 <td><code>$ make</code> </td>
99 <td><a href="#install">Install</a></td>
101 <td><code>$ make install</code> </td>
105 <td><a href="#customize">Customize</a></td>
107 <td><code>$ vi <em>PREFIX</em>/conf/httpd.conf</code> </td>
111 <td><a href="#test">Test</a></td>
113 <td><code>$ <em>PREFIX</em>/bin/apachectl -k start</code>
118 <p><em>NN</em> must be replaced with the current version
119 number, and <em>PREFIX</em> must be replaced with the
120 filesystem path under which the server should be installed. If
121 <em>PREFIX</em> is not specified, it defaults to
122 <code>/usr/local/apache2</code>.</p>
124 <p>Each section of the compilation and installation process is
125 described in more detail below, beginning with the requirements
126 for compiling and installing Apache httpd.</p>
127 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
128 <div class="section">
129 <h2><a name="requirements" id="requirements">Requirements</a></h2>
131 <p>The following requirements exist for building Apache httpd:</p>
134 <dt>APR and APR-Util</dt>
135 <dd>Make sure you have APR and APR-Util already installed on
136 your system. If you don't, or prefer to not use the system-provided
137 versions, download the latest versions of both APR and APR-Util
138 from <a href="http://apr.apache.org/">Apache APR</a>, unpack
139 them into <code>/httpd_source_tree_root/srclib/apr</code> and /httpd_source_tree_root<code>/srclib/apr-util</code>
140 (be sure the directory names do not have version numbers; for example,
141 the APR distribution must be under /httpd_source_tree_root/srclib/apr/) and use
142 <code>./configure</code>'s <code>--with-included-apr</code>
143 option. On some platforms, you may have to install the
144 corresponding <code>-dev</code> packages to allow httpd to build
145 against your installed copy of APR and APR-Util.</dd>
147 <dt>Perl-Compatible Regular Expressions Library (PCRE)</dt>
148 <dd>This library is required but not longer bundled with httpd.
149 Download the source code from <a href="http://www.pcre.org/">http://www.pcre.org</a>,
150 or install a Port or Package. If your build system can't find
151 the pcre-config script installed by the PCRE build, point to it
152 using the <code>--with-pcre</code> parameter. On some platforms,
153 you may have to install the corresponding <code>-dev</code>
154 package to allow httpd to build against your installed copy
158 <dd>Make sure you have at least 50 MB of temporary free disk
159 space available. After installation the server occupies
160 approximately 10 MB of disk space. The actual disk space
161 requirements will vary considerably based on your chosen
162 configuration options, any third-party modules, and, of course,
163 the size of the web site or sites that you have on the server.</dd>
165 <dt>ANSI-C Compiler and Build System</dt>
166 <dd>Make sure you have an ANSI-C compiler installed. The <a href="http://gcc.gnu.org/">GNU C
167 compiler (GCC)</a> from the <a href="http://www.gnu.org/">Free Software Foundation (FSF)</a>
168 is recommended. If you don't have GCC
169 then at least make sure your vendor's compiler is ANSI
170 compliant. In addition, your <code>PATH</code> must contain
171 basic build tools such as <code>make</code>.</dd>
173 <dt>Accurate time keeping</dt>
174 <dd>Elements of the HTTP protocol are expressed as the time of
175 day. So, it's time to investigate setting some time
176 synchronization facility on your system. Usually the
177 <code>ntpdate</code> or <code>xntpd</code> programs are used for
178 this purpose which are based on the Network Time Protocol (NTP).
179 See the <a href="http://www.ntp.org">NTP
180 homepage</a> for more details about NTP software and public
183 <dt><a href="http://www.perl.org/">Perl 5</a>
185 <dd>For some of the support scripts like <code class="program"><a href="./programs/apxs.html">apxs</a></code> or <code class="program"><a href="./programs/dbmmanage.html">dbmmanage</a></code> (which are
186 written in Perl) the Perl 5 interpreter is required (versions
187 5.003 or newer are sufficient). If no Perl 5 interpreter is found by the
188 <code class="program"><a href="./programs/configure.html">configure</a></code> script, you will not be able to use
189 the affected support scripts. Of course, you will still be able to
190 build and use Apache httpd.</dd>
192 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
193 <div class="section">
194 <h2><a name="download" id="download">Download</a></h2>
196 <p>The Apache HTTP Server can be downloaded from the <a href="http://httpd.apache.org/download.cgi">Apache HTTP Server
197 download site</a>, which lists several mirrors. Most users of
198 Apache on unix-like systems will be better off downloading and
199 compiling a source version. The build process (described below) is
200 easy, and it allows you to customize your server to suit your needs.
201 In addition, binary releases are often not up to date with the latest
202 source releases. If you do download a binary, follow the instructions
203 in the <code>INSTALL.bindist</code> file inside the distribution.</p>
205 <p>After downloading, it is important to verify that you have a
206 complete and unmodified version of the Apache HTTP Server. This
207 can be accomplished by testing the downloaded tarball against the
208 PGP signature. Details on how to do this are available on the <a href="http://httpd.apache.org/download.cgi#verify">download
209 page</a> and an extended example is available describing the <a href="http://httpd.apache.org/dev/verification.html">use of
212 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
213 <div class="section">
214 <h2><a name="extract" id="extract">Extract</a></h2>
216 <p>Extracting the source from the Apache HTTP Server tarball is a
217 simple matter of uncompressing, and then untarring:</p>
219 <div class="example"><p><code>
220 $ gzip -d httpd-<em>NN</em>.tar.gz<br />
221 $ tar xvf httpd-<em>NN</em>.tar
224 <p>This will create a new directory under the current directory
225 containing the source code for the distribution. You should
226 <code>cd</code> into that directory before proceeding with
227 compiling the server.</p>
228 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
229 <div class="section">
230 <h2><a name="configure" id="configure">Configuring the source tree</a></h2>
232 <p>The next step is to configure the Apache source tree for your
233 particular platform and personal requirements. This is done using
234 the script <code class="program"><a href="./programs/configure.html">configure</a></code> included in
235 the root directory of the distribution. (Developers downloading
236 an unreleased version of the Apache source tree will need to have
237 <code>autoconf</code> and <code>libtool</code> installed and will
238 need to run <code>buildconf</code> before proceeding with the next
239 steps. This is not necessary for official releases.)</p>
241 <p>To configure the source tree using all the default options,
242 simply type <code>./configure</code>. To change the default
243 options, <code class="program"><a href="./programs/configure.html">configure</a></code> accepts a variety of variables
244 and command line options.</p>
246 <p>The most important option is the location <code>--prefix</code>
247 where Apache is to be installed later, because Apache has to be
248 configured for this location to work correctly. More fine-tuned
249 control of the location of files is possible with additional <a href="programs/configure.html#installationdirectories">configure
252 <p>Also at this point, you can specify which <a href="programs/configure.html#optionalfeatures">features</a> you
253 want included in Apache by enabling and disabling <a href="mod/">modules</a>. Apache comes with a wide range of modules
254 included by default. They will be compiled as
255 <a href="dso.html">shared objects (DSOs)</a> which can be loaded
256 or unloaded at runtime.
257 You can also choose to compile modules statically by using the option
258 <code>--enable-<var>module</var>=static</code>.</p>
260 <p>Additional modules are enabled using the
261 <code>--enable-<var>module</var></code> option, where
262 <var>module</var> is the name of the module with the
263 <code>mod_</code> string removed and with any underscore converted
264 to a dash. Similarly, you can disable modules with the
265 <code>--disable-<var>module</var></code> option. Be careful when
266 using these options, since <code class="program"><a href="./programs/configure.html">configure</a></code> cannot warn you
267 if the module you specify does not exist; it will simply ignore the
270 <p>In addition, it is sometimes necessary to provide the
271 <code class="program"><a href="./programs/configure.html">configure</a></code> script with extra information about the
272 location of your compiler, libraries, or header files. This is
273 done by passing either environment variables or command line
274 options to <code class="program"><a href="./programs/configure.html">configure</a></code>. For more information, see the
275 <code class="program"><a href="./programs/configure.html">configure</a></code> manual page. Or invoke
276 <code class="program"><a href="./programs/configure.html">configure</a></code> using the <code>--help</code> option.</p>
278 <p>For a short impression of what possibilities you have, here
279 is a typical example which compiles Apache for the installation
280 tree <code>/sw/pkg/apache</code> with a particular compiler and flags
281 plus the two additional modules <code class="module"><a href="./mod/mod_ldap.html">mod_ldap</a></code> and
282 <code class="module"><a href="./mod/mod_lua.html">mod_lua</a></code>:</p>
284 <div class="example"><p><code>
285 $ CC="pgcc" CFLAGS="-O2" \<br />
286 ./configure --prefix=/sw/pkg/apache \<br />
287 --enable-ldap=shared \<br />
291 <p>When <code class="program"><a href="./programs/configure.html">configure</a></code> is run it will take several minutes to
292 test for the availability of features on your system and build
293 Makefiles which will later be used to compile the server.</p>
295 <p>Details on all the different <code class="program"><a href="./programs/configure.html">configure</a></code> options are
296 available on the <code class="program"><a href="./programs/configure.html">configure</a></code> manual page.</p>
297 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
298 <div class="section">
299 <h2><a name="compile" id="compile">Build</a></h2>
301 <p>Now you can build the various parts which form the Apache
302 package by simply running the command:</p>
304 <div class="example"><p><code>$ make</code></p></div>
306 <p>Please be patient here, since a base configuration takes
307 several minutes to compile and the time will vary widely
308 depending on your hardware and the number of modules that you
310 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
311 <div class="section">
312 <h2><a name="install" id="install">Install</a></h2>
314 <p>Now it's time to install the package under the configured
315 installation <em>PREFIX</em> (see <code>--prefix</code> option
316 above) by running:</p>
318 <div class="example"><p><code>$ make install</code></p></div>
320 <p>This step will typically require root privileges, since
321 <em>PREFIX</em> is usually a directory with restricted write
324 <p>If you are upgrading, the installation will not overwrite
325 your configuration files or documents.</p>
326 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
327 <div class="section">
328 <h2><a name="customize" id="customize">Customize</a></h2>
330 <p>Next, you can customize your Apache HTTP server by editing
331 the <a href="configuring.html">configuration files</a> under
332 <code><em>PREFIX</em>/conf/</code>.</p>
334 <div class="example"><p><code>$ vi <em>PREFIX</em>/conf/httpd.conf</code></p></div>
336 <p>Have a look at the Apache manual under
337 <code><em>PREFIX</em>/docs/manual/</code> or consult <a href="http://httpd.apache.org/docs/trunk/">http://httpd.apache.org/docs/trunk/</a> for the most recent
338 version of this manual and a complete reference of available <a href="mod/directives.html">configuration directives</a>.</p>
339 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
340 <div class="section">
341 <h2><a name="test" id="test">Test</a></h2>
343 <p>Now you can <a href="invoking.html">start</a> your Apache
344 HTTP server by immediately running:</p>
346 <div class="example"><p><code>$ <em>PREFIX</em>/bin/apachectl -k start</code></p></div>
348 <p>You should then be able to request your first document
349 via the URL <code>http://localhost/</code>. The web page you see is located
350 under the <code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code>,
351 which will usually be <code><em>PREFIX</em>/htdocs/</code>.
352 Then <a href="stopping.html">stop</a> the server again by
355 <div class="example"><p><code>$ <em>PREFIX</em>/bin/apachectl -k stop</code></p></div>
356 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
357 <div class="section">
358 <h2><a name="upgrading" id="upgrading">Upgrading</a></h2>
360 <p>The first step in upgrading is to read the release announcement
361 and the file <code>CHANGES</code> in the source distribution to
362 find any changes that may affect your site. When changing between
363 major releases (for example, from 2.0 to 2.2 or from 2.2 to 2.4),
364 there will likely be major differences in the compile-time and
365 run-time configuration that will require manual adjustments. All
366 modules will also need to be upgraded to accommodate changes in the
369 <p>Upgrading from one minor version to the next (for example, from
370 2.2.55 to 2.2.57) is easier. The <code>make install</code>
371 process will not overwrite any of your existing documents, log
372 files, or configuration files. In addition, the developers make
373 every effort to avoid incompatible changes in the
374 <code class="program"><a href="./programs/configure.html">configure</a></code> options, run-time configuration, or the
375 module API between minor versions. In most cases you should be able to
376 use an identical <code class="program"><a href="./programs/configure.html">configure</a></code> command line, an identical
377 configuration file, and all of your modules should continue to
380 <p>To upgrade across minor versions, start by finding the file
381 <code>config.nice</code> in the <code>build</code> directory of
382 your installed server or at the root of the source tree for your
383 old install. This will contain the exact
384 <code class="program"><a href="./programs/configure.html">configure</a></code> command line that you used to
385 configure the source tree. Then to upgrade from one version to
386 the next, you need only copy the <code>config.nice</code> file to
387 the source tree of the new version, edit it to make any desired
388 changes, and then run:</p>
390 <div class="example"><p><code>
391 $ ./config.nice<br />
394 $ <em>PREFIX</em>/bin/apachectl -k graceful-stop<br />
395 $ <em>PREFIX</em>/bin/apachectl -k start<br />
398 <div class="warning">You should always test any new version in your
399 environment before putting it into production. For example, you
400 can install and run the new version along side the old one by
401 using a different <code>--prefix</code> and a
402 different port (by adjusting the <code class="directive"><a href="./mod/mpm_common.html#listen">Listen</a></code> directive) to test for any
403 incompatibilities before doing the final upgrade.</div>
405 <p>You can pass additional arguments to <code>config.nice</code>,
406 which will be appended to your original <code class="program"><a href="./programs/configure.html">configure</a></code>
409 <div class="example"><p><code>
410 $ ./config.nice --prefix=/home/test/apache --with-port=90
412 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
413 <div class="section">
414 <h2><a name="thirdp" id="thirdp">Third-party packages</a></h2>
416 <p>A large number of third parties provide their own packaged
417 distributions of the Apache HTTP Server for installation on
418 particular platforms. This includes the various Linux distributions,
419 various third-party Windows packages, Mac OS X, Solaris, and many
422 <p>Our software license not only permits, but encourages, this kind
423 of redistribution. However, it does result in a situation where the
424 configuration layout and defaults on your installation of the server
425 may differ from what is stated in the documentation. While
426 unfortunate, this situation is not likely to change any time
429 <p>A <a href="http://wiki.apache.org/httpd/DistrosDefaultLayout">description
430 of these third-party distrubutions</a> is maintained in the HTTP
431 Server wiki, and should reflect the current state of these
432 third-party distributions. However, you will need to familiarize
433 yourself with your particular platform's package management and
434 installation procedures.</p>
437 <div class="bottomlang">
438 <p><span>Available Languages: </span><a href="./de/install.html" hreflang="de" rel="alternate" title="Deutsch"> de </a> |
439 <a href="./en/install.html" title="English"> en </a> |
440 <a href="./es/install.html" hreflang="es" rel="alternate" title="Español"> es </a> |
441 <a href="./fr/install.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
442 <a href="./ja/install.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
443 <a href="./ko/install.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
444 <a href="./tr/install.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
445 </div><div class="top"><a href="#page-header"><img src="./images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
446 <script type="text/javascript"><!--//--><![CDATA[//><!--
447 var comments_shortname = 'httpd';
448 var comments_identifier = 'http://httpd.apache.org/docs/trunk/install.html';
450 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
451 d.write('<div id="comments_thread"><\/div>');
452 var s = d.createElement('script');
453 s.type = 'text/javascript';
455 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
456 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
459 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
461 })(window, document);
462 //--><!]]></script></div><div id="footer">
463 <p class="apache">Copyright 2016 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
464 <p class="menu"><a href="./mod/">Modules</a> | <a href="./mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="./glossary.html">Glossary</a> | <a href="./sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
465 if (typeof(prettyPrint) !== 'undefined') {