If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Anonymous
-
2003-08-19
I have one but it was only partially translated o_O
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Anonymous
-
2003-08-19
PHPOpenChat manual
by Michael Oertel
PHPOpenChat manual
by Michael Oertel
Published 10.01.2002
Copyright 2001, 2002 PHPOpenChat team
This document contacts Web master and designer, those the mechanism, adjustment and/or configuration
a Community on basis of the PHPOpenChat accomplish. It describes detailiert the installation procedure and
the possibilities of the adjustment of Templates to existing Corporate Design.
This document is subject the PHPOpenChat Lizens [ http://www.ortelius.de/phpopenchat/license.txt ].
Table OF CONTENTS
Preface........................................................
1 Ueberblick............................................................
Copyright and trademarks....................................................................... 1
2Installation...............................................................
Components.................................................................................... 2
Installation of the PHP module....................................................................... 2
Installation of the PHPOpenChat distribution.............................................................. 2
Installation of the MySQL data base................................. 2
.................................................. 2
3
Windows
Linux............................................................................
Furnishes to the data base.............................................................. 4
Adapts the configuration files.......................................................... 4
Apache Web server.......................................................................
PHP 5
4
.............................................................................................
3PHPOpenChat-Konfiguration..................................................................
The configuration file........................................................................... 7
The administration interface..................................................................... 8
................................................................................................ 9
9
User administration
Administration of the godfather/operators.......................................
Administration of the moderators and VIPs............................................ 10
the CO moderators............................................................. 12 administration
Configuration of the Channel................................................................. 13
............................................................................................. 14 notifications
AReferences..................................................................................
Cunning OF Tables
2.1PHPOpenChat-Verzeichnisstruktur........................................................
Preface
The PHPOpenChat makes synchronous real time communication possible between two or several users.
These discussions can itself on mehere user groups in verschieneden areas
(Channels) divide. Everyone has the user default-moderately its own private area, in those
it also of him invited users closed discuss.
vi
Chapter 1. Overview
Chapter 1. Overview
For real time communication over the PHPOpenChat it is not necessary, a constant connection
to keep open between Client and servers. New data become by dynamic Polling (dependent on
) to the Clients conveys to the user numbers.
The system necessarily beside the HTTP haven 80 no further haven, in order to be addressed from the outside.
Copyright and trademarks
PHPOpenChat team, http://www.ortelius.de/phpopenchat/ http://sourceforge.net/projects/phpopenchat/
Copyright 2001
[ http://www.ortelius.de/phpopenchat/\],
[ http://sourceforge.net/projects/phpopenchat/\]
1
Chapter 2. Installation
Chapter 2. Installation
In this chapter the individual steps are described, those for the installation of the PHPOpenChat
to be accomplished must.
Components
For the enterprise of the PHPOpenChat the following software components are needed:
? Web server
? PHP module for the selected Web server
? MySQL data base system
? PHPOpenChat distribution
Installation of the PHP module
The PHPOpenChat is written in PHP. Please install therefore a PHP module for the selected
Web server.
? PHP homepage [ http://www.php.net/\]
? Documentation [ http://www.php.net/download docs.php ]
? German manual [ http://www.php.net/manual/de/\]
Installation of the PHPOpenChat distribution
Unpack the PHPOpenChat distribution, which is present in form of a ZIP- or gezipten TAR file,
into any listing (called in the following "[ PHPOpenChat_Dir ]"), so that the following
Listing structure relative to this listing develops:
Installation of the MySQL data base
In the following the installation is described by MySQL. Becomes more necessary for the enterprise
Data base entrance produced and the initials data imports.
Windows
1. Unpack the MySQL distribution into any listing
2
Chapter 2. Installation
2. Start setup.exe to install over the MySQL data base and select thereby e.g. the program directory
c:\mysql
3. Start MySQL from one COMMAND-BRIGHTLY out by the following instructions:
CD c:\mysql\bin
mysqld shareware -- alone
4. Open second COMMAND-BRIGHTLY and enter:
CD c:\mysql\bin
mysql u root mysql
5. The following SQL commands enter, in order to put on the entrance to the data base.
INSERT INTO user VALUES('localhost', 'phpopenchat', PASSWORD('<your password > '),
' Y', 'y', 'y', 'y', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n ');
FLUSH OF PRIVILEGES;
6. Leave the MySQL echelon of command by the input of exit
7. Produce with the following instruction a data base for the PHPOpenChat!
mysqladmin u root create phpopenchat
Linux
1. With the installation of the MySQL distribution we go from the installation by means of talking having
Package of manager (RPM) out. The installation listing is distribution dependent.
2. Start RPM i mysql xx.xx.xx.rpm and RPM i mysql clients xx.xx.xx.rpm, around the MySQLDatenbank
to install.
3. Start MySQL from a Shell by the following instructions:
CD /etc/init.d
/mysqld start
4. Afterwards the following enters in this Shell:
mysql u root mysql
5. The following SQL commands enter, in order to put on the entrance to the data base.
3
Chapter 2. Installation
INSERT INTO user VALUES('localhost', 'phpopenchat', PASSWORD('<your password > '),
' Y', 'y', 'y', 'y', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n ');
FLUSH OF PRIVILEGES;
6. Leave the MySQL echelon of command by the input of exit
7. Produce with the following instruction a data base for the PHPOpenChat!
mysqladmin u root create phpopenchat
Furnish to the data base
For the Community a data base must be furnished in the data base management system (MySQL)
(see installation of the MySQL data base). After is data base-furnished, must still
the PHPOpenChat specific data as well as the data base schema to be imported. This becomes
both under Windows and under Linux reaches as follows:
Windows
1. Open one COMMAND-BRIGHTLY and enter:
CD c:\mysql\bin
mysql u phpopenchat p[Dein password ] phpopenchat < [ PHPOpenChat_Dir]/db.schema
Linux
1. Open one COMMAND-BRIGHTLY and enter:
mysql u phpopenchat p[Dein password ] phpopenchat < [ PHPOpenChat_Dir]/db.schema
Adapt the configuration files
Before you can begin with the trying of the Community out, are still the following configuration files
to adapt.
Apache Web server
apache/conf/httpd.conf
4
Chapter 2. Installation
? Activate the PHP support:
for Windows:
ScriptAlias /php/ "C:/php/"
ADD type application/x httpd php php
Action application/x httpd php "/php/php.exe"
for Linux:
ADD type application/x httpd php php php3
Optionally should also still the directory index can over index.php be extended.
< IfModule mod_dir.c >
Directory index index HTML index.php
</IfModule >
PHP
So that the PHPOpenChat can find the Include files lying outside of the document roots,
must be extended in the file php.ini include_path as follows:
include_path = ";c:\php\includes;[PHPOpenChat_Dir]\includes"
php.ini
? Windows
Please implement the following commands in one COMMAND-BRIGHTLY. We go from a Windows
System listing c:\windows out. Under other Windowsversionen the Windows can
System listing other names, as possess bspw. c:\winnt for the Windowsversion "NT".
CD c:\windows
edit php.ini
Within the file the variable is to be supplemented include_path as follows:
? Linux
Please implement the following commands in one COMMAND-BRIGHTLY. The place, at that the PHPKonfigurationsdatei
to find is differed, between the individual distributions. Usually is it however
to find in the listing /etc. With a standard installation one finds the file under/
usr/local/lib. In the following example we proceed from a standard installation.
CD /usr/local/lib
vi php.ini
5
Chapter 2. Installation
Within the file the variable is to be supplemented include_path as follows:
include_path = ":[PHPOpenChat_Dir]/includes"
6
Chapter 3. PHPOpenChat configuration
Chapter 3. PHPOpenChat configuration
The configuration file
The file defaults_inc.php is the central configuration file of the PHPOpenChat. In it all become
Changes to everyone of the available modules made.
Language selection: All available languages are listed in the form of PHP Includestatements. To
Activate a certain language must only the prominent comment symbols ('//') removed
become. Default-moderately the language English is activated.
#CHATNAME: Name of the Community
$MAX_NICK_LENGTH: Number maximally for a pitch name usable indications. Those should
Number to be changed, must be considered also the data base schema.
$FILE_EXTENSION: used file dung. If this value is changed, all files must so renamed
become, which they carry this Dateiaendung.
$INSTALL_DIR: Installation listing of the PHPOpenChat relative to Web server "document root".
If the Community is to run in the document root, this variable remains empty. For an accepted installation listing
the PHPOpenChat under "phpopenchat/" the variable must be set as follows:
$INSTALL_DIR = "/phpopenchat";
#CHATSERVERNAME: The DNS name or the IP of the Communityservers will be defined here.
$BACKGROUNDIMAGE: Definition of the background diagram of the input window.
$DATABASENAME: Name of the data base within the data base management system (MySQL) up
that the Communityinstallation is based.
$DATABASEHOST: DNS name or IP of the server, on which MySQL is installed.
more $DATABASEUSER: User name by means of that the Community on the data base accesses.
$DATABASEPASSWD: The password of the specified MySQL user in the plain language.
#CONNECT_TRIES: Number of MySQL call attempts.
$ENTRYCHANNELNAME: Name of the first Channels in the Chat. If the value is changed here, must in that
Data base a Channel of the same name to be put on. The Admin Tool offers the possibility on easy
To do way this.
$MAX_LINE_LENGTH: Maximum length of a line written in the Chat. Everything in addition it
entered lines are rejected.
$ROW_BUFFER_SIZE: Size of the ring buffer for each Channel the available. This
Size can be changed at will, whereby additionally with the data base table "Channels" of fields
to be added must. Format of these fields: "line _" (Prefix) plus a serial-number. There that
Default value for the size of the ring buffer "40" is, exists the fields "Zeile_0" already to "Zeile_39"
in the data base.
$MODERATOR_RATE: Time interval in seconds in that automatic messages in the Chat spent
become.
$LAST_TIME_ONLINE: Time interval the one Community member to be maximally absent may, before
its Registration is deleted.
$ADDITIONAL_LETTERS: Letter or special character, those additionally for use in one
Pitch names are permitted.
$ENABLE_SESSION: The use of sessions and thus the safest function switches that
Community (true) or out (false).
$USERIMG_MAX_BYTES: Limits the maximum size of a user Icons to the indicated
Size in bytes. This value plays a role with the Upload of the user Icons within the profile.
$USERIMG_IMGSIZE_X: Limits the size of the user Icons to the indicated number pixels
in the x axis.
$USERIMG_IMGSIZE_Y: Limits the size of the user Icons to the indicated number pixels
in the y axis.
$SESSION_NAME: Name the session.
7
Chapter 3. PHPOpenChat configuration
more $VERSION_NUMBER: PHPOpenChat version number
$ADMIN_DIR: Path starting from the document root of the Web server to the administration interface.
$NO_NO_WORDS: In the Chat did not permit words. If they will close-give, they become by in
"Ooops" replaces.
$NICK_NOT_ALLOWED: Reserved and did not permit pitch name.
$UNACCEPTABLE_CONTENT: If over URLs inerhalb the Chat module to web pages referred
becomes, may contain this none of the words indicated here. Otherwise does not become the indicated
URL passed on.
$pass_phrase: This sentence or wortgruppe becomes the determination of the check totals distorted. It is
very importantly to change contents of this variables immediately after the installation!
$FORUMDATE: Time interval in days, from which forum contributions are indicated.
$KICK_COUNT: Disturbers can also by a group of users, who ignore this user,
are eliminated. If the group is large enough, a disturber is excluded automatically. With
this variables determines one the size of this group.
$SPERRPASSWORT: If a user was eliminated, its Registration remains, only
the password is changed, so that repeated logging in is impossible. Here this password becomes
determined.
$MAIL_TEXT_COLOR: Color of the Mailtextes in the Chatmail module.
$MODERATOR_COLOR: Pitch name color within moderated Channels of the moderator.
#COMODERATOR_COLOR: Pitch name color within moderated Channels of the CO moderator.
$VIP_COLOR: Pitch name color within moderated Channels of the VIPs and/or the special guest.
$PATEN_COLOR: Pitch name color of a godfather/operator of the Community.
#CHAT_TEXT_SIZE: Size in pixels of the text within the Chat module.
$PRIVAT_ICON_PATH: Path relative to the private Icons of the users to the Web server document root.
$ICON_PATH: Path relative to the Chat Icons to the Web server document root.
$BG_IMAGE: Background diagram in the input Frame of the Chat module.
$LOGO: Logo in the input Frame of the Chat module.
$TEAM_MAIL_ADDR: Mailadresse of the Community team. This becomes in some places the assistance that
User spent.
$LOOK_IN_COLOR: Preset text color for each new user, still no own color
to select could.
$DEFAULT_TEXT_COLOR: Background colour of the Adminoberflaeche.
$DEFAULT_BG_COLOR: Time was written at the one line in the Chatmodul to indicate.
$SHOW_TIME: IRC commands in the Chatmodul permit.
$IRC_COMMANDS: A changing into different Channels/Raeume permit.
$SELECT_CHANNEL: The direct responding of users permit.
more $SELECT_USER: Choice of different Scrollgeschwindigkeiten permit.
#CHANGE_SCROLLING: Filter possibility of status messages in the Chatmodul permit.
more $SET_STATUSFILTER: Filter possibility own communication in the Chatmodul do not permit.
more $SET_TWADDLEFILTER: Assistance button indicate.
$BUTTON_HELP: Entrance to the module Blackboard permit.
$BUTTON_FORUM: Entrance to the module Chat Mail permit.
$BUTTON_MESSAGES: Ignore from users and inviting users into private areas permit.
$BUTTON_IGNORE: Changes of the own text color permit.
#CHANGE_COLOR_LINK: Fluessstern to other users permit.
$WISPERING: Provide from friend lists permit.
$BUTTON_NOTIFY: Entrance to the dialogue "who is on-line" permit.
The administration interface
The administration interface is, as far as differently in the configuration file do not indicate, under Web
8
server documentroot/$INSTALL_DIR/admin (see also the section called "the configuration file")
to find.
User administration
For the user administration three menu options are available:
???
Administration of the godfather/operators
Godfathers or also operators users mentioned, have special rights within the Community. It
are starting from the version 2.2.2 in a the position to close over a special interface user.
Chapter 3. PHPOpenChat configuration
9
Chapter 3. PHPOpenChat configuration
With one click at (1) arrives one at the administration of the godfather/operators. Under (2) is it then
to add possible to the list of the godfathers and/or operators as many as desired users. Is on existence
to respect the user who can be added.
Administration of the moderators and VIPs
Moderators release individual text lines of users, so that they are readable by all users.
10
Chapter 3. PHPOpenChat configuration
VIPs can read excluding lines, which were released by a moderator. Lines,
Moderator or a VIP writes, is indicated immediately.
The moderators and VIPs are defined always in pairs.
Note
Moderator and VIP rights are valid only within moderated Channels.
Under (1) one arrives at the administration of the moderators and VIPs. An entry consists thereby of three
Fields:
11
???
Administration of the CO moderators
CO moderators can within as moderate characterized Channels all lines to read.
12
Chapter 3. PHPOpenChat configuration
Note
(pointed)namen the VIPs or the moderator must in the user data base registered
its.
Chapter 3. PHPOpenChat configuration
> with one click at (1) arrives one at the administration of the CO moderators. Under (2) is it then
to add possible to the list of the CO moderators as many as desired users. Is on existence
to respect the user who can be added.
Configuration of the Channel
Under the menu option "administration of the Channels" (1) can be attained the configuration interface.
Under (2) of any size a number of Channels of the Community can be added. That
Recreation and/or editing existing Channels (3) differs concerning the proceeding
13
Chapter 3. PHPOpenChat configuration
not. Therefore ledliglich with editing the Channels one deals here.
Note
?
If the default-moderately stopped name "Channel_1" is changed, additionally the configuration variable must
$ENTRYCHANNELNAME (see also the section called "the configuration file")
are changed!
?????????
Notifications
Over automatically in the Chat appearing message (1) or over a Chatmail to all registered
14
Chapter 3. PHPOpenChat configuration
user (2), can the Chatsdministrator innovations, changes or announcements to the Community
easily communicate.
15
Appendix A. References
Appendix A. References
PHPOpenChat homepage http://www.ortelius.de/phpopenchat/ [ http://www.ortelius.de/phpopenchat/\], http://sourceforge.net/projects/phpopenchat/ [ http://sourceforge.net/projects/phpopenchat/\]
Websites, where the PHPOpenChat is successfully used. http://www.ortelius.de/phpopenchat/links.html [ http://www.ortelius.de/phpopenchat/links.html ]
16
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Anonymous
-
2003-08-19
Sorry about that long post....babelfish translation :)
Read through most of it with my limited German and it looks pretty good. A few words not complete.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
In no way do I wish to offend, I am simply curious and searching - Is there an English translated PDF document that covers this project?
Thanks!
Ryan
I'm interested also.
Rich
same here
Please Please can we please have one?
I have one but it was only partially translated o_O
PHPOpenChat manual
by Michael Oertel
PHPOpenChat manual
by Michael Oertel
Published 10.01.2002
Copyright 2001, 2002 PHPOpenChat team
This document contacts Web master and designer, those the mechanism, adjustment and/or configuration
a Community on basis of the PHPOpenChat accomplish. It describes detailiert the installation procedure and
the possibilities of the adjustment of Templates to existing Corporate Design.
This document is subject the PHPOpenChat Lizens [ http://www.ortelius.de/phpopenchat/license.txt ].
Table OF CONTENTS
Preface........................................................
1 Ueberblick............................................................
Copyright and trademarks....................................................................... 1
2Installation...............................................................
Components.................................................................................... 2
Installation of the PHP module....................................................................... 2
Installation of the PHPOpenChat distribution.............................................................. 2
Installation of the MySQL data base................................. 2
.................................................. 2
3
Windows
Linux............................................................................
Furnishes to the data base.............................................................. 4
Adapts the configuration files.......................................................... 4
Apache Web server.......................................................................
PHP 5
4
.............................................................................................
3PHPOpenChat-Konfiguration..................................................................
The configuration file........................................................................... 7
The administration interface..................................................................... 8
................................................................................................ 9
9
User administration
Administration of the godfather/operators.......................................
Administration of the moderators and VIPs............................................ 10
the CO moderators............................................................. 12 administration
Configuration of the Channel................................................................. 13
............................................................................................. 14 notifications
AReferences..................................................................................
Cunning OF Tables
2.1PHPOpenChat-Verzeichnisstruktur........................................................
Preface
The PHPOpenChat makes synchronous real time communication possible between two or several users.
These discussions can itself on mehere user groups in verschieneden areas
(Channels) divide. Everyone has the user default-moderately its own private area, in those
it also of him invited users closed discuss.
vi
Chapter 1. Overview
Chapter 1. Overview
For real time communication over the PHPOpenChat it is not necessary, a constant connection
to keep open between Client and servers. New data become by dynamic Polling (dependent on
) to the Clients conveys to the user numbers.
The system necessarily beside the HTTP haven 80 no further haven, in order to be addressed from the outside.
Copyright and trademarks
PHPOpenChat team, http://www.ortelius.de/phpopenchat/
http://sourceforge.net/projects/phpopenchat/
Copyright 2001
[ http://www.ortelius.de/phpopenchat/\],
[ http://sourceforge.net/projects/phpopenchat/\]
1
Chapter 2. Installation
Chapter 2. Installation
In this chapter the individual steps are described, those for the installation of the PHPOpenChat
to be accomplished must.
Components
For the enterprise of the PHPOpenChat the following software components are needed:
? Web server
? PHP module for the selected Web server
? MySQL data base system
? PHPOpenChat distribution
Installation of the PHP module
The PHPOpenChat is written in PHP. Please install therefore a PHP module for the selected
Web server.
? PHP homepage [ http://www.php.net/\]
? Documentation [ http://www.php.net/download docs.php ]
? German manual [ http://www.php.net/manual/de/\]
Installation of the PHPOpenChat distribution
Unpack the PHPOpenChat distribution, which is present in form of a ZIP- or gezipten TAR file,
into any listing (called in the following "[ PHPOpenChat_Dir ]"), so that the following
Listing structure relative to this listing develops:
Installation of the MySQL data base
In the following the installation is described by MySQL. Becomes more necessary for the enterprise
Data base entrance produced and the initials data imports.
Windows
1. Unpack the MySQL distribution into any listing
2
Chapter 2. Installation
2. Start setup.exe to install over the MySQL data base and select thereby e.g. the program directory
c:\mysql
3. Start MySQL from one COMMAND-BRIGHTLY out by the following instructions:
CD c:\mysql\bin
mysqld shareware -- alone
4. Open second COMMAND-BRIGHTLY and enter:
CD c:\mysql\bin
mysql u root mysql
5. The following SQL commands enter, in order to put on the entrance to the data base.
INSERT INTO user VALUES('localhost', 'phpopenchat', PASSWORD('<your password > '),
' Y', 'y', 'y', 'y', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n ');
FLUSH OF PRIVILEGES;
6. Leave the MySQL echelon of command by the input of exit
7. Produce with the following instruction a data base for the PHPOpenChat!
mysqladmin u root create phpopenchat
Linux
1. With the installation of the MySQL distribution we go from the installation by means of talking having
Package of manager (RPM) out. The installation listing is distribution dependent.
2. Start RPM i mysql xx.xx.xx.rpm and RPM i mysql clients xx.xx.xx.rpm, around the MySQLDatenbank
to install.
3. Start MySQL from a Shell by the following instructions:
CD /etc/init.d
/mysqld start
4. Afterwards the following enters in this Shell:
mysql u root mysql
5. The following SQL commands enter, in order to put on the entrance to the data base.
3
Chapter 2. Installation
INSERT INTO user VALUES('localhost', 'phpopenchat', PASSWORD('<your password > '),
' Y', 'y', 'y', 'y', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n', 'n ');
FLUSH OF PRIVILEGES;
6. Leave the MySQL echelon of command by the input of exit
7. Produce with the following instruction a data base for the PHPOpenChat!
mysqladmin u root create phpopenchat
Furnish to the data base
For the Community a data base must be furnished in the data base management system (MySQL)
(see installation of the MySQL data base). After is data base-furnished, must still
the PHPOpenChat specific data as well as the data base schema to be imported. This becomes
both under Windows and under Linux reaches as follows:
Windows
1. Open one COMMAND-BRIGHTLY and enter:
CD c:\mysql\bin
mysql u phpopenchat p[Dein password ] phpopenchat < [ PHPOpenChat_Dir]/db.schema
Linux
1. Open one COMMAND-BRIGHTLY and enter:
mysql u phpopenchat p[Dein password ] phpopenchat < [ PHPOpenChat_Dir]/db.schema
Adapt the configuration files
Before you can begin with the trying of the Community out, are still the following configuration files
to adapt.
Apache Web server
apache/conf/httpd.conf
4
Chapter 2. Installation
? Activate the PHP support:
for Windows:
ScriptAlias /php/ "C:/php/"
ADD type application/x httpd php php
Action application/x httpd php "/php/php.exe"
for Linux:
ADD type application/x httpd php php php3
Optionally should also still the directory index can over index.php be extended.
< IfModule mod_dir.c >
Directory index index HTML index.php
</IfModule >
PHP
So that the PHPOpenChat can find the Include files lying outside of the document roots,
must be extended in the file php.ini include_path as follows:
include_path = ";c:\php\includes;[PHPOpenChat_Dir]\includes"
php.ini
? Windows
Please implement the following commands in one COMMAND-BRIGHTLY. We go from a Windows
System listing c:\windows out. Under other Windowsversionen the Windows can
System listing other names, as possess bspw. c:\winnt for the Windowsversion "NT".
CD c:\windows
edit php.ini
Within the file the variable is to be supplemented include_path as follows:
? Linux
Please implement the following commands in one COMMAND-BRIGHTLY. The place, at that the PHPKonfigurationsdatei
to find is differed, between the individual distributions. Usually is it however
to find in the listing /etc. With a standard installation one finds the file under/
usr/local/lib. In the following example we proceed from a standard installation.
CD /usr/local/lib
vi php.ini
5
Chapter 2. Installation
Within the file the variable is to be supplemented include_path as follows:
include_path = ":[PHPOpenChat_Dir]/includes"
6
Chapter 3. PHPOpenChat configuration
Chapter 3. PHPOpenChat configuration
The configuration file
The file defaults_inc.php is the central configuration file of the PHPOpenChat. In it all become
Changes to everyone of the available modules made.
Language selection: All available languages are listed in the form of PHP Includestatements. To
Activate a certain language must only the prominent comment symbols ('//') removed
become. Default-moderately the language English is activated.
#CHATNAME: Name of the Community
$MAX_NICK_LENGTH: Number maximally for a pitch name usable indications. Those should
Number to be changed, must be considered also the data base schema.
$FILE_EXTENSION: used file dung. If this value is changed, all files must so renamed
become, which they carry this Dateiaendung.
$INSTALL_DIR: Installation listing of the PHPOpenChat relative to Web server "document root".
If the Community is to run in the document root, this variable remains empty. For an accepted installation listing
the PHPOpenChat under "phpopenchat/" the variable must be set as follows:
$INSTALL_DIR = "/phpopenchat";
#CHATSERVERNAME: The DNS name or the IP of the Communityservers will be defined here.
$BACKGROUNDIMAGE: Definition of the background diagram of the input window.
$DATABASENAME: Name of the data base within the data base management system (MySQL) up
that the Communityinstallation is based.
$DATABASEHOST: DNS name or IP of the server, on which MySQL is installed.
more $DATABASEUSER: User name by means of that the Community on the data base accesses.
$DATABASEPASSWD: The password of the specified MySQL user in the plain language.
#CONNECT_TRIES: Number of MySQL call attempts.
$ENTRYCHANNELNAME: Name of the first Channels in the Chat. If the value is changed here, must in that
Data base a Channel of the same name to be put on. The Admin Tool offers the possibility on easy
To do way this.
$MAX_LINE_LENGTH: Maximum length of a line written in the Chat. Everything in addition it
entered lines are rejected.
$ROW_BUFFER_SIZE: Size of the ring buffer for each Channel the available. This
Size can be changed at will, whereby additionally with the data base table "Channels" of fields
to be added must. Format of these fields: "line _" (Prefix) plus a serial-number. There that
Default value for the size of the ring buffer "40" is, exists the fields "Zeile_0" already to "Zeile_39"
in the data base.
$MODERATOR_RATE: Time interval in seconds in that automatic messages in the Chat spent
become.
$LAST_TIME_ONLINE: Time interval the one Community member to be maximally absent may, before
its Registration is deleted.
$ADDITIONAL_LETTERS: Letter or special character, those additionally for use in one
Pitch names are permitted.
$ENABLE_SESSION: The use of sessions and thus the safest function switches that
Community (true) or out (false).
$USERIMG_MAX_BYTES: Limits the maximum size of a user Icons to the indicated
Size in bytes. This value plays a role with the Upload of the user Icons within the profile.
$USERIMG_IMGSIZE_X: Limits the size of the user Icons to the indicated number pixels
in the x axis.
$USERIMG_IMGSIZE_Y: Limits the size of the user Icons to the indicated number pixels
in the y axis.
$SESSION_NAME: Name the session.
7
Chapter 3. PHPOpenChat configuration
more $VERSION_NUMBER: PHPOpenChat version number
$ADMIN_DIR: Path starting from the document root of the Web server to the administration interface.
$NO_NO_WORDS: In the Chat did not permit words. If they will close-give, they become by in
"Ooops" replaces.
$NICK_NOT_ALLOWED: Reserved and did not permit pitch name.
$UNACCEPTABLE_CONTENT: If over URLs inerhalb the Chat module to web pages referred
becomes, may contain this none of the words indicated here. Otherwise does not become the indicated
URL passed on.
$pass_phrase: This sentence or wortgruppe becomes the determination of the check totals distorted. It is
very importantly to change contents of this variables immediately after the installation!
$FORUMDATE: Time interval in days, from which forum contributions are indicated.
$KICK_COUNT: Disturbers can also by a group of users, who ignore this user,
are eliminated. If the group is large enough, a disturber is excluded automatically. With
this variables determines one the size of this group.
$SPERRPASSWORT: If a user was eliminated, its Registration remains, only
the password is changed, so that repeated logging in is impossible. Here this password becomes
determined.
$MAIL_TEXT_COLOR: Color of the Mailtextes in the Chatmail module.
$MODERATOR_COLOR: Pitch name color within moderated Channels of the moderator.
#COMODERATOR_COLOR: Pitch name color within moderated Channels of the CO moderator.
$VIP_COLOR: Pitch name color within moderated Channels of the VIPs and/or the special guest.
$PATEN_COLOR: Pitch name color of a godfather/operator of the Community.
#CHAT_TEXT_SIZE: Size in pixels of the text within the Chat module.
$PRIVAT_ICON_PATH: Path relative to the private Icons of the users to the Web server document root.
$ICON_PATH: Path relative to the Chat Icons to the Web server document root.
$BG_IMAGE: Background diagram in the input Frame of the Chat module.
$LOGO: Logo in the input Frame of the Chat module.
$TEAM_MAIL_ADDR: Mailadresse of the Community team. This becomes in some places the assistance that
User spent.
$LOOK_IN_COLOR: Preset text color for each new user, still no own color
to select could.
$DEFAULT_TEXT_COLOR: Background colour of the Adminoberflaeche.
$DEFAULT_BG_COLOR: Time was written at the one line in the Chatmodul to indicate.
$SHOW_TIME: IRC commands in the Chatmodul permit.
$IRC_COMMANDS: A changing into different Channels/Raeume permit.
$SELECT_CHANNEL: The direct responding of users permit.
more $SELECT_USER: Choice of different Scrollgeschwindigkeiten permit.
#CHANGE_SCROLLING: Filter possibility of status messages in the Chatmodul permit.
more $SET_STATUSFILTER: Filter possibility own communication in the Chatmodul do not permit.
more $SET_TWADDLEFILTER: Assistance button indicate.
$BUTTON_HELP: Entrance to the module Blackboard permit.
$BUTTON_FORUM: Entrance to the module Chat Mail permit.
$BUTTON_MESSAGES: Ignore from users and inviting users into private areas permit.
$BUTTON_IGNORE: Changes of the own text color permit.
#CHANGE_COLOR_LINK: Fluessstern to other users permit.
$WISPERING: Provide from friend lists permit.
$BUTTON_NOTIFY: Entrance to the dialogue "who is on-line" permit.
The administration interface
The administration interface is, as far as differently in the configuration file do not indicate, under Web
8
server documentroot/$INSTALL_DIR/admin (see also the section called "the configuration file")
to find.
User administration
For the user administration three menu options are available:
???
Administration of the godfather/operators
Godfathers or also operators users mentioned, have special rights within the Community. It
are starting from the version 2.2.2 in a the position to close over a special interface user.
Chapter 3. PHPOpenChat configuration
9
Chapter 3. PHPOpenChat configuration
With one click at (1) arrives one at the administration of the godfather/operators. Under (2) is it then
to add possible to the list of the godfathers and/or operators as many as desired users. Is on existence
to respect the user who can be added.
Administration of the moderators and VIPs
Moderators release individual text lines of users, so that they are readable by all users.
10
Chapter 3. PHPOpenChat configuration
VIPs can read excluding lines, which were released by a moderator. Lines,
Moderator or a VIP writes, is indicated immediately.
The moderators and VIPs are defined always in pairs.
Note
Moderator and VIP rights are valid only within moderated Channels.
Under (1) one arrives at the administration of the moderators and VIPs. An entry consists thereby of three
Fields:
11
???
Administration of the CO moderators
CO moderators can within as moderate characterized Channels all lines to read.
12
Chapter 3. PHPOpenChat configuration
Note
(pointed)namen the VIPs or the moderator must in the user data base registered
its.
Chapter 3. PHPOpenChat configuration
> with one click at (1) arrives one at the administration of the CO moderators. Under (2) is it then
to add possible to the list of the CO moderators as many as desired users. Is on existence
to respect the user who can be added.
Configuration of the Channel
Under the menu option "administration of the Channels" (1) can be attained the configuration interface.
Under (2) of any size a number of Channels of the Community can be added. That
Recreation and/or editing existing Channels (3) differs concerning the proceeding
13
Chapter 3. PHPOpenChat configuration
not. Therefore ledliglich with editing the Channels one deals here.
Note
?
If the default-moderately stopped name "Channel_1" is changed, additionally the configuration variable must
$ENTRYCHANNELNAME (see also the section called "the configuration file")
are changed!
?????????
Notifications
Over automatically in the Chat appearing message (1) or over a Chatmail to all registered
14
Chapter 3. PHPOpenChat configuration
user (2), can the Chatsdministrator innovations, changes or announcements to the Community
easily communicate.
15
Appendix A. References
Appendix A. References
PHPOpenChat homepage
http://www.ortelius.de/phpopenchat/ [ http://www.ortelius.de/phpopenchat/\],
http://sourceforge.net/projects/phpopenchat/ [ http://sourceforge.net/projects/phpopenchat/\]
Websites, where the PHPOpenChat is successfully used.
http://www.ortelius.de/phpopenchat/links.html [ http://www.ortelius.de/phpopenchat/links.html ]
16
Sorry about that long post....babelfish translation :)
Read through most of it with my limited German and it looks pretty good. A few words not complete.