ParaChat Server v4.5
ParaChat Room and User Creation Guide


Overview


  1. Using the Test Room As a Guide
  2. Creating A New ParaChat Group
  3. Creating A New ParaChat Room
  4. Admin User Creation
  5. Adding A Room To Your Web Page


Using the Test Room As a Guide

  • Use the sample HTML applet code that is found on the testroom.html page (..\ParaChat\ParaChat450\httpd\testroom.html) that comes with your server software as a foundation for creating new rooms
  • Here is the what the HTML applet code looks like for the #TestRoom that comes with your server software:
    <applet codebase=pchat/classes archive=pchat.zip code=ParaChat.class HEIGHT=400 WIDTH=600>
    <param name="ServerPort" value="7777">
    <param name="HTTPPort" value="7877">
    <param name="roam.Group" value="community">
    <param name="Channel" value="#TestRoom">
    <param name="roam.TopRooms" value="#TestRoom">
    <param name="ui.BgColor" value="CCCC99">
    <param name="net.Heartbeat" value="true">
    <param name="net.Protocol" value="true">
    If you see this message you do not have a Java
    enabled browser. Visit <a href="http://www.parachat.com/faq/java.html">
    ParaChat Support</a> for more information on how to upgrade your browser!
    </applet>

     
  • The sample HTML applet code uses the relative path to the server's class files (see codebase=pchat/classes).  If you are placing HTML applet code for new rooms on web pages that reside on a different host from where your ParaChat Server is running, than you will need to use the absolute path to the class files instead of the relative path.

    Example:  If your chat server host is called parachat.com, but you are placing HTML applet code on a page served by chatmadness.com, the absolute path to the ParaChat Server class files on parachat.com would be included as indicated in red below:

    <applet codebase="http://www.parachat.com:7877/pchat/classes" archive=pchat.zip code=ParaChat.class HEIGHT=400 WIDTH=600>
    <param name="ServerPort" value="7777">
    <param name="HTTPPort" value="7877">
    <param name="roam.Group" value="group">
    <param name="Channel" value="#TestRoom">
    <param name="roam.TopRooms" value="#TestRoom">
    <param name="ui.BgColor" value="CCCC99">
    <param name="net.Heartbeat" value="true">
    <param name="net.Protocol" value="true">
    If you see this message you do not have a Java
    enabled browser. Visit <a href="http://www.parachat.com/faq/java.html">
    ParaChat Support</a> for more information on how to upgrade your browser!
    </applet>

     
  • The sample above assumes that you are not using an external web server, and includes the default port number (7877) of the web server that comes with ParaChat Server.  If you include this port number in the absolute path to the class files, there is no need to include the parameter <param name="HTTPPort" value="7877">.
 HINT:  The net.Heartbeat parameter is not a required parameter, and can be completely removed.  When included, the HEARTBEAT parameter sends a pulse to the chat server every 5 minutes to keep even idle connections alive.  This parameter is ideal for moderated events when users tend to view the chat without submitting text themselves.  The default time-out for user connections to ParaChat Server is 10 minutes.  If you elect to remove the HEARTBEAT parameter, user connections that are idle for 10 minutes will be automatically severed.


Creating A New ParaChat Group


Log in to your ParaChat Server's Administration pages:

    http://<your-host-name>:7877/plynx/parachat/index.lhtml
    Start >>> Programs >>> ParaChat Server v4.5 >>> Admin Pages

Step 1. Enter the Server Admin name and password you selected during installation, and click the 'Sign In' button.

Step 2. You will arrive at the ParaChat Server Administration Main Menu (see image below).

Step 3. To start creating your chat community you will need to create your chat Group. Click on the group icon in the top navigation bar. You will be brought to the group admin page.

Enter the name of your new group into the 'Create New Group' text field and press the create button.

Step 4. After you are successful in creating a new group you will be brought to a page similar to this one.

In order to customize the setting in your new group, click on the edit <groupname> link.

There are 8 fields on the Group Settings page. A description of each field can be found below this screen shot:

1. Group Name:
The name of the Group that you created.

2. Topic:
Enter a standard default topic for rooms. The topic you enter here will appear each time a user logs into created chat rooms or dynamic (user created) chat rooms. You will have an opportunity to change this later and you can set each individual room with their own topic. You can also make changes to the topic from the ParaChat room itself using the GUI Admin Console or admin commands. This field is not required.

