path: root/etc/ychat.conf

<?xml version="5.0" encoding="ISO-8859-1" standalone="yes" ?>
<category name="chat">
    <option name="defaultop">
        <value>Snoop</value>
        <descr>The default user which has operator status</descr>
    </option>
    <option name="enableguest">
        <value>true</value>
        <descr>Is set to true if guest chatters are allowed. If database support is disabled this option HAS to be enabled otherwise no login will work because all chatter are treated as guests if there is no database!</descr>
    </option>
    <option name="defaultrang">
        <value>3</value>
        <descr>The default user rang/status</descr>
    </option>
    <option name="defaultroom">
        <value>Lounge</value>
        <descr>The default chat room</descr>
    </option>
    <option name="printalwaystime">
        <value>true</value>
        <descr>If true, for each message in the chat window will be printed out the current time</descr>
    </option>
    <option name="timeoffset">
        <value>0</value>
        <descr>The time offset. Negative values are not allowed. If you have an offset of X please enter 24+X+12 here. Example: Offset = -6, 24-6+12 = 30 :)</descr>
    </option>
    <category name="permissions">
        <option name="uptime">
            <value>1</value>
        </option>
        <option name="ko">
            <value>1</value>
        </option>
        <option name="topic">
            <value>2</value>
        </option>
        <option name="ren">
            <value>1</value>
        </option>
        <option name="version">
            <value>3</value>
        </option>
        <option name="compopt">
            <value>3</value>
        </option>
        <option name="s">
            <value>3</value>
        </option>
        <option name="msg">
            <value>3</value>
        </option>
        <option name="users">
            <value>3</value>
        </option>
        <option name="me">
            <value>3</value>
        </option>
        <option name="m">
            <value>3</value>
        </option>
        <option name="j">
            <value>3</value>
        </option>
        <option name="getroom">
            <value>3</value>
        </option>
        <option name="morph">
            <value>3</value>
        </option>
        <option name="away">
            <value>3</value>
        </option>
        <option name="q">
            <value>3</value>
        </option>
        <option name="time">
            <value>3</value>
        </option>
        <option name="col">
            <value>3</value>
        </option>
        <option name="help">
            <value>3</value>
        </option>
    </category>
    <category name="database">
        <option name="mincon">
            <value>2</value>
            <descr>The amount of database connections which will be created at yChat startup</descr>
        </option>
        <option name="maxcon">
            <value>10</value>
            <descr>The maximum amount of concurrent connections to the database</descr>
        </option>
        <option name="contimeout">
            <value>600</value>
            <descr>Seconds of idling after a database connection will be closed. Will be checked once each minute</descr>
        </option>
        <option name="serverhost">
             <value>localhost</value>
             <descr>Specifies hostname oder ip address of the MySQL database server</descr>
        </option>
            <option name="user">
                <value>ychat</value>
                <descr>Specifies the MySQL username</descr>
            </option>
            <option name="password">
                <value>hahaha</value>
                <descr>Specifies the MySQL password</descr>
            </option>
            <option name="dbname">
                <value>ychat_advanced</value>
                <descr>Specifies the MySQL database name</descr>
            </option>
            <option name="port">
                <value>3306</value>
                <descr>Specifies the MySQL server port</descr>
            </option>
        <category name="mysql">
            <option name="registernick">
                 <value>user nick password color1 color2 email registerdate</value>
                 <descr>Specifies the fields which will be saved into the database if a new user has been registered</descr>
            </option>
            <option name="savechangednick">
                 <value>user password color1 color2 status email</value>
                 <descr>Specifies the fields which will be saved into the database if a new user has been changed then the user loggs out or goes offline</descr>
            </option>
            <option name="selectlogin">
                 <value>user nick password color1 color2 status email</value>
                 <descr>Specifies the fields which will be selected from the database if a registered user loggs in</descr>
            </option>
            <option name="selectnick">
                 <value>user nick</value>
                 <descr>Specifies the fields which will be selected from the database a user tries to logg in. Here only the nick will be fetched to check if the username is registered or not</descr>
            </option>
        </category>
    </category>
    <category name="maxlength">
        <option name="word">
            <value>50</value>
            <descr>Maximum length of a word inside a chat message. The word will be seperate by a blank if exceeded</descr>
        </option>
        <option name="message">
            <value>500</value>
            <descr>Maximum length of a chat message</descr>
        </option>
        <option name="username">
            <value>15</value>
            <descr>Maximum length of a user name</descr>
        </option>
        <option name="roomname">
            <value>20</value>
            <descr>Maximum length of a room name</descr>
        </option>
        <option name="emailaddress">
            <value>20</value>
            <descr>Maximum length of an email address</descr>
        </option>
        <option name="password">
            <value>20</value>
            <descr>Maximum length of the user password</descr>
        </option>
        <option name="topic">
            <value>20</value>
            <descr>Maximum length of a room&apos;s topic</descr>
        </option>
    </category>
    <category name="system">
        <option name="mysqlclient">
            <value>/usr/local/bin/mysql</value>
            <descr>Full path to the mysql client program</descr>
        </option>
    </category>
    <category name="msgs">
        <option name="userlist">
            <value>List of logged in users: </value>
        </option>
        <option name="system">
            <value>Global system message: </value>
        </option>
        <option name="servertime">
            <value>The server system time: </value>
        </option>
        <option name="guest">
            <value>This person is a guest chatter!</value>
        </option>
        <option name="lastactivity">
            <value>Last activity:</value>
        </option>
        <option name="userrenamesroom">
            <value> renames the room into </value>
        </option>
        <option name="usermorphs">
            <value> morphs his name into </value>
        </option>
        <option name="optionschanged">
            <value>Your options have been changed!&lt;br&gt;&lt;br&gt;</value>
        </option>
        <option name="rang0">
            <value>Operator</value>
        </option>
        <option name="rang1">
            <value>Half-Operator</value>
        </option>
        <option name="rang2">
            <value>Voiced user</value>
        </option>
        <option name="registernick">
            <value>Your nick has been registered successfully. You may log in now!&lt;br&gt;&lt;br&gt;</value>
        </option>
        <option name="reloadonlineframe">
            <value>Reloaded online frame</value>
        </option>
        <option name="scream">
            <value> screams:</value>
        </option>
        <option name="servertime">
            <value>The server system time::</value>
        </option>
        <option name="setcommandstatus">
            <value> sets command status</value>
        </option>
        <option name="setmodeaway">
            <value> sets mode away</value>
        </option>
        <option name="setmodefake">
            <value>Fake modus acticated!</value>
        </option>
        <option name="setmodeinvisible">
            <value>Invisible modus activated!</value>
        </option>
        <option name="topic">
            <value> changes the topic to:</value>
        </option>
        <option name="topiccut">
            <value>The topic you have choosen was too long and has been cut!</value>
        </option>
        <option name="topicdelete">
            <value> deletes the topic of the room.</value>
        </option>
        <option name="unsetmodeaway">
            <value> is back </value>
        </option>
        <option name="unsetmodefake">
            <value>Fake modus deactivated!</value>
        </option>
        <option name="unsetmodeinvisible">
            <value>Invisible modus deactivated!</value>
        </option>
        <option name="uptime">
            <value>yChat uptime: </value>
        </option>
        <option name="userautoawaytimeout">
            <value> has been set to away (auto away)</value>
        </option>
        <option name="userenterschat">
            <value> enters the chat.</value>
        </option>
        <option name="userentersroom">
            <value> enters the room </value>
        </option>
        <option name="userhasstatus">
            <value> has status </value>
        </option>
        <option name="userinroom">
            <value> is in room </value>
        </option>
        <option name="userkicksout1">
            <value> kicks </value>
        </option>
        <option name="userkicksout2">
            <value> out of the chat at room </value>
        </option>
        <option name="userleaveschat">
            <value> leaves the chat.</value>
        </option>
        <option name="userleavesroom">
            <value> leaves this room and switches to </value>
        </option>
        <option name="whisper">
            <value> whispers to you</value>
        </option>
        <option name="whisperto">
            <value>Whispered to </value>
        </option>
        <category name="help">
            <option name="all">
                <value>Writes a global system message into all available rooms. Usage: /all MESSAGE</value>
            </option>
            <option name="away">
                <value>Sets mode away. Usage: /away AWAYTEST</value>
            </option>
            <option name="col">
                <value>Changes the color. Usage: /col NICKCOLOR TEXTCOLOR</value>
            </option>
            <option name="exec">
                <value>Executes a command in the system shell. Usage: /exec SHELLCOMMAND</value>
            </option>
            <option name="fake">
                <value>Hides status logo. Usage: /fake</value>
            </option>
            <option name="getrusage">
                <value>Shows informations describing the resources utilized by the yChat process. Usage: /getrusage</value>
            </option>
            <option name="about">
                <value>Gets some usefull and interesting infos about NICK. Usage: /about NICK</value>
            </option>
            <option name="help">
                <value>Shows help text for a specific command. Usage: /help chatcommand</value>
            </option>
            <option name="invisible">
                <value>Activates or deactivates the invisible mode</value>
            </option>
            <option name="j">
                <value>Changes the room. Usage: /j ROOMNAME</value>
            </option>
            <option name="ko">
                <value>Kicks a user out of the chat. Usage: /ko NICKNAME</value>
            </option>
            <option name="m">
                <value>Writes the text italic (two colors). Usage: /m ACTION</value>
            </option>
            <option name="morph">
                <value>Morphes your current nick into MORPHNICK. This command is used to change the upper and lower case letters of your current nick. Usage: /morph MORPHNICK</value>
            </option>
            <option name="md5">
                <value>MD5 hashes SOME STRINGS with SALT. Usage: /md5 SOME STRINGS SALT</value>
            </option>
            <option name="me">
                <value>Writes the text italic (one color). Usage: /m ACTION</value>
            </option>
            <option name="msg">
                <value>Whispers TEXT to NICKNAME. Usage: /msg NICKNAME TEXT</value>
            </option>
            <option name="version">
                <value>Shows the version of the running yChat server. Usage: /version</value>
            </option>
            <option name="compopt">
                <value>Shows some options of the compiler being used to build this yChat version. It also shows the current systen architecture and operating system as well as the yChat build number. Usage: /compopt</value>
            </option>
            <option name="q">
                <value>Leaving the chat. Usage: /q</value>
            </option>
            <option name="ren">
                <value>Renames the current room into NEWROOMNAME. Usage: /ren NEWROOMNAME</value>
            </option>
            <option name="reload">
                <value>Reloads the online frame of the current room. Usage: /reload</value>
            </option>
            <option name="set">
                <value>Changes command permissions. P.e.: &quot;/set q status 3&quot; allows the command from status 3 or &quot;/set q disable 1&quot; deactivates the command. Disable 0 reactivates the command again. Usage: /set COMMAND MODE VAL</value>
            </option>
            <option name="getroom">
                <value>Shows the room of the specific user. Useage: /getroom NICKNAME</value>
            </option>
            <option name="time">
                <value>Shows the server system time. Usage: /time</value>
            </option>
            <option name="uptime">
                <value>Shows the yChat uptime. Usage: /uptime</value>
            </option>
            <option name="users">
                <value>Shows currently logged in users. Usage: /users</value>
            </option>
            <option name="s">
                <value>Screams the TEXT. Usage: /s TEXT</value>
            </option>
            <option name="topic">
                <value>Changes the topic of the current room into TOPIC. Usage: /topic TOPIC</value>
            </option>
        </category>
        <category name="err">
            <option name="alpnum">
                <value>The nick you have specifued is not alphanumeric, please change that.&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="alreadyinroom">
                <value>You are already in the room</value>
            </option>
            <option name="changepassword">
                <value>The old password you have entered is wrong. In order to change your password you need to enter a correct old password!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="changepassword2">
                <value>The two password fiels oth the new password are not identical. Please check that again otherwise the password will not be changed!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="emaillength">
                <value>Your email address is too long!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="execcommand">
                <value>Could not execute command!</value>
            </option>
            <option name="findingcommand">
                <value>No such command!&lt;br&gt;</value>
            </option>
            <option name="maxuserlimit">
                <value>You cant log in because the maxuser limit has been reached. Please try again later.&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="messagelength">
                <value>Your message was too long and has been shortened!</value>
            </option>
            <option name="morphnick">
                <value>Your morph nick needs to be the same like your current nick, only up- and lowercase letters are allowed to differ!</value>
            </option>
            <option name="nicklength">
                <value>Your nick is too long!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="nonick">
                <value>You need to specify a nickname!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="noguest">
                <value>Guest chatting is currently disabled. Please use a registered nick!</value>
            </option>
            <option name="noroom">
                <value>You have to enter a valid room name!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="notavailable">
                <value>is not available!</value>
            </option>
            <option name="notonline">
                <value>An error occured. Your nick is not online!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="online">
                <value>The nick you have specified is already online. Please try another nick!!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="passlength">
                <value>Your password is too long!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="registerexists">
                <value>The nickname you want to register already exists. Please choose another one!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="registerpassword">
                <value>The password selections differ. Please re-enter your password fields!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="roomexists">
                <value>The new name of the room you have choosen is already taken by another room!</value>
            </option>
            <option name="roomnamelength">
                <value>Your room name too long!&lt;br&gt;&lt;br&gt;</value>
            </option>
            <option name="wrongcommandusage">
                <value>Wrong command usage. Please read the help site or type /help commandname!</value>
            </option>
            <option name="wrongpassword">
                <value>The nickname you have selected already exists in the user database and you have entered a wrong password!&lt;br&gt;&lt;br&gt;</value>
            </option>
        </category>
    </category>
    <category name="idle">
        <option name="awaytimeout">
            <value>1800</value>
            <descr>Seconds of inanctivity after a user will get logged out if the user is away</descr>
        </option>
        <option name="autoawaytimeout">
            <value>500</value>
            <descr>Seconds until a user will be set to away automatically</descr>
        </option>
        <option name="timeout">
            <value>900</value>
            <descr>Seconds of inactivity after a user will get logged out automatically</descr>
        </option>
    </category>
    <category name="session">
        <option name="md5hash">
            <value>true</value>
            <descr>If set to true, then the session id will be hashed by MD5 to make the id even more random</descr>
        </option>
        <option name="md5salt">
            <value>tASDlkjadSD</value>
            <descr>Some random string which will affect the md5-hash. Change this to another random string!</descr>
        </option>
        <option name="length">
            <value>64</value>
            <descr>Length of the generated session id. The length will be shorter if md5hash is activated</descr>
        </option>
        <option name="validchars">
            <value>.abcdefghijklmnopqrstuvwxyz0123456789-_</value>
            <descr>Valid chars which can be in a session id. The generated session will use other chars if md5hash is activated</descr>
        </option>
        <option name="kloakkey">
            <value>123987</value>
            <descr>Some numner which will affect the session id. Change this to another random number!</descr>
        </option>
    </category>
    <category name="html">
        <option name="tagsallow">
            <value>false</value>
            <descr>If set to false, yChat strips all html tags from incoming messages</descr>
        </option>
        <option name="ghost">
            <value>size="1" color="#999999"</value>
            <descr>Specifies the font-parameters for the nick name if the user is a ghost chatter</descr>
        </option>
        <option name="errorcolor">
            <value>FF0000</value>
            <descr>Specifies the standard error message color</descr>
        </option>
        <option name="sysmsgcolor">
            <value>FF0000</value>
            <descr>Specifies the standard system message color</descr>
        </option>
        <option name="onlinebefore">
            <value>&lt;tr&gt;&lt;td&gt;</value>
            <descr>HTML-Tags which will be placed before each nickname in the user online frame</descr>
        </option>
        <option name="onlinebehind">
            <value>&lt;/td&gt;&lt;/tr&gt;</value>
            <descr>HTML-Tags which will be placed behind each nickname in the user online frame</descr>
        </option>
        <category name="rangimages">
            <option name="location">
                <value>images/</value>
                <descr>Specifies the location of the status (status) symbols of the users. This path has to be reachable through the web, e.g.: &quot;http://www.webreachable.com/images/&quot;. If no http:// is specified then the images are inside the conf:httpd.templatedir directory</descr>
            </option>
            <option name="options">
                <value> width=&quot;16&quot; height=&quot;16&quot;</value>
                <descr>Options to add to the &lt;img&gt; tag (leave first char blank)</descr>
            </option>
        </category>
        <category name="user">
            <option name="color1">
                <value>AAAAAA</value>
                <descr>User&apos;s standard nick color in hexadecimal</descr>
            </option>
            <option name="color2">
                <value>FFFFFF</value>
                <descr>User&apos;s standard text color in hexadecimal</descr>
            </option>
        </category>
        <category name="replace">
            <option name="activate">
                <value>true</value>
                <descr>If set to true, then this replace option will be used</descr>
            </option>
            <category name="from">
                <option name="red">
                    <value>red</value>
                </option>
                <option name="green">
                    <value>green</value>
                </option>
                <option name="orange">
                    <value>orange</value>
                </option>
                <option name="yellow">
                    <value>yellow</value>
                </option>
            </category>
            <category name="into">
                <option name="red">
                    <value>&lt;font color=&quot;red&quot;&gt;red&lt;/font&gt;</value>
                </option>
                <option name="green">
                    <value>&lt;font color=&quot;green&quot;&gt;green&lt;/font&gt;</value>
                </option>
                <option name="orange">
                    <value>&lt;font color=&quot;orange&quot;&gt;orange&lt;/font&gt;</value>
                </option>
                <option name="yellow">
                    <value>&lt;font color=&quot;yellow&quot;&gt;yellow&lt;/font&gt;</value>
                </option>
            </category>
        </category>
    </category>
    <category name="logging">
        <option name="roomlogdir">
            <value>log/rooms/</value>
            <descr>Specifies the relative or absolute path to the directory of the room log files</descr>
        </option>
        <option name="roomloglines">
            <value>20</value>
            <descr>Number of room log lines which will be buffered in the main memory until they will be written into the file</descr>
        </option>
    </category>
