Remove data/ dir from distribution, update docs accordingly.
[squirrelmail.git] / config / config_default.php
index cb69b50e7a8d3f2793e08c92b9f5689e0f6c42b0..90e8ede09026bc92b7b5f20db175a7b3fed4e9ea 100644 (file)
@@ -50,7 +50,7 @@ $org_logo_height = '111';
  * This is the web page title that appears at the top of the browser window.
  * @global string $org_title
  */
-$org_title = "SquirrelMail $version";
+$org_title = "SquirrelMail";
 
 /**
  * Signout page
@@ -80,7 +80,7 @@ $frame_top = '_top';
  *
  * Here you can set name of the link displayed on the right side of main page.
  *
- * Link will be displayed only if you have $hide_sm_attributions 
+ * Link will be displayed only if you have $hide_sm_attributions
  * option set to true.
  * @global string $provider_name
  */
@@ -90,12 +90,12 @@ $provider_name = 'SquirrelMail';
  * Provider URI
  *
  * Here you can set URL of the link displayed on the right side of main page.
- *
- * Link will be displayed only if you have $hide_sm_attributions 
+ * When empty, this refers to the SquirrelMail About page.
+ * Link will be displayed only if you have $hide_sm_attributions
  * option set to true.
  * @global string $provider_uri
  */
-$provider_uri = 'http://www.squirrelmail.org/';
+$provider_uri = '';
 
 /*** Server Settings ***/
 /**
@@ -104,7 +104,7 @@ $provider_uri = 'http://www.squirrelmail.org/';
  * The domain part of local email addresses.
  *   This is for all messages sent out from this server.
  *   Reply address is generated by $username@$domain
- * Example: In bob@foo.com, foo.com is the domain.
+ * Example: In bob@example.com, example.com is the domain.
  * @global string $domain
  */
 $domain = 'example.com';
@@ -125,7 +125,7 @@ $invert_time = false;
  *
  * What should be used when sending email.
  * If it is set to false, SquirrelMail will use SMTP server settings.
- * If it is set to true, SquirrelMail will use program defined in 
+ * If it is set to true, SquirrelMail will use program defined in
  * $sendmail_path
  * @global bool $useSendmail
  */
@@ -143,29 +143,34 @@ $smtpServerAddress = 'localhost';
 $smtpPort = 25;
 
 /**
- * SquirrelMail header control
+ * SquirrelMail header encryption
+ *
+ * Encryption key allows to hide SquirrelMail Received: headers
+ * in outbound messages. Interface uses encryption key to encode
+ * username, remote address and proxied address, then stores encoded
+ * information in X-Squirrel-* headers.
  *
- * Option can be used to disable Received: headers added by squirrelmail.
- * This can increase user's privacy and solve problems with spam filters
- * that increase spam marks for dynamic dialup addresses.
+ * Warning: used encryption function is not bulletproof. When used
+ * with static encryption keys, it provides only minimal security
+ * measures and information can be decoded quickly.
  *
- * If admin enables this setting, system should have some logging facility 
- * or other tools to control users. SquirrelMail's Received: header provides 
- * information, that can't be forged by webmail user.
- * @global bool $skip_SM_header
+ * Encoded information can be decoded with decrypt_headers.php script
+ * from SquirrelMail contrib/ directory.
+ * @global string $encode_header_key
+ * @since 1.5.1 and 1.4.5
  */
-$skip_SM_header = false;
+$encode_header_key = '';
 
 /**
  * Path to Sendmail
  *
  * Program that should be used when sending email. SquirrelMail expects that
- * this program will follow options used by original sendmail 
+ * this program will follow options used by original sendmail
  * (http://www.sendmail.org).
  * @global string $sendmail_path
  */
 $sendmail_path = '/usr/sbin/sendmail';