3. Rooms in Group:
This is a list of Rooms belonging to this Group and can only be modified by adding and deleting rooms.

4. Admin user(s):
Enter the user name(s) of the Room Admin user(s). You may enter multiple names here separated only by a comma. There is no need to place a comma and a space between Admin user names, just a comma. If you leave this field blank, only the Server Admin User will have admin powers in this group.

     HINT:  Room Admin user names should be password protected. If you list a user name(s) in this field, it is suggested that you create a User Profile for each user. If you do not create a User Profile for an Admin name, any person who logs into the chat room using that Admin name will have admin privileges in the room.

5. Allowed URLs:
ParaChat's unique URL enforcement system allows you to limit the way applet code for a particular room can be distributed onto other web pages on the Internet. By indicating the EXACT URL(s) where you wish your room HTML applet code to run, you may limit people from taking the code from your HTML page and running your chat room on their own web page without your permission. List all URLs where you wish to run your applet code in this field. There is no need to place a comma and a space between allowed URLs, just a comma.

     HINT:  It is important to note that users sometimes access domains without the www suffix before your domain name. Therefore, if your chat page is http://www.domain-name.com/chat.html, you may also wish to include http://domain-name.com/chat.html - without the www suffix -  as an allowed URL.  It is best to use the complete URL structure here, so be certain to include the http:// as well.  It is also important to note that if you designate an allowed URL as http://www.domain-name.com, for example, the server will permit the ParaChat room to run on any web page within that domain, and not just on a specific page within that domain.

6. Enforce URLs:
ParaChat Server will enforce the URLs you provide for each room in this group by either:

  • allow - allows all user connections regardless of URL
  • warn - warns users that a ParaChat room is running on a web page that is not allowed
  • deny - prevents a connection to the chat server from URLs not indicated as allowed

Users will still be able to connect with the URL enforcement set to both allow and warn. However, an Imposter Room server message will appear in the room if the Enforce URLs is set to warn, and a page is running on a disallowed web page.

     HINT:  The default URL enforcement for ParaChat Server is warn This configuration can be easily changed in the server configuration file (\ParaChat\ParaChat450\config\pchatd) to either allow or deny.  Each room that you create will always use the servers default URL enforcement.  You may configure the room to a URL enforcement setting other than the server default using this pull-down menu.

7. Profanity Filter:

  • True: text in rooms within this group will be filtered for profanity using the words in the profanity filter
  • False: text in rooms within this group will not be filtered for profanity

     HINT: ParaChat Server's profanity filter is pre-populated with a select listing of words. To edit, add, or delete words from the list, click the Server icon at the top of the Administration Pages, and select "Edit Language Filter / Profanity Filter"

8. Banned IPs:
You may manually add user IP addresses in this location that you wish to ban from all your chat rooms in this group. IP addresses should be separated by a comma only, and not a comma and a space. If you wish to remove an IP address that is on the list, simply highlight the IP address and delete it, remembering not to leave 2 commas separating any remaining IP addresses. You do not need to add data to this field during room creation.

     HINT: When an IP address appears on this list (i.e. 111.222.333.444), any user who attempts to access your ParaChat room from the IP address will be prevented from doing so. If a Class C IP address is banned (i.e. 111.222.333), any user whose IP address contains the Class C range will be prevented from entering. In extreme cases, you may also ban users from entire ISPs by adding the Class B range (i.e. 111.222) of an IP address, or even the Class A range (i.e. 111) of an IP address to your list of IP addresses. Be aware that you when you add the Class B and Class A ranges, you are preventing a great number of potential users from accessing your ParaChat room.
Here is an example of what your completed group settings might look like:


Creating A New ParaChat Room


Log in to your ParaChat Server's Administration pages:

    http://<your-host-name>:7877/plynx/parachat/index.lhtml
Step 1. Enter the Server Admin name and password you selected during installation, and click the 'Sign In' button.

Step 2. You will arrive at the ParaChat Server Administration Main Menu (see image below).

Step 3. To create a new room, enter the group in which you would like the room added to. Click on the Groups icon in the top navigation bar.

Step 4. If you click on 'See all the groups on this server' you will be shown a list of groups on your server.

Click on the group you would like to edit.

Step 5. To create a new room, enter the room name in the 'Add a Room to Group' field and select 'Add'.

     HINT:  ParaChat room names must begin with the "#" symbol to be recognized by the server. By default, the "#" symbol is auto-filled in the Add a Room to Group field.

