X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=config%2Fconfig_default.php;h=5beea9631280a38a19ae4b51f6d4e09fa51cf520;hp=b5c2e4191e8eacaabdad24de1855daad0efb23db;hb=b9a873d7ed3979bb6de827ea831301a336e5327e;hpb=82351c82c9251726ce0f999708d06b3460db3714 diff --git a/config/config_default.php b/config/config_default.php index b5c2e419..5beea963 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-2014 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 */ @@ -661,34 +682,143 @@ $allow_advanced_search = 0; */ $session_name = 'SQMSESSID'; +/** + * Secure Cookies + * + * Only transmit cookies via a secure connection + * if the session was started using HTTPS/SSL? + * + * Highly recommended + * + * @global bool $only_secure_cookies + * @since 1.5.2 and 1.4.16 + */ +$only_secure_cookies = true; + +/** + * 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 + */ +$disable_security_tokens = false; + +/** + * 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 = ''; + +/** + * 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; + /** * User Themes - * You can define your own theme and put it in this directory. + * 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. For an example of a theme, see the ones - * included in the config directory. + * 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 - * used by default. + * * @global integer $user_theme_default + * @since 1.5.2 */ $user_theme_default = 0; /** * Listing of installed themes * @global array $user_themes + * @since 1.5.2 */ $user_themes[0]['PATH'] = 'none'; $user_themes[0]['NAME'] = 'Default'; +$user_themes[1]['PATH'] = '../css/blue_gradient/'; +$user_themes[1]['NAME'] = 'Blue Options'; + +/** + * Message Icons control + * + * Use icons for message and folder markers + * @global bool $use_icons + * @since 1.5.1 + */ +$use_icons = true; + +/** + * 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; + +/** + * Listing of installed icon themes + * @global array $icon_themes + * @since 1.5.2 + */ +$icon_themes[0]['PATH'] = 'none'; +$icon_themes[0]['NAME'] = 'No Icons'; + +$icon_themes[1]['PATH'] = 'template'; +$icon_themes[1]['NAME'] = 'Template Default Icons'; + +$icon_themes[2]['PATH'] = '../images/themes/default/'; +$icon_themes[2]['NAME'] = 'Default Icon Set'; + +$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 a new directory - * under SM_PATH/templates. The ID must match the name of + * 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. @@ -696,12 +826,37 @@ $user_themes[0]['NAME'] = 'Default'; * 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. - * - * @global integer $templateset_default - */ -$templateset_default = 0; -$templateset_fallback = 0; + * $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'; @@ -815,23 +970,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 @@ -1021,15 +1188,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 * @@ -1059,12 +1217,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 * @@ -1086,3 +1301,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; +