Menu
▾
▴
[phpMyChat CVS] CVS: phpMyChat-0.15/docs configuration.txt,NONE,1.1
|
From: Lo?c C. <lo...@us...> - 2001-06-13 18:07:02
|
Update of /cvsroot/phpmychat/phpMyChat-0.15/docs In directory usw-pr-cvs1:/tmp/cvs-serv7872/docs Added Files: configuration.txt Log Message: A new file to document the config script --- NEW FILE --- +--------------------------------------------------------------------------+ | phpMyChat version 0.15.0 | +--------------------------------------------------------------------------+ | Copyright (c) 2000-2001 The phpHeaven-team | +--------------------------------------------------------------------------+ | License: GNU/GPL - http://www.gnu.org/copyleft/gpl.html | +--------------------------------------------------------------------------+ | Brief desciption of the directives of the phpMyChat configuration file | +--------------------------------------------------------------------------+ | From the phpMyChat project: | | http://www.phpheaven.net/projects/phpMyChat/ | | | | Authors: the phpHeaven-team <te...@ph...> | +--------------------------------------------------------------------------+ $Id: configuration.txt,v 1.1 2001/06/13 18:06:59 loic1 Exp $ This is the documented list of all the directives defined in the configuration script of phpMyChat. Database settings """"""""""""""""" C_DB_TYPE The SQL server type: mysql, pgsql (PostgreSQL) or oci8 (Oracle 8). C_DB_HOST The hostname of your SQL server. C_DB_NAME The logical database name on that server. C_DB_USER C_DB_PASS Your login and password for this database. C_SESS_TBL C_USR_TBL C_REG_TBL C_BAN_TBL Names of the tables where will be stored: - session datas; - informations about connected users; - profiles of the registered users; - banished users. C_ROOM_TBL C_RIGHT_TBL C_MSG_TBL Names of the tables where will be stored: - information about existing rooms; - right level of users in these rooms; - the messages. Cleaning settings """"""""""""""""" C_SESS_DEL Sessions are deleted when its last use is C_SESS_DEL minutes old. This setting must be greater than C_USR_AWAY + C_USR_DEL (see below). C_USR_AWAY C_DEL_AWAY_LEVEL C_USR_DEL These directives define the way the connected users table is updated and cleaned. C_USR_AWAY defines the delay of inactivity (no message sent) in minutes before an user is considered as "away from his/her keyboard". C_DEL_AWAY_LEVEL tell the script that an user whose right level is inferior to C_DEL_AWAY_LEVEL should be kicked as soon as he/she is "away from his/her keyboard" since more than C_USR_DEL minutes. Examples: 1. An user is away if he/she didn't post any message during the past 4 minutes and, if he/she is not moderator, he/she sould be kicked two minutes later (except if he/she send a message during this period, of course): C_USR_AWAY = 4 C_DEL_AWAY_LEVEL = 5 C_USR_DEL = 2 2. An user is away if he/she didn't post any message during the past 5 minutes and, if he/she is not the administrator, he/she sould be kicked one minute later (except if he/she send a message during this period, of course): C_USR_AWAY = 5 C_DEL_AWAY_LEVEL = 10 C_USR_DEL = 1 Important notes: C_USR_AWAY + C_USR_DEL must be lower than C_SESS_DEL; C_USR_AWAY and C_USR_DEL must be greater than the default time between messages list refresh (see the C_MSG_REFRESH directive below). C_REG_DEL A profile is deleted when its last use is C_REG_DEL days old. C_REG_DEL should be 0 for "never". C_MSG_DEL Messages are deleted when there are C_MSG_DEL hours old. Default rooms """"""""""""" $defaultChatRooms The list of the default public rooms an user will be proposed. $defaultPrivateRooms The list of reserved names for the default private rooms. Language settings """"""""""""""""" C_LANGUAGE The default language to use. C_MULTI_LANG Tell to script to use the multi-languages/charset feature (0 = no, 1 = yes). To enable this feature you have to download more than one translation. Registration of users """"""""""""""""""""" C_REQUIRE_REGISTER Whether to require registration or not (1/0). If set to 1, user must register to enter the chat. C_EMAIL_PASWD Tell the script whether to generate a password and send it to the user by e-mail or not when he/she register (1/0). This functionaly is available only if the php 'mail()' function is enabled. To use it the C_MAIL_FUNCTION, C_REG_SENDER and C_REG_EMAIL directives have to be completed (see below) Security and restrictions """"""""""""""""""""""""" C_MAX_USERS The maximum authorized number of connected users (0 for no limit). C_SHOW_ADMIN C_SHOW_DEL_PROF Whether to display the links for administration resources and deleting profiles at startup screen or not (1/0). C_VERSION Available rooms : users may enter... 0 = only the first room within the public default ones; 1 = all the public default rooms but not create a room; 2 = all the rooms and also create new ones. C_BANISH Enable the banishment feature and define the delay for banishment. Values are: 0 = disabled; any positive number = number of banishment day(s). If you want all moderators (and not only yourself) to banish users "forever", set C_BANISH to 2000000 (six zero) C_NO_SWEAR Whether to check for swear words (defined in the 'chat/lib/swearing.lib.php3' script) or not (1/0). If enabled: - nicks and room names containing these words won't be allowed, - each of these words will be replaced by a "mask" in messages. C_SAVE The maximum number of message that an user may export with the '/save' command. Special values: 0 = none (disable the command); * = no limit. Messages enhancements """"""""""""""""""""" C_MAX_GSMILIES The maximun number of graphical smilies per message. Special values: 0 = none; * = no limit. C_HTML_TAGS_KEEP Whether to keep HTML tags in messages or not. Values are: simple = keep bold, italic and underline tags; none = keep none. C_HTML_TAGS_SHOW Whether to show discarded HTML tags or not (1/0). Default display settings """""""""""""""""""""""" C_TMZ_OFFSET The timezone offset in hour between the server time and your lacal time C_MSG_ORDER For browsers that do not support DHTML/DOM, the order of messages: 0 = last on top (default); 1 = last on bottom. C_MSG_NB The default number of messages to display. C_MSG_REFRESH The default timeout between each update in seconds C_SHOW_TIMESTAMP Whether to show timsestamp before messages or not (1/0). C_NOTIFY Whether to show nofications of user entrance/exit as default or not (1/0). C_WELCOME Whether to display a welcome message at user entrance as default or not (1/0). E-mail stuff """""""""""" C_MAIL_FUNCTION Whether the php 'mail()' function is enabled or not (1/0). C_REG_SENDER C_REG_EMAIL The full sender name and the sender e-mail address used by the profile registration script. C_ADM_SENDER C_ADM_EMAIL The full sender name and the sender e-mail address used by the last administration script. Name and release number """"""""""""""""""""""" APP_NAME APP_VERSION The name and release number you want to be displayed at the start screen. Complete Url of the chat """""""""""""""""""""""" C_CHAT_URL The complete url of your chat (ie 'http://www.mysite.net/chat/'). This value will be used: - in the registration messages send to user if C_EMAIL_PASWD is set to 1; - when an user is kicked away from the chat. |
