install.html revision 76cb3193ccec4ea129005df639c23840f40b7e00
21236ab51082668914b933041893a1cf45218a3dLennart Poettering<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
21236ab51082668914b933041893a1cf45218a3dLennart Poettering<TITLE>Compiling and Installing Apache</TITLE>
21236ab51082668914b933041893a1cf45218a3dLennart Poettering<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
21236ab51082668914b933041893a1cf45218a3dLennart Poettering BGCOLOR="#FFFFFF"
21236ab51082668914b933041893a1cf45218a3dLennart Poettering TEXT="#000000"
21236ab51082668914b933041893a1cf45218a3dLennart Poettering LINK="#0000FF"
21236ab51082668914b933041893a1cf45218a3dLennart Poettering VLINK="#000080"
21236ab51082668914b933041893a1cf45218a3dLennart Poettering ALINK="#FF0000"
21236ab51082668914b933041893a1cf45218a3dLennart Poettering<!--#include virtual="header.html" -->
21236ab51082668914b933041893a1cf45218a3dLennart Poettering<H1 ALIGN="CENTER">Compiling and Installing Apache 1.2</H1>
21236ab51082668914b933041893a1cf45218a3dLennart Poettering<P>If you wish to download and install an earlier version of Apache please
21236ab51082668914b933041893a1cf45218a3dLennart Poetteringread <A HREF="install_1_1.html">Compiling and Installing Apache 1.1</A>.</P>
d3fae78fe86f1dfcdb07fd613ccbb3adf547a617Josh TriplettUnixWare users will want to consult <A HREF="unixware.html">build notes</A>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekfor various UnixWare versions before compiling.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekInformation on the latest version of Apache can be found on the Apache
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekHREF="http://www.apache.org/">http://www.apache.org/</A>. This will
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmeklist the current release, any more recent beta-test release, together
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekwith details of mirror web and anonymous ftp sites.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIf you downloaded a binary distribution, skip to <A
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekHREF="#install">Installing Apache</A>. Otherwise read the next section
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekfor how to compile the server.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekCompiling Apache consists of three steps: Firstly select which Apache
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<b>modules</b> you want to include into the server. Secondly create a
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekconfiguration for your operating system. Thirdly compile the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekAll configuration of Apache is performed in the <CODE>src</CODE>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdirectory of the Apache distribution. Change into this directory.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Select modules to compile into Apache in the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <CODE>Configuration</CODE> file. Uncomment lines corresponding to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek those optional modules you wish to include (among the AddModule lines
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek at the bottom of the file), or add new lines corresponding to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek additional modules you have downloaded or written. (See <A
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek HREF="misc/API.html">API.html</A> for preliminary docs on how to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek write Apache modules). Advanced users can comment out some of the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek default modules if they are sure they will not need them (be careful
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek though, since many of the default modules are vital for the correct
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek operation and security of the server).
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek You should also read the instructions in the <CODE>Configuration</CODE>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek file to see if you need to set any of the <CODE>Rule</CODE> lines.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Configure Apache for your operating system. Normally you can just
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek type run the <CODE>Configure</CODE> script as given below. However
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek if this fails or you have any special requirements (e.g. to include
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek an additional library required by an optional module) you might need
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek to edit one or more of the following options in the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <CODE>Configuration</CODE> file:
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek <CODE>EXTRA_CFLAGS, LIBS, LDFLAGS, INCLUDES</CODE>.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Run the <CODE>Configure</CODE> script:
a12b0cc34d80a2d13c87d1f57059339cfc780912Lennart Poettering Using 'Configuration' as config file
7629889c86005017eb1a7f1f803c0d8e7a5bef08Lennart Poettering + configured for <whatever> platform
7629889c86005017eb1a7f1f803c0d8e7a5bef08Lennart Poettering + setting C compiler to <whatever> *
21236ab51082668914b933041893a1cf45218a3dLennart Poettering + setting C compiler optimization-level to <whatever> *
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek + Adding selected modules
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek + doing sanity check on compiler and options
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Creating Makefile in support
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Creating Makefile in main
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Creating Makefile in modules/standard
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek (*: Depending on Configuration and your system, Configure
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek make not print these lines. That's OK).<P>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek This generates a Makefile for use in stage 3. It also creates a
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Makefile in the support directory, for compilation of the optional
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek support programs.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek (If you want to maintain multiple configurations, you can give a
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek option to <CODE>Configure</CODE> to tell it to read an alternative
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek Configuration file, such as <CODE>Configure -file
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekThe modules we place in the Apache distribution are the ones we have
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmektested and are used regularly by various members of the Apache
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdevelopment group. Additional modules contributed by members or third
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekparties with specific needs or functions are available at <A
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekHREF="http://www.apache.org/dist/contrib/modules/"><URL:http://www.apache.org/dist/contrib/modules/></a>.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekThere are instructions on that page for linking these modules into the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekcore Apache code.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<h2><A NAME="install">Installing Apache</A></h2>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekYou will have a binary file called <CODE>httpd</CODE> in the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<CODE>src</CODE> directory. A binary distribution of Apache will
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmeksupply this file. <P>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekThe next step is to install the program and configure it. Apache is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdesigned to be configured and run from the same set of directories
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekwhere it is compiled. If you want to run it from somewhere else, make
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmeka directory and copy the <CODE>conf</CODE>, <CODE>logs</CODE> and
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<CODE>icons</CODE> directories into it. <P>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekThe next step is to edit the configuration files for the server. This
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekconsists of setting up various <B>directives</B> in up to three
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekcentral configuration files. By default, these files are located in
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekthe <CODE>conf</CODE> directory and are called <CODE>srm.conf</CODE>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<CODE>access.conf</CODE> and <CODE>httpd.conf</CODE>. To help you get
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekstarted there are same files in the <CODE>conf</CODE> directory of the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdistribution, called <CODE>srm.conf-dist</CODE>,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<CODE>access.conf-dist</CODE> and <CODE>httpd.conf-dist</CODE>. Copy
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekor rename these files to the names without the <CODE>-dist</CODE>.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekThen edit each of the files. Read the comments in each file carefully.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekFailure to setup these files correctly could lead to your server not
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekworking or being insecure. You should also have an additional file in
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekthe <CODE>conf</CODE> directory called <CODE>mime.types</CODE>. This
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekfile usually does not need editing.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekFirst edit <CODE>httpd.conf</CODE>. This sets up general attributes
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekabout the server: the port number, the user it runs as, etc. Next
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekedit the <CODE>srm.conf</CODE> file; this sets up the root of the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdocument tree, special functions like server-parsed HTML or internal
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekimagemap parsing, etc. Finally, edit the <CODE>access.conf</CODE>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekfile to at least set the base cases of access.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIn addition to these three files, the server behavior can be configured
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekon a directory-by-directory basis by using <CODE>.htaccess</CODE>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekfiles in directories accessed by the server.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<H3>Starting and Stopping the Server</H3>
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekTo start the server, simply run <CODE>httpd</CODE>. This will look for
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<CODE>httpd.conf</CODE> in the location compiled into the code (by
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdefault <CODE>/usr/local/etc/httpd/conf/httpd.conf</CODE>). If
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekthis file is somewhere else, you can give the real
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmeklocation with the -f argument. For example:
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek /usr/local/etc/apache/src/httpd -f /usr/local/etc/apache/conf/httpd.conf
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIf all goes well this will return to the command prompt almost
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekimmediately. This indicates that the server is now up and running. If
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekanything goes wrong during the initialization of the server you will
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmeksee an error message on the screen.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIf the server started ok, you can now use your browser to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekconnect to the server and read the documentation. If you are running
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekthe browser on the same machine as the server and using the default
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekport of 80, a suitable URL to enter into your browser is
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekNote that when the server starts it will create a number of
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<i>child</i> processes to handle the requests. If you started Apache
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekas the root user, the parent process will continue to run as root
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekwhile the children will change to the user as given in the httpd.conf
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIf when you run <CODE>httpd</CODE> it complained about being unable to
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek"bind" to an address, then either some other process is already using
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekthe port you have configured Apache to use, or you are running httpd
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekas a normal user but trying to use port below 1024 (such as the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekdefault port 80).
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIf the server is not running, read the error message displayed
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekwhen you run httpd. You should also check the server
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekerror_log for additional information (with the default configuration,
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekthis will be located in the file <CODE>error_log</CODE> in the
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekIf you want your server to continue running after a system reboot, you
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekshould add a call to <CODE>httpd</CODE> to your system startup files
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek(typically <CODE>rc.local</CODE> or a file in an
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmek<CODE>rc.<I>N</I></CODE> directory). This will start Apache as root.
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-SzmekBefore doing this ensure that your server is properly configured
798d3a524ea57aaf40cb53858aaa45ec702f012dZbigniew Jędrzejewski-Szmekfor security and access restrictions.
<!--#include virtual="footer.html" -->