![]() ![]() ![]() ![]() |
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 configuration files, you must restart the VolanoChat server for the changes to take effect.
Each of the VolanoChat server properties is explained below, showing the default values defined in the sample properties file included in your download. You can let a property take on its default value by commenting out its definition, like this:
# server.port=8000
For file path names you should specify the path in Web notation using a forward slash ("/"
) for the path separator. There can be no spaces on either side of the equal sign when defining the property values.
applet.codebase=webapps/ROOT/vcclient
server.host=
0.0.0.0
"wildcard" server socket address such that it will open the chat server socket on all TCP/IP interfaces on the machine when the server.host
server property is either undefined, empty, or has a value of 0.0.0.0
, as in the following three examples:
# server.host= # Value is undefined (commented out) server.host= # Value is the empty string server.host=0.0.0.0 # Value is a zero IPv4 addressWhen using server sockets of this type on multihomed hosts (such as those using IP-based virtual hosts for Web hosting), the primary IP address of the system must be the addresses found in the VolanoChat license key file. The primary IP address is the one that is returned when looking up the address of the system's host name, such as with the command
host `hostname`
on Linux.server.port=8000
server.port
property value. The default is port 8000.server.password=
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.client.authentication=true
page.java.version=
page specified in your client applet properties file.duplicate.addresses=true
admin.client.host=127.0.0.1
COM.volano.Status
and COM.volano.Shutdown
programs can be executed against this VolanoChat server. The default is the IP address of the localhost, meaning the status and shutdown programs must be run on the same machine as the VolanoChat server itself.admin.port=8001
admin.password=
COM.volano.Status
and COM.volano.Shutdown
applications. The default is no password, which allows no administrative connections.status.interval=60
COM.volano.Status
application. The default is 60 seconds.server.backlog=50
server.limit=0
server.timeout=10
server.verbose=false
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.trace=false
true
, the Java class name of each object serialized across each client network connection is written to standard output. The default value is false
.address.broadcast=false
false
prevents the address information from being sent to anyone except VolanoChat monitors and administrators. A value of true
sends each visitor's IP address to all other visitors. The VolanoChat applet properties text.status.profile
and text.status.noprofile
determine whether VolanoChat applets display the address information along with the profile text when it is received from the server. The default value of the property prevents people from obtaining IP addresses using TCP/IP trace tools or non-Volano clients.script.timeout=10
script.trace=false
true
, each HTTP request and response is written to standard output and can be used to debug problems with your membership access. The default value is false
.server.nothreadgroups=false
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.room.limit=25
room.nodynamic=false
true
, this property will completely prevent any dynamic rooms from being created since the referrer-based access control can be defeated by imposter VolanoChat applets. The default value is false
.room.sweep.interval=15
username.matchcase=true
length.chattext=200
length.profile=200
length.roomname=100
length.username=20
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.More information on the Apache Tomcat Servlet Runner can be found here:
http://jakarta.apache.org/tomcat/tomcat-4.0-doc/config/http11.html
servlet.port=8080
servlet.port=-1
.servlet.minprocessors=5
servlet.maxprocessors=20
Any delay will happen after the specified request is received by the server, and will delay the processing of any type of request from the same client. A more detailed explanation of flood control can be found on the [8.2] Flood Control Feature page.
delay.access=0
delay.authenticate=0
delay.beep=1000
delay.chat=1000
delay.enter.private=1000
delay.enter.room=1000
delay.exit.private=0
delay.exit.room=0
delay.kick=0
delay.ping=0
delay.room.list=0
delay.user.list=0
A more detailed explanation of DNS Blacklisting can be found on the [8.4] DNS Blacklist Feature page.
dnslist.denied=
dnslist.dynamic=
ban.static.duration=1440
ban.dynamic.duration=60
ban.netblock.duration=60
ban.netblock.ipv4mask=255.255.0.0
server.key=conf/key.txt
server.rooms=conf/rooms.txt
access.hosts.allow=conf/hosts-allow.txt
access.hosts.deny=conf/hosts-deny.txt
access.referrers.allow=conf/referrers-allow.txt
access.referrers.deny=conf/referrers-deny.txt
These properties define the names and locations of the VolanoChat server log files. More detailed information on Log Files and Rotation can be found in our [5.4] Log Files Feature section. The default when a log property is undefined or omitted is to disable the corresponding log file.
log.directory=logs
log.access.prefix=access-
log.access.suffix=.log
log.error.prefix=error-
log.error.suffix=.log
log.public.prefix=
log.public.suffix=.log
log.private.prefix=
log.private.suffix=.log
log.banned.prefix=banned-
log.banned.suffix=.log
log.servlet.prefix=servlet-
log.servlet.suffix=.log
log.http.prefix=http-
log.http.suffix=.log
log.velocity.prefix=velocity-
log.velocity.suffix=.log
log.support=logs/support.log
log.chat.public.dir=webapps/ROOT
log.chat.public.suffix=.html
log.chat.private=
log.chat.public.dir
defines the directory where each of the public room chat transcription files are stored, with the file name equal to the room name followed by the suffix defined by the log.chat.public.suffix
property value. The default location is the webapps/ROOT
directory located under the VolanoChat server installation directory, and the default suffix is .html
. This will allow you to use the internal HTTP server to pull the files. If you're going to make the files available on your website, you should set this value to a directory that resides within your public HTML structure and use your own webserver to serve the pages. The property log.chat.private
defines the name of the single file containing the chat messages from all private rooms. Omitting a public message log directory location or a private message log file name disables the message logging. Message logging may also be enabled or disabled through the room transcription properties below.transcribe.room.permanent=false
transcribe.room.dynamic=false
transcribe.room.event=false
transcribe.room.private=false
true
and disabled when set to false
. The default value for each property is false
. The properties for permanent, dynamic, and event chat rooms control the logging of public messages into the directory defined by log.chat.public.dir
. The property for private chat rooms controls the logging of private chat messages into the file defined by log.chat.private
. Permanent public rooms are those listed in the rooms.txt
file by default. Dynamic public rooms are those created by access through VolanoChat applets defining the group
applet parameter, and event rooms are auditoriums created for moderated events.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.banned=
{1}\={2,choice,0\#Static|1\#Dynamic|2\#Netblock} address banned at {0} as {4} in {3} by {5}
format.status=
{0} {1} {2} {3,number,0} {4,number,0} {5,number,0} {6,number,0} {7,number,0} {8,number,0}
format.status.memory=
{0,number,0}KB/{1,number,0}KB {2,number,0%}
format.status.resources=
{0,number,0} {1,number,0} ({2,number,0})
These properties define the message format templates of the server, public, and private access log files, and the banned host log. They also define 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 [5.6] Report Formats section later in this chapter for details on the message format templates.
format.chat.public=
{3,date,[dd/MMM/yyyy:HH:mm:ss]} <b><{0}></b> {2}<br>
format.chat.private=
{3,date,[dd/MMM/yyyy:HH:mm:ss]} <b><{0} -> {1}></b> {2}<br>
These properties define the format for logging public and private chat messages, where {0} is the name of the sender, {1} is the name of the receiver, and {2} is the chat message text. You can add the variable {3} as a formatted time stamp, such as {3,date,[dd/MMM/yyyy:HH:mm:ss]}. With the default definitions above, public chat messages are saved like the following two examples:
[27/November/2002:14:42:22] <John> Hi there! [27/November/2002:14:42:30] <Mark> Hi, John. What's up?
and private chat messages are saved like the following:
[27/November/2002:14:42:22] <John -> Mark> What's up? [27/November/2002:14:42:30] <Mark -> John> Not much here. And you?
member.version=
member.only=false
member.access=
member.name=
member.version
is set to 2.1
, the new interface for VolanoChat 2.1 is used instead of the older VolanoChat 2.0 member script interface. 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, using the older version 2.0 interface, allowing access to non-members, and defining no database access scripts. See the [5.7] Member Database Support chapter for details on the database interface.member.monitor.matchcase=false
member.monitor.multiuse=false
member.monitors=
member.monitors
. For example, if your member-monitors are Matt and Jane, you could create a file called monitors.txt
containing the following:matt jane
conf
directory (where the properties.txt
file is located), and then specify:member.monitors=monitors.txt
member.monitor.matchcase
determines whether to match the case of the member names when looking up member-monitors in the list. The default value is false
, in which case both the requested member name and the list are converted to lower case characters before comparing their values. Otherwise, the names are matched in a case-sensitive manner when true
.member.monitor.multiuse
determines whether there can be more than one connection with the same member-monitor name in the VolanoChatPro server. When set to true
, the property allows more than one person with the same member name to be signed into the server as a monitor at the same time. The default value is false
, which disconnects any other person using the same member-monitor name when a member signs in as a monitor.auditoriums.permanent=false
true
causes all event auditoriums to remain in the server until it is stopped. A value of false
allows the event auditorium to be removed from the server once all the guests and moderators on stage have left the room.entrance.stage=
event.callback.prefix=
The VolanoChat server properties file gives the location of four access control files:
and the list of permanent rooms (defined by server.rooms
).
In addition, it specifies the location of as many as eleven sets of optional log files:
log.access.*
),log.error.*
),log.support
),log.public.*
),log.private.*
),log.banned.*
),log.servlet.*
),log.http
),log.velocity.*
and not currently used),log.chat.public.*
), andlog.chat.private
).You may specify absolute or relative paths to these secondary files and directories. If the file paths are not absolute, they are assumed to be relative to the VolanoChat server base directory (default installation directory).
![]() ![]() ![]() ![]() |
XHTML 1.0 | Table of Contents |