modules/phpfreechat/INSTALL.txt

// $Id:

phpFreeChat module

This module adds free, simple, fast and customizable chat to your Drupal site, using the open source phpFreeChat

Requirements
------------

* phpFreeChat 1.0 final 
	Later versions may work, but haven't been tested
	Earlier versions will not work!
  
Installation
------------

1.  Extract and the phpFreeChat module with all its files to:
    * modules/phpfreechat or
    * sites/[yoursite]/modules/phpfreechat
    on your web server.

2.  Download phpFreeChat from http://www.phpfreechat.net/
	or http://sourceforge.net/project/showfiles.php?group_id=158880
    
3.  Extract phpFreeChat with all its files to a folder named phpfreechat in the same folder you put this module in,
    for example:
    * modules/phpfreechat/phpfreechat or
    * sites/[yoursite]/modules/phpfreechat/phpfreechat
    on your web server. You do not need to follow the instructions from the phpFreeChat INSTALL file - the module handles all the configuration and creation of chats.

4.  Enable the phpFreeChat module in administer >> modules

5.  Configure phpFreeChat access rights in administer >> access rights

6.	Check the module settings in 
	administer >> settings >> phpfreechat.
	Note, that almost all the settings should work fine left at their defaults. Changing some settings (especially advanced settings) could stop phpFreeChat functioning. Only change these if you know what you are doing!

7.  You must then enable one or more node types to be used with phpFreeChat. You can do this by going to administer >> content >> configure >> content types and selecting a node type from the list.
	If the phpFreeChat module is installed properly you should see a section called 'phpFreeChat Settings' with three options below it:
	* None: Nodes of this content type can never have a chat room.
	* Always: Nodes of this content type will always have a chat room.
	* Per Node: Nodes of this content type can choose to have a chat room if desired.
	You also have the opportunity to select the title and channel for this content type.
	If you do not want to have chats on a core node type (like story or blog) it is recommended that you install CCK or flexinode module and create chat content types for this purpose,
	
8.  Chat channels are like chat rooms, and are independent of nodes - so users can be on different pages and still chat in the same channel.
	Channels operate as follows:
		* Each node can be it's own chat channel (the default)
		* The whole site can have a single channel (so users can chat in a single 'space' whatever page they are on)
		* Channels can be set on a content-type level, so - for example - all users looking at blogs can participate in a single chat
		* Channels can be overriden at the node level, so the admin can group several nodes into a single chat space by giving them the same channel name

9. To get an idea of what phpFreeChat is capable of (i.e. what you can do using the settings page above, and the phpFreeChat themeing system) browse to:
	/modules/phpfreechat/phpfreechat/demo/
	or /sites/[yoursite]/modules/phpfreechat/phpfreechat/demo/

Problem Solving
---------------

Caching issues:
* Try deleting files/phpfreechat
* Try clearing your cookies

Path issues:
* Try turning on 'Debug Parameters' and check that all the things it is looking for are in the right place

Reporting Bugs
--------------

Please add all bugs to the projects issue queue!
With your bug report please include your server and client OS/version and browser, module and phpFreeChat version, together with the output of 'Debug Parameters'
1	// $Id:
2
3	phpFreeChat module
4
5	This module adds free, simple, fast and customizable chat to your Drupal site, using the open source phpFreeChat
6
7	Requirements
8	------------
9
10	* phpFreeChat 1.0 final
11	Later versions may work, but haven't been tested
12	Earlier versions will not work!
13
14	Installation
15	------------
16
17	1. Extract and the phpFreeChat module with all its files to:
18	* modules/phpfreechat or
19	* sites/[yoursite]/modules/phpfreechat
20	on your web server.
21
22	2. Download phpFreeChat from http://www.phpfreechat.net/
23	or http://sourceforge.net/project/showfiles.php?group_id=158880
24
25	3. Extract phpFreeChat with all its files to a folder named phpfreechat in the same folder you put this module in,
26	for example:
27	* modules/phpfreechat/phpfreechat or
28	* sites/[yoursite]/modules/phpfreechat/phpfreechat
29	on your web server. You do not need to follow the instructions from the phpFreeChat INSTALL file - the module handles all the configuration and creation of chats.
30
31	4. Enable the phpFreeChat module in administer >> modules
32
33	5. Configure phpFreeChat access rights in administer >> access rights
34
35	6. Check the module settings in
36	administer >> settings >> phpfreechat.
37	Note, that almost all the settings should work fine left at their defaults. Changing some settings (especially advanced settings) could stop phpFreeChat functioning. Only change these if you know what you are doing!
38
39	7. You must then enable one or more node types to be used with phpFreeChat. You can do this by going to administer >> content >> configure >> content types and selecting a node type from the list.
40	If the phpFreeChat module is installed properly you should see a section called 'phpFreeChat Settings' with three options below it:
41	* None: Nodes of this content type can never have a chat room.
42	* Always: Nodes of this content type will always have a chat room.
43	* Per Node: Nodes of this content type can choose to have a chat room if desired.
44	You also have the opportunity to select the title and channel for this content type.
45	If you do not want to have chats on a core node type (like story or blog) it is recommended that you install CCK or flexinode module and create chat content types for this purpose,
46
47	8. Chat channels are like chat rooms, and are independent of nodes - so users can be on different pages and still chat in the same channel.
48	Channels operate as follows:
49	* Each node can be it's own chat channel (the default)
50	* The whole site can have a single channel (so users can chat in a single 'space' whatever page they are on)
51	* Channels can be set on a content-type level, so - for example - all users looking at blogs can participate in a single chat
52	* Channels can be overriden at the node level, so the admin can group several nodes into a single chat space by giving them the same channel name
53
54	9. To get an idea of what phpFreeChat is capable of (i.e. what you can do using the settings page above, and the phpFreeChat themeing system) browse to:
55	/modules/phpfreechat/phpfreechat/demo/
56	or /sites/[yoursite]/modules/phpfreechat/phpfreechat/demo/
57
58	Problem Solving
59	---------------
60
61	Caching issues:
62	* Try deleting files/phpfreechat
63	* Try clearing your cookies
64
65	Path issues:
66	* Try turning on 'Debug Parameters' and check that all the things it is looking for are in the right place
67
68	Reporting Bugs
69	--------------
70
71	Please add all bugs to the projects issue queue!
72	With your bug report please include your server and client OS/version and browser, module and phpFreeChat version, together with the output of 'Debug Parameters'