X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=config%2Fconfig_default.php;h=b5c2e4191e8eacaabdad24de1855daad0efb23db;hp=a94e2b7a7718363d981f3f1a12a426b361d4d757;hb=acd7fdf263929e876918bc434086626ec871afb1;hpb=e498ebbdf3b0933a733da9b52d9d6b6ca1e0815e diff --git a/config/config_default.php b/config/config_default.php index a94e2b7a..b5c2e419 100644 --- a/config/config_default.php +++ b/config/config_default.php @@ -10,6 +10,14 @@ * conf.pl if at all possible. That is the easiest and cleanest way * to configure. * + * Note on SECURITY: some options require putting a password in this file. + * Please make sure that you adapt its permissions appropriately to avoid + * 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 + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ * @package squirrelmail * @subpackage config */ @@ -166,11 +174,25 @@ $encode_header_key = ''; * * Program that should be used when sending email. SquirrelMail expects that * this program will follow options used by original sendmail - * (http://www.sendmail.org). + * (http://www.sendmail.org). Support of -f argument is required. * @global string $sendmail_path */ $sendmail_path = '/usr/sbin/sendmail'; +/** + * Extra sendmail command arguments. + * + * Sets additional sendmail command arguments. Make sure that arguments are + * supported by your sendmail program. -f argument is added automatically by + * SquirrelMail scripts. Variable defaults to standard /usr/sbin/sendmail + * arguments. If you use qmail-inject, nbsmtp or any other sendmail wrapper, + * which does not support -t and -i arguments, set variable to empty string + * or use arguments suitable for your mailer. + * @global string $sendmail_args + * @since 1.5.1 and 1.4.8 + */ +$sendmail_args = '-i -t'; + /** * IMAP server address * @@ -212,22 +234,30 @@ $imapPort = 143; $imap_server_type = 'other'; /** - * Advanced IMAP authentication options control + * Secure IMAP connection controls * - * CRAM-MD5, DIGEST-MD5, Plain, and TLS - * Set reasonable defaults - you'd never know this was there unless you ask for it - * @global bool $use_imap_tls + * 0 - use plain text connection, + * 1 - use imaps (adds tls:// prefix to hostname), + * 2 - use IMAP STARTTLS extension (rfc2595). + * + * Was boolean before 1.5.1. + * @global integer $use_imap_tls + * @since 1.4.0 */ -$use_imap_tls = false; +$use_imap_tls = 0; /** - * Advanced SMTP authentication options control + * Secure SMTP connection controls + * + * 0 - use plain text connection, + * 1 - use ssmtp (adds tls:// prefix to hostname), + * 2 - use SMTP STARTTLS extension (rfc2487). * - * CRAM-MD5, DIGEST-MD5, Plain, and TLS - * Set reasonable defaults - you'd never know this was there unless you ask for it - * @global bool $use_smtp_tls + * Was boolean before 1.5.1. + * @global integer $use_smtp_tls + * @since 1.4.0 */ -$use_smtp_tls = false; +$use_smtp_tls = 0; /** * SMTP authentication mechanism @@ -237,6 +267,28 @@ $use_smtp_tls = false; */ $smtp_auth_mech = 'none'; +/** + * Custom SMTP authentication username + * + * IMAP username is used if variable is set to empty string. + * Variable is included in main configuration file only from 1.5.2 version. + * Older versions stored it in config_local.php. + * @global string $smtp_sitewide_user + * @since 1.5.0 + */ +$smtp_sitewide_user = ''; + +/** + * Custom SMTP authentication password + * + * IMAP password is used if $smtp_sitewide_user global is set to empty string. + * Variable is included in main configuration file only from 1.5.2 version. + * Older versions stored it in config_local.php. + * @global string $smtp_sitewide_pass + * @since 1.5.0 + */ +$smtp_sitewide_pass = ''; + /** * IMAP authentication mechanism * @@ -431,6 +483,7 @@ $noselect_fix_enable = false; * It is a possible security hole to have a writable directory * under the web server's root directory (ex: /home/httpd/html). * The path name can be absolute or relative (to the config directory). + * If path is relative, it must use SM_PATH constant. * Here are two examples: * * Absolute: @@ -443,7 +496,7 @@ $noselect_fix_enable = false; * * @global string $data_dir */ -$data_dir = '/var/local/squirrelmail/data'; +$data_dir = '/var/local/squirrelmail/data/'; /** * Attachments directory @@ -462,7 +515,7 @@ $data_dir = '/var/local/squirrelmail/data'; * + It should probably be another directory than data_dir. * @global string $attachment_dir */ -$attachment_dir = $data_dir; +$attachment_dir = '/var/local/squirrelmail/attach/'; /** * Hash level used for data directory. @@ -511,6 +564,7 @@ $default_use_priority = true; * This option disables display of "created by SquirrelMail developers" * strings and provider link * @global bool $hide_sm_attributions + * @since 1.2.0 */ $hide_sm_attributions = false; @@ -538,8 +592,8 @@ $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 + * 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 @@ -555,22 +609,29 @@ $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 - * this to work. - * @global bool $allow_thread_sort + * Set it to true, if you want to disable server side thread + * sorting options. Your IMAP server must support the THREAD + * extension for this to have any effect. + * + * Older SquirrelMail versions used $allow_thread_sort option. + * @global bool $disable_thread_sort + * @since 1.5.1 */ -$allow_thread_sort = false; +$disable_thread_sort = false; /** * Server Side Sorting Control * - * to use server-side sorting instead of SM client side. - * Your IMAP server must support the SORT extension for this - * to work. - * @global bool $allow_server_sort + * Set it to true, if you want to disable server side sorting + * and use SM client side sorting instead (client side sorting + * can be slow). Your IMAP server must support the SORT extension + * for this to have any effect. + * + * Older SquirrelMail versions used $allow_server_sort option. + * @global bool $disable_server_sort + * @since 1.5.1 */ -$allow_server_sort = false; +$disable_server_sort = false; /** * IMAP Charset Use Control @@ -602,7 +663,7 @@ $session_name = 'SQMSESSID'; /** - * Themes + * User 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 @@ -611,150 +672,67 @@ $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 + * $user_theme_default sets theme that will be used by default * used by default. - * @global integer $theme_default - * @global string $theme_css + * @global integer $user_theme_default */ -$theme_default = 0; -$theme_css = ''; +$user_theme_default = 0; /** * Listing of installed themes - * @global array $theme + * @global array $user_themes */ -$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'; - -$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'; +$user_themes[0]['PATH'] = 'none'; +$user_themes[0]['NAME'] = 'Default'; -$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'; +/** + * 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 + * 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. + * + * @global integer $templateset_default + */ +$templateset_default = 0; +$templateset_fallback = 0; -$theme[40]['PATH'] = SM_PATH . 'themes/wood_theme.php'; -$theme[40]['NAME'] = 'Wood'; +$aTemplateSet[0]['ID'] = 'default'; +$aTemplateSet[0]['NAME'] = 'Default'; +$aTemplateSet[1]['ID'] = 'default_advanced'; +$aTemplateSet[1]['NAME'] = 'Advanced'; -$theme[41]['PATH'] = SM_PATH . 'themes/bluesome.php'; -$theme[41]['NAME'] = 'Bluesome'; +/** + * Default interface font size. + * @global string $default_fontsize + * @since 1.5.1 + */ +$default_fontsize = ''; -$theme[42]['PATH'] = SM_PATH . 'themes/simple_green2.php'; -$theme[42]['NAME'] = 'Simple Green 2'; +/** + * Default font set + * @global string $default_fontset + * @since 1.5.1 + */ +$default_fontset = ''; -$theme[43]['PATH'] = SM_PATH . 'themes/simple_purple.php'; -$theme[43]['NAME'] = 'Simple Purple'; +/** + * List of available fontsets. + * @global array $fontsets + * @since 1.5.1 + */ +$fontsets = array(); +$fontsets['serif'] = 'serif'; +$fontsets['sans'] = 'helvetica,arial,sans-serif'; +$fontsets['comicsans'] = 'comic sans ms,sans-serif'; +$fontsets['verasans'] = 'bitstream vera sans,verdana,sans-serif'; +$fontsets['tahoma'] = 'tahoma,sans-serif'; /** * LDAP server(s) @@ -768,6 +746,9 @@ $theme[43]['NAME'] = 'Simple Purple'; * 'name' => 'Netcenter Member Directory', * 'base' => 'ou=member_directory,o=netcenter.com' * ); + * + * NOTE: please see security note at the top of this file when + * entering a password. */ // Add your ldap server options here @@ -804,6 +785,24 @@ $abook_global_file_writeable = false; */ $abook_global_file_listing = true; +/** + * Controls file based address book entry size + * + * This setting controls space allocated to file based address book records. + * End users will be unable to save address book entry, if total entry size + * (quoted address book fields + 4 delimiters + linefeed) exceeds allowed + * address book length size. + * + * Same setting is applied to personal and global file based address books. + * + * It is strongly recommended to keep default setting value. Change it only + * if you really want to store address book entries that are bigger than two + * kilobytes (2048). + * @global integer $abook_file_line_length + * @since 1.5.2 + */ +$abook_file_line_length = 2048; + /** * MOTD * @@ -838,6 +837,9 @@ $motd = ""; * The DSN is in the format: mysql://user:pass@hostname/dbname * The table is the name of the table to use within the * specified database. + * + * NOTE: please see security note at the top of this file when + * entering a password. */ $addrbook_dsn = ''; $addrbook_table = 'address'; @@ -847,7 +849,7 @@ $addrbook_table = 'address'; $prefs_dsn = ''; $prefs_table = 'userprefs'; /** - * Preference key field + * Preference key field * @global string $prefs_key_field */ $prefs_key_field = 'prefkey'; @@ -858,7 +860,7 @@ $prefs_key_field = 'prefkey'; */ $prefs_key_size = 64; /** - * Preference owner field + * Preference owner field * @global string $prefs_user_field */ $prefs_user_field = 'user'; @@ -869,7 +871,7 @@ $prefs_user_field = 'user'; */ $prefs_user_size = 128; /** - * Preference value field + * Preference value field * @global string $prefs_val_field */ $prefs_val_field = 'prefval'; @@ -884,25 +886,25 @@ $prefs_val_size = 65536; /** * DSN of global address book database * @global string $addrbook_global_dsn - * @since 1.5.1 + * @since 1.5.1 and 1.4.4 */ $addrbook_global_dsn = ''; /** * Table used for global database address book * @global string $addrbook_global_table - * @since 1.5.1 + * @since 1.5.1 and 1.4.4 */ $addrbook_global_table = 'global_abook'; /** * Control writing into global database address book * @global boolean $addrbook_global_writeable - * @since 1.5.1 + * @since 1.5.1 and 1.4.4 */ $addrbook_global_writeable = false; /** * Control listing of global database address book * @global boolean $addrbook_global_listing - * @since 1.5.1 + * @since 1.5.1 and 1.4.4 */ $addrbook_global_listing = false; @@ -924,7 +926,7 @@ $squirrelmail_default_language = 'en_US'; * This option controls what character set is used when sending * mail and when sending HTML to the browser. Option works only * with US English (en_US) translation. Other translations use - * charsets that are set in functions/i18n.php. + * charsets that are set in translation settings. * * @global string $default_charset */ @@ -985,16 +987,30 @@ $lossy_encoding = false; */ $time_zone_type = 0; -/*** Tweaks ***/ /** - * Advanced DHTML tree control + * Location base + * + * This is used to build the URL to the SquirrelMail location. + * It should contain only the protocol and hostname/port parts + * of the URL; the full path will be appended automatically. * - * Use experimental DHTML folder listing - * @global bool $advanced_tree - * @since 1.5.0 + * If not specified or empty, it will be autodetected. + * + * Examples: + * http://webmail.example.org + * http://webmail.example.com:8080 + * https://webmail.example.com:6691 + * + * To be clear: do not include any of the path elements, so if + * SquirrelMail is at http://www.example.net/web/mail/src/login.php, you + * write: http://www.example.net + * + * @global string $config_location_base + * @since 1.5.2 and 1.4.8 */ -$advanced_tree = false; +$config_location_base = ''; +/*** Tweaks ***/ /** * Iframe sandbox code control * @@ -1070,17 +1086,3 @@ $no_list_for_subscribe = false; * @global integer $config_use_color */ $config_use_color = 2; - -/** - * This option includes special configuration options - */ -@include SM_PATH . 'config/config_local.php'; - -/** - * Make sure there are no characters after the PHP closing - * tag below (including newline characters and whitespace). - * Otherwise, that character will cause the headers to be - * sent and regular output to begin, which will majorly screw - * things up when we try to send more headers later. - */ -?>