X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=config%2Fconfig_default.php;h=c21f96d0f669033a4463cd376214d741c86d27d1;hp=4d73465436d9117b612b3574fbf91bee390335fb;hb=babad50305f1b991f32209a7f2e3b72a5eefe5c7;hpb=029d1fc26037b2b0c3744452ca26970c136d7009 diff --git a/config/config_default.php b/config/config_default.php index 4d734654..c21f96d0 100644 --- a/config/config_default.php +++ b/config/config_default.php @@ -15,7 +15,7 @@ * passwords being leaked to e.g. other system users. Take extra care when * the webserver is shared with untrusted users. * - * @copyright © 2000-2006 The SquirrelMail Project Team + * @copyright 2000-2019 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail @@ -23,9 +23,8 @@ */ /* Do not change this value. */ -global $version; global $config_version; -$config_version = '1.4.0'; +$config_version = '1.5.0'; /*** Organization preferences ***/ /** @@ -86,21 +85,23 @@ $frame_top = '_top'; /** * Provider name * - * Here you can set name of the link displayed on the right side of main page. + * Here you can set the text of the link displayed on the top-right + * of the message list. + * + * Defaults to empty (no link). * - * Link will be displayed only if you have $hide_sm_attributions - * option set to true. * @global string $provider_name */ -$provider_name = 'SquirrelMail'; +$provider_name = ''; /** * Provider URI * - * Here you can set URL of the link displayed on the right side of main page. - * When empty, this refers to the SquirrelMail About page. - * Link will be displayed only if you have $hide_sm_attributions - * option set to true. + * Here you can set URL of the link displayed on the top-right of + * the message list. + * + * Defaults to empty (no link). + * * @global string $provider_uri */ $provider_uri = ''; @@ -297,6 +298,15 @@ $smtp_sitewide_pass = ''; */ $imap_auth_mech = 'login'; +/** + * Show login error from the IMAP server (true) or show + * the traditional/generic "Unknown user or password + * incorrect" (false)? + * + * @global boolean $display_imap_login_error + */ +$display_imap_login_error = false; + /** * IMAP folder delimiter * @@ -321,6 +331,17 @@ $optional_delimiter = 'detect'; */ $pop_before_smtp = false; +/** + * POP before SMTP server address + * + * When using POP3 before SMTP, if the POP server address is + * not the same as the SMTP server address, specify it here. + * If this is left empty, the SMTP server address will be + * used by default. + * @global bool $pop_before_smtp_host + */ +$pop_before_smtp_host = ''; + /*** Folder Settings ***/ /** @@ -562,7 +583,7 @@ $default_use_priority = true; * SquirrelMail Attributions Control * * This option disables display of "created by SquirrelMail developers" - * strings and provider link + * strings and links. * @global bool $hide_sm_attributions * @since 1.2.0 */ @@ -580,15 +601,18 @@ $default_use_mdn = true; * Identity Controls * * If you don't want to allow users to change their email address - * then you can set $edit_identity to false, if you want them to + * then you can set $edit_identity to false; if you want them to * not be able to change their full name too then set $edit_name - * to false as well. $edit_name has no effect unless $edit_identity - * is false; + * to false as well. $edit_reply_to likewise controls users' ability + * to change their reply-to address. $edit_name and $edit_reply_to + * have no effect unless $edit_identity is false; * @global bool $edit_identity * @global bool $edit_name + * @global bool $edit_reply_to */ $edit_identity = true; $edit_name = true; +$edit_reply_to = true; /** * SquirrelMail adds username information to every sent email. @@ -661,206 +685,186 @@ $allow_advanced_search = 0; */ $session_name = 'SQMSESSID'; - /** - * Themes - * You can define your own theme and put it in this directory. - * You must call it as the example below. You can name the theme - * whatever you want. For an example of a theme, see the ones - * included in the config directory. + * Secure Cookies * - * 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. + * Only transmit cookies via a secure connection + * if the session was started using HTTPS/SSL? * - * $theme_default sets theme that will be used by default - * $theme_css sets stylesheet (from theme/css directory) that will be - * used by default. - * @global integer $theme_default - * @global string $theme_css + * Highly recommended + * + * @global bool $only_secure_cookies + * @since 1.5.2 and 1.4.16 */ -$theme_default = 0; -$theme_css = ''; +$only_secure_cookies = true; /** - * Listing of installed themes - * @global array $theme + * Secure Forms + * + * Disable security tokens used to authenticate the + * source of user data received by SquirrelMail? + * + * It is highly discouraged to enable this setting. + * + * @global bool $disable_security_tokens + * @since 1.5.2 and 1.4.20RC1 */ -$theme[0]['PATH'] = SM_PATH . 'themes/default_theme.php'; -$theme[0]['NAME'] = 'Default'; - -$theme[1]['PATH'] = SM_PATH . 'themes/plain_blue_theme.php'; -$theme[1]['NAME'] = 'Plain Blue'; - -$theme[2]['PATH'] = SM_PATH . 'themes/sandstorm_theme.php'; -$theme[2]['NAME'] = 'Sand Storm'; - -$theme[3]['PATH'] = SM_PATH . 'themes/deepocean_theme.php'; -$theme[3]['NAME'] = 'Deep Ocean'; - -$theme[4]['PATH'] = SM_PATH . 'themes/slashdot_theme.php'; -$theme[4]['NAME'] = 'Slashdot'; - -$theme[5]['PATH'] = SM_PATH . 'themes/purple_theme.php'; -$theme[5]['NAME'] = 'Purple'; - -$theme[6]['PATH'] = SM_PATH . 'themes/forest_theme.php'; -$theme[6]['NAME'] = 'Forest'; - -$theme[7]['PATH'] = SM_PATH . 'themes/ice_theme.php'; -$theme[7]['NAME'] = 'Ice'; - -$theme[8]['PATH'] = SM_PATH . 'themes/seaspray_theme.php'; -$theme[8]['NAME'] = 'Sea Spray'; - -$theme[9]['PATH'] = SM_PATH . 'themes/bluesteel_theme.php'; -$theme[9]['NAME'] = 'Blue Steel'; - -$theme[10]['PATH'] = SM_PATH . 'themes/dark_grey_theme.php'; -$theme[10]['NAME'] = 'Dark Grey'; - -$theme[11]['PATH'] = SM_PATH . 'themes/high_contrast_theme.php'; -$theme[11]['NAME'] = 'High Contrast'; - -$theme[12]['PATH'] = SM_PATH . 'themes/black_bean_burrito_theme.php'; -$theme[12]['NAME'] = 'Black Bean Burrito'; - -$theme[13]['PATH'] = SM_PATH . 'themes/servery_theme.php'; -$theme[13]['NAME'] = 'Servery'; - -$theme[14]['PATH'] = SM_PATH . 'themes/maize_theme.php'; -$theme[14]['NAME'] = 'Maize'; - -$theme[15]['PATH'] = SM_PATH . 'themes/bluesnews_theme.php'; -$theme[15]['NAME'] = 'BluesNews'; +$disable_security_tokens = false; -$theme[16]['PATH'] = SM_PATH . 'themes/deepocean2_theme.php'; -$theme[16]['NAME'] = 'Deep Ocean 2'; - -$theme[17]['PATH'] = SM_PATH . 'themes/blue_grey_theme.php'; -$theme[17]['NAME'] = 'Blue Grey'; - -$theme[18]['PATH'] = SM_PATH . 'themes/dompie_theme.php'; -$theme[18]['NAME'] = 'Dompie'; - -$theme[19]['PATH'] = SM_PATH . 'themes/methodical_theme.php'; -$theme[19]['NAME'] = 'Methodical'; - -$theme[20]['PATH'] = SM_PATH . 'themes/greenhouse_effect.php'; -$theme[20]['NAME'] = 'Greenhouse Effect (Changes)'; - -$theme[21]['PATH'] = SM_PATH . 'themes/in_the_pink.php'; -$theme[21]['NAME'] = 'In The Pink (Changes)'; - -$theme[22]['PATH'] = SM_PATH . 'themes/kind_of_blue.php'; -$theme[22]['NAME'] = 'Kind of Blue (Changes)'; - -$theme[23]['PATH'] = SM_PATH . 'themes/monostochastic.php'; -$theme[23]['NAME'] = 'Monostochastic (Changes)'; - -$theme[24]['PATH'] = SM_PATH . 'themes/shades_of_grey.php'; -$theme[24]['NAME'] = 'Shades of Grey (Changes)'; - -$theme[25]['PATH'] = SM_PATH . 'themes/spice_of_life.php'; -$theme[25]['NAME'] = 'Spice of Life (Changes)'; - -$theme[26]['PATH'] = SM_PATH . 'themes/spice_of_life_lite.php'; -$theme[26]['NAME'] = 'Spice of Life - Lite (Changes)'; - -$theme[27]['PATH'] = SM_PATH . 'themes/spice_of_life_dark.php'; -$theme[27]['NAME'] = 'Spice of Life - Dark (Changes)'; - -$theme[28]['PATH'] = SM_PATH . 'themes/christmas.php'; -$theme[28]['NAME'] = 'Holiday - Christmas'; - -$theme[29]['PATH'] = SM_PATH . 'themes/darkness.php'; -$theme[29]['NAME'] = 'Darkness (Changes)'; - -$theme[30]['PATH'] = SM_PATH . 'themes/random.php'; -$theme[30]['NAME'] = 'Random (Changes every login)'; - -$theme[31]['PATH'] = SM_PATH . 'themes/midnight.php'; -$theme[31]['NAME'] = 'Midnight'; - -$theme[32]['PATH'] = SM_PATH . 'themes/alien_glow.php'; -$theme[32]['NAME'] = 'Alien Glow'; - -$theme[33]['PATH'] = SM_PATH . 'themes/dark_green.php'; -$theme[33]['NAME'] = 'Dark Green'; - -$theme[34]['PATH'] = SM_PATH . 'themes/penguin.php'; -$theme[34]['NAME'] = 'Penguin'; - -$theme[35]['PATH'] = SM_PATH . 'themes/minimal_bw.php'; -$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'; +/** + * Check Page Referrer + * + * Enforces a safety check on page requests by checking + * that the referrer is the domain specified by this + * setting. If this setting is "###DOMAIN###", the + * current value of the $domain variable will be used + * for the check. + * + * If a browser doesn't send referrer data, this check + * will be silently bypassed. + * + * Examples: + * $check_referrer = 'example.com'; + * $check_referrer = '###DOMAIN###'; + * + * @global string $check_referrer + * @since 1.5.2 and 1.4.20RC1 + */ +$check_referrer = ''; -$theme[41]['PATH'] = SM_PATH . 'themes/bluesome.php'; -$theme[41]['NAME'] = 'Bluesome'; +/** + * Security Image Type + * + * Switches between using a transparent image + * and one that states "this image has been + * removed for security reasons" + * + * @global bool $use_transparent_security_image + * @since 1.5.2 and 1.4.23 + */ +$use_transparent_security_image = true; -$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'; +/** + * User Themes + * You can define your own theme and put it in directory in SM_PATH/css/. + * You must call it as the example below. You can name the theme + * whatever you want. + * + * 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. + * + * $user_theme_default sets theme that will be used by default + * + * @global integer $user_theme_default + * @since 1.5.2 + */ +$user_theme_default = 0; -$theme[44]['PATH'] = SM_PATH . 'themes/autumn.php'; -$theme[44]['NAME'] = 'Autumn'; +/** + * Listing of installed themes + * @global array $user_themes + * @since 1.5.2 + */ +$user_themes[0]['PATH'] = 'none'; +$user_themes[0]['NAME'] = 'Default'; -$theme[45]['PATH'] = SM_PATH . 'themes/autumn2.php'; -$theme[45]['NAME'] = 'Autumn 2'; +$user_themes[1]['PATH'] = '../css/blue_gradient/'; +$user_themes[1]['NAME'] = 'Blue Options'; -$theme[46]['PATH'] = SM_PATH . 'themes/blue_on_blue.php'; -$theme[46]['NAME'] = 'Blue on Blue'; +/** + * Message Icons control + * + * Use icons for message and folder markers + * @global bool $use_icons + * @since 1.5.1 + */ +$use_icons = true; -$theme[47]['PATH'] = SM_PATH . 'themes/classic_blue.php'; -$theme[47]['NAME'] = 'Classic Blue'; +/** + * Icon Themes + * You can create your own icon themes and put them in a directory in + * SM_PATH/images/themes/. Your users will be able to choose whatever + * icon themes are listed below. + * + * To add a new theme to the list of available icon themes, just add a new + * number to the array below and follow the pattern + * + * $icon_theme_default sets the theme that will be used by default. + * $icon_theme_fallback specifies which theme will be used if an icon is + * not found in the selected theme + * + * @global integer $icon_theme_def + * @global integer $icon_theme_fallback + * @since 1.5.2 + */ +$icon_theme_def = 1; +$icon_theme_fallback = 3; -$theme[48]['PATH'] = SM_PATH . 'themes/classic_blue2.php'; -$theme[48]['NAME'] = 'Classic Blue 2'; +/** + * Listing of installed icon themes + * @global array $icon_themes + * @since 1.5.2 + */ +$icon_themes[0]['PATH'] = 'none'; +$icon_themes[0]['NAME'] = 'No Icons'; -$theme[49]['PATH'] = SM_PATH . 'themes/powder_blue.php'; -$theme[49]['NAME'] = 'Powder Blue'; +$icon_themes[1]['PATH'] = 'template'; +$icon_themes[1]['NAME'] = 'Template Default Icons'; -$theme[50]['PATH'] = SM_PATH . 'themes/techno_blue.php'; -$theme[50]['NAME'] = 'Techno Blue'; +$icon_themes[2]['PATH'] = '../images/themes/default/'; +$icon_themes[2]['NAME'] = 'Default Icon Set'; -$theme[51]['PATH'] = SM_PATH . 'themes/turquoise.php'; -$theme[51]['NAME'] = 'Turquoise'; +$icon_themes[3]['PATH'] = '../images/themes/xp/'; +$icon_themes[3]['NAME'] = 'XP Style Icons'; /** * Templates - * You can define your own template and put it in this directory. - * You must call it as the example below. You can name the template - * whatever you want. For an example of a template, see the ones - * included in the template directory. + * You can define your own template set (skin) and put it in a new + * directory under SM_PATH/templates. The ID must match the name of + * the template directory as the example below. You can name the + * template whatever you want. For an example of a template, see + * the ones included in the SM_PATH/templates directory. * * To add a new template to the options that users can choose from, just * add a new number to the array at the bottom, and follow the pattern. * - * $templateset_default sets theme that will be used by default - * used by default. - * @global integer $templateset_default - */ -$templateset_default = 0; - -$aTemplateSet[0]['PATH'] = SM_PATH . 'templates/default/'; -$aTemplateSet[0]['NAME'] = 'Default template'; -$aTemplateSet[1]['PATH'] = SM_PATH . 'templates/default_advanced/'; -$aTemplateSet[1]['NAME'] = 'Advanced template'; + * $templateset_default sets the skin that will be used by default + * when a user doesn't have a skin selection + * in their preferences. (Must be the "ID" of + * the desired template set) + * + * $templateset_fallback tells SquirrelMail which template set (skin) + * to use when looking for a file that is not + * contained within whatever skin is currently + * being used. (Must be the "ID" of the desired + * template set) + * + * $rpc_templateset sets the skin that will be used by default + * when a user is making an RPC request. This + * does not usually need to be changed, but + * can be used to change the RPC protocol that + * is used to respond to RPC requets. (Must be + * the "ID" of the desired template set and + * should NOT be a template set that is included + * in the $aTemplateSet list; PLEASE NOTE that + * new RPC template sets should always be named + * "_rpc", as SquirrelMail will assume + * any template sets ending in "_rpc" are intended + * for its RPC interface only) + * + * @global string $templateset_default + * @global string $templateset_fallback + * @global string $rpc_templateset + */ +$templateset_default = 'default'; +$templateset_fallback = 'default'; +$rpc_templateset = 'default_rpc'; + +$aTemplateSet[0]['ID'] = 'default'; +$aTemplateSet[0]['NAME'] = 'Default'; +$aTemplateSet[1]['ID'] = 'default_advanced'; +$aTemplateSet[1]['NAME'] = 'Advanced'; /** * Default interface font size. @@ -969,23 +973,35 @@ $motd = ""; /** * To install plugins, just add elements to this array that have * the plugin directory name relative to the /plugins/ directory. - * For instance, for the 'sqclock' plugin, you'd put a line like + * For instance, for the 'squirrelspell' plugin, you'd put a line like * the following. - * $plugins[] = 'sqclock'; - * $plugins[] = 'attachment_common'; + * $plugins[] = 'squirrelspell'; + * $plugins[] = 'listcommands'; */ // Add list of enabled plugins here +/** + * To disable all plugins regardless of any that are installed + * above, turn on $disable_plugins. To disable them ONLY for + * one user, put that username into $disable_plugins_user. + * @global boolean $disable_plugins + * @global string $disable_plugins_user + * @since 1.5.2 + */ +$disable_plugins = false; +$disable_plugins_user = ''; + + /*** Database ***/ /** - * Read doc/database.txt in order to get more information + * Read the administrator's manual in order to get more information * about these settings. */ /** * Database-driven private addressbooks * DSN (Data Source Name) for a database where the private - * addressbooks are stored. See doc/db-backend.txt for more info. + * addressbooks are stored. See the administrator's manual for more info. * If it is not set, the addressbooks are stored in files * in the data dir. * The DSN is in the format: mysql://user:pass@hostname/dbname @@ -1175,15 +1191,6 @@ $config_location_base = ''; */ $use_iframe = false; -/** - * Message Icons control - * - * Use icons for message and folder markers - * @global bool $use_icons - * @since 1.5.1 - */ -$use_icons = false; - /** * PHP recode functions control * @@ -1213,12 +1220,69 @@ $use_php_recode = false; $use_php_iconv = false; /** + * Output Buffering + * + * In some cases, buffering all output allows more complex functionality, + * especially for plugins that want to add headers on hooks that are beyond + * the point of output having been sent to the browser otherwise (although + * most plugins that need this feature will turn it on automatically by + * themselves). + * + * It is also possible to define a custom output handler as needed by special + * environments. If $buffered_output_handler is non-empty, a function named + * the same as the value of $buffered_output_handler should be defined in + * config_local.php. + * + */ +$buffer_output = false; +$buffered_output_handler = ''; + +/** + * Allow Remote configtest Access + * * Controls remote configuration checks * @global boolean $allow_remote_configtest * @since 1.5.1 */ $allow_remote_configtest = false; +/** + * SquirrelMail Debug Mode + * + * Various debugging levels can be enabled using this setting. + * More than one mode can be used at once by combining them + * with pipes ("|"). See the SM_DEBUG_MODE_* constants in + * include/constants.php + */ +$sm_debug_mode = SM_DEBUG_MODE_OFF; + +/** + * "Secured Configuration" Mode + * + * Enable/disable "Secured Configuration" mode, wherein certain + * security-sensitive configuration settings are made immutable + * by other code. + */ +$secured_config = true; + +/** + * HTTPS Port + * + * This is the HTTPS (SSL-secured HTTP) port. It can be left empty, + * in which case SquirrelMail will assume the standard port 443. + * Make sure to set this correctly when serving HTTPS on a non- + * standard port. + */ +$sq_https_port = 443; + +/** + * Ignore HTTP_X_FORWARDED_* headers? + * + * Whether or not HTTP_X_FORWARDED_* headers are respected by + * SquirrelMail (or plugins). + */ +$sq_ignore_http_x_forwarded_headers = true; + /** * Subscribe Listing Control * @@ -1240,3 +1304,15 @@ $no_list_for_subscribe = false; * @global integer $config_use_color */ $config_use_color = 2; + +/** + * Ask User for Personal Information on login + * + * When a user logs in that doesn't have an email address configured, + * redirect him/her to the options page with a request to fill in their + * personal information. + * + * @global bool $ask_user_info + */ +$ask_user_info = true; +