
--------------------------------------------------------------------------------
LOCUS (tm) Agent Version 1.2 INSTALLATION
(c) 2003 Tikal Technology, Inc.
--------------------------------------------------------------------------------

Locus Agent Installation Steps:


Step 1: Installing the lagent.tar file.
---------------------------------------

Install the lagent.tar file in a directory of your choosing. The agent startup
script is written to find the agent in either ${HOME}/opt/locus/agent,
/opt/locus/agent, or /usr/local/locus/agent. You can also modify the startup 
script to support any directory of your choosing. You will want to un-"tar" the 
tar file in a directory of your choosing. Un-"Tarring" the file will create a 
directory tree with the top directory being named "agent". So make a directory
tree with the last directory being named "locus". Place the lagent.tar file in
that directory and un-tar the file.

The locus agent directory tree appears as follows:

	+ agent
		- bin (scripts)
		- cfgmgmt (configuration files)
		- data (data collection files)
		- doc (readmes)
		- lib (jar files)
		- logs (log files)
		- scripts (script files)
		- tmp (temporary files)


Step 2: Agent configuration file settings.
------------------------------------------

The "cfgmgmt" directory contains all the runtime configuration files for the 
Locus Agent. There is only one configuraiton file in this directory after the
installation: the Agent.conf file. This configuration file must be modified to 
connect to the Locus Server. This file is NOT changed by a running Locus Agent.

There are 2 parts to this configuration file that must be addressed.

A. Agent Base Configuration

- Agent.Server.IP=SERVER-IP-ADDRESS

	- Replace SERVER-IP-ADDRESS with the ip address of the machine on which
	the Locus Server is installed.

- Agent.Server.Port=SERVER-SERVICE-PORT

	- Replace SERVER-SERVICE-PORT with the port number on which the Locus
	Server provides service or listens for Locus Agents or Web Application
	requests.

- Agent.ListenPort=AGENT-SERVICE-PORT
			
	- Replace AGENT-SERVICE-PORT with the port number the Locus Agent will
	provide service or listen for connections from the Locus Server.

B. Web Application Service

	The Locus Agent has the ability to generate email that directly 
	references the URL of the Locus Web Application. To this end, you must
	configure the following:

- Agent.Service.Http=http://YOUR-WEBAPP-SERVER:YOUR-WEBAPP-SERVER-PORT

	- Replace YOUR-WEBAPP-SERVER with the host name or ip address of the
	host machine that is running your J2EE Servlet Container server.
	- Replace YOUR-WEBAPP-SERVER-PORT with the port that your J2EE Servlet
	Container server provides service on, i.e. 8080.

- Agent.Service.Prefix=/locus/servlet/Dispatch

	- This item need not change. However if you must change it, only the 
	first part, "locus", can be changed and expect the web application to 
	interface to agent email.


Step 3: Start Locus Agent.
--------------------------

Now you can start the Locus Agent on the host. Using the Locus Agent startup
script you can test your environment, and start, stop, and restart the agent.
From the "locus/agent" directory execute any of the following:

- "bin/agent.sh env"		will display the agent's environment.
- "bin/agent.sh start"		will start the agent
- "bin/agent.sh stop"		will stop the agent
- "bin/agent.sh restart"	will restart the agent

Issue the start command to put the agent in the background. If a Locus Server is
running the agent will connect. If a Locus Server can not be found, the agent 
will continue to run. Once connected to a Locus Server, the agent will receive
the appropriate configuration and be accessible from the Locus Web Application.

--------------------------------------------------------------------------------
Visit Tikal Technology on the web at http://www.tikaltech.com/locus
Contact us at support@tikaltech.com
--------------------------------------------------------------------------------
LOCUS (tm) Agent Version 1.2 INSTALLATION
(c) 2003 Tikal Technology, Inc.
--------------------------------------------------------------------------------