Step 6. You will see that your room has been created. To complete this creation process, you must now customize your new room settings. To customize your new room, click on the new roomname link. In the example below you would click on 'Edit #Test_Room.'

Step 7. You will arrive at the Room Parameters page for the ParaChat room you are creating (see image below).

There are 9 input fields on the Room Parameters page.  A description of each follows:

1. Room Name:
This is the name of the room

2. Title:
For internal use only, and is not required.  The title you place here will appear along with the ParaChat room name on the "View currently active rooms" list that is linked from the Main Menu page.  It will not appear in the ParaChat Room itself

3. Topic:
Enter the topic or greeting for the chat room. The topic you enter here will appear each time a user logs into the chat room. You will have an opportunity to change this later, or from the ParaChat room itself using the GUI Admin Console or admin commands. This field is not required and will overwrite your Group Topic setting.

3. Admin user(s):
Enter the user name(s) of the Room Admin user. You may enter multiple names here separated only by a comma.  There is no need to place a comma and a space between Admin user names, just a comma.  If you leave this field blank, only the Server Admin User will have admin powers in this room.

     HINT:  Room Admin user names should be password protected. If you list a user name(s) in this field, it is suggested that you create a User Profile for each user. If you do not create a User Profile for an Admin name, any person who logs into the chat room using that Admin name will have admin privileges in the room. Instructions for creating User Profiles.

4. Banned IPs:
You may manually add user IP addresses in this location that you wish to ban from the chat room. User IP addresses that are banned by the Admin user from the chat room (via the GUI Admin Console, or using admin user commands) will appear in this list. IP addresses should be separated by a comma only, and not a comma and a space. If you wish to remove an IP address that is on the list, simply highlight the IP address and delete it, remembering not to leave 2 commas separating any remaining IP addresses. You do not need to add data to this field during room creation.

     HINT: When an IP address appears on this list (i.e. 111.222.333.444), any user who attempts to access your ParaChat room from the IP address will be prevented from doing so. If a Class C IP address is banned (i.e. 111.222.333), any user whose IP address contains the Class C range will be prevented from entering. In extreme cases, you may also ban users from entire ISPs by adding the Class B range (i.e. 111.222) of an IP address, or even the Class A range (i.e. 111) of an IP address to your list of IP addresses. Be aware that you when you add the Class B and Class A ranges, you are preventing a great number of potential users from accessing your ParaChat room.

5. Allowed URLs:
ParaChat's unique URL enforcement system allows you to limit the way applet code for a particular room can be distributed onto other web pages on the Internet.  By indicating the EXACT URL(s) where you wish your room HTML applet code to run, you may limit people from taking the code from your HTML and running your chat room on their own web page without your permission.  List all URLs where you wish to run your applet code in this field.

     HINT:  It is important to note that users sometimes access domains with out the www suffix before your domain name.  Therefore, if your chat page is http://www.domain-name.com/chat.html, you may also wish to include http://domain-name.com/chat.html - without the www suffix -  as an allowed URL.  It is best to use the complete URL structure here, so be certain to include the http:// as well.  It is also important to note that if you designate an allowed URL as http://www.domain-name.com, for example, the server will permit the ParaChat room to run on any web page within that domain, and not just on a specific page within that domain.

6. Enforce URLs:
ParaChat Server will enforce the URLs you provide for each room by either:

  • allow - allows all user connections regardless of URL
  • warn - warns users that a ParaChat room is running on a web page that is not allowed
  • deny - prevents a connection to the chat server from URLs not indicated as allowed

Users will still be able to connect with the URL enforcement set to both allow and warn. However, an Imposter Room server message will appear in the room if the Enforce URLs is set to warn, and a page is running on a disallowed web page.

     HINT:  The default URL enforcement for ParaChat Server is warn This configuration can be easily changed in the server configuration file (\ParaChat\ParaChat450\config\pchatd) to either allow or deny.  Each room that you create will always use the servers default URL enforcement.  You may configure the room to a URL enforcement setting other than the server default using this pull-down menu.

7. Profanity Filter:

  • True: text in rooms within this group will be filtered for profanity using the words in the profanity filter
  • False: text in rooms within this group will not be filtered for profanity

     HINT: ParaChat Server's profanity filter is pre-populated with a select listing of words. To edit, add, or delete words from the list, click the Server icon at the top of the Administration Pages, and select "Edit Language Filter / Profanity Filter"

