|
|
Table of Contents |
The properties file itself looks like this by default. To change the server properties, simply edit the file with any plain text editor. When changes are made to any of the server files, you must restart the VolanoChat server for the changes to take effect.
The VolanoChat server looks for its Java properties file in its base directory. The server determines its base directory depending on whether it was started:
If the server is started with no parameters, as with the command
java COM.volano.Main, its base is the directory from which
it was started. It looks in the current working directory for a file
called properties.txt. In this way if you simply change to
the installation directory (called vchat2.0.0 by default)
and start the server, it will find all of the configuration files
created during its installation.
If the server is started with a command parameter specifying the path to its properties file, as in the UNIX command:
java COM.volano.Main /home/volano/vchat2.0.0/properties.txt
it will set its base to the directory containing the properties file
you specify (/home/volano/vchat2.0.0 in this example). In
this way you can start the server and point to a different directory for
the location of its configuration files. This method also allows you to
start more than one instance of the VolanoChat server, each with a
different configuration and different set of log files.
If the server is started with the vcstart InstallShield
launch script on Windows or UNIX, it will set its base to the root
directory you specified during the installation process. In this way you
can start the server from any location and it will automatically point
back to its root installation directory.
The VolanoChat server properties file gives the location of three other configuration files:
server.http),
server.access), and
server.rooms).
In addition, it specifies the location of as many as five optional log files:
log.access),
log.public),
log.private),
log.error), and
log.support).
You may specify absolute or relative paths to these secondary files. If the file paths are not absolute, they are assumed to be relative to the VolanoChat server base directory, as described above.
Each of the VolanoChat server properties is explained below, showing the value initially defined by the sample properties file. You can let a property take on its default value either by omitting its value, as in:
server.port=
or by omitting the entire line defining the property.
For file path names, you should specify the path in Web notation,
using a forward slash, "/", for the path separator instead
of the Windows backward slash character, "\". There can be
no spaces on either side of the equal sign when defining the property
values.
server.host=
This property allows you to define the host name or IP address at which the VolanoChat server accepts connections. It can be used to direct the server to bind to a particular address when running on a multi-homed host with multiple virtual addresses. The default if undefined is to accept connections on all of the machine's addresses.
server.port=8000
This property defines the port number at which the VolanoChat server
accepts chat connections from VolanoChat client applets. This number
must be the same as the VolanoChat applet server.port
property value. The default is port 8000.
server.password=
This property defines the password required to monitor chat rooms
when using the monitor interface of the VolanoChat applet. Monitoring
capabilities are activated in the VolanoChat applet by setting the
applet monitor parameter to true, although the
correct password is required in order to use any of the monitoring
capabilities. The default is no password, which allows no monitoring of
any chat rooms.
admin.port=8001
This property defines the port number at which the VolanoChat server accepts administrative connections. The default is port 8001.
admin.password=
This property defines the password required to make administrative
connections to the VolanoChat server from the
COM.volano.Status and COM.volano.Shutdown
applications. The default is no password, which allows no administrative
connections.
status.interval=60
This property defines the interval, in seconds, at which you wish to
receive status reports from the VolanoChat server when using the
COM.volano.Status application. The default is 60 seconds.
server.backlog=50
This property specifies the number of incoming connections that can be queued up by your operating system while waiting for the VolanoChat server to accept them. Connections are queued when the VolanoChat server has reached the connection limit defined by the server administrator or set by your VolanoChat license key. If a connection request arrives when the queue is full, the connection is refused. The default is 50 pending connections.
server.limit=0
This property sets the limit on the total number of simultaneous chat connections to your VolanoChat server. You can use this value to control the total number of people using your VolanoChat server, thereby placing a limit on the resources used by the server. The default is zero, allowing an unlimited number of concurrent connections or the maximum number of connections allows by your VolanoChat license key.
server.timeout=10
This property defines the number of minutes before a connection is disconnected after the VolanoChat server detects the client applet is not responding. Note that this is not an idle timeout on the person actually chatting—rather, it is a timeout used to clean up any connections which were not closed normally. The default is 10 minutes.
server.verbose=false
This property enables or disables verbose error logging. When the
verbose error logging is enabled with a value of true, a
complete Java stack trace is recorded for each error in addition to the
message text. When disabled with a value of false, only the
error message text is recorded. The default value is false.
server.nothreadgroups=false
This property, when set to true, works around Apple Mac
Runtime for Java bug number 2232076. It should be set to
true when running the VolanoChat server on the Mac with the
Apple MRJ virtual machine in order to avoid
java.lang.IllegalThreadStateException errors.
install.root=
This property sets the root installation directory of the VolanoChat server and is especially useful when running the server as a Windows NT service. Otherwise, you may omit the definition of this property. See the notes on Microsoft Windows NT 4.0 for additional information.
room.limit=25
This property sets the maximum number of people allowed to enter each chat room. The default is a maximum of 25 people per room.
length.chattext=1000 length.profile=1000 length.roomname=100 length.username=20
These properties set the maximum length of character strings received
from a VolanoChat client applet. The property
length.roomname defines the maximum number of characters
for a room name; length.username defines the maximum number
of characters for a person's nickname; length.profile
defines the maximum number of characters for a profile; and
length.chattext defines the maximum number of characters
for one chat message.
Their default values are those shown above. The values of these properties should be equal to or greater than the properties of the same name for the VolanoChat client applet, since any applet sending more characters will be disconnected and assumed not to be a VolanoChat applet.
server.http=httpd.txt
This property defines the name and location of the properties file used by VolanoChat's built-in servlet runner. See the Servlet Runner section for an explanation of the servlet runner's properties. The default when omitted is to disable the servlet runner.
server.access=access.txt
This property defines the name and location of the access control file which defines the people and the Web pages that may access to your VolanoChat server. The syntax of the access control file is documented in the Access Control section later in this chapter. The default when omitted allows access from any host or Web page.
server.rooms=rooms.txt
This property defines the name and location of the file containing the list of rooms to be permanently available in the VolanoChat server. The syntax of the room list file is documented in the Permanent Rooms section later in this chapter. The default when omitted is to have no permanent chat rooms.
log.access=access.log log.error=error.log log.support=support.log log.public= log.private=
These properties define the names and locations of the VolanoChat
server log files. The property log.access defines the
server access log file, log.error defines the error log
file, log.support defines the file to contain support
information, log.public defines the public room access log
file, and log.private defines the private room access log
file. The format of the server, public, and private access logs can be
defined with format properties shown below. The default when a log
property is undefined or omitted is to disable the corresponding log
file.
format.date=
[dd/MMM/yyyy:HH:mm:ss z]
format.access=
{0} - - {1} "GET {2} HTTP/{3}" {4,number,0} {5,number,0} "{6}" "{7}" {8}
format.access.agent=
{0}/{1} API/{2} ({3}/{4} {5}) {6}
format.access.extra=
{0,number,0} {6}
format.public=
{0} {1,number,0} "{2}" "{3}" {4}
format.private=
{0} {1,number,0} "{2}" "{3}" {4} "{5}" {6}
format.status=
{0} {1} {2,number,0} {3,number,0} {4,number,0} {5,number,0} {6,number,0} {7,number,0} {8,number,0} {9,number,0}
format.status.memory=
{0,number,0}KB {1,number,0}KB {2,number,0%}
These properties define the message format templates of the server,
public, and private access log files, as well as the templates used by
the COM.volano.Status application to format status reports
from the server. The message formats allow the server administrator to
create log files for any log analysis program or for importing into any
spreadsheet program. The defaults are the message format templates shown
for each property above. See the Log Files
section later in this chapter for details on the message format
templates.
member.only=false member.access= member.name=
The VolanoChat server supports connectivity to member databases. If
member.only is set to false, members and
non-members can access the chat server. If true, only
members may access the VolanoChat server. The member.access
and member.name properties allow you to define Uniform
Resource Locators (URLs) for the scripts that access information in your
member database. The defaults are shown above, allowing access to
non-members and defining no database access scripts. See the
Member Database Support chapter for details
on the database interface.
|
|
Check HTML | Table of Contents |