-    
+
 /**
  * IMAP server address
  *
@@ -192,13 +197,15 @@ $imapPort = 143;
  *   exchange
  *   uw
  *   macosx
+ *   hmailserver
  *   mercury32
+ *   dovecot
  *   other
  *
  * Please note that this changes only some of server settings.
  *
  * In order to set everything correctly, you need to adjust several
- * squirrelmail options. These options are listed in doc/presets.txt
+ * SquirrelMail options. These options are listed in doc/presets.txt
  * @global string $imap_server_type
  */
 $imap_server_type = 'other';
@@ -360,7 +367,7 @@ $auto_create_special = true;
  * List Special Folders First Control
  *
  * Whether or not to list the special folders first (true/false).
- * @global bool $list_special_folders_first 
+ * @global bool $list_special_folders_first
  */
 $list_special_folders_first = true;
 
@@ -382,7 +389,7 @@ $default_sub_of_inbox = true;
  * option during folder creation. The option toggles which type of
  * folder it should be.
  *
- * If this option confuses you, just set it to 'true'. You can not hurt 
+ * If this option confuses you, just set it to 'true'. You can not hurt
  * anything if it's true, but some servers will respond weird if it's
  * false. (Cyrus works fine whether it's true OR false).
  * @global bool $show_contain_subfolders_option
@@ -393,7 +400,7 @@ $show_contain_subfolders_option = false;
  * These next two options set the defaults for the way that the
  * users see their folder list.
  *   $default_unseen_notify
- *       Specifies whether or not the users will see the number of 
+ *       Specifies whether or not the users will see the number of
  *       unseen in each folder by default and also which folders to
  *       do this to. Valid values are: 1=none, 2=inbox, 3=all.
  *   $default_unseen_type
@@ -418,21 +425,24 @@ $noselect_fix_enable = false;
 /**
  * Path to the data/ directory
  *
+ *   You need to create this directory yourself (see INSTALL).
+ *
  *   It is a possible security hole to have a writable directory
  *   under the web server's root directory (ex: /home/httpd/html).
- *   For this reason, it is possible to put the data directory
- *   anywhere you would like. The path name can be absolute or
- *   relative (to the config directory). It doesn't matter. Here
- *   are two examples:
+ *   The path name can be absolute or relative (to the config directory).
+ *   Here are two examples:
  *
  * Absolute:
- *   $data_dir = '/usr/local/squirrelmail/data/';
+ *   $data_dir = '/var/local/squirrelmail/data/';
  *
  * Relative (to main SM directory):
  *   $data_dir = SM_PATH . 'data/';
+ *   (NOT recommended: you need to secure apache to make sure these
+ *   files are not world readable)
+ *
  * @global string $data_dir
  */
-$data_dir = SM_PATH . 'data/';
+$data_dir = '/var/local/squirrelmail/data';
 
 /**
  * Attachments directory
@@ -445,8 +455,9 @@ $data_dir = SM_PATH . 'data/';
  *      list files in this directory. Confidential data might be laying
  *      around there.
  *    + Since the webserver is not able to list the files in the content
- *       is also impossible for the webserver to delete files lying around 
- *       there for too long.
+ *      is also impossible for the webserver to delete files lying around
+ *      there for too long. You should have some script that deletes
+ *      left over temp files.
  *    + It should probably be another directory than data_dir.
  * @global string $attachment_dir
  */
@@ -454,12 +465,12 @@ $attachment_dir = $data_dir;
 
 /**
  * Hash level used for data directory.
- * 
- * This option allows spliting file based squirrelmail user
+ *
+ * This option allows spliting file based SquirrelMail user
  * data storage directory into several subfolders. Number from
  * 0 to 4 allows allows having up to four subfolder levels.
  *
- * Hashing should speed up directory access if you have big number 
+ * Hashing should speed up directory access if you have big number
  * of users (500 and more).
  * @global integer $dir_hash_level
  */
@@ -496,7 +507,7 @@ $default_use_priority = true;
 /**
  * SquirrelMail Attributions Control
  *
- * This option disables display of "created by squirrelmail developers" 
+ * This option disables display of "created by SquirrelMail developers"
  * strings and provider link
  * @global bool $hide_sm_attributions
  */
@@ -524,11 +535,27 @@ $default_use_mdn = true;
 $edit_identity = true;
 $edit_name = true;
 
+/**
+ * SquirrelMail adds username information to every sent email.
+ * It is done in order to prevent possible sender forging when 
+ * end users are allowed to change their email and name 
+ * information.
+ *
+ * You can disable this header, if you think that it violates
+ * user's privacy or security. Please note, that setting will
+ * work only when users are not allowed to change their identity.
+ *
+ * See SquirrelMail bug tracker #847107 for more details about it.
+ * @global bool $hide_auth_header
+ * @since 1.5.1 and 1.4.5
+ */
+$hide_auth_header = false;
+
 /**
  * Server Side Threading Control
  *
  * If you want to enable server side thread sorting options
- * Your IMAP server must support the THREAD extension for 
+ * Your IMAP server must support the THREAD extension for
  * this to work.
  * @global bool $allow_thread_sort
  */
@@ -548,7 +575,7 @@ $allow_server_sort = false;
  * IMAP Charset Use Control
  *
  * This option allows you to choose if SM uses charset search
- * Your imap server should support SEARCH CHARSET command for 
+ * Your imap server should support SEARCH CHARSET command for
  * this to work.
  * @global bool $allow_charset_search
  */
@@ -582,9 +609,9 @@ $session_name = 'SQMSESSID';
  *
  * To add a new theme to the options that users can choose from, just
  * add a new number to the array at the bottom, and follow the pattern.
- * 
+ *
  * $theme_default sets theme that will be used by default
- * $theme_css sets stylesheet (from theme/css directory) that will be 
+ * $theme_css sets stylesheet (from theme/css directory) that will be
  * used by default.
  * @global integer $theme_default
  * @global string $theme_css
@@ -707,6 +734,27 @@ $theme[35]['NAME'] = 'Minimal BW';
 $theme[36]['PATH'] = SM_PATH . 'themes/redmond.php';
 $theme[36]['NAME'] = 'Redmond';
 
+$theme[37]['PATH'] = SM_PATH . 'themes/netstyle_theme.php';
+$theme[37]['NAME'] = 'Net Style';
+
+$theme[38]['PATH'] = SM_PATH . 'themes/silver_steel_theme.php';
+$theme[38]['NAME'] = 'Silver Steel';
+
+$theme[39]['PATH'] = SM_PATH . 'themes/simple_green_theme.php';
+$theme[39]['NAME'] = 'Simple Green';
+
+$theme[40]['PATH'] = SM_PATH . 'themes/wood_theme.php';
+$theme[40]['NAME'] = 'Wood';
+
+$theme[41]['PATH'] = SM_PATH . 'themes/bluesome.php';
+$theme[41]['NAME'] = 'Bluesome';
+
+$theme[42]['PATH'] = SM_PATH . 'themes/simple_green2.php';
+$theme[42]['NAME'] = 'Simple Green 2';
+
+$theme[43]['PATH'] = SM_PATH . 'themes/simple_purple.php';
+$theme[43]['NAME'] = 'Simple Purple';
+
 /**
  * LDAP server(s)
  *   Array of arrays with LDAP server parameters. See
@@ -718,7 +766,7 @@ $theme[36]['NAME'] = 'Redmond';
  *       'host' => 'memberdir.netscape.com',
  *       'name' => 'Netcenter Member Directory',
  *       'base' => 'ou=member_directory,o=netcenter.com'
- *   ); 
+ *   );
  */
 // Add your ldap server options here
 
@@ -734,11 +782,31 @@ $theme[36]['NAME'] = 'Redmond';
  */
 $default_use_javascript_addr_book = false;
 
+/**
+ * Shared filebased address book
+ * @global string $abook_global_file
+ * @since 1.5.1 and 1.4.4
+ */
+$abook_global_file = '';
+
+/**
+ * Writing into shared address book control
+ * @global bool $abook_global_file_writeable
+ * @since 1.5.1 and 1.4.4
+ */
+$abook_global_file_writeable = false;
+
+/**
+ * Listing of shared address book control
+ * @global bool $abook_global_file_listing
+ * @since 1.5.1
+ */
+$abook_global_file_listing = true;
 
 /**
  * MOTD
  *
- * This is a message that is displayed immediately after a user logs in. 
+ * This is a message that is displayed immediately after a user logs in.
  * @global string $motd
  */
 $motd = "";
@@ -749,15 +817,15 @@ $motd = "";
  * the plugin directory name relative to the /plugins/ directory.
  * For instance, for the 'sqclock' plugin, you'd put a line like
  * the following.
- *    $plugins[0] = 'sqclock';
- *    $plugins[1] = 'attachment_common';
+ *    $plugins[] = 'sqclock';
+ *    $plugins[] = 'attachment_common';
  */
 // Add list of enabled plugins here
 
 
 /*** Database ***/
 /**
- * Read doc/database.txt in order to get more information 
+ * Read doc/database.txt in order to get more information
  * about these settings.
  */
 /**
@@ -780,12 +848,31 @@ $prefs_table = 'userprefs';
 $prefs_key_field = 'prefkey';
 $prefs_user_field = 'user';
 $prefs_val_field = 'prefval';
+
+/*** Global sql database options ***/
 /**
- * Global sql database options
+ * DSN of global address book database
+ * @global string $addrbook_global_dsn
+ * @since 1.5.1
  */
 $addrbook_global_dsn = '';
+/**
+ * Table used for global database address book
+ * @global string $addrbook_global_table
+ * @since 1.5.1
+ */
 $addrbook_global_table = 'global_abook';
+/**
+ * Control writing into global database address book
+ * @global boolean $addrbook_global_writeable
+ * @since 1.5.1
+ */
 $addrbook_global_writeable = false;
+/**
+ * Control listing of global database address book
+ * @global boolean $addrbook_global_listing
+ * @since 1.5.1
+ */
 $addrbook_global_listing = false;
 
 /*** Language settings ***/
@@ -794,7 +881,7 @@ $addrbook_global_listing = false;
  *
  *   This is the default language. It is used as a last resort
  *   if SquirrelMail can't figure out which language to display.
- *   Language names usually consist of language code, undercore 
+ *   Language names usually consist of language code, undercore
  *   symbol and country code
  * @global string $squirrelmail_default_language
  */
@@ -812,23 +899,10 @@ $squirrelmail_default_language = 'en_US';
  */
 $default_charset = 'iso-8859-1';
 
-/**
- * Available Languages
- *
- * This option controls number of languages available to end user in
- * language selection preferences. You can use space separated list
- * of translations installed in locale/ directory or special keys
- * 'all' (all languages are available) and 'none' (language selection
- * is disabled, interface is set to $squirrelmail_default_language
- * @global string $available_languages
- * @since 1.5.0
- */
-$available_languages   = 'all';
-
 /**
  * Alternative Language Names Control
  *
- * This options allows displaying native language names in language 
+ * This options allows displaying native language names in language
  * selection box.
  * @global bool $show_alternative_names
  * @since 1.5.0
@@ -838,7 +912,7 @@ $show_alternative_names   = false;
 /**
  * Aggressive Decoding Control
  *
- * This option enables reading of Eastern multibyte encodings. 
+ * This option enables reading of Eastern multibyte encodings.
  * Functions that provide this support are very cpu and memory intensive.
  * Don't enable this option unless you really need it.
  * @global bool $aggressive_decoding
@@ -847,19 +921,42 @@ $show_alternative_names   = false;
 $aggressive_decoding = false;
 
 /**
- * Loosy Encoding Control
+ * Lossy Encoding Control
  *
- * This option allows charset conversions when output charset does not support 
- * all symbols used in original charset. Symbols unsupported by output charset 
+ * This option allows charset conversions when output charset does not support
+ * all symbols used in original charset. Symbols unsupported by output charset
  * will be replaced with question marks.
- * @global bool $loosy_encoding
+ * @global bool $lossy_encoding
+ * @since 1.5.1
+ */
+$lossy_encoding = false;
+
+/**
+ * Controls use of time zone libraries
+ *
+ * Possible values:
+ * <ul>
+ *  <li>0 - default, SquirrelMail uses GNU C timezone names in
+ *          TZ environment variables
+ *  <li>1 - strict, SquirrelMail uses 'TZ' subkey values in TZ
+ *          environment variables
+ *  <li>2 - custom, SquirrelMail loads time zone data from
+ *          config/timezones.php and uses time zone array keys in
+ *          TZ enviroment variables
+ *  <li>3 - custom strict, SquirrelMail loads time zone data from
+ *          config/timezones.php and uses TZ subkey values in
+ *          TZ enviroment variables
+ * </ul>
+ * Use of any other value switches to default SquirrelMail time zone
+ * handling ($time_zone_type).
+ * @global integer $time_zone_type
  * @since 1.5.1
  */
-$loosy_encoding = false;
+$time_zone_type = 0;
 
 /*** Tweaks ***/
 /**
- * Advanced DHTML tree control 
+ * Advanced DHTML tree control
  *
  * Use experimental DHTML folder listing
  * @global bool $advanced_tree
@@ -868,18 +965,21 @@ $loosy_encoding = false;
 $advanced_tree = false;
 
 /**
- * Older listing way control
+ * Iframe sandbox code control
  *
- * Use older way of folder listing
- * @global bool $oldway
+ * Use iframe to render html emails
+ * (temp option used during debuging of new code)
+ * @global bool $use_iframe
+ * @since 1.5.1
  */
-$oldway = false;
+$use_iframe = false;
 
 /**
  * Message Icons control
  *
  * Use icons for message and folder markers
  * @global bool $use_icons
+ * @since 1.5.1
  */
 $use_icons = false;
 
@@ -889,8 +989,8 @@ $use_icons = false;
  * Use experimental code with php recode functions when reading messages with
  * different encoding. This code is faster that original SM functions,
  * but it require php with recode support.
- * 
- * Don't enable this option if you are not sure about availability of 
+ *
+ * Don't enable this option if you are not sure about availability of
  * recode support.
  * @global bool $use_php_recode
  * @since 1.5.0
@@ -903,14 +1003,21 @@ $use_php_recode = false;
  * Use experimental code with php iconv functions when reading messages with
  * different encoding. This code is faster that original SM functions,
  * but it require php with iconv support and works only with some translations.
- * 
- * Don't enable this option if you are not sure about availability of 
+ *
+ * Don't enable this option if you are not sure about availability of
  * iconv support.
  * @global bool $use_php_iconv
  * @since 1.5.0
  */
 $use_php_iconv = false;
 
+/**
+ * Controls remote configuration checks
+ * @global boolean $allow_remote_configtest
+ * @since 1.5.1
+ */
+$allow_remote_configtest = false;
+
 /**
  * Subscribe Listing Control
  *
@@ -918,7 +1025,7 @@ $use_php_iconv = false;
  * generate the folder subscribe listbox (this can take a long time
  * when you have a lot of folders).  Instead, a textbox will be
  * displayed allowing users to enter a specific folder name to subscribe to
- * 
+ *
  * This option can't be changed by conf.pl
  * @global bool $no_list_for_subscribe
  */
@@ -928,7 +1035,7 @@ $no_list_for_subscribe = false;
  * Color in config control
  *
  * This option is used only by conf.pl script to generate configuration
- * menu with some colors and is provided here only as reference. 
+ * menu with some colors and is provided here only as reference.
  * @global integer $config_use_color
  */
 $config_use_color = 2;
@@ -945,4 +1052,4 @@ $config_use_color = 2;
  * sent and regular output to begin, which will majorly screw
  * things up when we try to send more headers later.
  */
-?>
\ No newline at end of file
+?>