Begin some re-orginization of UI controls. Remove support for $theme_css, since...
[squirrelmail.git] / config / config_default.php
index 6cd161050943937433c42e070d0a709bda1fad67..4b0d442c141a7e90cd0a2cdc80b8ff643ef2a55a 100644 (file)
  * 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$
@@ -184,7 +189,7 @@ $sendmail_path = '/usr/sbin/sendmail';
  * 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
+ * @since 1.5.1 and 1.4.8
  */
 $sendmail_args = '-i -t';
 
@@ -262,6 +267,28 @@ $use_smtp_tls = 0;
  */
 $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
  *
@@ -469,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
@@ -488,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.
@@ -537,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;
 
@@ -645,13 +673,11 @@ $session_name = 'SQMSESSID';
  * 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
  * used by default.
  * @global integer $theme_default
  * @global string $theme_css
  */
 $theme_default = 0;
-$theme_css = '';
 
 /**
  * Listing of installed themes
@@ -789,25 +815,52 @@ $theme[42]['NAME'] = 'Simple Green 2';
 $theme[43]['PATH'] = SM_PATH . 'themes/simple_purple.php';
 $theme[43]['NAME'] = 'Simple Purple';
 
+$theme[44]['PATH'] = SM_PATH . 'themes/autumn.php';
+$theme[44]['NAME'] = 'Autumn';
+
+$theme[45]['PATH'] = SM_PATH . 'themes/autumn2.php';
+$theme[45]['NAME'] = 'Autumn 2';
+
+$theme[46]['PATH'] = SM_PATH . 'themes/blue_on_blue.php';
+$theme[46]['NAME'] = 'Blue on Blue';
+
+$theme[47]['PATH'] = SM_PATH . 'themes/classic_blue.php';
+$theme[47]['NAME'] = 'Classic Blue';
+
+$theme[48]['PATH'] = SM_PATH . 'themes/classic_blue2.php';
+$theme[48]['NAME'] = 'Classic Blue 2';
+
+$theme[49]['PATH'] = SM_PATH . 'themes/powder_blue.php';
+$theme[49]['NAME'] = 'Powder Blue';
+
+$theme[50]['PATH'] = SM_PATH . 'themes/techno_blue.php';
+$theme[50]['NAME'] = 'Techno Blue';
+
+$theme[51]['PATH'] = SM_PATH . 'themes/turquoise.php';
+$theme[51]['NAME'] = 'Turquoise';
+
 /**
  * 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 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.
+ * $templateset_default sets theme that will be used by default.
+ *
  * @global integer $templateset_default
  */
 $templateset_default = 0;
+$templateset_fallback = 0;
 
-$aTemplateSet[0]['PATH'] = SM_PATH . 'templates/default/';
-$aTemplateSet[0]['NAME'] = 'Default template';
-
+$aTemplateSet[0]['ID'] = 'default';
+$aTemplateSet[0]['NAME'] = 'Default';
+$aTemplateSet[1]['ID'] = 'default_advanced';
+$aTemplateSet[1]['NAME'] = 'Advanced';
 
 /**
  * Default interface font size.
@@ -847,6 +900,9 @@ $fontsets['tahoma'] = 'tahoma,sans-serif';
  *       '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
 
@@ -883,6 +939,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
  *
@@ -917,6 +991,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';
@@ -1003,7 +1080,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
  */
@@ -1064,16 +1141,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
  *
@@ -1149,17 +1240,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.
- */
-?>
\ No newline at end of file