Previous Next Up FAQ Table of Contents

4.2 Installing on Linux

Please read the VolanoChat server software requirements in the [3.1] Requirements section before installing VolanoChat on your system. The installation instructions below assume you are using one of the recommended Java platforms for Linux listed in Table 1.

This section consists of the following five parts:

Installing VolanoChat

Download the Java class file installation program from the VolanoChat Download page and run the installation program using the java command. For example, if you download the file vchat2_6_1.class, you would run the installation program as a graphical desktop application by changing to the directory where you saved the file and running the following command:

java vchat2_6_1

If you are using a character-based Telnet or SSH session to login to a remote system with no graphical desktop, you can perform the installation directly from the command prompt with the -o option:

java vchat2_6_1 -o path

where path is the directory where you want the VolanoChat software installed. Note that if you attempt to use the graphical installation program without an X11 graphical display, you'll receive the error messages:

Unable to extract this archive.
java.lang.InternalError: Can't connect to X11 window server using ':0.0'
  as the value of the DISPLAY variable.
  ...
**ERROR failed to install

We recommend that you install each VolanoChat version into its own directory under the home directory of a new user account on your system, such as volano. For example, if you're installing VolanoChat version 2.6.1, you would create a new user account called volano, login to that account, and install VolanoChat into the following location:

/home/volano/vchat2.6.1

with the command:

java vchat2_6_1 -o ~/vchat2.6.1

If you're unable to create a new account, you can simply install into a location under your own home directory. The examples that follow use the installation directory /home/volano/vchat2.6.1, but your location may be different if you installed into a different directory or under a different account name.

Download a trial license key from the VolanoChatPro Trial Licenses page and save the generated file as a plain text file. The easiest way to save the trial key is to select Save As... or Save Page As... from the Web browser File menu. Put the key.txt file in the conf subdirectory of your VolanoChat installation. For example, if you installed VolanoChat in the location /home/volano/vchat2.6.1, you would put the trial license key in:

/home/volano/vchat2.6.1/conf/key.txt

Write to Volano Support <service@volano.com> if you are moving or upgrading servers and need to exchange your purchased non-trial license for a new one with a different address.

Starting the server

You can start the VolanoChat server from the command prompt or automatically as a service when your system starts.

From the Command Prompt

VolanoChat includes a sample startup shell script called startup.sh. To start the VolanoChat server, change to the VolanoChat installation directory, make the shell script executable, and run the script. For example, if you installed into the directory /home/volano/vchat2.6.1, you would enter:

cd /home/volano/vchat2.6.1
chmod a+x startup.sh
./startup.sh

You should then see messages like the following:

java version "1.4.2_03"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2_03-b02)
Java HotSpot(TM) Server VM (build 1.4.2_03-b02, mixed mode)
VolanoChat(TM) Server Version 2.6.1
Copyright (c) 1996-2004 Volano Software.  All rights reserved.
Loading server properties from "/home/volano/vchat2.6.1/conf/properties.txt".
guest.vmware.volano.com:8000 (192.168.0.3:8000) VolanoChatPro - 5 connection limit.
This evaluation copy expires on Tue Mar 02 00:00:00 PST 2004.
Apache Tomcat/4.1.29

If you get an error message like the following:

Java virtual machine not found: /usr/local/j2sdk1.3.1/bin/java

you'll need to modify the line in the startup.sh script which specifies the location of the Java command on your system. Change the value of the java variable in the Linux section of the script, shown below. Note that the "#" character is used for comments.

