APC PowerChute Shutdown Utility for Apache Web Server -- User ...

3RZHU&KXWH6KXWGRZQ8WLOLW
w w w. a p c c . c o m IRU$SDFKH:HE6HUYHU

Product Overview

Purpose American Power Conversion (APC) has developed the APC PowerChute
Shutdown Utility for Apache Web Server to configure the automatic shut-
down of Apache HTTP Server software running on a UNIX operating system.
Shutdown is invoked by PowerChute® plus when it detects a given condition
in the attached APC uninterruptible power supply (UPS).

Versions Supported The Shutdown Utility for Apache Web Server supports Apache HTTP Server
releases 1.2.x and 1.3.x running on Sun® Solaris™ SPARCStations and IBM®
AIX systems.

Apache HTTP Server An Apache Web server—the common name for a server running Apache
Software HTTP Server software—manages Web sites by storing Web pages which are
then sent out in response to HTTP requests from remote browsers. Apache
Web servers often work in conjunction with e-commerce packages and data-
base software to manage large volumes of customer transactions.

Apache Web Servers In the event of a sudden loss of power, an Apache Web server without UPS
and Power Failure protection does not complete the steps it would normally take in order to close
all open Web transactions and shut down. When the Apache Web server is not
correctly shut down, log files may be incomplete, incorrect, or corrupted. Thus
administrators can lose critical transaction data (data upload or download
transactions, etc.) when the Apache Web server is stopped abnormally.
A protected Apache Web server that lacks automatic shutdown capability
requires the presence of the Web administrator. In the event of a power failure,
the administrator must quickly send a complex “kill” command to the server
in order to shut down the software before the UPS stops supplying power.

continued on next page

User Guide
1

w w w. a p c c . c o m
PowerChute Shutdown Utility for Apache Web Server

Product Overview, continued

APC Solution to The Shutdown Utility for Apache Web Server provides a solution to the prob-
Apache Web Server lem of abnormal shutdown of an Apache Web server. The utility automates
Shutdown the process of creating the proper command script to be invoked by Power-
Chute plus in the event of a power failure.
While the APC UPS is providing battery power to your Apache Web server
during a power failure, PowerChute plus (via FlexEvents) initiates the com-
mand script which prevents new connections, finishes processing current
transactions, shuts down the software gracefully, and logs all transactions.

Features of the Utility With the Shutdown Utility for Apache Web Server you can:
• Easily configure PowerChute plus to shut down your Apache Web
server automatically during a power failure.
• Keep a log of all unattended shutdowns.
• Specify the location of the shutdown script.

User Guide
2


Using the Shutdown Utility for Apache Web Server

Overview Setting up your Apache Web server to use the shutdown utility will require
you to perform several procedures:
1. Downloading the Utility to your system, if you have not already done
so.
2. Running the Utility to configure your Web server for shutdown.
3. Setting Up PowerChute plus to run the shutdown script created in
Procedure 2.

Downloading the To download the utility to your system:
Utility
1. Go to Application Shutdown Utilities from the Free Software
Upgrades page on the APC Web site.
2. Select the link entitled apacheshut.tar.
3. Create or select a download directory and filename for the file. If you
give the download file a different name, you must ensure that the new
name has the same tar extension. Select OK. The brief download will
begin.
4. Go to the download directory. From the command line, type:
tar -xvf filename
where filename is the name of the file you downloaded in Step 3. Press
ENTER. The command will extract 4 files:

a. apacheshut—the Shutdown Utility for Apache Web Server.
b. apacheshut.pdf—this user guide in portable document format
(PDF).
c. README—a text file with basic information on the contents of
the download.
d. language.txt—a file for use only by the shutdown utility.


User Guide
3


Using the Shutdown Utility for Apache Web Server, continued

Required Privileges To use the utility, you must have one of the following privileges:
• root
• root equivalent
• write to file system
If necessary, change your privileges to match one of the three privileges listed
above. For information on how to change privileges, refer to the instructions
available for your UNIX system.

Required Information When you run the utility, you will be asked for two pieces of information:
• Location of the Apache Web Server configuration files
• Location for the shutdown script that will be created by this utility.
You will be able to use the default path or enter a path of your choosing.

Running the Utility To run the Shutdown Utility for Apache Web Server:
1. From the command line in the download directory, type:
./apacheshut
and press ENTER. The opening screen of the utility appears.
2. Answer the questions as prompted by the utility. See Required Infor-
mation above.
3. The closing screen will show the path and filename of the shutdown
script that has just been created by the Shutdown Utility for Apache
Web Server. You will use this path and filename when setting up Pow-
erChute plus to implement the shutdown script. The filename will be
apacheshutscript.


User Guide
4



Setting Up Next you must configure PowerChute plus to invoke the shutdown script cre-
PowerChute plus ated by the shutdown utility. For a full description of how to set up
PowerChute plus to execute command files, see “FlexEvents” in the Power-
Chute plus User’s Guide. Complete the following procedure to set up
PowerChute plus FlexEvents for Apache Web server shutdown.
1. Start PowerChute plus. Connect to the UPS.
2. From the PowerChute plus Configuration menu, select Event
Actions. In the Event Action dialog box, select the event that will in-
voke the shutdown script you just created.
Note: You can set up more than one event to trigger a shutdown of the
Apache Web server. If one event triggers a shutdown of the
Apache Web server, subsequent shutdown commands
(triggered by other events) have no effect on the Apache Web
server.
3. Select Run Command File and select Options next to it. In the Run
Command File dialog box, enter the path and filename of the shut-
down script in the Command File line. If the line already contains a
filename, follow the procedure in Multiple Shutdown Commands
before proceeding with Step 4.
4. Do not change Wait __ Seconds Before Executing unless you have
specific reasons to do so. For further information, see the PowerChute
plus User’s Guide.
5. Select OK. PowerChute plus is now configured to shut down your
Apache Web server automatically when the chosen condition occurs.
6. Repeat Steps 2–5 for each event to be configured.
Note: If you start shutdown from FlexEvents, PowerChute plus is committed
to that type of shutdown. Any subsequent event that invokes a
shutdown for the server will not override a shutdown in progress.


