Room Configuration (#roomname.profile)
Each ParaChat room (also known as a "channel") that you create on your ParaChat Server has its own room profile that
contains the configuration information for the chat room. Room profiles are located in the "rooms" directory
(...\ParaChat\ParaChat400\rooms\#roomname.profile) of your ParaChat Server. A room profile is automatically created in the
"rooms" directory when you create new ParaChat rooms. All chat room names begin with a pound sign (#). For example, a chat
room called "JustTalk" is defined by the parameters in the file '#JustTalk.profile'. In some cases, data is automatically
written to the room profile from the administrator's console (i.e. topic, moderation features, room password, etc.) and
there is no requirement that you edit the room profile to implement these features. Chat room attributes are simply stored
in their corresponding room profile. Below is a listing of important room configuration parameters, and their function.
Room profile files are simple text files that can be edited using a text editor. Please note that any change to a room
profile requires that the information cached in the chat server be cleared before the changes take effect. To "reread" the
most current room profile configuration, simply log into the chat room that you edited using your admin name and password,
and then type the following command: /room reread
Feature |
Configuration parameter |
Defaults / Values / Examples |
|
URL for the Web page containing the chat room |
channel.creator_url |
Use full path name to chat page or to the document root of Web site containing the room |
|
Maximum number of users for the room |
channel.max_sessions |
Default:
channel.max_sessions=25 |
|
Chat room name |
channel.name |
Example:
channel.name=#partychat |
|
Topic of the room |
channel.topic |
Example:
channel.topic=Welcome to my chat room! |
|
Profanity Filter |
channel.profanityfilter |
Example:
channel.profanityfilter=true
channel.profanityfilter=false |
|
Action taken if URL of entering Web page does not match the creator URL in the room configuration file.
(Can be set on a per-room basis.) |
channel.enforce_url |
Values:
channel.enforce_url=warn
Issues warning message but allows entry to room.
channel.enforce_url=allow
Allows any URL without warning.
channel.enforce_url=deny
Denies entry to room if URL does not match creator URL.
|
|
Admins for the room. |
channel.admins |
Example:
channel.admins=Ann,Clay
Comma-separated list of usernames with admin privileges to the room. |
|
Closes or opens a room |
channel.state |
Values:
channel.state=open
channel.state=close |
|
Closes a room and displays a message giving the reason |
channel.close_reason |
Example:
channel.close_reason=The room is closed and will reopen at 8:00pm |
|
Password required for the chat room. If set to true then only users with valid
user profiles,i.e accounts can enter the chat room. Example: in a members-only room |
passwd.required |
Default: false
passwd.required=false
Values:
passwd.required=true
passwd.required=false |
|
Password for the room. |
channel.password |
Example:
channel.password=ready123
Room admins do not require a room password. |
|
Message displayed when an unauthorized user attempts to enter a password-protected room |
passwd.failmsg |
Example:
passwd.failmsg=Please register before entering the chat room. |
|
Name of log file where transcripts are written. More information |
channel.logfile |
Example:
channel.logfile=session.log |
|
Comma-separated list of IP address prefixes to be banned.
If defined, client must be from allowed_ip list AND NOT IN banned_ip list. |
channel.banned_ip |
Example:
channel.banned_ip=201.234.345,233.234.555.2 |
|
Comma-separated list of IP address prefixes to allow client connections from.
If defined, client must be from allowed_ip list AND NOT IN banned_ip list. |
channel.allowed_ip |
Example:
channel.allowed_ip=201.234.345,233.234.555.2 |
|
Determines whether room is moderated or not.
More information |
channel.moderate.state |
Values:
channel.moderate.state=false
channel.moderate.state=true |
|
List of moderators in the room
More information |
channel.moderate.moderators |
Example:
channel.moderate.moderators=Mark,Laura |
|
List of speakers in the room
More information |
channel.moderate.speakers |
Example:
channel.moderate.speakers=Bob,Danae
Comma-separated list of usernames |
|
Maximum length (in bytes) allowed for transcript file. |
channel.max_transcript_length |
Example:
channel.max_transcript_length=4000000
means max is 4M bytes per transcript file |
|
Determines who will respond to a %page command from a user. |
channel.page.target |
Example:
channel.page.target=Bob
auto - Any room admin logged in responds |
