install.html revision e0811a74b001c92842391061147fe21b1782a1e2
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes BGCOLOR="#FFFFFF"
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes TEXT="#000000"
0662ed52e814f8f08ef0e09956413a792584eddffuankg LINK="#0000FF"
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes VLINK="#000080"
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes ALINK="#FF0000"
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<!--#include virtual="header.html" -->
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<H1 ALIGN="CENTER">Compiling and Installing Apache 1.3</H1>
70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholesUnixWare users will want to consult <A HREF="unixware.html">build notes</A>
70953fb44a7140fe206c3a5f011e24209c8c5c6abnicholesfor various UnixWare versions before compiling.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesInformation on the latest version of Apache can be found on the Apache
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesweb server at <A
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesHREF="http://www.apache.org/">http://www.apache.org/</A>. This will
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeslist the current release, any more recent beta-test release, together
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeswith details of mirror web and anonymous ftp sites.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIf you downloaded a binary distribution, skip to <A
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesHREF="#install">Installing Apache</A>. Otherwise read the next section
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesfor how to compile the server.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesCompiling Apache consists of three steps: Firstly select which Apache
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<STRONG>modules</STRONG> you want to include into the server. Secondly create a
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesconfiguration for your operating system. Thirdly compile the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesAll configuration of Apache is performed in the <CODE>src</CODE>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesdirectory of the Apache distribution. Change into this directory.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Select modules to compile into Apache in the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <CODE>Configuration</CODE> file. Uncomment lines corresponding to
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes those optional modules you wish to include (among the AddModule lines
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes at the bottom of the file), or add new lines corresponding to
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes additional modules you have downloaded or written. (See <A
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes HREF="misc/API.html">API.html</A> for preliminary docs on how to
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes write Apache modules). Advanced users can comment out some of the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes default modules if they are sure they will not need them (be careful
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes though, since many of the default modules are vital for the correct
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg operation and security of the server).
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes You should also read the instructions in the <CODE>Configuration</CODE>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes file to see if you need to set any of the <CODE>Rule</CODE> lines.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Configure Apache for your operating system. Normally you can just
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes type run the <CODE>Configure</CODE> script as given below. However
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes if this fails or you have any special requirements (e.g. to include
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes an additional library required by an optional module) you might need
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes to edit one or more of the following options in the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes <BLOCKQUOTE>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Using 'Configuration' as config file
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes + configured for <whatever> platform
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes + setting C compiler to <whatever> *
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes + setting C compiler optimization-level to <whatever> *
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes + Adding selected modules
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes + doing sanity check on compiler and options
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Creating Makefile in support
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Creating Makefile in main
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes </BLOCKQUOTE>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes (*: Depending on Configuration and your system, Configure
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes make not print these lines. That's OK).<P>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes This generates a Makefile for use in stage 3. It also creates a
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Makefile in the support directory, for compilation of the optional
ac7985784d08a3655291f24f711812b4d8b1cbcffuankg support programs.
0a39e7683f6611d66c55712f50bb240428d832a1bnicholes (If you want to maintain multiple configurations, you can give a
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes option to <CODE>Configure</CODE> to tell it to read an alternative
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes Configuration file, such as <CODE>Configure -file
0662ed52e814f8f08ef0e09956413a792584eddffuankgThe modules we place in the Apache distribution are the ones we have
bb2b38cd44b032118359afbc743efbea12f48e61bnicholestested and are used regularly by various members of the Apache
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgdevelopment group. Additional modules contributed by members or third
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesparties with specific needs or functions are available at <A
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesHREF="http://www.apache.org/dist/contrib/modules/"><URL:http://www.apache.org/dist/contrib/modules/></A>.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesThere are instructions on that page for linking these modules into the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholescore Apache code.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesYou will have a binary file called <CODE>httpd</CODE> in the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<CODE>src</CODE> directory. A binary distribution of Apache will
bb2b38cd44b032118359afbc743efbea12f48e61bnicholessupply this file. <P>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesThe next step is to install the program and configure it. Apache is
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesdesigned to be configured and run from the same set of directories
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeswhere it is compiled. If you want to run it from somewhere else, make
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesa directory and copy the <CODE>conf</CODE>, <CODE>logs</CODE> and
0662ed52e814f8f08ef0e09956413a792584eddffuankg<CODE>icons</CODE> directories into it. In either case you should
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesread the <A HREF="misc/security_tips.html#serverroot">security tips</A>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesdescribing how to set the permissions on the server root directory.<P>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesThe next step is to edit the configuration files for the server. This
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesconsists of setting up various <STRONG>directives</STRONG> in up to three
bb2b38cd44b032118359afbc743efbea12f48e61bnicholescentral configuration files. By default, these files are located in
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesthe <CODE>conf</CODE> directory and are called <CODE>srm.conf</CODE>,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<CODE>access.conf</CODE> and <CODE>httpd.conf</CODE>. To help you get
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesstarted there are same files in the <CODE>conf</CODE> directory of the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<CODE>access.conf-dist</CODE> and <CODE>httpd.conf-dist</CODE>. Copy
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesor rename these files to the names without the <CODE>-dist</CODE>.
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgThen edit each of the files. Read the comments in each file carefully.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesFailure to setup these files correctly could lead to your server not
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesworking or being insecure. You should also have an additional file in
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesthe <CODE>conf</CODE> directory called <CODE>mime.types</CODE>. This
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgfile usually does not need editing.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesFirst edit <CODE>httpd.conf</CODE>. This sets up general attributes
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesabout the server: the port number, the user it runs as, etc. Next
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesedit the <CODE>srm.conf</CODE> file; this sets up the root of the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesdocument tree, special functions like server-parsed HTML or internal
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesimagemap parsing, etc. Finally, edit the <CODE>access.conf</CODE>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesfile to at least set the base cases of access.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIn addition to these three files, the server behavior can be configured
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeson a directory-by-directory basis by using <CODE>.htaccess</CODE>
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesfiles in directories accessed by the server.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesProper operation of a public web server requires accurate time
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeskeeping, since elements of the HTTP protocol are expressed as the time
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesof day. So, it's time to investigate setting up NTP or some other
bb2b38cd44b032118359afbc743efbea12f48e61bnicholestime synchronization system on your Unix box, or whatever the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesequivalent on NT would be.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesTo start the server, simply run <CODE>httpd</CODE>. This will look for
cf7ca2f9eaa6523fefcccba4287b91637391fb51fuankg<CODE>httpd.conf</CODE> in the location compiled into the code (by
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesdefault <CODE>/usr/local/apache/conf/httpd.conf</CODE>). If
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesthis file is somewhere else, you can give the real
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeslocation with the -f argument. For example:
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes /usr/local/apache/httpd -f /usr/local/apache/conf/httpd.conf
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIf all goes well this will return to the command prompt almost
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesimmediately. This indicates that the server is now up and running. If
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesanything goes wrong during the initialization of the server you will
bb2b38cd44b032118359afbc743efbea12f48e61bnicholessee an error message on the screen.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIf the server started ok, you can now use your browser to
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesconnect to the server and read the documentation. If you are running
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgthe browser on the same machine as the server and using the default
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesport of 80, a suitable URL to enter into your browser is
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesNote that when the server starts it will create a number of
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<EM>child</EM> processes to handle the requests. If you started Apache
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesas the root user, the parent process will continue to run as root
bb2b38cd44b032118359afbc743efbea12f48e61bnicholeswhile the children will change to the user as given in the httpd.conf
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIf when you run <CODE>httpd</CODE> it complained about being unable to
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes"bind" to an address, then either some other process is already using
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgthe port you have configured Apache to use, or you are running httpd
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgas a normal user but trying to use port below 1024 (such as the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesdefault port 80).
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIf the server is not running, read the error message displayed
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgwhen you run httpd. You should also check the server
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgerror_log for additional information (with the default configuration,
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesthis will be located in the file <CODE>error_log</CODE> in the
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesIf you want your server to continue running after a system reboot, you
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesshould add a call to <CODE>httpd</CODE> to your system startup files
bb2b38cd44b032118359afbc743efbea12f48e61bnicholes<CODE>rc.<EM>N</EM></CODE> directory). This will start Apache as root.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesBefore doing this ensure that your server is properly configured
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesfor security and access restrictions.
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesTo stop Apache send the parent process a TERM signal. The PID of this
ac7985784d08a3655291f24f711812b4d8b1cbcffuankgprocess is written to the file <CODE>httpd.pid</CODE> in the
0662ed52e814f8f08ef0e09956413a792584eddffuankg<CODE>logs</CODE> directory (unless configured otherwise). Do not
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesattempt to kill the child processes because they will be renewed by
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesthe parent. A typical command to stop the server is:
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesFor more information about Apache command line options, configuration
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesand log files, see <A HREF="invoking.html">Starting Apache</A>. For a
bb2b38cd44b032118359afbc743efbea12f48e61bnicholesreference guide to all Apache directives supported by the distributed
0662ed52e814f8f08ef0e09956413a792584eddffuankgmodules, see the <A HREF="mod/directives.html">Apache directives</A>.
<!--#include virtual="footer.html" -->