</category>
<category name="httpd">
    <option name="serverport">
        <value>2000</value>
        <descr>Local port on which the server listens</descr>
    </option>
    <option name="enablecgi">
        <value>false</value>
        <descr>Support for CGI scripts</descr>
    </option>
    <option name="startsite">
        <value>index.html</value>
        <descr>Specifies the standard start HTML-template</descr>
    </option>
    <option name="templatedir">
        <value>html/</value>
        <descr>If set to false, yChat strips all html tags from incoming messages</descr>
    </option>
    <option name="ipcachesize">
        <value>50</value>
        <descr>Specifies the IP cache size. If set to 0, the IP cache will be cleared every 10 minutes. Otherwise, the IP cache will be cleared every 10 minutes only if there are more IPs in the cache than the specified amount.</descr>
    </option>
    <category name="html">
        <option name="notfound">
            <value>notfound.html</value>
            <descr>The HTML site which will be displayed if the requested file does not exists</descr>
        </option>
    </category>
    <category name="thread">
        <option name="initpoolsize">
            <value>10</value>
            <descr>Initial number of threads running at the same time. If there are less than 5 threads in the pool waiting, the thread pool will resize to 10.</descr>
	</option>
        <option name="maxpoolsize">
            <value>0</value>
            <descr>Maximum amount of parallel running threads. Change this to 0 if you want to use unlimited threads. If you have set a number not equal to 0, then there have to be at least 2 waiting threads to allow a new user login. A maxpoolsize of 52 means a max user limit of 50 users.</descr>
        </option>
    </category>
    <category name="stats">
        <option name="rusagehistory">
            <value>7</value>
            <descr>Number of days to track the system resource usage. You can check the history in the CLI mode</descr>
        </option>
    </category>
    <category name="system">
        <option name="shell">
            <value>tcsh</value>
            <descr>The external command for the system shell which can be selected in the CLI mode</descr>
        </option>
    </category>
    <category name="modules">
        <option name="commandsdir">
            <value>mods/commands/</value>
            <descr>Specifies the relative or absolute path to the command&apos;s .so module files which can be loaded and unloaded at runtime</descr>
        </option>
        <option name="htmldir">
            <value>mods/html/</value>
            <descr>Specifies the relative or absolute path to the html&apos;s .so module files which can be loaded and unloaded at runtime</descr>
        </option>
        <option name="preloadcommands">
            <value>true</value>
            <descr>If set to true, all command modules will be preloaded at server startup</descr>
        </option>
        <option name="preloadhtml">
            <value>true</value>
            <descr>If set to true, all html modules will be preloaded at server startup</descr>
        </option>
    </category>
    <category name="logging">
        <option name="accessfile">
            <value>log/access_log</value>
            <descr>Specifies the relative or absolute path to the apache combined style log file</descr>
        </option>
        <option name="systemfile">
            <value>log/system_log</value>
            <descr>Specifies the relative or absolute path to the system messsage log file</descr>
        </option>
        <option name="accesslines">
            <value>20</value>
            <descr>Number of access log lines which will be buffered in the main memory until they will be written into the file</descr>
        </option>
        <option name="systemlines">
            <value>20</value>
            <descr>Number of system log lines which will be buffered in the main memory until they will be written into the file</descr>
        </option>
    </category>
    <category name="contenttypes">
        <option name="htm">
            <value>text/html</value>
        </option>
        <option name="html">
            <value>text/html</value>
        </option>
        <option name="gif">
            <value>image/gif</value>
        </option>
        <option name="jpg">
            <value>image/jpeg</value>
        </option>
        <option name="jpe">
            <value>image/jpeg</value>
        </option>
        <option name="jpeg">
            <value>image/jpeg</value>
        </option>
        <option name="png">
            <value>image/png</value>
        </option>
        <option name="txt">
            <value>text/plain</value>
        </option>
        <option name="default">
            <value>text/html</value>
        </option>
    </category>
</category>