======================================================================
Halcyon PrimeAlert (R) for Apache Web Server
Version 1.0.0a
README.install
======================================================================
Overview
======================================================================
This README.install file describes how to install and setup the
PrimeAlert for Apache Web Server module.
It consists of the following sections:
- Definitions
- Extracting the Distribution
- Installation Instructions
. Server Packages
. Agent Packages
. Console Packages
- Uninstallation Instructions
. Server Packages
. Agent Packages
. Console Packages
- Install & Uninstall Logs
- Module Loading
Definitions
======================================================================
Server Host The host where the Sun Management Center server is
installed and running. This system must be a Solaris
host, and contain the package SUNWessrv.
Agent Host A host where a Sun Management Center or PrimeAlert agent
is installed and running. If the host is a Solaris host,
it contains the package SUNWesagt; for a Linux host,
HALpialag.
Console Host A host where the Sun Management Center console is
installed and running. This system may be a Solaris or
a windows host. On Solaris it contains the package
SUNWescon.
Extracting the Distribution
======================================================================
The PrimeAlert for Apache Web Server distribution file,
HALsmxapa_1.0.0a.tar.Z OR
HALsmxapa_1.0.0a.tar.gz
must be extracted on a UNIX host before any packages can be installed.
For example, assume that the distribution file has been copied to the
following directory:
/tmp
In this case, the procedure for extracting the distribution will be:
% su -
# cd /tmp
# uncompress HALsmxapa_1.0.0a.tar.Z OR
gzip -d HALsmxapa_1.0.0a.tar.gz
# tar -xvf HALsmxapa_1.0.0a.tar
Following the example above, the source directory <EXTRACT_DIR> would
be the following:
/tmp/HALsmxapa_1.0.0
Installation Instructions
======================================================================
There is one optional and two required steps to install this product:
1. Install the server host packages
2. Install the agent host packages
3. Install the console host packages
1. Server Packages (Solaris Only)
----------------------------------------------------------------------
To install the "PrimeAlert for Apache Web Server" module packages
on the Server Host, do the following:
1. Become "root" on the Server Host
2. Extract the distribution file
3. Run the install script
% su -
# cd <EXTRACT_DIR> (i.e. /tmp/HALsmxapa_1.0.0)
# ./HALHTTPAlertApache-install.sh
Note: During installation on the server host, when asked whether you
want to install the packages for the agent layer, answer "y"
only if the Apache Web Server software is installed on
that particular host. Answer "y" when asked to install the
console layer packages, if the console packages are installed.
In general, the agent host packages should only be installed on
hosts where the Apache Web Server application is installed
and running.
The following packages are installed or upgraded:
- HALmmsapa
- HALmmsprc
- HALmmslog
- HALmmskit
2. Agent Packages (Solaris or Linux)
----------------------------------------------------------------------
This should be performed on the Agent Host where the Apache Web Server
is installed.
Note: The server host packages should be installed or upgraded before
any of the agent or console host packages.
1. Become "root" on the agent host
2. Extract the distribution file
3. Run the install script
4. Run the Apache module installation script
5. Restart the agent
6. Restart the Apache Web Server
% su -
# cd <EXTRACT_DIR> (i.e. /tmp/HALsmxapa_1.0.0)
# ./HALHTTPAlertApache-install.sh
# ./HALHTTPAlertApache-configureApache.sh ADD <PATH_TO_HTTPD.CONF>
On Solaris:
# /opt/SUNWsymon/sbin/es-stop -a
# /opt/SUNWsymon/sbin/es-start -a
On Linux:
# /opt/PrimeAlert/bin/pa stop agent
# /opt/PrimeAlert/bin/pa start agent
# <PATH_TO_APACHE>/bin/apachectl restart
The following packages are installed or upgraded by the installation:
On Solaris:
- HALmmaapa
- HALsmahtp
- HALsmaprc
- HALsmalog
- HALsmakit
- HALsmasub
On Linux:
- HALpmaapa
- HALpmahtp
- HALpmaprc
- HALpmalog
- HALpmakit
- HALpmasub
3. Console Packages (Solaris and Windows)
----------------------------------------------------------------------
The installation of the console host packages is optional. These
packages install the HELP files for the module. The packages can be
installed on either the Solaris or the Windows console.
To install the "PrimeAlert for Apache Web Server" module packages
on the Console Host, do the following:
Solaris Console
---------------
1. Become "root" Console Host
2. Extract the distribution file
3. Run the install script
4. Restart the console
% su -
# cd <EXTRACT_DIR> (i.e. /tmp/HALsmxapa_1.0.0)
# ./HALHTTPAlertApache-install.sh
# /opt/SUNWsymon/sbin/es-start -c
The following packages are installed or upgraded:
- HALmmcapa
- HALmmcprc
- HALmmclog
Windows Console
---------------
1. Extract the distribution file
2. Run the InstallShield installer for Windows
3. Restart the console
# cd <EXTRACT_DIR>/packages/win32/HALsmxapa_1.0.0
# Double click on "HALsmxapa_1.0.0.exe"
# Double click on "Sun Management Center.exe" to start the console
Uninstallation Instructions
======================================================================
This section explains how to uninstall the various PrimeAlert for
Apache Web Server components:
1. Uninstall the server host packages
2. Uninstall the agent host packages
3. Uninstall the console host packages
In general, the uninstall script can be used with no arguments to
uninstall any Halcyon PrimeAlert product:
On Solaris:
# /var/opt/SUNWsymon/uninstall/HALUninstall.sh
On Linux:
# /var/opt/PrimeAlert/uninstall/HALUninstall.sh
To manually uninstall the product, use the UNIX "pkgrm" command with
the name of the packages to be removed as arguments. Refer to the
"Installation Instructions" section to determine the various packages
installed.
On Solaris:
# pkgrm <PKG_1> <PKG_2> ... <PKG_N>
On Linux:
# rpm -e <PKG_1> <PKG_2> ... <PKG_N>
Uninstall Server Packages
----------------------------------------------------------------------
To uninstall the PrimeAlert for Apache Web Server module packages
on the Server Host, do the following:
1. Become "root" on the Server Host
2. Run the uninstall script with the appropriate parameters
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module HTTPAlertApache server
Uninstall Agent Packages
----------------------------------------------------------------------
To uninstall the PrimeAlert for Apache Web Server module packages
on the Agent Host, do the following:
1. Become "root" on the agent host
2. Run the uninstall script with the appropriate parameters
3. Remove the Apache module
% su -
On Solaris:
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module HALHTTPAlertApache agent
# /opt/SUNWsymon/modules/sbin/HALHTTPAlertApache-configureApache.sh \
REMOVE <PATH_TO_HTTPD.CONF>
On Linux:
# cd /var/opt/PrimeAlert/uninstall
# ./HALUninstall.sh -module HALHTTPAlertApache agent
# /opt/PrimeAlert/sbin/HALHTTPAlertApache-configureApache.sh \
REMOVE <PATH_TO_HTTPD.CONF>
Uninstall Console Packages (Solaris & Windows)
----------------------------------------------------------------------
To uninstall the PrimeAlert for Apache Web Server module packages on
the Console Host, do the following:
Solaris Console
---------------
1. Become "root" on the Console Host
2. Run the uninstall script with the appropriate parameters
% su -
# cd /var/opt/SUNWsymon/uninstall
# ./HALUninstall.sh -module HALHTTPAlertApache console
Windows Console
---------------
1. Double-click on "Add/Remove Programs" in the "Control Panel"
Start -> Settings -> Control Panel
2. Select "Halcyon PrimeAlert for Apache Web Server" and
click the "Add/Remove..." button.
3. An UnInstallShield session will be launch; follow the
instructions to uninstall the product.
Install & Uninstall Logs
======================================================================
All Halcyon PrimeAlert install and uninstall log files can be found
in the following directories:
On Solaris:
/var/opt/SUNWsymon/install
/var/opt/SUNWsymon/uninstall
On Linux:
/var/opt/PrimeAlert/install
/var/opt/PrimeAlert/uninstall
Note: There are no install or uninstall logs for the Windows console.
Installation Log
----------------
The name of the installation log for this product is the following:
HALHTTPAlertApache-install_<YYYYMMDD>-<HHMMSS>.log
Uninstall Log
-------------
The following is the generic uninstall log file:
uninstall.log.<YYYYMMDD>-<HHMMSS>
Module Loading
======================================================================
Modify Apache Configuration
---------------------------
The Apache Web Server needs to be configured before loading the module.
Modifications must be made to the the following Apache file:
httpd.conf
Simply run the following script, which will ask you for the location
of the configuration file and make the changes automatically for you:
# cp <PATH_TO_HTTPD.CONF>/httpd.conf <PATH_TO_HTTPD.CONF>/httpd.conf.SAV
# HALHTTPAlertApache-configureApache.sh ADD <PATH_TO_HTTPD.CONF>
This script will add configuration information to the end of the
httpd.conf file. To remove it, run the above script with the "REMOVE" argument.
Once the script is run, Apache will need to be restarted:
# /usr/local/apache/bin/apachectl stop
# /usr/local/apache/bin/apachectl start
Please refer to the "Module Loading" section in the help
documentation for details on how to load the module. Information on
how to access the help documentation is available in the "README"
file under the section "Help Documentation".
---//---