This document lists all of the current $config vars (found in the realm files) and descriptions/use of each.

Last Updated: March 12, 2002

NOTE: Not all options work in all versions of eF. We recommend using the most recent eF available from the website at http://www.electrifiedpenguin.com
If you have upgraded from previous versions, you may need to manually add config vars to your realm file.

Core Options
--------------------------------------------------------------------------------

$config['title']

The "Title" of this realm. Default is set by the installer to the admin's preference.


Database Options
--------------------------------------------------------------------------------

$config['dbhost']

The hostname/ipaddress (and :port, if needed) of the database server. Default is set by the installer to the admin's preference.
Example Values: "localhost"    "mysql.mydomain.com"    "mysqlserver.website.com:3306"   "123.123.123.123:6000"


$config['dbuser']

The database username of a user with read/write permissions to the database. Default is set by the installer to the admin's preference.


$config['dbpass']

The password for the above named database user.


$config['dbname']

The name of the database to be used to store the eF tables. Default is set by the installer to the admin's preference.


$config['utable']

The table used to store user information. Default is "fusers"


$config['mtable']

The table used to store messages. Default is "messages"


$config['ftable']

The table used to store forum information. Default is "forums"


$config['pmtable']

The table used to store private messages. Default is "pmessages"


Registration Options
--------------------------------------------------------------------------------

$config['req_auth']

Possible values: TRUE, FALSE
If set to true, users must log-in prior to even viewing the boards. Unregistered users can still access registration. Default is FALSE (off).


$config['req_auth_text']

Default this is blank.  The value of this setting will be displayed when a user has to register, or login first.  If this field is blank, the default text will be used


$config['restrict_new_signups']

Possible values: TRUE, FALSE
If set to true, no new registrations will be accepted. Registered users can still log in. Default is FALSE (off).


$config['restrict_signups_text']

Default this is blank.  The value of this setting will be displayed when a user attempts to register when new registration is disabled.  If this field is blank, the default text will be used


$config['allow_multiple_accts']

Possible values: TRUE, FALSE
If set to true, users will be allowed to signup for more than one account using the same email address. Otherwise, users may only have one account per email address. Default is FALSE (one account per email).


$config['allow_anon']

Possible values: TRUE, FALSE
If set to true, users will be allowed to post anonymously, AND unregistered users will be allowed to post as anonymous. The default is set during installation.


$config['moderate_signups'] (FUTURE OPTION)

Possible values: TRUE, FALSE
If set to true, Administrators must approve of all new signups before they are activated. Default is FALSE (off)


$config['signups_notification'] (FUTURE OPTION)

Possible values: TRUE, FALSE
If set to true, Administrators will recieve an email each time someone registers. This is a good idea to enable if using signups moderation. Default is FALSE (off)


$config['verify_email'] (FUTURE OPTION)

Possible values: TRUE, FALSE
If set to true, new users must verify their email address before their account is fully active. If used with [moderate_signups], this part will happen before an Admin is asked to approve of an account. Default is FALSE (off)


Localization Options
--------------------------------------------------------------------------------

$config['language']

Language file for eF to use. Must match up to the middle part of a language file in the lang subdirectory, for example, to use english (lang.english.php), the value would be "english". The default for this option is set at install time.


$config['24hour']

Possible values: TRUE, FALSE
If set to true, time will be displayed in 24 hour format instead of 12 hour AM/PM format. Default is FALSE (off)


$config['time_offset'] (FUTURE OPTION)


Security Options
--------------------------------------------------------------------------------

$config['pass_encrypt']

Possible values: "mysql", ""
If left blank, passwords will be stored in plaintext. It is recommended that you use mysql encryption. More options to come later. Default is set at install time.
NOTE: DO NOT change this option once your realm is set up. If sharing a user table between realms, all realms must have the same value here.


User Rating Options
--------------------------------------------------------------------------------

$config['karma_disable']

Possible values: TRUE, FALSE
If set to true, the old-style "karma" rating system will be disabled. Default is FALSE (Karma on)


$config['show_post_count']

Possible values: TRUE, FALSE
If set to true, the number of posts a user has made will be displayed next to their posts. Default is TRUE (on)


$config['post_count_ratings']

Possible values: TRUE, FALSE
If set to true, the post count rating method is enabled and their rating will be displayed next to their posts. Default is TRUE (on)


$config['hide_level']