Linux)      # Linux
    ulimit -n 1024
    for file in lib/*.jar; do classpath="$classpath:$file"; done

    # For the Blackdown Java 2 Classic VM, use these variables:
    java=/usr/local/j2sdk1.3.1/bin/java
    options="-green -Xmx256m -Xss128k"

    # For the Sun Java 2 HotSpot Server VM, use these variables:
    # java=/usr/j2se/bin/java
    # options="-server -Xmx256m -Xss128k"
    ;;

To stop the VolanoChat server, enter the Ctrl-C keyboard shortcut in the terminal window where you started it. If you started the server as a background process, you can find it with the ps command and then stop it with the kill command.

Note: You may need to modify the line in the startup script which specifies the file descriptor limit for the VolanoChat server process. You need one file descriptor for each simultaneous chat connection, so set this number greater than the maximum number of people you expect to be chatting in your VolanoChat server at the same time. By default, the script sets the limit to 1,024, allowing for about 1,000 concurrent chat connections:
ulimit -n 1024

To increase the limit beyond 1,024, you may need to modify your operating system parameters in the following files:

/etc/security/limits.conf
    *  hard  nofile  10240
/etc/sysconfig/sshd
    ulimit -Hn 10240

As a Service

You may want to create your own startup script to start the VolanoChat server in the background and save any output to a log file, as in the following sample script:

#!/bin/sh
cd $HOME/vchat2.6.1
./startup.sh -r >> server.log 2>&1 &

If you put the script in $HOME/bin/startchat.sh and make it exectuable, you can then invoke it from the /etc/rc.local system startup script to have the VolanoChat server started when you start your Linux system. Add the following lines to your /etc/rc.local file, shown below for a user account called volano:

echo "Starting VolanoChat Server ..."
su -l volano -c /home/volano/bin/startchat.sh

After rebooting, you can find the process identifiers (PIDs) of the startup script and the VolanoChat server Java process with the -u option of the ps command, such as the following example with the account name volano:

ps -u volano

With the process identifier, you can use the kill command to stop both the VolanoChat server and the startup script which launches and restarts it.

Starting the applets

If you're using a Web browser on the same machine that is running the VolanoChat server, you can load the applet from the following link:

http://localhost:8080/vcclient/index.html

If the server is on some other machine, change localhost in the address shown above to the actual host name of the machine running the VolanoChat server. After your browser loads the page, push the button to connect to your VolanoChat server using the VolanoChat applet.

Although the applets and their resources can be delivered through the built-in Apache Tomcat servlet container as shown above, you should use a Web server like the Apache HTTP Server for delivering the VolanoChat applets and files on a production system. These files must be publicly available through your Web server so that the applet can be loaded onto Web pages. Do not move or copy the vcclient subdirectory, but rather set up an Apache Alias or even just a symbolic link (using the "ln -s" command) for the applet class files and resources.

For example, to publish your vcclient directory using Apache, you would add an Alias directive like the following to your Apache configuration file:

Alias /vcclient/ /home/volano/vchat2.6.1/webapps/ROOT/vcclient/

With that change, you can drop the 8080 port number from the address and pull the applet through your normal Web server:

http://localhost/vcclient/index.html

Purchasing a license

You can purchase a license key from Volano through our online store to increase the trial license connection limit and remove its expiration date. You will need the support.log file that is generated by the VolanoChat server each time you start it, found under the logs subdirectory. We'll use the server.host IP address and server.port port number to generate the new license. The contents of the support log file look like the following:

server.version     = Version 2.6.1
server.properties  = /home/volano/vchat2.6.1/conf/properties.txt
server.license     = VolanoChatPro - 5 connection limit
server.expiration  = Tue Mar 02 00:00:00 PST 2004
server.host        = guest.vmware.volano.com (192.168.0.3)
server.port        = 8000
java.vendor        = Sun Microsystems Inc.
java.vendor.url    = http://java.sun.com/
java.version       = 1.4.2_03
java.class.version = 48.0
java.compiler      =
os.name            = Linux
os.version         = 2.4.21-9.0.1.EL
os.arch            = i386
user.language      = en
user.region        =
file.encoding      = UTF-8
file.encoding.pkg  = sun.io

Removing VolanoChat

To remove VolanoChat using the graphical desktop application, change to the VolanoChat installation directory and enter the following command:

java uninstall

If you are using a character-based Telnet or SSH session to login to a remote system with no graphical desktop, you can remove VolanoChat directly from the command prompt with the -console option:

java uninstall -console

The uninstall program will remove all files except for those you have modified or created after installation, such as the modified configuration files or new log files. Simply delete these files if you don't want to keep them.


Previous Next Up FAQ XHTML 1.0 Table of Contents

2014-07-11 — An updated version of the VOLANO chat server that supports the latest Java 8 Plug-in is now available. More…

The VOLANO® chat software for the Java™ platform lets you build on-line communities and add real-time social networking to your Web site. More…

John Neffenger <john@status6.com>
More…

A PROJECT OF STATUS:6®