8. Timestamp Every Message in Transcripts:
If you wish to enable a timestamp on every message written to a transcript, select true in the pull-down menu.

     HINT It is important to note that this feature operates independently of the timestamp feature in the chat window. You must set this value to true to add a timestamp to a chat transcript. Turning on the timestamp feature in your ParaChat room's Control Panel will not turn on a timestamp for your chat transcript.

9. Home URL:
For internal use only, and not required. Place the home domain name of the ParaChat room if applicable as a point of reference if the Allowed URLs reside on a different domain.


Admin User Creation

Log in to your ParaChat Server's Administration pages:

    http://<your-host-name>:7877/plynx/parachat/index.lhtml

Step 1. Enter the Server Admin name and password you selected during installation, and click the 'Sign In' button.

Step 2. You will arrive at the ParaChat Server Administration Main Menu (see image below).

Step 3. The User Admin Page will allow you to:

  • Edit User
  • Create New User
  • Delete User

Step 4. Create a new user.

Step 5. You can edit the following data for your room admin account:

    Email:
    First Name:
    Last Name:
    Password:
    Verify Password:
    On Connect Commands
    Max Idle Time

OnConnect Options:

OnConnect settings are options for individual users when they log into the room. These settings are only enabled for the user it is set for and not for the entire room. OnConnect Options are a list of semi-colon separated commands that need to start with a % sign. Please see the image above.

  • admin - launches the admin console after you log in
  • help - displays a list of help commands
  • chat fgcolor [<color>] - changes your main chat window font color
  • chat bgcolor [<color>] - changes your main chat window background color
  • chat fontsize [<integer>] - changes your fontsize
  • beep play <sound name>.au - ads a sound when you enter the room
  • chat float [on|off] - floats the chat room
  • chat nl [on|off] - adds a line between each submitted chat line

How To Create New Room Applet Code


We highly recommend using our Customization Tool to generate your new room code. However, the following is an example on how to create new room applet code from your current ParaChat Pro Room code.

    Current "room1" code:

      <!-- Begin ParaChat v4.5 Applet Code -->
      <applet codebase="http://www.parachat.com:7877/pchat/classes" archive=pchat.zip code=ParaChat.class HEIGHT=400 WIDTH=600>
      <param name="ServerPort" value="7777">
      <param name="HTTPPort" value="7877">
      <param name="roam.Group" value="group">
      <param name="Channel" value="#Test_Room">
      <param name="roam.TopRooms" value="#Test_Room">
      Sorry, but your browser is not Java enabled, and you will not be able to chat
      </applet>
      <!-- End ParaChat v4.5 Applet Code -->

If you created a new room called room2 you would need to change the following value:
    <param name="Channel" value="#room2">
You would also need to add this room to the Top Rooms list in both your old and new room code. Thisnippetit of code 'param name="roam.TopRooms"' forces your admin created rooms to the top of the rooms list.


This is what your new code for both rooms should look like at the end of the process. The values that have been modified are highlighted in red.

Original - room1

    <!-- Begin ParaChat v4.5 Applet Code -->
    <applet codebase="http://www.parachat.com:7877/pchat/classes" archive=pchat.zip code=ParaChat.class HEIGHT=400 WIDTH=600>
    <param name="ServerPort" value="7777">
    <param name="HTTPPort" value="7877">
    <param name="roam.Group" value="group">
    <param name="Channel" value="#Test_Room">
    <param name="roam.TopRooms" value="#Test_Room,#room2">
    Sorry, but your browser is not Java enabled, and you will not be able to chat
    </applet>
    <!-- End ParaChat v4.5 Applet Code -->

Newly Created - room2

    <!-- Begin ParaChat v4.5 Applet Code -->
    <applet codebase="http://www.parachat.com:7877/pchat/classes" archive=pchat.zip code=ParaChat.class HEIGHT=400 WIDTH=600>
    <param name="ServerPort" value="7777">
    <param name="HTTPPort" value="7877">
    <param name="roam.Group" value="group">
    <param name="Channel" value="#room2">
    <param name="roam.TopRooms" value="#Test_Room,#room2">
    Sorry, but your browser is not Java enabled, and you will not be able to chat
    </applet>
    <!-- End ParaChat v4.5 Applet Code -->

Home | Hosting | Server | Features | Samples | Chat Now | Web Tools | Help | Affiliate

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