1.0 Preface

This document describes how to install, configure, run, and monitor your VolanoChat server. It is intended to be used by the VolanoChat server administrator.

Download

Use the following link if you would like to download a copy of the guide for use on your local computer:

HTTP:  http://www.volano.com/pub/guide25.zip

This guide is updated frequently. Please check the online version for the latest updates and corrections.

Organization of this guide

The chapters of this guide are divided into several main sections as follows.

Getting started

Overview: gives a general overview of how the client applets and server application work together to provide chat rooms on Web sites.
Release Notes: helps you plan for your chat service by providing the system requirements, the new features in the latest release of VolanoChat, and the known issues and problems.
Installation: provides step-by-step instructions for installing and starting the VolanoChat server on your computer.

Server side

Server: describes the parts of the VolanoChat server and describes all of its properties, configuration files, and log files.
Servlets: describes the Java servlets that are provided with VolanoChat and shows you how to add other Java servlets to the VolanoChat server.

Client side

VolanoChat Applet: describes the parameters and properties of the VolanoChat applet and how to modify its interface for monitors, administrators, and members.
WebVolanoChat Applet: describes the parameters of the WebVolanoChat applet used for accessing public rooms embedded on the Web page.
MyVolanoChat Applet: describes the parameters of the MyVolanoChat applet used for accessing hidden personal chat rooms or normal public chat rooms.
BannerPlayer Applet: describes the BannerPlayer applet that is provided with VolanoChat for displaying banner images from your server or from remote advertisement servers.
Adding Other Applets: shows you how to add other Java applets to the chat rooms.

Features

Translating VolanoChat: explains how to translate the VolanoChat user interface into languages which use non-Western character coding.
Flood Control: explains how to administer the flood control features of VolanoChat.
Advertising Control: shows examples of using the BannerPlayer applet with remote ad servers such as DoubleClick.
DNS Blacklisting: describes how to set up DNS-based blacklist support.
Themes: explains how to define the font and color themes.
Moderated Events: explains how to set up your VolanoChatPro server for moderated events.

Reference

Command Reference: gives a synopsis of the Java console applications provided with VolanoChat and other Volano products, such as VolanoMark.

Appendices

Error Messages: lists the most common error messages reported by the server or client.
Server Tools: shows some helpful system administration commands.
NAT/Firewall/Proxy: provides information for setting up VolanoChat to work through NAT, firewall, or proxy servers
Licensing: explains how the VolanoChat product is licensed.
Frequently Asked Questions: lists common questions about VolanoChat, along with answers.
Multiple Windows Service Install: explains how to install multiple VolanoChat servers as Windows NT, 2000, or XP Services.

VolanoChat users

Hosted VolanoChatPro Chat Rooms: provides information for those using a MyVolanoChat Personal Chat Room through a Web hosting provider.
VolanoChat End User FAQ: answers the most common questions asked by those using VolanoChat applets.
Browser Info: lists detailed version information about your Web browser and Java support.

Conventions used in this guide

Each page in this guide has a header and footer containing navigational icons which link to other pages. In addition, each page contains a link to the Table of Contents.

takes you to the previous page in the guide.
takes you to the next page in the guide.
takes you up one level in the guide's hierarchy.
takes you to a page containing the frequently asked questions and their answers.

The current VolanoChat product version is denoted throughout this guide by VolanoChat 2.5.x.y, where 2 is the release number, 5 is the major version number, x is the minor version number, and y is the build number. The build number is usually included only in the download file names.

A monospace type is used for code samples, computer commands, file names and Java property names. For example:

server.port=8000

When showing the format of computer commands with parameters, the parameters are shown in italic monospace type. For example:

java vchat2_5_1_1 -o directory

When showing HTML code, the parts that you may modify are shown in bold monospace type. For example:

<applet codebase="http://www.volano.com/vcclient"
        archive="COM/volano/MyVolanoChat.jar"
        code="COM.volano.MyVolanoChat.class"
        width="500" height="100">
<param name="cabbase" value="COM/volano/MyVolanoChat.cab" />
<param name="color"   value="#FFFFFF" />
<param name="group"   value="Welcome to Volano!" />
<param name="text"    value="english.txt" />
</applet>

When showing sample computer commands along with their output, the part that you type is shown in bold monospace type. For example:

$ ./startup.sh
java version "1.3.1_09"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.1_09-b03)
Java HotSpot(TM) Server VM (build 1.3.1_09-b03, mixed mode)
VolanoChat(TM) Server Version 2.5.1.1
Copyright (C) 1996-2003 Volano LLC.  All rights reserved.
Loading server properties from "C:\home\john\vchat2.5.1.1\conf\properties.txt".
x21:8000 (192.168.2.3:8000) VolanoChatPro - 5 connection limit.
This evaluation copy expires on Mon Dec 22 00:00:00 PST 2003.

Feedback

We welcome your feedback about this guide, especially if you spot errors or omissions. You can write us at Volano Support <support@volano.com>.

Trademarks

Volano, VolanoChat, VolanoChatPro, and VolanoMark are trademarks of Volano LLC. Java is a trademark of Sun Microsystems, Inc., and refers to Sun's Java programming language.

HTML version

The VolanoChat Administrator Guide is written using valid XHTML 1.0 Transitional and Cascading Style Sheets Level 2.

XHTML 1.0

Table of Contents