install.html.en revision e0811a74b001c92842391061147fe21b1782a1e2
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb BGCOLOR="#FFFFFF"
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb TEXT="#000000"
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb LINK="#0000FF"
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb VLINK="#000080"
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ALINK="#FF0000"
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<!--#include virtual="header.html" -->
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<H1 ALIGN="CENTER">Compiling and Installing Apache 1.3</H1>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbUnixWare users will want to consult <A HREF="unixware.html">build notes</A>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbfor various UnixWare versions before compiling.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbInformation on the latest version of Apache can be found on the Apache
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbweb server at <A
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbHREF="http://www.apache.org/">http://www.apache.org/</A>. This will
b38846b15c8891c6dec44dcc4f96ca40721bf663rbblist the current release, any more recent beta-test release, together
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbwith details of mirror web and anonymous ftp sites.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbIf you downloaded a binary distribution, skip to <A
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbHREF="#install">Installing Apache</A>. Otherwise read the next section
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbfor how to compile the server.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbCompiling Apache consists of three steps: Firstly select which Apache
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<STRONG>modules</STRONG> you want to include into the server. Secondly create a
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbconfiguration for your operating system. Thirdly compile the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbexecutable.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAll configuration of Apache is performed in the <CODE>src</CODE>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbdirectory of the Apache distribution. Change into this directory.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb Select modules to compile into Apache in the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb <CODE>Configuration</CODE> file. Uncomment lines corresponding to
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb those optional modules you wish to include (among the AddModule lines
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb at the bottom of the file), or add new lines corresponding to
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb additional modules you have downloaded or written. (See <A
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb HREF="misc/API.html">API.html</A> for preliminary docs on how to
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb write Apache modules). Advanced users can comment out some of the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb default modules if they are sure they will not need them (be careful
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb though, since many of the default modules are vital for the correct
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb operation and security of the server).
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb You should also read the instructions in the <CODE>Configuration</CODE>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb file to see if you need to set any of the <CODE>Rule</CODE> lines.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb Configure Apache for your operating system. Normally you can just
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb type run the <CODE>Configure</CODE> script as given below. However
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb if this fails or you have any special requirements (e.g. to include
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb an additional library required by an optional module) you might need
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb to edit one or more of the following options in the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb <BLOCKQUOTE>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb % Configure
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb Using 'Configuration' as config file
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb + configured for <whatever> platform
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb + setting C compiler to <whatever> *
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb + setting C compiler optimization-level to <whatever> *
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb + Adding selected modules
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb + doing sanity check on compiler and options
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb Creating Makefile in support
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb Creating Makefile in main
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb </BLOCKQUOTE>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb (*: Depending on Configuration and your system, Configure
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb make not print these lines. That's OK).<P>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb This generates a Makefile for use in stage 3. It also creates a
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb Makefile in the support directory, for compilation of the optional
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb support programs.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb (If you want to maintain multiple configurations, you can give a
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb option to <CODE>Configure</CODE> to tell it to read an alternative
b45c1c292ff1fa635004ae81fa691f8cb3cdda85rbb Configuration file, such as <CODE>Configure -file
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbThe modules we place in the Apache distribution are the ones we have
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbtested and are used regularly by various members of the Apache
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbdevelopment group. Additional modules contributed by members or third
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbparties with specific needs or functions are available at <A
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbHREF="http://www.apache.org/dist/contrib/modules/"><URL:http://www.apache.org/dist/contrib/modules/></A>.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbThere are instructions on that page for linking these modules into the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbcore Apache code.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbYou will have a binary file called <CODE>httpd</CODE> in the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>src</CODE> directory. A binary distribution of Apache will
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbsupply this file. <P>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbThe next step is to install the program and configure it. Apache is
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbdesigned to be configured and run from the same set of directories
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbwhere it is compiled. If you want to run it from somewhere else, make
b38846b15c8891c6dec44dcc4f96ca40721bf663rbba directory and copy the <CODE>conf</CODE>, <CODE>logs</CODE> and
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>icons</CODE> directories into it. In either case you should
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbread the <A HREF="misc/security_tips.html#serverroot">security tips</A>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbdescribing how to set the permissions on the server root directory.<P>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbThe next step is to edit the configuration files for the server. This
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbconsists of setting up various <STRONG>directives</STRONG> in up to three
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbcentral configuration files. By default, these files are located in
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbthe <CODE>conf</CODE> directory and are called <CODE>srm.conf</CODE>,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>access.conf</CODE> and <CODE>httpd.conf</CODE>. To help you get
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbstarted there are same files in the <CODE>conf</CODE> directory of the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>access.conf-dist</CODE> and <CODE>httpd.conf-dist</CODE>. Copy
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbor rename these files to the names without the <CODE>-dist</CODE>.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbThen edit each of the files. Read the comments in each file carefully.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbFailure to setup these files correctly could lead to your server not
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbworking or being insecure. You should also have an additional file in
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbthe <CODE>conf</CODE> directory called <CODE>mime.types</CODE>. This
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbfile usually does not need editing.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbFirst edit <CODE>httpd.conf</CODE>. This sets up general attributes
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbabout the server: the port number, the user it runs as, etc. Next
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbedit the <CODE>srm.conf</CODE> file; this sets up the root of the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbdocument tree, special functions like server-parsed HTML or internal
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbimagemap parsing, etc. Finally, edit the <CODE>access.conf</CODE>
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbfile to at least set the base cases of access.
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweIn addition to these three files, the server behavior can be configured
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweon a directory-by-directory basis by using <CODE>.htaccess</CODE>
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowefiles in directories accessed by the server.
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweProper operation of a public web server requires accurate time
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowekeeping, since elements of the HTTP protocol are expressed as the time
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweof day. So, it's time to investigate setting up NTP or some other
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowetime synchronization system on your Unix box, or whatever the
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweequivalent on NT would be.
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweTo start the server, simply run <CODE>httpd</CODE>. This will look for
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe<CODE>httpd.conf</CODE> in the location compiled into the code (by
2f1949bb0e3c209db94c8d521cba7380b9d11421trawickdefault <CODE>/usr/local/apache/conf/httpd.conf</CODE>). If
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowethis file is somewhere else, you can give the real
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowelocation with the -f argument. For example:
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe /usr/local/apache/httpd -f /usr/local/apache/conf/httpd.conf
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweIf all goes well this will return to the command prompt almost
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweimmediately. This indicates that the server is now up and running. If
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweanything goes wrong during the initialization of the server you will
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowesee an error message on the screen.
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweIf the server started ok, you can now use your browser to
2f1949bb0e3c209db94c8d521cba7380b9d11421trawickconnect to the server and read the documentation. If you are running
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowethe browser on the same machine as the server and using the default
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweport of 80, a suitable URL to enter into your browser is
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweNote that when the server starts it will create a number of
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe<EM>child</EM> processes to handle the requests. If you started Apache
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwroweas the root user, the parent process will continue to run as root
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowewhile the children will change to the user as given in the httpd.conf
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbIf when you run <CODE>httpd</CODE> it complained about being unable to
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb"bind" to an address, then either some other process is already using
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbthe port you have configured Apache to use, or you are running httpd
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbas a normal user but trying to use port below 1024 (such as the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbdefault port 80).
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbIf the server is not running, read the error message displayed
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbwhen you run httpd. You should also check the server
b38846b15c8891c6dec44dcc4f96ca40721bf663rbberror_log for additional information (with the default configuration,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbthis will be located in the file <CODE>error_log</CODE> in the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbIf you want your server to continue running after a system reboot, you
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbshould add a call to <CODE>httpd</CODE> to your system startup files
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>rc.<EM>N</EM></CODE> directory). This will start Apache as root.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbBefore doing this ensure that your server is properly configured
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbfor security and access restrictions.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbTo stop Apache send the parent process a TERM signal. The PID of this
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbprocess is written to the file <CODE>httpd.pid</CODE> in the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>logs</CODE> directory (unless configured otherwise). Do not
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbattempt to kill the child processes because they will be renewed by
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbthe parent. A typical command to stop the server is:
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbFor more information about Apache command line options, configuration
b38846b15c8891c6dec44dcc4f96ca40721bf663rbband log files, see <A HREF="invoking.html">Starting Apache</A>. For a
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbreference guide to all Apache directives supported by the distributed
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbmodules, see the <A HREF="mod/directives.html">Apache directives</A>.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbIn addition to the main <CODE>httpd</CODE> server which is compiled
b38846b15c8891c6dec44dcc4f96ca40721bf663rbband configured as above, Apache includes a number of support programs.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbThese are not compiled by default. The support programs are in the
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<CODE>support</CODE> directory of the distribution. To compile
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbthe support programs, change into this directory and type
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb<!--#include virtual="footer.html" -->