NestChat Help Document

1.Introduction
2.Installation
3.Management
3.1 User
   3.1.1 Administrator
   3.1.2 Global Users
   3.1.3 Ban Users
3.2 Room
   3.2.1 Set Room
   3.2.2 Moderator
3.3 System
   3.3.1 Privilege
      3.3.1.1 Users
      3.3.1.2 Chars
      3.3.1.3 Functions
      3.3.1.4 User Status
   3.3.2 Display
   3.3.3 Message
      3.3.3.1 Parameters
      3.3.3.2 Records
      3.3.3.3 Filter Words
   3.3.4 Settings
   3.3.5 Links
3.4 Resource
   3.4.1 Logo
   3.4.2 Background / Wallpaper
   3.4.3 Cartoon
   3.4.4 Advertisement
   3.4.5 Language
3.5 Function
   3.5.1 Audio & Video
      3.5.1.1 FMS
      3.5.1.2 Audio
      3.5.1.3 Video
   3.5.2 Media Play
   3.5.3 Transfer File
3.6 Message
   3.6.1 Room Message
   3.6.2 History Message
   3.6.3 Export Message

1. Introduction

NestChat is a video web chat, which is a system that allows users to communicate in real time using easily accessible web interfaces. It is a kind of internet online chat distinguished by its simplicity and accessibility to users who do not wish to take the time to install and learn to use specialized chat software. This trait allows users instantaneous access and only a web browser is required to chat.

 

NestChat is developed by the popular Adobe Flash technology. It's light and can be embedded into your website easily. It supports most mainly features of IM software including audio/video chat, private chat, file transfer and media player. It can be used widely in many fields such as entertainment, e-commerce, net meeting, e-learning etc.

 

2. Installation

Register to be a member of NestChat, then you will get some HTML or Javascript codes, copy either HTML or Javascript code to your webpage, browse your webpage and the chat will be there.

 

Browse http://www.nestchat.com, then do it step by step below,

Figure 2-1 Register to NestChat

Figure 2-2 Get Your Code

 

Figure 2-3 Embed to Your Webpage

 

3. Management

You can set or manage your chat by NestChat Console. There are several places to access NestChat Console.

1)You can visit directly to http://www.nestchat.com/nc/console.html
2)You can click "CONSOLE DEMO" link in the webpage http://www.nestchat.com/demo
3)You can click "Manage all rooms" link in the webpage http://www.nestchat.com/room/myroom

 

Please enter the console with the account what you have registered to NestChat and you will see the interface with screenshot below,

Figure 3-1 NestChat Console Interface

There are six folders on the left tree: User, Room, System, Resource, Function and Message, click the arrow icon to expand the folders and you can see more sub-items and set each of them.

 

3.1 User

Please set your account, global users and ban users here.

Figure 3-2 User: Administrator, Global Users and Ban Users

 

3.1.1 Administrator

You are the administrator of the chat room what you have applied. And you can change your account both USER NAME and PASSWORD here for security reason.

 

Note: Do not change them just for test, do not change them frequently. Once you have changed them, please remember the new account in your mind. Many people couldn't access NestChat Console again after they changed this account mostly caused by new account lost.

 

3.1.2 Global Users

NestChat divides users to be non-managers and managers. The non-manager users are guests and members while the manager users are room moderators, room owners and room administrators. You can set one manager user only to one room, or to all your chat rooms. Please set the moderators only to one room by "Room" -> "Moderator". With "Global Users" here, you can set the managers to all of the chat room one time.

 

Figure 3-3 Global Users

You can ADD, MODIFY, DELETE a global user with both his/her user name and level. The global user list on the left side will refresh after you succeed to set a global user.

 

Note: Please set the global user with his/her user name, not with his/her nick name. The user's nick name changes at any time and it can not be available to identify user in the chat room, so you can not set nick name here, it's same to other places.

 

3.1.3 Ban Users

You can ban some users if you want to prevent them from accessing your chat room. The users can be banned with either user name or user IP. To members, you can ban them with user name, while to guests you should ban them with their IPs because they have no user name to the chat room.

1) Ban Users: You can add, modify and delete a banned user. Please ban user with user name, NOT with nick name.

2) Ban IPs: You can add, modify and delete a banned IP. You can ban single IP or a section of IPs.

3) Search: Search log can help you to get more details to ban user or IP. You can search log by either username or IP.

Figure 3-4 Ban Users

 

3.2 Room

Please set chat room and room moderators here.

 

3.2.1 Set Room

You can add, delete and modify a chat room here.

1) room name: set the name or title of your chat room, do not type special characters.

2) user number: set the maximum user number to your chat room. The free version is limited to be less 50 users.

3) description: set the description to your chat room and give a short introduction to your visitors. Do not type the description over 200 characters.

4) member only: set this room only public to members and guests will be prevented from accessing.

