This document describes how to install and uninstall TelServer.
The installation procedure of TelServer has the following steps :
Afterwards, please refer to the User Guide to learn about the TelServer options and configuration file.
To uninstall TelServer, see :
TelServer is a pure Java application. To run it, you need a Java Virtual Machine 1.5 or later installed; we conduct our tests with SUN JVM 1.6. To get a free JVM from SUN, see http://java.sun.com/j2se/downloads.html.
The following provides the data exchanged by the TelServices clients and TelServer.
TelServer's distribution is a simple zip file providing a non-intrusive installation. You have to download it from the uniGone web site.
TelServer is zipped in the "uniGone" directory letting you unzip the file wherever you like (c:\Program Files or /opt are classic installation directories). The complete path including the "uniGone" prefix is known as "uniGone_HOME".
The distribution leads to the following image in the "uniGone_HOME" directory :
For running the evaluation version of TelServer a license file named 'unigoneeval.dat' is provided by uniGone. The evaluation license file is checked periodically. At the end of the evaluation period, we invite you to contact us.
For running the release version of TelServer, a license file named 'TelServerLicense.txt' is provided by uniGone. The license is valid for a specific machine and controls if features are allowed (for example, the number of sessions to be opened simultaneously).
NOTE: the machine name that is checked by the license is the "hardware address" setting or "hostname" setting provided within the results of the "TelServer -version" command.
The license file must be copied to your platform. It will be searched as follows:
The 'bin' directory of the distribution contains the batch files of the application.
The batch files make use of two environment variables :
The 'work' directory of the distribution contains the default properties files to configure the application. TelServer will detect missing mandatory properties and display appropriate messages.
To configure TelServer, refer to the configuration chapter.
For starting TelServer in console mode :
Please refer to the User Guide to learn about TelServer options.
A convenient way to run TelServer is to use it as a service.
NOTE 1: Because it relies on "JavaService", this feature is restricted by "JavaService" restrictions (mainly Windows user must login with administrative rights) . It is available on Windows NT, 2000, XP or 2003 - not Windows 95, 98.
For 64-bit Windows architecture and a JVM 64 bits, one must use JavaService-x64.exe. For that, the appropriate line in TelServer.bat file must be uncommented.
NOTE 2: "JavaService" requires that a JDK is installed (with the jre/bin/server/jvm.dll file); note that a normal JRE does not install the server dll.
NOTE 3: If you are using a SUN JDK 6, the msvcr71.dll must be installed in the same path as the JavaService.exe. SUN provides this explanation: Windows Java SE 6 applications using custom launchers must be installed with msvcr71.dll in the same directory as the launcher executable. According to http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclib/html/_CRT_C_Run.2d.Time_Libraries.asp, this is the new Microsoft C runtime distribution model: "An application should use and redistribute msvcr71.dll, and it should avoid placing a copy or using an existing copy of msvcr71.dll in the system directory. Instead, the application should keep a copy of msvcr71.dll in its application directory with the program executable. Any application built with Visual C++ .NET using the /MD switch will necessarily use msvcr71.dll.".
The batch file TelServer.bat, contains the commands to manage the Windows TelServer service:
Note that the service can also be started or stopped through the Windows Administrative Tools / Services tools.
NOTE: TelServer.sh relies on the start-stop-daemon program which is not present on all Linux systems.
For example, on a Debian distribution, assuming TelServer is installed in "/opt", the script "/opt/uniGone/TelServer/vx.x.x/bin/TelServer.sh" is used to launch TelServer as a service. The following commands must be run with the root account :
cd /opt/uniGone/TelServer/vx.x.x/bin chmod u+x TelServer.sh cd /etc/init.d ln -s /opt/uniGone/TelServer/vx.x.x/bin/TelServer.sh update-rc.d TelServer.sh defaultsThe proper installation of the service depends on the OS. The batch file TelServer.sh contains the commands to manage the TelServer service:
While trying to run TelServer, you may encounter some problems.
This means that the current JVM version is less or equal to 1.4. Fix the JAVA_HOME in the batch file specifying a JVM 1.5 or upper.
This means that the current JVM version does not contain all the necessary classes required by TelServer, although it may be a JVM 1.5 (this may happen with the Debian default JVM for example). We recommend using the JVM 1.5 or upper from SUN. See the system requirements.
This may happen because the batch file variables are not defined properly or the license file or configuration file cannot be located... A log file (TelServer-start.log) is created in the 'work/logs' directory of the TelServer installation when it does not start, giving the reason of the failure.
In all situations, launch TelServer with option "-server" in console mode before trying to launch it as a service. Once it can be launched properly in the console mode, it should start as a service normally (after proper installation of the service).
If problems happen on Windows while the console mode works properly, see the JavaService notes. If you are using a SUN JDK 6, ensure the msvcr71.dll is installed in the same path as the JavaService.exe. If you are using a JVM 64 bits on a 64 bits Windows system, ensure you have uncommented the appropriate line in TelServer.bat to use JavaService-x64.exe.
It may happen that the service has not been properly uninstalled after an update of TelServer. When TelServer batch is launched from another location (such as a new installation bin directory), for running the new service, it is important to first uninstall the TelServer (using "TelServer.bat uninstall" command), to install the new one (with "TelServer.bat install" launched from the new bin directory) and then to start the service. If the service uninstallation is refused, close the command shell window and open a new one.
On machines with low RAM resources, you may encounter a "java.lang.OutOfMemoryError" error. This may be avoided by setting a higher value to the size of the memory allocation pool of the JVM. The -Xmx and -Xms parameter may be used like explained below.
Within the batch files, you can add -Xmx512m -Xms512m on the command line launching the application.
Passing the "-Xmx512m" parameter to the Java executable sets 512MB as the maximum size, in bytes, of the memory allocation pool. This value should be adjusted for your local RAM. It is not recommended to set too high a value in relation with the local RAM resource. A normal value is the size of the local RAM. It is recommended on a server-side application to set both -Xmx and -Xms to the same value.
Also note the the -Xss option lets you specify the stack size allocated for each thread. This value limits the number of thread the JVM can have.
For more explanations and adaptations, you should refer to the documentation of your local JVM.
To uninstall TelServer simply remove the directory containing the distribution.