-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
+<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta name="generator" content="HTML Tidy, see www.w3.org" />
+<manualpage>
+ <relativepath href=".." />
- <title>Running Apache for Windows as a Service</title>
- </head>
- <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
-
- <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
- vlink="#000080" alink="#FF0000">
- <!--#include virtual="header.html" -->
+ <title>Running Apache for Windows as a Service</title>
- <h1 align="center">Running Apache for Windows as a Service</h1>
+ <summary>
<p>Apache can be run as a service on Windows NT/2000. (There is
also some HIGHLY EXPERIMENTAL support for similar behavior on
can successfully run it in a console window. See <a
href="windows.html">Using Apache with Microsoft Windows</a>
before you attempt to install or run Apache as a service.
- Changes to the httpd.conf file should always be followed by
- starting Apache as a console window. If this succeeds, the
- service should succeed.</p>
+ Changes to the <code>httpd.conf</code> file should always be
+ followed by starting Apache as a console window. If this
+ succeeds, the service should succeed.</p>
- <p><strong>NOTE: Prior to version 1.3.13, the configuration was
+ <note><strong>Prior to version 1.3.13, the configuration was
<em>not tested</em> prior to performing the
installation</strong>, and a lack of service dependencies often
caused the console window to succeed, but the service would
still fail. See <a href="#service">below</a> if you are having
problems running a version of Apache prior to 1.3.13 to resolve
the issue. If you have this problem with version 1.3.13 or
- greater, first try uninstalling (-u) and re-installing (-i) the
- Apache service.</p>
- <hr />
+ greater, first try uninstalling (<code>-u</code>) and re-installing
+ (<code>-i</code>) the Apache service.</note>
<p>To start Apache as a service, you first need to install it
as a service. Multiple Apache services can be installed, each
You can later stop Apache by clicking on Stop. As an
alternative to using the Services window, you can start and
stop the "Apache" service from the command line with</p>
-<pre>
- NET START APACHE
- NET STOP APACHE
-</pre>
+
+ <example>
+ NET START APACHE<br />
+ NET STOP APACHE
+ </example>
<p>See <a href="#signal">Controlling Apache as a Service</a>
for more information on installing and controlling Apache
services.</p>
- <p><strong>Apache, unlike many other Windows NT/2000 services,
+ <note><title>Note</title>
+ Apache, unlike many other Windows NT/2000 services,
logs any errors to its own error.log file in the logs folder
within the Apache server root folder. You will <em>not</em>
find Apache error details in the Windows NT Event
- Log.</strong></p>
+ Log.</note>
<p>After starting Apache as a service (or if you have trouble
starting it) you can test it using the same <a
href="windows.html#cmdline">procedure</a> as for running in a
console window. Remember to use the command:</p>
-<pre>
- apache -n "service name"
-</pre>
+
+ <example>
+ apache -n "service name"
+ </example>
<p>to assure you are using the service's configuration.</p>
- <h2><a id="service" name="service">Running Apache for Windows
- as a Service</a></h2>
+ </summary>
- <p><strong>Note: The -n option to specify a service name is
- only available with Apache 1.3.7 and later.</strong> Earlier
- versions of Apache only support the default service name
- 'Apache'.</p>
+ <section id="service">
+
+ <title>Running Apache for Windows as a Service</title>
+
+ <note><strong>The <code>-n</code> option to specify a service
+ name is only available with Apache 1.3.7 and later.</strong>
+ Earlier versions of Apache only support the default service name
+ "Apache".</note>
<p>You can install Apache as a Windows NT service as
follows:</p>
-<pre>
- apache -i -n "service name"
-</pre>
+
+ <example>
+ apache -i -n "service name"
+ </example>
<p>To install a service to use a particular configuration,
specify the configuration file when the service is
installed:</p>
-<pre>
- apache -i -n "service name" -f "\my server\conf\my.conf"
-</pre>
+
+ <example>
+ apache -i -n "service name" -f "\my server\conf\my.conf"
+ </example>
<p>To remove an Apache service, use:</p>
-<pre>
- apache -u -n "service name"
-</pre>
+
+ <example>
+ apache -u -n "service name"
+ </example>
<p>The default "service name", if one is not specified, is
"Apache".</p>
- <p>Once a service is installed, you can use the <samp>-n</samp>
+ <p>Once a service is installed, you can use the <code>-n</code>
option, in conjunction with other options, to refer to a
service's configuration file. For example:</p>
<p>To test a service's configuration file:</p>
-<pre>
- apache -n "service name" -t
-</pre>
+
+ <example>
+ apache -n "service name" -t
+ </example>
<p>To start a console Apache using a service's configuration
file:</p>
-<pre>
- apache -n "service name"
-</pre>
- <h2><a id="depends" name="depends">Important Note on service
- dependencies:</a></h2>
+ <example>
+ apache -n "service name"
+ </example>
+
+ </section>
+
+ <section id="depends">
+
+ <title>Important Note on service dependencies:</title>
<p>Prior to Apache release 1.3.13, the dependencies required to
successfully start an installed service were not configured.
After installing a service using earlier versions of Apache,
you must follow these steps:</p>
-<pre>
- Run regedt32
- Select <u>W</u>indow - "HKEY_LOCAL_MACHINE on Local Machine" from the menu
- Double-click to open the SYSTEM, then the CurrentControlSet keys
- Scroll down and click on the Apache servicename
- Select <u>E</u>dit - Add <u>V</u>alue... from the menu
- Fill in the Add Value dialog with
- <u>V</u>alue Name: DependOnGroup
- <u>D</u>ata Type: REG_MULTI_SZ
- and click OK
- Leave the Multi-String Editor dialog empty and click OK
- Select <u>E</u>dit - Add <u>V</u>alue... from the menu
- Fill in the Add Value dialog with
- <u>V</u>alue Name: DependOnService
- <u>D</u>ata Type: REG_MULTI_SZ
- and click OK
- Type the following list (one per line) in the Multi-String Editor dialog
- Tcpip
- Afd
- and click OK
-</pre>
+
+ <example>
+ Run regedt32 <br />
+ Select Window - "HKEY_LOCAL_MACHINE on Local Machine" from the menu <br />
+ Double-click to open the SYSTEM, then the CurrentControlSet keys <br />
+ Scroll down and click on the Apache servicename <br />
+ Select Edit - Add Value... from the menu <br />
+ Fill in the Add Value dialog with <br />
+     Value Name: DependOnGroup <br />
+     Data Type: REG_MULTI_SZ <br />
+     and click OK <br />
+ Leave the Multi-String Editor dialog empty and click OK <br />
+ Select Edit - Add Value... from the menu <br />
+ Fill in the Add Value dialog with <br />
+     Value Name: DependOnService <br />
+     Data Type: REG_MULTI_SZ <br />
+     and click OK <br />
+ Type the following list (one per line) in the Multi-String Editor dialog <br />
+     Tcpip <br />
+     Afd <br />
+     and click OK <br />
+ </example>
<p>If you are using COM or DCOM components from a third party
module, ISAPI, or other add-in scripting technologies such as
DependOnService value, double click that value if it already
exists, and add the Rpcss entry to the list.</p>
- <h2>User Account for Apache Service to Run As (NT/2000)</h2>
+ </section>
+
+ <section id="account">
+
+ <title>User Account for Apache Service to Run As (NT/2000)</title>
<p>When Apache is first installed as a service (e.g. with the
- -i option) it will run as user "System" (the LocalSystem
+ <code>-i</code> option) it will run as user "System" (the LocalSystem
account). There should be few issues if all resources for the
web server reside on the local system, but it has broad
security privileges to affect the local machine!</p>
- <blockquote>
- LocalSystem is a very privileged account locally, so you
- shouldn't run any shareware applications there. However, it
- has no network privileges and cannot leave the machine via
- any NT-secured mechanism, including file system, named pipes,
- DCOM, or secure RPC.
- </blockquote>
+ <note>LocalSystem is a very privileged account locally, so you
+ shouldn't run any shareware applications there. However, it
+ has no network privileges and cannot leave the machine via
+ any NT-secured mechanism, including file system, named pipes,
+ DCOM, or secure RPC.</note>
<p><strong>NEVER grant network privileges to the SYSTEM
account!</strong> Create a new user account instead, grant the
- appropriate privileges to that user, and use the the 'Log On
- As:' option. Select the Start Menu -> Settings -> Control
+ appropriate privileges to that user, and use the the "Log On
+ As:" option. Select the Start Menu -> Settings -> Control
Panel -> Services -> apache service ... and click the
"Startup" button to access this setting.</p>
- <blockquote>
- A service that runs in the context of the LocalSystem account
- inherits the security context of the SCM. It is not
- associated with any logged-on user account and does not have
- credentials (domain name, user name, and password) to be used
- for verification.
- </blockquote>
+ <note>A service that runs in the context of the LocalSystem account
+ inherits the security context of the SCM. It is not
+ associated with any logged-on user account and does not have
+ credentials (domain name, user name, and password) to be used
+ for verification.</note>
<p>The SYSTEM account has no privileges to the network, so
shared pages or a shared installation of Apache is invisible to
<li>
In the drop-down list, verify that the following rights
- have been granted to the selected account:
+ have been granted to the selected account:
<ul>
<li>Act as part of the operating system</li>
<li>Confirm that the selected account is a member of the
Users group.</li>
- <li>Confirm the selected account has access to all document
- and script directories (minimally read and browse
- access).</li>
+ <li>Confirm the selected account has access to all
+ <code>document</code> and <code>script</code>
+ directories (minimally read and browse access).</li>
<li>Confirm the selected account has read/write/delete access
- to the Apache logs directory!</li>
+ to the Apache <code>logs</code> directory!</li>
</ul>
<p>If you allow the account to log in as a user, then you can
followed the steps above, Apache should execute as a service
with no problems.</p>
- <p><strong>Note: error code 2186</strong> is a good indication
- that you need to review the 'Log On As' configuration, since
- the server can't access a required network resource.</p>
+ <note><strong>Error code 2186</strong> is a good indication
+ that you need to review the "Log On As" configuration, since
+ the server can't access a required network resource.</note>
+
+ </section>
- <h2><a id="trouble" name="trouble">Troubleshooting Apache for
- Windows as a Service</a></h2>
+ <section id="trouble">
+
+ <title>Troubleshooting Apache for Windows as a Service</title>
<p>When starting Apache as a service you may encounter an error
message from Windows service manager. For example if you try to
start Apache using the Services applet in Windows Control Panel
- you may get the following message;</p>
-<pre>
- Could not start the apache service on \\COMPUTER
- Error 1067; The process terminated unexpectedly.
-</pre>
+ you may get the following message:</p>
+
+ <example>
+ Could not start the apache service on \\COMPUTER <br />
+ Error 1067; The process terminated unexpectedly.
+ </example>
<p>You will get this error if there is any problem starting
Apache. In order to see what is causing the problem you should
<p>Also, Apache 1.3.13 now records startup errors in the
Application Event Log under Windows NT/2000, if Apache is run
- as a service. Run the Event Viewer and select <u>L</u>og ...
- <u>A</u>pplication to see these events.</p>
+ as a service. Run the Event Viewer and select Log ...
+ Application to see these events.</p>
- <p><strong>Check the Application Event Log with the Event
+ <note><strong>Check the Application Event Log with the Event
Viewer in case of any problems, even if no error message pops
- up to warn you that an error occured.</strong></p>
+ up to warn you that an error occured.</strong></note>
+
+ </section>
+
+ <section id="cmdline">
+
+ <title>Running Apache for Windows from the Command Line</title>
- <h2><a id="cmdline" name="cmdline">Running Apache for Windows
- from the Command Line</a></h2>
- For details on controlling Apache service from the command
+ <p>For details on controlling Apache service from the command
line, please refer to <a href="windows.html#cmdline">console
- command line</a> section.
+ command line</a> section.</p>
- <h2><a id="signal" name="signal">Controlling Apache as a
- Service</a></h2>
+ </section>
+
+ <section id="signal">
+
+ <title>Controlling Apache as a Service</title>
<p>Multiple instances of Apache can be installed and run as
services. Signal an installed Apache service to start, restart,
or shutdown/stop as follows:</p>
-<pre>
- apache -n "service name" -k start
- apache -n "service name" -k restart
- apache -n "service name" -k shutdown
- apache -n "service name" -k stop
-</pre>
-
- <p>For the default "Apache" service, the -n Apache option is
- still required, since the -k commands without the -n option are
- directed at Apache running in a console window. The quotes are
- only required if the service name contains spaces.</p>
-
- <p><strong>Note: the -k stop alias for the -k shutdown command
- was introduced in Apache version 1.3.13.</strong> Earlier
- versions of Apache will only recognize the -k shutdown option.
- Prior to 1.3.3, Apache did not recognize <em>any</em> -k
- options at all!</p>
-
- <p>In addition, you can use the native NT NET command to start
- and stop Apache services as follows:</p>
-<pre>
- NET START "service name"
- NET STOP "service name"
-</pre>
+
+ <example>
+ apache -n "service name" -k start <br />
+ apache -n "service name" -k restart <br />
+ apache -n "service name" -k shutdown <br />
+ apache -n "service name" -k stop
+ </example>
+
+ <p>For the default "Apache" service, the <code>-n</code> Apache
+ option is still required, since the <code>-k</code> commands without
+ the <code>-n</code> option are directed at Apache running in a console
+ window. The quotes are only required if the service name contains spaces.</p>
+
+ <note><strong>Note the <code>-k stop</code> alias for the
+ <code>-k shutdown</code> command was introduced in Apache version
+ 1.3.13.</strong> Earlier versions of Apache will only recognize the
+ <code>-k shutdown</code> option. Prior to 1.3.3, Apache did not
+ recognize <em>any</em> <code>-k</code> options at all!</note>
+
+ <p>In addition, you can use the native NT <code>NET</code> command
+ to start and stop Apache services as follows:</p>
+
+ <example>
+ NET START "service name" <br />
+ NET STOP "service name"
+ </example>
<p>Again, quotes are only required if the service name contains
spaces.</p>
- <h2><a id="win95svc" name="win95svc">HIGHLY EXPERIMENTAL
- Windows 95/98 Service</a></h2>
+ </section>
+
+ <section id="win95svc">
- <p><strong>Note: The service options for Windows 95 and 98 are
+ <title>HIGHLY EXPERIMENTAL Windows 95/98 Service</title>
+
+ <note><strong>The service options for Windows 95 and 98 are
only available with Apache 1.3.13 and later.</strong> Earlier
versions of Apache only supported Apache in a console window
- for Windows 95/98.</p>
+ for Windows 95/98.</note>
<p>There is some support for Apache on Windows 95/98 to behave
in a similar manner as a service on Windows NT/2000. It is
<p>Apache will attempt to start and if successful it will run
in the background. If you run the command</p>
-<pre>
- Apache -n "service name" -k start
-</pre>
+
+ <example>
+ Apache -n "service name" -k start
+ </example>
<p>via a shortcut on your desktop, for example, then if the
service starts successfully a console window will flash up but
immediately disappears. If Apache detects any errors on startup
- such as a incorrect entries in the httpd.conf file, then the
- console window will remain visible. This will display an error
- message which will be useful in tracking down the cause of the
- problem.</p>
+ such as a incorrect entries in the <code>httpd.conf</code> file,
+ then the console window will remain visible. This will display
+ an error message which will be useful in tracking down the cause
+ of the problem.</p>
- <p>Windows 95/98 does not support NET START or NET STOP
- commands so you must use Apache's Service Control options at a
- command prompt. You may wish to set up a shortcut for each of
- these commands so that you can just choose it from the start
- menu or desktop to perform the required action.</p>
+ <p>Windows 95/98 does not support <code>NET START</code> or
+ <code>NET STOP</code> commands so you must use Apache's Service
+ Control options at a command prompt. You may wish to set up a
+ shortcut for each of these commands so that you can just choose
+ it from the start menu or desktop to perform the required action.</p>
<p>Apache and Windows 95/98 offer no support for running the
Apache service as a specific user with network privileges. In
httpd server. These facilities exist only to assist the user in
developing web content and learning the Apache server, and
perhaps as a intranet server on a secured, private network.</p>
- <!--#include virtual="footer.html" -->
- </body>
-</html>
+
+ </section>
+
+</manualpage>
projects / apache / blobdiff