Possible values: TRUE, FALSE
If set to true, the "Member" attribute will be hidden. This is good to do when using post count ratings. Default is TRUE (hide level)


Post Count Ratings Array Information:

If you have enabled post count ratings, you will need to setup your ratings structure.
This uses an array, $config[ratings]. An example is provided, and we will discuss it below.

$config[ratings][0][min] = 1;						<--- This is the minimum number of posts to reach this level									
$config[ratings][0][max] = 9;						<--- This is the maximum number of posts to stay in this level									
$config[ratings][0][text] = "Newbie";		<--- This is the 'rating' for the level, what is displayed next to a user in this level									
$config[ratings][1][min] = 10;
$config[ratings][1][max] = 29;
$config[ratings][1][text] = "Lurker";

You can have any number of levels. Please take care to assure you have no levels overlapping, and no gaps between levels. If in doubt, stick to the default, and inquire on our support boards.


Feature Options
--------------------------------------------------------------------------------

$config['messaging']

Possible Values: TRUE, FALSE
If set to true, private messaging will be enabled. Setting to false will turn off private messaging completely. Default is TRUE (enable private messaging)


$config['filtering']

Possible Values: TRUE, FALSE
If set to true, messages will be filtered, starring out words based on the $config[badwords] array. Default is FALSE (off)


$config['badwords']

Array of words to be filtered, when filtering is enabled.
Example: array("word1", "word2", "word3")


$config['efcode']

Possible Values: TRUE, FALSE
If set to true, eF Code will be allowed & processed in messages. Default is TRUE (enabled)


$config['use_gzip']

Possible Values: TRUE, FALSE
If set to true, eF will compress the output in GZip format, lowering bandwidth use. In order to use GZip, you must have the zlib extension in PHP. Default is TRUE (gzip on)
NOTE: This option is safe to leave on, even if you are unsure of the zlib support in PHP. If zlib is not available, or if the end user's browser does not support gzip compression, this option will be ignored.


Display Options
--------------------------------------------------------------------------------

$config['show_debug_info']

Possible Values: TRUE, FALSE
If set to true, technical info (execution time, # of sql queries, etc) will be displayed at the bottom of the page. Default is FALSE (do not show debug info)


$config['topics_per_page']

This is an integer value of the number of topics shown per forum page. The default is set at install time.


$config['posts_per_page']

This is an integer value of the number of posts shown per topic page. The default is set at install time.


$config['use_buttons']

Possible Values: TRUE, FALSE
If set to true, graphical post/reply buttons will be used. If false, only text links will be shown for posting/replying. Default is TRUE (graphical buttons)


$config['reply_butn']

The path/filename (relative from the ef install root) of the image to use for 'reply'.


$config['post_butn']

The path/filename (relative from the ef install root) of the image to use for 'new post'.


$config['avatar_dir']

The path (relative from the ef install root) of the directory storing avatar images. Default is 'art/avatars/'


$config['msgicons_dir']

The path (relative from the ef install root) of the directory storing icons that can be used to identify posts. Default is 'art/msgicons/'


$config['msgicon']

The filename of the image to use as a default message icon. Image must be in the msgicons_dir directory. Default is 'icon1.gif'


$config['forumicon']

The path/filename (relative from the ef install root) of the forum icon to use for forums without new messages. Default is 'art/grey_folder.gif'


$config['forumiconnew']

The path/filename (relative from the ef install root) of the forum icon to use for forums with new messages. Default is 'art/blue_folder.gif'


$config['rankcolor']

The directory name (under the art directory) of the images used for rankings (only old karma system). Default is 'blue'


$config['table_width']

The width of the tables. Can be fixed or percentage. Default is '90%'


$config['icondir']

The path (relative from the ef install root) of the directory storing icons used for things like aim, icq, quote, etc. Default is 'art/icons'. We also include icons-white, icons with white text, in the directory 'art/icons-white'


$config['color_top']

Color of the header rows of the tables. Color is chosen at install time, and is in HTML Hex format.


$config['color_top_font']

Color of the header row text. Color is chosen at install time, and is in HTML Hex format.


$config['color_a']

Color of primary table rows. Color is chosen at install time, and is in HTML Hex format.


$config['color_b']

Color of alternating table rows. Color is chosen at install time, and is in HTML Hex format.


$config['tcolor']

Color of the table borders. Color is chosen at install time, and is in HTML Hex format.