5) protected password: set this room to be protected room with a room password and your visitors need to input the room password to enter it.

6) room logo file: set the room logo or picture and it will be displayed on the chat room panel.

 

3.2.2 Moderator

Select a room from the left room list, then add or delete a moderator to the selected room. If you want to set the moderator to all of your chat rooms, please set them by "Users" -> "Global Users".

Note: You need set the moderators with their user name, do no with nick name.

 

3.3 System

Please set the system privilege, display, message, settings and links here.

 

3.3.1 Privilege

Set all the system privileges to your chat.

 

3.3.1.1 Users

Set the privileges what is allowed to users or managers.

1) guest allowed: allow guest to access your chat or not.

2) register allowed: allow users to register in your chat or not.

3) view ip allowed: allow managers to view users' ip information or not.

4) block user on: allow managers to block users or not.

5) ban user on: allow managers to ban user or not.

6) kick user on: allow managers to kick user or not.

User kicked time(min): set the time how long the kicked user can re-enter the chat room after he/she is kicked by managers. The unit for the time is minute.

7) quit system automatically: turn on/off the automatic quitting chat room function, the user will be obliged to quit the chat if he/she never type a message when it's turned on.

Idle time to quit(min): set the time how long the user will be obliged to quit the chat if he/she is always idle in the chat. The unit for the time is minute.

 

3.3.1.2 Chars

Set the maximum characters length to some important parameters.

1) username's max char number: the maximum characters length to the user name when users register to the chat.

2) password's max char number: the maximum characters length to the password when users register to the chat.

3) nickname's max char number: the maximum characters length to the nick name when users register to the chat or change them in the chat.

4) signature's max char number: the maximum characters length to the users' signature when users set or change them in the chat.

5) email's max char number: the maximum characters length to the users' email when users set or change them in the chat.

 

3.3.1.3 Functions

Turn on/off all the functions in the chat room.

1) whisper on: allow user "says to" and "whisper" or not. There are three talking messages in the chat: "says to", "whisper" and "private chat". The "says to " messages can be viewed by all other users in the chat; the "whisper" messages can be viewed only by the receiving user; and the "private chat" message can be viewed only by the receiving user in the private message panel.

2) private chat on: allow user private chatting or not.

3) audio video on: allow user audio video chatting or not.

4) media play on: allow user to play media files or not.

5) transfer file on: allow user to transfer files or not.

6) view history on: allow user to view the history message in the chat or not.

7) settings on: allow user to do some settings by the settings panel or not.

8) apply room on: allow user to apply a new room in the chat or not.

9) set room on: allow room owner to set his/her room in the chat or not.

10) admin console on: allow room administrator to click the console link in the chat or not.

11) change nickname on: allow user to change his/her nick name in the chat or not.

12) change profile on: allow user to change his/her profile in the chat or not.

13) custom avatar on: allow user to upload and use his/her own photo to be an avatar in the chat or not.

14) client cache on: allow user to save his/her own settings on his/her computer or not, the chat will remember the user's personal settings such as text, wallpaper and others if it's turned on.

15) typing on: turn on/off the typing hint to users.

 

3.3.1.4 User Status

There are four kind of user status: online, busy, away and invisible. Users can set their own status in the chat room at any time.

 

 

1) user status on: turn on/off user status in the chat.

2) online: show or hide "online" option on the user status list, select user level from the right combo box, all other high level users will get this status at the same time, for example, if you select "guest" to be "online" option, all other high level users including member, moderator, owner and administrator can also have this "online" status on their status list.

3) busy: show or hide "busy" option on the user status list.

4) away: show or hide "away" option on the user status list.

5) invisible: show or hide "invisible" option on the user status list. You had better to set this "invisible" option only to managers.

 

3.3.2 Display

You can show or hide some buttons on the three panels: tool, input and profile panel. It has been marked on the screenshots below.

 

 

3.3.3 Message

Please set the message parameters, records and filter words here.

 

3.3.3.1 Parameters

Set some parameters to chat messages.

1) room's cache message number: the maximum number of cache message, these cache messages will be showed to users when they enter the chat room firstly.

2) input message's max char number: the maximum characters length when users type message on the input panel.

3) input message's max line number: the maximum lines length when users type message on the input panel.

4) output message's interval time(ms): the minimum interval time between user type two messages, with this parameter, you can prevent users from flooding in the chat room.

 

3.3.3.2 Records

Users can view the history message in their chat client. As an administrator, you can set the client message records here.

1) client saves public message: save public message to client and users can view it on the history panel

2) client saves private message: save private message to the client and users can view it on the history panel

3) client history message size(KB): set the maximum history message size which can be saved on the client.

 

3.3.3.3 Filter Words

You can set some words to be filtered to a message. There are some dirty or illegal words in the messages and with filter words function, these words will be replaced with "*" character.

Please add, modify and delete a filter word here.

 

3.3.4 Settings