User Guide
5



Testing Operation To test the shutdown script:
1. Simulate a power failure or other event that you expect to trigger the
shutdown of your Apache Web server.
2. Wait for the Apache Web server to shut down.
3. Check for successful shutdown by using a text editor to open the
Apache Web server error log. (The default for Apache HTTP Server
software is /var/log/error_log.)
4. When the shutdown has been successful, the following messages ap-
pear at the end of the error log:
Apache Web Server Automated Shutdown
Starting:
Apache Web Server Automated Shutdown
Successful.
If these messages (above) do not appear in the error log, see
Troubleshooting on page 7.
Note: If you have set up more than one event to use the shutdown
script, certain power events could trigger more than one of
these events. When the shutdown script has been run more than
once, the error log will show multiple entries of successful
shutdown.

Multiple Shutdown Each event action in FlexEvents can run only one command file. If the Run
Commands Command File dialog box already contains the name of an existing file, per-
form the following steps.
1. Do not change the current path name in the text box.
2. Using a text editor, open the command file listed in the Command File
dialog box.
3. Append the contents of the Apache Web server shutdown script at the
end of the file.
Note: Placing the contents of the shutdown script after existing
commands will ensure that any existing commands are not
delayed during an automated shutdown.
4. Save the file.
5. Proceed with Step 4 of the procedure in Setting Up PowerChute plus
on page 5.

User Guide
6


After Installation

Reusing the Utility After you have successfully configured PowerChute plus to run apacheshut-
Files script during a utility power failure, you will not normally need the shutdown
utility files. However, you may want to save these files for future use.

Warning Do not edit the shutdown script. If you make changes to the location of
Apache Web server configuration files or of the shutdown script, you must run
the Shutdown Utility for Apache Web Server again to provide the updated
locations. If you change the name or location of the shutdown script:
• Reconfigure PowerChute plus to run the new script.
• Delete the old shutdown script.

Troubleshooting If you have trouble with the Shutdown Utility for Apache Web Server, refer to
the following table.

Table 1: Troubleshooting

Problem Possible Cause Solution

The language file does Find the language file—
not exist in the same by re-downloading and
directory as apacheshut. uncompressing, if
necessary—and move it
An error message to the same directory as
appears while you are apacheshut.
running the utility.
You do not have one of Change one of the privi-
the privileges required leges as described by the
for writing the shutdown error message.
script.

When you test the script, The location you gave Run the utility again and
the Apache Web server for the Apache Web provide the correct loca-
does not shut down and server configuration files tion of the Apache Web
no shutdown entry is not correct for the server configuration
appears at the end of the installation of Apache files.
error log. HTTP Server software
that is running.


User Guide
7


After Installation, continued

Troubleshooting,
continued Table 1: Troubleshooting


The delay (Wait __ Sec- Shorten the delay in the
onds Before Executing) Run Command File dia-
is set too long, and the log box or associate the
UPS turns off its output script file with a different
The shutdown script runs before the delay expires. event, one that is trig-
successfully when tested gered sooner in the
in PowerChute plus, but PowerChute plus shut-
does not run during an down sequence.
actual power outage. The operating system Lengthen the Shutdown
shut down before the Server Delay in
Apache Web server had PowerChute plus.
time to complete shut-
down.

During a shutdown The shutdown script was There is a problem with
sequence (testing or executed, but failed to the Apache Web server
automatic), the Apache complete. The server has configuration. Consider
Web server does not shut stopped responding. reconfiguring or rein-
down. The error log stalling the Apache Web
records the starting of the server software.
shutdown process, but The OS shut down Lengthen the Shutdown
has no message about before the Apache Web Server Delay in
successful shutdown and server had time to com- PowerChute plus.
no failure message. plete shutdown.

The location you gave Run the utility again and
for the Apache Web provide the correct loca-
During a shutdown server configuration files tion of the Apache Web
sequence (testing or is not correct for the server configuration
automatic), the Apache installation of Apache files.
Web server does not shut HTTP Server software
down. The error log that is running.
records the starting of the The kill command did Change the privileges for
shutdown process and a not complete success- the PowerChute plus ser-
failure message. fully because Power- vice to include root or
Chute plus does not have root-equivalent rights.
the required privileges. Retest.


User Guide
8


After Installation, continued

Troubleshooting,
continued Table 1: Troubleshooting


After automated shut- This message, generated N/A
down, the error log con- by the Web server, indi-
tains the message: cates normal operation.
“[notice] httpd: caught Neither Apache HTTP
SIGTERM, shutting Server nor the APC
down.” shutdown utility has
encountered an error or
problem.

Contacting APC The following table shows how to contact APC by phone or online.

Table 2: Contacting APC

USA Canada 1-800-800-4272

Mexico 95 800 804 4283

Brazil 0800-127221

Worldwide 1-401-789-5735

Web site http://www.apcc.com

Online technical support http://support.apcc.com

User Guide
9

APC PowerChute Shutdown Utility for Apache Web Server -- User ...

More Related Content

What's hot (19)

Viewers also liked (8)

Similar to APC PowerChute Shutdown Utility for Apache Web Server -- User ... (20)

More from webhostingguy (20)

APC PowerChute Shutdown Utility for Apache Web Server -- User ...