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 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5 This file is generated from xml source: DO NOT EDIT
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8 <title>Compiling Apache for Microsoft Windows - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <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" />
12 <script src="../style/scripts/prettify.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
16 <body id="manual-page"><div id="page-header">
17 <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>
18 <p class="apache">Apache HTTP Server Version 2.5</p>
19 <img alt="" src="../images/feather.gif" /></div>
20 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
22 <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> > <a href="./">Platform Specific Notes</a></div><div id="page-content"><div id="preamble"><h1>Compiling Apache for Microsoft Windows</h1>
24 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English"> en </a> |
25 <a href="../ko/platform/win_compiling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
29 <p>There are many important points to consider before you begin compiling
30 Apache. See <a href="windows.html">Using Apache with Microsoft
31 Windows</a> before you begin.</p>
34 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#requirements">Requirements</a></li>
35 <li><img alt="" src="../images/down.gif" /> <a href="#unixsrcbuild">Building from Unix sources</a></li>
36 <li><img alt="" src="../images/down.gif" /> <a href="#commandbuild">Command-Line Build</a></li>
37 <li><img alt="" src="../images/down.gif" /> <a href="#workspacebuild">Developer Studio Workspace IDE Build</a></li>
38 <li><img alt="" src="../images/down.gif" /> <a href="#exportingmakfiles">Exporting command-line .mak files</a></li>
39 <li><img alt="" src="../images/down.gif" /> <a href="#installation">Installation</a></li>
40 <li><img alt="" src="../images/down.gif" /> <a href="#projectcomponents-warn">Warning about building Apache from the development tree</a></li>
41 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
42 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
44 <h2><a name="requirements" id="requirements">Requirements</a></h2>
48 <p>Compiling Apache requires the following environment to be
49 properly installed:</p>
55 <p>Make sure you have at least 200 MB of free disk space
56 available. After installation Apache requires approximately
57 80 MB of disk space, plus space for log and cache files,
58 which can grow rapidly. The actual disk space requirements
59 will vary considerably based on your chosen configuration and
60 any third-party modules or libraries, especially when OpenSSL
61 is also built. Because many files are text and very easily
62 compressed, NTFS filesystem compression cuts these requirements
67 <p>Appropriate Patches</p>
69 <p>The httpd binary is built with the help of several patches to
70 third party packages, which ensure the released code is buildable
71 and debuggable. These patches are available and distributed from <a href="http://www.apache.org/dist/httpd/binaries/win32/patches_applied/">http://www.apache.org/dist/httpd/binaries/win32/patches_applied/</a>
72 and are recommended to be applied to obtain identical results as the
73 "official" ASF distributed binaries.</p>
77 <p>Microsoft Visual C++ 6.0 (Visual Studio 97) or later.</p>
79 <p>Apache can be built using the command line tools, or from
80 within the Visual Studio IDE Workbench. The command line
81 build requires the environment to reflect the <code>PATH</code>,
82 <code>INCLUDE</code>, <code>LIB</code> and other variables
83 that can be configured with the <code>vcvars32.bat</code> script.</p>
85 <div class="note">You may want the Visual Studio Processor Pack for your older
86 version of Visual Studio, or a full (not Express) version of newer
87 Visual Studio editions, for the ml.exe assembler. This will allow
88 you to build OpenSSL, if desired, using the more efficient assembly
89 code implementation.</div>
91 <div class="note">Only the Microsoft compiler tool chain is actively supported by
92 the active httpd contributors. Although the project regularly accepts
93 patches to ensure MinGW and other alternative builds work and improve
94 upon them, they are not actively maintained and are often broken in
95 the course of normal development.</div>
99 <p>Updated Microsoft Windows Platform SDK, February 2003 or later.</p>
101 <p>An appropriate Windows Platform SDK is included by default in the
102 full (not express/lite) versions of Visual C++ 7.1 (Visual Studio 2002)
103 and later, these users can ignore these steps unless explicitly choosing
104 a newer or different version of the Platform SDK.</p>
106 <p>To use Visual C++ 6.0 or 7.0 (Studio 2000 .NET), the Platform SDK
107 environment must be prepared using the <code>setenv.bat</code>
108 script (installed by the Platform SDK) before starting the command
109 line build or launching the msdev/devenv GUI environment. Installing
110 the Platform SDK for Visual Studio Express versions (2003 and later)
111 should adjust the default environment appropriately.</p>
113 <div class="example"><p><code>
114 "c:\Program Files\Microsoft Visual Studio\VC98\Bin\VCVARS32"<br />
115 "c:\Program Files\Platform SDK\setenv.bat"
122 <p>Several steps recommended here require a perl interpreter during
123 the build preparation process, but it is otherwise not required.</p>
125 <p>To install Apache within the build system, several files are
126 modified using the <code>awk.exe</code> utility. awk was chosen since
127 it is a very small download (compared with Perl or WSH/VB) and
128 accomplishes the task of modifying configuration files upon
129 installation. Brian Kernighan's
130 <a href="http://www.cs.princeton.edu/~bwk/btl.mirror/">http://www.cs.princeton.edu/~bwk/btl.mirror/</a>
131 site has a compiled native Win32 binary,
132 <a href="http://www.cs.princeton.edu/~bwk/btl.mirror/awk95.exe">http://www.cs.princeton.edu/~bwk/btl.mirror/awk95.exe</a> which
133 you must save with the name <code>awk.exe</code> (rather than
134 <code>awk95.exe</code>).</p>
136 <div class="note">If awk.exe is not found, Makefile.win's install target
137 will not perform substitutions in the installed .conf files.
138 You must manually modify the installed .conf files to allow
139 the server to start. Search and replace all "@token@" tags
140 as appropriate.</div>
142 <div class="note">The Visual Studio IDE will only find <code>awk.exe</code>
143 from the PATH, or executable path specified in the menu option
144 Tools -> Options -> (Projects ->) Directories. Ensure
145 awk.exe is in your system path.</div>
147 <div class="note">Also note that if you are using Cygwin tools
148 (<a href="http://www.cygwin.com/">http://www.cygwin.com/</a>)
149 the awk utility is named <code>gawk.exe</code> and that the file
150 <code>awk.exe</code> is really a symlink to the <code>gawk.exe</code>
151 file. The Windows command shell does not recognize symlinks, and
152 because of this building InstallBin will fail. A workaround is
153 to delete <code>awk.exe</code> from the cygwin installation and
154 copy <code>gawk.exe</code> to <code>awk.exe</code>. Also note the
155 cygwin/mingw ports of gawk 3.0.x were buggy, please upgrade to 3.1.x
156 before attempting to use any gawk port.</div>
160 <p>[Optional] zlib library (for <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>)</p>
162 <p>Zlib must be installed into a <code>srclib</code> subdirectory named
163 <code>zlib</code>. This must be built in-place. Zlib can be obtained
164 from <a href="http://www.zlib.net/">http://www.zlib.net/</a> -- the
165 <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> is confirmed to work correctly with
168 <div class="example"><p><code>
169 nmake -f win32\Makefile.msc<br />
170 nmake -f win32\Makefile.msc test
175 <p>[Optional] OpenSSL libraries (for <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
176 and <code>ab.exe</code> with ssl support)</p>
178 <div class="note">The OpenSSL library is cryptographic software. The country
179 in which you currently reside may have restrictions on the import,
180 possession, use, and/or re-export to another country, of encryption
181 software. BEFORE using any encryption software, please check your
182 country's laws, regulations and policies concerning the import,
183 possession, or use, and re-export of encryption software, to see
184 if this is permitted. See
185 <a href="http://www.wassenaar.org/">http://www.wassenaar.org/</a>
186 for more information.</div>
188 <p>Configuring and building OpenSSL requires perl to be installed.</p>
190 <p>OpenSSL must be installed into a <code>srclib</code> subdirectory
191 named <code>openssl</code>, obtained from
192 <a href="http://www.openssl.org/source/">http://www.openssl.org/source/</a>, in order to compile
193 <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> or the <code>abs.exe</code> project, which
194 is ab.c with SSL support enabled. To prepare OpenSSL to be linked
195 to Apache mod_ssl or abs.exe, and disable patent encumbered features
196 in OpenSSL, you might use the following build commands:</p>
198 <div class="example"><p><code>
199 perl Configure no-rc5 no-idea enable-mdc2 enable-zlib VC-WIN32
200 -Ipath/to/srclib/zlib -Lpath/to/srclib/zlib<br />
202 nmake -f ms\ntdll.mak
205 <div class="note">It is not advisable to use zlib-dynamic, as that transfers
206 the cost of deflating SSL streams to the first request which must
207 load the zlib dll. Note the suggested patch enables the -L flag to
208 work with windows builds, corrects the name of zdll.lib and ensures
209 .pdb files are generated for troubleshooting. If the assembler is
210 not installed, you would add no-asm above and use ms\do_ms.bat
211 instead of the ms\do_masm.bat script.</div>
215 <p>[Optional] Database libraries (for <code class="module"><a href="../mod/mod_dbd.html">mod_dbd</a></code>
216 and <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>)</p>
218 <p>The apr-util library exposes dbm (keyed database) and dbd (query
219 oriented database) client functionality to the httpd server and its
220 modules, such as authentication and authorization. The sdbm dbm and
221 odbc dbd providers are compiled unconditionally.</p>
223 <p>The dbd support includes the Oracle instantclient package, MySQL,
224 PostgreSQL and sqlite. To build these all, for example, set up the
225 LIB to include the library path, INCLUDE to include the headers path,
226 and PATH to include the dll bin path of all four SDK's, and set the
227 DBD_LIST environment variable to inform the build which client driver
228 SDKs are installed correctly, e.g.;</p>
230 <div class="example"><p><code>
231 set DBD_LIST=sqlite3 pgsql oracle mysql
234 <p>Similarly, the dbm support can be extended with DBM_LIST to
235 build a Berkeley DB provider (db) and/or gdbm provider, by similarly
236 configuring LIB, INCLUDE and PATH first to ensure the client library
237 libs and headers are available.</p>
239 <div class="example"><p><code>
243 <div class="note">Depending on the choice of database distributions, it may be
244 necessary to change the actual link target name (e.g. gdbm.lib vs.
245 libgdb.lib) that are listed in the corresponding .dsp/.mak files
246 within the directories srclib\apr-util\dbd or ...\dbm.</div>
248 <p>See the README-win32.txt file for more hints on obtaining the
249 various database driver SDKs.</p>
253 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
254 <div class="section">
255 <h2><a name="unixsrcbuild" id="unixsrcbuild">Building from Unix sources</a></h2>
259 <p>The policy of the Apache HTTP Server project is to only release Unix sources.
260 Windows source packages made available for download have been supplied by
261 volunteers and may not be available for every release. You can still build
262 the server on Windows from the Unix source tarball with just a few additional
266 <li>Download and unpack the Unix source tarball for the latest version.</li>
267 <li>Download and unpack the Unix source tarball for latest version of
268 APR, AR-Util and APR-Iconv, place these sources in directories httpd-2.x.x\srclib\apr, httpd-2.x.x\srclib\apr-util and httpd-2.x.x\srclib\apr-iconv</li>
269 <li>Open a Command Prompt and CD to the httpd-2.x.x folder</li>
270 <li>Run the line endings conversion utility at the prompt;</li>
273 <div class="example"><p><code>
274 perl srclib\apr\build\lineends.pl
277 <p>You can now build the server with the Visual Studio 6.0 development
278 environment using the IDE. Command-Line builds of the server are not
279 possible from Unix sources unless you export .mak files as explained
283 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
284 <div class="section">
285 <h2><a name="commandbuild" id="commandbuild">Command-Line Build</a></h2>
289 <p><code>Makefile.win</code> is the top level Apache makefile.
290 To compile Apache on Windows, simply use one of the following commands
291 to build the <code>release</code> or <code>debug</code> flavor:</p>
293 <div class="example"><p><code>
294 nmake /f Makefile.win _apacher<br /><br />
295 nmake /f Makefile.win _apached
298 <p>Either command will compile Apache. The latter will disable
299 optimization of the resulting files, making it easier to single
300 step the code to find bugs and track down problems.</p>
302 <p>You can add your apr-util dbd and dbm provider choices with the
303 additional make (environment) variables DBD_LIST and DBM_LIST,
304 see the comments about [Optional] Database libraries, above.
305 Review the initial comments in Makefile.win for additional options
306 that can be provided when invoking the build.</p>
308 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
309 <div class="section">
310 <h2><a name="workspacebuild" id="workspacebuild">Developer Studio Workspace IDE Build</a></h2>
314 <p>Apache can also be compiled using VC++'s Visual Studio
315 development environment. To simplify this process, a
316 Visual Studio workspace, <code>Apache.dsw</code>, is provided.
317 This workspace exposes the entire list of working <code>.dsp</code>
318 projects that are required for the complete Apache binary release.
319 It includes dependencies between the projects to assure that they
320 are built in the appropriate order.</p>
322 <p>Open the <code>Apache.dsw</code> workspace, and select
323 <code>InstallBin</code> (<code>Release</code> or <code>Debug</code> build,
324 as desired) as the Active Project. <code>InstallBin</code> causes all
325 related project to be built, and then invokes <code>Makefile.win</code> to
326 move the compiled executables and dlls. You may personalize the
327 <code>INSTDIR=</code> choice by changing <code>InstallBin</code>'s Settings,
328 General tab, Build command line entry. <code>INSTDIR</code> defaults to the
329 <code>/Apache2</code> directory. If you only want a test compile (without
330 installing) you may build the <code>BuildBin</code> project instead.</p>
332 <p>The <code>.dsp</code> project files are distributed in Visual Studio 6.0
333 (98) format. Visual C++ 5.0 (97) will recognize them. Visual Studio
334 2002 (.NET) and later users must convert <code>Apache.dsw</code> plus
335 the <code>.dsp</code> files into an <code>Apache.sln</code> plus
336 <code>.msproj</code> files. Be sure you reconvert the <code>.msproj</code>
337 file again if its source <code>.dsp</code> file changes! This is really
338 trivial, just open <code>Apache.dsw</code> in the VC++ 7.0 IDE once again
341 <div class="note">There is a flaw in the .vcproj conversion of .dsp files. devenv.exe
342 will mis-parse the /D flag for RC flags containing long quoted /D'efines
343 which contain spaces. The command:
344 <div class="example"><p><code>
345 perl srclib\apr\build\cvtdsp.pl -2005
347 will convert the /D flags for RC flags to use an alternate, parseable
348 syntax; unfortunately this syntax isn't supported by Visual Studio 97
349 or its exported .mak files. These /D flags are used to pass the long
350 description of the mod_apachemodule.so files to the shared .rc resource
351 version-identifier build.</div>
353 <p>Visual Studio 2002 (.NET) and later users should also use the Build
354 menu, Configuration Manager dialog to uncheck both the <code>Debug</code>
355 and <code>Release</code> Solution modules <code>abs</code>,
356 <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> and <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> components, as
357 well as every component starting with <code>apr_db*</code>. These modules
358 are built by invoking <code>nmake</code>, or the IDE directly with the
359 <code>BinBuild</code> target, which builds those modules conditionally
360 if the <code>srclib</code> directories <code>openssl</code> and/or
361 <code>zlib</code> exist, and based on the setting of <code>DBD_LIST</code>
362 and <code>DBM_LIST</code> environment variables.</p>
364 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
365 <div class="section">
366 <h2><a name="exportingmakfiles" id="exportingmakfiles">Exporting command-line .mak files</a></h2>
370 <p>Exported <code>.mak</code> files pose a greater hassle, but they are
371 required for Visual C++ 5.0 users to build <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>,
372 abs (<code class="program"><a href="../programs/ab.html">ab</a></code> with SSL support) and/or
373 <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>. The .mak files also support a broader
374 range of C++ tool chain distributions, such as Visual Studio Express.</p>
376 <p>You must first build all projects in order to create all dynamic
377 auto-generated targets, so that dependencies can be parsed correctly.
378 Build the entire project from within the Visual Studio 6.0 (98) IDE,
379 using the <code>BuildAll</code> target, then use the Project Menu Export
380 for all makefiles (checking on "with dependencies".) Run the following
381 command to correct absolute paths into relative paths so they will build
384 <div class="example"><p><code>
385 perl srclib\apr\build\fixwin32mak.pl
388 <p>You must type this command from the <em>top level</em>
389 directory of the httpd source tree. Every
390 <code>.mak</code> and <code>.dep</code> project file within
391 the current directory and below will be corrected, and the
392 timestamps adjusted to reflect the <code>.dsp</code>.</p>
394 <p>Always review the generated <code>.mak</code> and <code>.dep</code>
395 files for Platform SDK or other local, machine specific file paths.
396 The <code>DevStudio\Common\MSDev98\bin\</code> (VC6) directory contains
397 a <code>sysincl.dat</code> file, which lists all exceptions. Update
398 this file (including both forward and backslashed paths, such as both
399 <code>sys/time.h</code> and <code>sys\time.h</code>) to ignore such
400 newer dependencies. Including local-install paths in a distributed
401 <code>.mak</code> file will cause the build to fail completely.</p>
403 <p>If you contribute back a patch that revises project files, we
404 must commit project files in Visual Studio 6.0 format. Changes
405 should be simple, with minimal compilation and linkage flags that
406 can be recognized by all Visual Studio environments.</p>
408 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
409 <div class="section">
410 <h2><a name="installation" id="installation">Installation</a></h2>
414 <p>Once Apache has been compiled, it needs to be installed in
415 its server root directory. The default is the
416 <code>\Apache2</code> directory, of the same drive.</p>
418 <p>To build and install all the files into the desired folder
419 <em>dir</em> automatically, use one of the following
420 <code>nmake</code> commands:</p>
422 <div class="example"><p><code>
423 nmake /f Makefile.win installr INSTDIR=<em>dir</em><br />
424 nmake /f Makefile.win installd INSTDIR=<em>dir</em>
427 <p>The <em>dir</em> argument to <code>INSTDIR</code> provides
428 the installation directory; it can be omitted if Apache is
429 to be installed into <code>\Apache22</code> (of the current
432 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
433 <div class="section">
434 <h2><a name="projectcomponents-warn" id="projectcomponents-warn">Warning about building Apache from the development tree</a></h2>
438 <div class="note">Note only the <code>.dsp</code> files are maintained between <code>release</code>
439 builds. The <code>.mak</code> files are NOT regenerated, due to the tremendous
440 waste of reviewer's time. Therefore, you cannot rely on the <code>NMAKE</code>
441 commands above to build revised <code>.dsp</code> project files unless you
442 then export all <code>.mak</code> files yourself from the project. This is
443 unnecessary if you build from within the Microsoft
444 Developer Studio environment.</div>
447 <div class="bottomlang">
448 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English"> en </a> |
449 <a href="../ko/platform/win_compiling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
450 </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>
451 <script type="text/javascript"><!--//--><![CDATA[//><!--
452 var comments_shortname = 'httpd';
453 var comments_identifier = 'http://httpd.apache.org/docs/trunk/platform/win_compiling.html';
455 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
456 d.write('<div id="comments_thread"><\/div>');
457 var s = d.createElement('script');
458 s.type = 'text/javascript';
460 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
461 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
464 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
466 })(window, document);
467 //--><!]]></script></div><div id="footer">
468 <p class="apache">Copyright 2013 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>
469 <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[//><!--
470 if (typeof(prettyPrint) !== 'undefined') {