This is to set the parameters on the preferences panel in the chat. Users can also set them by themselves on the preferences panel after you have set them here. You have only set the initialized parameters for your users.

 

 

3.3.5 Links

You can set "apply room" link and "admin console" link here to the chat.

 

 

 

3.4 Resource

Please set the chat logo, background, cartoon, advertisement and language here.

 

 

3.4.1 Logo

Set the logo link url, then upload a picture or flash swf file, and the logo will be displayed at bottom-left side in the chat.

 

3.4.2 Background / Wallpaper

You can add, delete and modify a background. Select a background picture from the background list, then modify its name or delete it. To add a new background, please upload a picture and set its name.

 

3.4.3 Cartoon

You can add, delete and modify a flash cartoon. Select a flash cartoon from the cartoon list, then modify its name or delete it. To add a new flash cartoon, please upload one and set its name.

 

3.4.4 Advertisement

There are two kinds of advertisement: image ones and text ones. The image advertisement displays at the top-right side in the chat while the text advertisement displays under the input field.

1) Image Advertisement: upload a picture or flash swf file and set its link.

2) Text Advertisement: you can add or edit the text advertisement, please set the text and its link. You can also set the interval time to the text advertisements to roll them.

Note: The text advertisement can not be set for the free version.

 

3.4.5 Language

Select an item from "current language", set it as the default language or not, then set the "value" to each "variable", submit them at last.
Note:
1. Do not modify the upper case words with % blanketed, for example, "Failed to block %USER%", don't change "%USER%" to your own language.
2. If you can't select your language from the "current language", please select it with "Other/unknown" as your default language.

 

3.5 Function

Set audio & video, media play and file transfer functions here.

 

3.5.1 Audio & Video

Set all video chatting parameters here.

3.5.1.1 FMS

It's the settings to flash media server.

1) FMS uri: a rtmp address connecting to a video server

2) FMS port: port connecting to a video server, the default value is "1935".

3) AV bandwidth(B/s): the maximum audio/video bandwidth same to video publisher and video receiver with the unit Byte per second. The suggested value is 12KB/s.

4) reconnect number: the maximum number of reconnecting to FMS, it will be disconnected after reconnecting is failed over this number.

Note:

1. The FMS settings can not be set to the free version.

2. The unit of AV bandwidth is Byte per second, not bit per second(1Byte = 8bits).

 

3.5.1.2 Audio

Set all audio parameters here.

1) echo loss on: tick it to decrease the echo feedback from speaker to microphone.

2) microphone loopback on: tick it to send the sound from microphone to the local speaker. Turn off it to be default value.

3) audio rate: select the sample rate to audio.

4) volume gain: set the gain to the volume. The value of 50 is the original volume, set it to be less 50 to reduce the volume, over 50 to amplify it.

5) silence level: it will not publish audio when the activity of microphone is less the silence level.

 

3.5.1.3 Video

Set all video parameters here.

1) video compress on: tick it to compress the video data, it can transfer more video data by its compression while it will also cost more time to compress and uncompress data. Turn off it to be the default value.

2) video capture width(px): set the width value in pixels when web camera captures video snapshot.

3) video capture height(px): set the height value in pixels when web camera captures video snapshot.

4) frame frequency(fps): set the maximum frame frequency value in frames per second when web camera captures video snapshot. The default value is 15.

5) key frame interval: set the interval frames between web camera captures two key frames. The default value is 15.

6) video quality: set the image quality to each frame when web camera captures video snapshot. The value 1 is the worst quality while 100 is the best quality. Please set it to 0 and the video quality will auto-adjust according to the "AV bandwidth" which has been set in "FMS". The default value is 0.

 

3.5.2 Media Play

It only supports mp3 and flv media files. Please upload the media files and set their name. You can also delete or modify them here.

 

3.5.3 Transfer File

Set file transfer parameters here.

1) upload file url: set this url to upload a transferred file, please do not change it if it's a free version or hosting version.

2) download file url: set this url to download a transferred file, please let it to be empty if it's a free version or hosting version.

3) forbidden file type: set the file types which are forbidden to be transferred, you can forbid users to transfer the files such as exe, php, sql files. Separate the file types by comma, do not leave any space character here.

4) max file size(MB): set the maximum file size to transfer.

 

3.6 Message

Please monitor the message in the current room, search and view the history message and export history message here.

 

3.6.1 Room Message

Select a room from the "monitor room" and you can view all the messages including public, whisper and private message here.

 

3.6.2 History Message

Search and view the history message here.

1) begin time: the begin date that you want to search

2) end time: the end date that you want to search

3) user: the messages talked or received by the user who you want to search

4) key words: search the history messages with the key words what you want

5) room: search the messages in the selected room

6) message type: search the messages with the selected message type

 

3.6.3 Export Message

Select a date and export the history messages to this date. The exported files are zipped txt files.