| Back | Next | Contents | Cams Administrator's Guide |
The following instructions will help you install the Cams server on Windows NT, Windows 2000, Windows Server 2003, Linux, and UNIX systems. In summary, the steps you will take include:
Let's get started!
The Cams server is available for download from the Cafésoft web site at http://www.cafesoft.com in both zip and tar/gzip formats. Download the zip file for Windows and the gzip (.gz) file for Linux/UNIX systems. For Windows, you select from two downloads. The Cams server for Windows includes a Java Runtime Environment, which elminates the need to install Java on Windows. The other requires that you install Java on your system.
The distribution files will unpack into a directory named cams-1.0. Change to a directory where you'll install Cams.
Windows
cd c:\
Linux/UNIX
cd /var
Unpack the distribution file (we'll assume it's in a directory named tmp).
Windows
copy c:\tmp\cams-1_5-0.zip .
pkunzip cams-1_5-0.zipLinux/UNIX
gunzip /tmp/cams-1_5-0.tar.gz
tar xvf /tmp/cams-1_5-0.tar
From here on, we'll use the symbol CAMS_HOME to represent the full path to the Cams server root directory. For example, if you unpacked the distribution to C:\ on Windows, CAMS_HOME would be C:\cams-1.5-0\camsServer.
NOTE: The Windows instructions above assume you have the pkunzip command line utility on your system. You may use any zip program including graphical tools like Winzip.
Cams requires a license-keys file. To obtain evaluation or production license-keys, contact Cafésoft. You need to save the license-keys in a file named cams-license-keys.xml in the Cams server's conf directory. These instructions assume you've already obtained the license-keys and saved them in the tmp directory to a file named cams-license-keys.xml.
Windows
copy c:\tmp\cams-license-keys.xml %CAMS_HOME%\conf
Linux/UNIX
cp /tmp/cams-license-keys.xml $CAMS_HOME/conf
WARNING: The license-keys include values that may restrict the use of Cams by version, date, host IP address, and number of concurrent connections. Do not attempt to change these values as it will invalidate the file. If the cams-license-keys.xml file is not valid or not found, you will see an error message when attempting to start Cams. If the number of concurrent sessions is exceeded at any time, a WARNING is logged and a notification is sent no more than once every two hours.
The Cams for Windows zip file includes the Java 1.4 JRE, you can skip this step. All other Cams installations require that the Java 2 Platform Standard Edition (J2SDK) release 1.4 be installed on your system. If J2SDK 1.4 is not already installed, please do so by referring to the Java download and installation instructions at:
The Java installation process may set the JAVA_HOME environment variable on your system. For correct operation of Cams, JAVA_HOME must point to the J2SDK 1.4 installation. You may verify the JAVA_HOME setting by typing:
Windows
set j
Linux/UNIX
env | grep JAVA_HOME
If JAVA_HOME does not point to the correct directory, you may temporarily set it in the console you are using, or set is permanently. Assuming the J2SDK 1.4.2 is installed in the default location, you would temporarily set the value of JAVA_HOME by entering in a console:
Windows
set JAVA_HOME=c:\j2sdk1.4.2
To permanently set JAVA_HOME, you set a system environment variable as defined above. The way you use the graphical administrative tools to do this is dependent upon the version of Windows you are using. If you do not know how, please contact your system administrator or Cafésoft support.
WARNING: You must set a system environment variable. If you set a user environment variable and attempt to start the Cams server service, the service will not find Java, which will result in a Windows error.
Linux/UNIX (borne or bash shell):
JAVA_HOME=/usr/local/j2sdk1.4.2
export JAVA_HOMETo permanently set the JAVA_HOME environment variable, you can edit the Cams server startup script to include the lines as defined above at the top.
That's it, you should now be ready to start the Cams Server!
The Cams server handles authentication and access control requests received from Cams web agents. You'll usually run the Cams server standalone in it's own Java Virtual Machine (JVM).
The Cams server can be run in a Windows console or as a service. You should try to start the Cams server in the console before attempting to install and start the Cams server as a service. When you start the Cams server in a Windows console system messages display immediately, which helps you detect and diagnose any startup issues. This is also a good approach when making changes at any time to Cams security domains files.
To run Cams in a Windows console:
%CAMS_HOME%\bin\runcams.bat
Enter control-C in the console window to gracefully stop Cams.
To install Cams as a Windows service, you must be logged into an account with Administrator privileges. If you are using a version of the Cams server that requires Java, you must also ensure that JAVA_HOME is correctly defined (see Step 4).
Running the following script will install a service named Cams Server:
%\CAMS_HOME%\bin\cams-service-install.bat
After installing, start Cams from the Windows Services client or by entering at the command line:
net start "Cams Server"
Stop the "Cams Server" service from the Windows Services client or by entering at a command line:
net stop "Cams Server"
To remove the Cams Windows service named Cams Server:
%\CAMS_HOME%\bin\cams-service-remove.bat
If you start the Cams server from the CAMS_HOME or CAMS_HOME/bin directory, you will not need to set the CAMS_HOME environment variable. However, if you start from any other directory, you'll need to set CAMS_HOME. Also, if you want to run the Cams server using a Java Virtual Machine security manager, a "-security" flag can be used for the Linux/UNIX and Windows run scripts. The default Cams server security policy is installed at: CAMS_HOME/conf/cams.policy and grants all permissions for classes installed in directories: CAMS_HOME/lib and CAMS_HOME/classes.
CAMS_HOME=/var/cams-1.0
export CAMS_HOME
To start the Cams server:
$CAMS_HOME/bin/runcams.sh
or
$CAMS_HOME/bin/runcams.sh -security
NOTE: If the scripts in this directory did not untar with execution permissions, you'll need to use the "chmod 755 *.sh" command before executing the previous command.
To gracefully shutdown the Cams server, use:
$CAMS_HOME/bin/shutdown.sh
In order to test your Cams server installation, you must configure the Cams server and install and configure at least one Cams agent. To start to learn about how to configure the Cams server, see the Integration Quick Start. You can also refer to the test page included with each Cams web agent to configure a quick test of the web agent and the Cams server. See the Cams Web Agent Guide for more information.
NOTE: You can start or restart the Cams server and Cams web agents in any order.
© Copyright 1996-2003 Cafésoft LLC. All rights reserved.