Server Configuration - #roomname.profile

Home >>> Server Configuration >>> #roomname.profile


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\ParaChat570\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:
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 Allowed Values:
true or 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 Allowed 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 Allowed Values:
open or close
Closes a room and displays a message giving the reason channel.close_reason Example:
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

Allowed Values:
true or false

Password for the room. channel.password Example:
channel.password=ready123
Room admins are not required
to enter a room password to gain
access to a room.
Message displayed when an unauthorized user attempts to enter a password-protected room passwd.failmsg Example:
Please register before entering the chat room.
Name of log file where transcripts are written.

More information

channel.logfile Example:
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:
201.234.345,233.234.555.2
Comma-separated list
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:
201.234.345,233.234.555.2
Comma-separated list
Determines whether room is moderated or not

More information

channel.moderate.state Allowed Values:
true or false
List of moderators in the room

More information

channel.moderate.moderators Example:
Mark,Laura
Comma-separated list of usernames
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
Show user names in the User List during a moderated event channel.ShowModeratedChatters Default:
true

Allowed Values:
true or false

Enable the ability to have private messages sent between roaming rooms channel.allow_remote_privmsg Default:
true

Allowed Values:
true or false

Enable the ability to have private messages within a room channel.allowprivate Default:
true

Allowed Values:
true or false

Created Group name if this room is part of a group. Note this room name has to be also listed in a group profile to be part of a group.(cross-reference) channel.group Allowed Values:
created Group name
Enable logging private chat in transcripts channel.transcripts.LogPrivate Default:
false

Allowed Values:
true or false

Logging timestamp in transcripts channel.transcripts.Timestamp Default:
false

Allowed Values:
true or false

Max number of active questions in a moderated event channel.moderate.MaxQuestions Default:
15,000

Allowed Values:
Integer

When this number is reached, new questions will be dropped.

The number of new questions before server sends a notification to a moderator logged in from an applet channel.moderate.NotifyInterval Allowed Values:
Integer (default=10)
Rotates transcript file when it is full channel.transcripts.Rotation Allowed Values:
true or false
Whether to allow overflow rooms. Roaming must be turned on for this to take effect channel.AllowOverflow Allowed Values:
true or false
Displayed when a room is protected by a password and a user entered a wrong password. channel.msg.RoomPasswordFailed Allowed Values:
text message
Whether to enable text ads channel.ad.Active Allowed Values:
true or false
Frequency of ads in minutes channel.RefreshMinutes Allowed Values:
integer (default is 5 mins)
First line of the text ad channel.ad.Text1 Allowed Values:
text (default is blank)
Second line of the text ad channel.ad.Text2 Allowed Values:
text
Third line of the text ad channel.ad.Text3 Allowed Values:
text (default is blank)

Examples

This is the room profile for the TestRoom (File #TestRoom.profile)

#Channel Settings in #TestRoom.profile
#Wed Feb 12 23:17:47 PST 2003

channel.title=The Test Room
channel.creator_url=http://www.parachat.com
channel.banned_ip=
channel.private=false
channel.enforce_url=allow
channel.admins=admin
channel.group=community
passwd.required=false
passwd.failmsg="Sorry, this room requires a password."
channel.topic=This is a room for testing ONLY
channel.profanityfilter=

This is a members Only room called PRIVATE (File #PRIVATE.profile)

#Channel Settings for #PRIVATE
#Fri July 09 04:38:12 PDT 2002
#channel.enforce_url=deny
channel.enforce_url=warn
channel.topic=Private channel for invited discussions
channel.creator_url=http://www.mydomain.com/
passwd.required=true


©1996 - 2006   M Square, Inc. |  Privacy Policy