@ -9,7 +9,7 @@
| Default settings for all configuration options |
| Default settings for all configuration options |
| |
| |
| This file is part of the Roundcube Webmail client |
| This file is part of the Roundcube Webmail client |
| Copyright (C) The Roundcube Dev Team |
| Copyright (C) 2005-2018, The Roundcube Dev Team |
| |
| |
| Licensed under the GNU General Public License version 3 or |
| Licensed under the GNU General Public License version 3 or |
| any later version with exceptions for skins & plugins. |
| any later version with exceptions for skins & plugins. |
@ -27,12 +27,8 @@ $config = array();
// Format (compatible with PEAR MDB2): db_provider://user:password@host/database
// Format (compatible with PEAR MDB2): db_provider://user:password@host/database
// Currently supported db_providers: mysql, pgsql, sqlite, mssql, sqlsrv, oracle
// Currently supported db_providers: mysql, pgsql, sqlite, mssql, sqlsrv, oracle
// For examples see http://pear.php.net/manual/en/package.database.mdb2.intro-dsn.php
// For examples see http://pear.php.net/manual/en/package.database.mdb2.intro-dsn.php
// Note : for SQLite use absolute path (Linux): 'sqlite:////full/path/to/sqlite.db?mode=0646'
// NOTE : for SQLite use absolute path (Linux): 'sqlite:////full/path/to/sqlite.db?mode=0646'
// or (Windows): 'sqlite:///C:/full/path/to/sqlite.db'
// or (Windows): 'sqlite:///C:/full/path/to/sqlite.db'
// Note: Various drivers support various additional arguments for connection,
// for Mysql: key, cipher, cert, capath, ca, verify_server_cert,
// for Postgres: application_name, sslmode, sslcert, sslkey, sslrootcert, sslcrl, sslcompression, service.
// e.g. 'mysql://roundcube:@localhost/roundcubemail?verify_server_cert=false'
$config['db_dsnw'] = 'mysql://roundcube:@localhost/roundcubemail';
$config['db_dsnw'] = 'mysql://roundcube:@localhost/roundcubemail';
// Database DSN for read-only operations (if empty write database will be used)
// Database DSN for read-only operations (if empty write database will be used)
@ -96,34 +92,34 @@ $config['syslog_facility'] = LOG_USER;
// Data will only be logged if a directory < log_dir > /< username > / exists and is writable.
// Data will only be logged if a directory < log_dir > /< username > / exists and is writable.
$config['per_user_logging'] = false;
$config['per_user_logging'] = false;
// Log sent messages to < log_dir > /sendmail.log or to syslog
// Log sent messages to < log_dir > /sendmail or to syslog
$config['smtp_log'] = true;
$config['smtp_log'] = true;
// Log successful/failed logins to < log_dir > /userlogins.log or to syslog
// Log successful/failed logins to < log_dir > /userlogins or to syslog
$config['log_logins'] = false;
$config['log_logins'] = false;
// Log session debug information/ authentication errors to < log_dir > /session.log or to syslog
// Log session authentication errors to < log_dir > /session or to syslog
$config['session_debug '] = false;
$config['log_ session'] = false;
// Log SQL queries to < log_dir > /sql.log or to syslog
// Log SQL queries to < log_dir > /sql or to syslog
$config['sql_debug'] = false;
$config['sql_debug'] = false;
// Log IMAP conversation to < log_dir > /imap.log or to syslog
// Log IMAP conversation to < log_dir > /imap or to syslog
$config['imap_debug'] = false;
$config['imap_debug'] = false;
// Log LDAP conversation to < log_dir > /ldap.log or to syslog
// Log LDAP conversation to < log_dir > /ldap or to syslog
$config['ldap_debug'] = false;
$config['ldap_debug'] = false;
// Log SMTP conversation to < log_dir > /smtp.log or to syslog
// Log SMTP conversation to < log_dir > /smtp or to syslog
$config['smtp_debug'] = false;
$config['smtp_debug'] = false;
// Log Memcache conversation to < log_dir > /memcache.log or to syslog
// Log Memcache conversation to < log_dir > /memcache or to syslog
$config['memcache_debug'] = false;
$config['memcache_debug'] = false;
// Log APC conversation to < log_dir > /apc.log or to syslog
// Log APC conversation to < log_dir > /apc or to syslog
$config['apc_debug'] = false;
$config['apc_debug'] = false;
// Log Redis conversation to < log_dir > /redis.log or to syslog
// Log Redis conversation to < log_dir > /redis or to syslog
$config['redis_debug'] = false;
$config['redis_debug'] = false;
@ -134,8 +130,7 @@ $config['redis_debug'] = false;
// The IMAP host chosen to perform the log-in.
// The IMAP host chosen to perform the log-in.
// Leave blank to show a textbox at login, give a list of hosts
// Leave blank to show a textbox at login, give a list of hosts
// to display a pulldown menu or set one host as string.
// to display a pulldown menu or set one host as string.
// Enter hostname with prefix ssl:// to use Implicit TLS, or use
// To use SSL/TLS connection, enter hostname with prefix ssl:// or tls://
// prefix tls:// to use STARTTLS.
// Supported replacement variables:
// Supported replacement variables:
// %n - hostname ($_SERVER['SERVER_NAME'])
// %n - hostname ($_SERVER['SERVER_NAME'])
// %t - hostname without the first part
// %t - hostname without the first part
@ -182,7 +177,7 @@ $config['imap_delimiter'] = null;
// If you know your imap's folder vendor, you can specify it here.
// If you know your imap's folder vendor, you can specify it here.
// Otherwise it will be determined automatically. Use lower-case
// Otherwise it will be determined automatically. Use lower-case
// identifiers, e.g. 'dovecot', 'cyrus', 'gimap ', 'hmail', 'uw-imap'.
// identifiers, e.g. 'dovecot', 'cyrus', 'gmail ', 'hmail', 'uw-imap'.
$config['imap_vendor'] = null;
$config['imap_vendor'] = null;
// If IMAP server doesn't support NAMESPACE extension, but you're
// If IMAP server doesn't support NAMESPACE extension, but you're
@ -233,7 +228,7 @@ $config['imap_disabled_caps'] = array();
// This is used to relate IMAP session with Roundcube user sessions
// This is used to relate IMAP session with Roundcube user sessions
$config['imap_log_session'] = false;
$config['imap_log_session'] = false;
// Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache' or 'memcached' .
// Type of IMAP indexes cache. Supported values: 'db', 'apc' and 'memcache'.
$config['imap_cache'] = null;
$config['imap_cache'] = null;
// Enables messages cache. Only 'db' cache is supported.
// Enables messages cache. Only 'db' cache is supported.
@ -258,8 +253,8 @@ $config['messages_cache_threshold'] = 50;
// ----------------------------------
// ----------------------------------
// SMTP server host (for sending mails).
// SMTP server host (for sending mails).
// Enter hostname with prefix ssl:// to use Implicit TLS, or use
// Enter hostname with prefix tls:// to use START TLS, or use
// prefix tls:// to use STARTTLS.
// prefix ssl:// to use the deprecated SSL over SMTP (aka SMTPS)
// Supported replacement variables:
// Supported replacement variables:
// %h - user's IMAP hostname
// %h - user's IMAP hostname
// %n - hostname ($_SERVER['SERVER_NAME'])
// %n - hostname ($_SERVER['SERVER_NAME'])
@ -267,11 +262,9 @@ $config['messages_cache_threshold'] = 50;
// %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
// %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
// %z - IMAP domain (IMAP hostname without the first part)
// %z - IMAP domain (IMAP hostname without the first part)
// For example %n = mail.domain.tld, %t = domain.tld
// For example %n = mail.domain.tld, %t = domain.tld
// To specify differnt SMTP servers for different IMAP hosts provide an array
// of IMAP host (no prefix or port) and SMTP server e.g. array('imap.example.com' => 'smtp.example.net')
$config['smtp_server'] = 'localhost';
$config['smtp_server'] = 'localhost';
// SMTP port. Use 25 for cleartext, 465 for Implicit TLS, or 587 for STARTTLS (default )
// SMTP port (default is 587 )
$config['smtp_port'] = 587;
$config['smtp_port'] = 587;
// SMTP username (if required) if you use %u as the username Roundcube
// SMTP username (if required) if you use %u as the username Roundcube
@ -322,7 +315,7 @@ $config['smtp_conn_options'] = null;
// LDAP
// LDAP
// ----------------------------------
// ----------------------------------
// Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache' or 'memcached' .
// Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache'.
$config['ldap_cache'] = 'db';
$config['ldap_cache'] = 'db';
// Lifetime of LDAP cache. Possible units: s, m, h, d, w
// Lifetime of LDAP cache. Possible units: s, m, h, d, w
@ -335,8 +328,7 @@ $config['ldap_cache_ttl'] = '10m';
// Use these hosts for accessing memcached
// Use these hosts for accessing memcached
// Define any number of hosts in the form of hostname:port or unix:///path/to/socket.file
// Define any number of hosts in the form of hostname:port or unix:///path/to/socket.file
// Example: array('localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock');
$config['memcache_hosts'] = null; // e.g. array( 'localhost:11211', '192.168.1.12:11211', 'unix:///var/tmp/memcached.sock' );
$config['memcache_hosts'] = null;
// Controls the use of a persistent connections to memcache servers
// Controls the use of a persistent connections to memcache servers
// See http://php.net/manual/en/memcache.addserver.php
// See http://php.net/manual/en/memcache.addserver.php
@ -351,15 +343,11 @@ $config['memcache_timeout'] = 1;
// See http://php.net/manual/en/memcache.addserver.php
// See http://php.net/manual/en/memcache.addserver.php
$config['memcache_retry_interval'] = 15;
$config['memcache_retry_interval'] = 15;
// Use these hosts for accessing Redis.
// use these hosts for accessing Redis.
// Currently only one host is supported. Cluster support may come in a future release.
// Currently only one host is supported. cluster support may come in a future release.
// You can pass 4 fields, host, port (optional), database (optional) and password (optional).
// You can pass 4 fields, host, port, database and password.
// Unset fields will be set to the default values host=127.0.0.1, port=6379.
// Unset fields will be set to the default values host=127.0.0.1, port=6379, database=0, password= (empty)
// Examples:
$config['redis_hosts'] = null; // e.g. array( 'localhost:6379' ); array( '192.168.1.1:6379:1:secret' );
// array('localhost:6379');
// array('192.168.1.1:6379:1:secret');
// array('unix:///var/run/redis/redis-server.sock:1:secret');
$config['redis_hosts'] = null;
// Maximum size of an object in memcache (in bytes). Default: 2MB
// Maximum size of an object in memcache (in bytes). Default: 2MB
$config['memcache_max_allowed_packet'] = '2M';
$config['memcache_max_allowed_packet'] = '2M';
@ -393,37 +381,16 @@ $config['advanced_prefs'] = array();
// PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
// PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE!
$config['support_url'] = '';
$config['support_url'] = '';
// Logo image replacement. Specifies location of the image as:
// replace Roundcube logo with this image
// - URL relative to the document root of this Roundcube installation
// specify an URL relative to the document root of this Roundcube installation
// - full URL with http:// or https:// prefix
// an array can be used to specify different logos for specific template files
// - URL relative to the current skin folder (when starts with a '/')
// '*' for default logo
//
// ':favicon' for favicon
// An array can be used to specify different logos for specific template files
// ':print' for logo on all print templates (e.g. messageprint, contactprint)
// The array key specifies the place(s) the logo should be applied to and
// ':small' for small screen logo in Elastic
// is made up of (up to) 3 parts:
// different logos can be specified for different skins by prefixing the skin name to the array key
// - skin name prefix (always with colon, can be replaced with *)
// config applied in order: < skin > :< template > , < skin > :*, < template > , *
// - template name (or * for all templates)
// for example array("*" => "/images/roundcube_logo.png", "messageprint" => "/images/roundcube_logo_print.png", "elastic:*" => "/images/logo.png")
// - logo type - it is used for logos used on multiple templates
// the available types include '[favicon]' for favicon, '[print]' for logo on all print
// templates (e.g. messageprint, contactprint) and '[small]' for small screen logo in supported skins
//
// Example config for skin_logo
/*
array(
// show the image /images/logo_login_small.png for the Login screen in the Elastic skin on small screens
"elastic:login[small]" => "/images/logo_login_small.png",
// show the image /images/logo_login.png for the Login screen in the Elastic skin
"elastic:login" => "/images/logo_login.png",
// show the image /images/logo_small.png in the Elastic skin
"elastic:*[small]" => "/images/logo_small.png",
// show the image /images/larry.png in the Larry skin
"larry:*" => "/images/larry.png",
// show the image /images/logo_login.png on the login template in all skins
"login" => "/images/logo_login.png",
// show the image /images/logo_print.png for all print type logos in all skins
"[print]" => "/images/logo_print.png",
);
*/
$config['skin_logo'] = null;
$config['skin_logo'] = null;
// automatically create a new Roundcube user when log-in the first time.
// automatically create a new Roundcube user when log-in the first time.
@ -504,19 +471,13 @@ $config['session_auth_name'] = null;
// Session path. Defaults to PHP session.cookie_path setting.
// Session path. Defaults to PHP session.cookie_path setting.
$config['session_path'] = null;
$config['session_path'] = null;
// Session samesite. Defaults to PHP session.cookie_samesite setting.
// Requires PHP >= 7.3.0, see https://wiki.php.net/rfc/same-site-cookie for more info
// Possible values: null (default), 'Lax', or 'Strict'
$config['session_samesite'] = null;
// Backend to use for session storage. Can either be 'db' (default), 'redis', 'memcache', or 'php'
// Backend to use for session storage. Can either be 'db' (default), 'redis', 'memcache', or 'php'
//
//
// If set to 'memcache' or 'memcached', a list of servers need to be specified in 'memcache_hosts'
// If set to 'memcache', a list of servers need to be specified in 'memcache_hosts'
// Make sure the Memcache extension (https://pecl.php.net/package/memcache) version >= 2.0.0
// Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed
// or the Memcached extension (https://pecl.php.net/package/memcached) version >= 2.0.0 is installed.
//
//
// If set to 'redis', a server needs to be specified in 'redis_hosts'
// If set to 'redis', a server needs to be specified in 'redis_hosts'
// Make sure the Redis extension (https ://pecl.php.net/package/redis) version >= 2.0.0 is installed.
// Make sure the Redis extension (http://pecl.php.net/package/redis) version >= 2.0.0 is installed
//
//
// Setting this value to 'php' will use the default session save handler configured in PHP
// Setting this value to 'php' will use the default session save handler configured in PHP
$config['session_storage'] = 'db';
$config['session_storage'] = 'db';
@ -544,10 +505,9 @@ $config['x_frame_options'] = 'sameorigin';
// This key is used for encrypting purposes, like storing of imap password
// This key is used for encrypting purposes, like storing of imap password
// in the session. For historical reasons it's called DES_key, but it's used
// in the session. For historical reasons it's called DES_key, but it's used
// with any configured cipher_method (see below).
// with any configured cipher_method (see below).
// For the default cipher_method a required key length is 24 characters.
$config['des_key'] = 'rcmail-!24ByteDESkey*Str';
$config['des_key'] = 'rcmail-!24ByteDESkey*Str';
// Encryption algorithm. You can use any method supported by OpenSSL .
// Encryption algorithm. You can use any method supported by openssl .
// Default is set for backward compatibility to DES-EDE3-CBC,
// Default is set for backward compatibility to DES-EDE3-CBC,
// but you can choose e.g. AES-256-CBC which we consider a better choice.
// but you can choose e.g. AES-256-CBC which we consider a better choice.
$config['cipher_method'] = 'DES-EDE3-CBC';
$config['cipher_method'] = 'DES-EDE3-CBC';
@ -655,12 +615,9 @@ $config['identities_level'] = 0;
$config['identity_image_size'] = 64;
$config['identity_image_size'] = 64;
// Mimetypes supported by the browser.
// Mimetypes supported by the browser.
// Attachments of these types will open in a preview window.
// attachments of these types will open in a preview window
// Either a comma-separated list or an array. Default list includes:
// either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf'
// text/plain,text/html,
$config['client_mimetypes'] = null; # null == default
// image/jpeg,image/gif,image/png,image/bmp,image/tiff,image/webp,
// application/x-javascript,application/pdf,application/x-shockwave-flash
$config['client_mimetypes'] = null;
// Path to a local mime magic database file for PHPs finfo extension.
// Path to a local mime magic database file for PHPs finfo extension.
// Set to null if the default path should be used.
// Set to null if the default path should be used.
@ -839,6 +796,11 @@ $config['max_pagesize'] = 200;
// Minimal value of user's 'refresh_interval' setting (in seconds)
// Minimal value of user's 'refresh_interval' setting (in seconds)
$config['min_refresh_interval'] = 60;
$config['min_refresh_interval'] = 60;
// Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option.
// By default refresh time is set to 1 second. You can set this value to true
// or any integer value indicating number of seconds.
$config['upload_progress'] = false;
// Specifies for how many seconds the Undo button will be available
// Specifies for how many seconds the Undo button will be available
// after object delete action. Currently used with supporting address book sources.
// after object delete action. Currently used with supporting address book sources.
// Setting it to 0, disables the feature.
// Setting it to 0, disables the feature.
@ -850,19 +812,17 @@ $config['compose_responses_static'] = array(
// array('name' => 'Canned Response 2', 'text' => 'Static Response Two'),
// array('name' => 'Canned Response 2', 'text' => 'Static Response Two'),
);
);
// List of HKP key servers for PGP public key lookups in Enigma/Mailvelope
// Note: Lookup is client-side, so the server must support Cross-Origin Resource Sharing
$config['keyservers'] = array('keys.openpgp.org');
// ----------------------------------
// ----------------------------------
// ADDRESSBOOK SETTINGS
// ADDRESSBOOK SETTINGS
// ----------------------------------
// ----------------------------------
// This indicates which type of address book to use. Possible choises:
// This indicates which type of address book to use. Possible choises:
// 'sql' - built-in sql addressbook enabled (default),
// 'sql' (default), 'ldap' and ''.
// '' - built-in sql addressbook disabled.
// If set to 'ldap' then it will look at using the first writable LDAP
// Still LDAP or plugin-added addressbooks will be available.
// address book as the primary address book and it will not display the
// BC Note: The value can actually be anything except 'sql', it does not matter.
// SQL address book in the 'Address Book' view.
// If set to '' then no address book will be displayed or only the
// addressbook which is created by a plugin (like CardDAV).
$config['address_book_type'] = 'sql';
$config['address_book_type'] = 'sql';
// In order to enable public ldap search, configure an array like the Verisign
// In order to enable public ldap search, configure an array like the Verisign
@ -895,7 +855,6 @@ $config['ldap_public']['Verisign'] = array(
// %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
// %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part)
// %z - IMAP domain (IMAP hostname without the first part)
// %z - IMAP domain (IMAP hostname without the first part)
// For example %n = mail.domain.tld, %t = domain.tld
// For example %n = mail.domain.tld, %t = domain.tld
// Note: Host can also be a full URI e.g. ldaps://hostname.local:636 (for SSL)
'hosts' => array('directory.verisign.com'),
'hosts' => array('directory.verisign.com'),
'port' => 389,
'port' => 389,
'use_tls' => false,
'use_tls' => false,
@ -1092,11 +1051,10 @@ $config['contact_search_name'] = '{name} <{email}>';
// Use this charset as fallback for message decoding
// Use this charset as fallback for message decoding
$config['default_charset'] = 'ISO-8859-1';
$config['default_charset'] = 'ISO-8859-1';
// S kin name: folder from skins/
// s kin name: folder from skins/
$config['skin'] = 'elastic ';
$config['skin'] = 'larry ';
// Limit skins available for the user.
// limit skins available/shown in the settings section
// Note: When not empty, it should include the default skin set in 'skin' option.
$config['skins_allowed'] = array();
$config['skins_allowed'] = array();
// Enables using standard browser windows (that can be handled as tabs)
// Enables using standard browser windows (that can be handled as tabs)
@ -1202,7 +1160,7 @@ $config['refresh_interval'] = 60;
// If true all folders will be checked for recent messages
// If true all folders will be checked for recent messages
$config['check_all_folders'] = false;
$config['check_all_folders'] = false;
// If true, after message/contact delete/move, the next message/contact will be displayed
// If true, after message delete/move, the next message will be displayed
$config['display_next'] = true;
$config['display_next'] = true;
// Default messages listing mode. One of 'threads' or 'list'.
// Default messages listing mode. One of 'threads' or 'list'.
@ -1250,6 +1208,12 @@ $config['search_mods'] = null; // Example: array('*' => array('subject'=>1, 'fr
// Defaults of the addressbook search field configuration.
// Defaults of the addressbook search field configuration.
$config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
$config['addressbook_search_mods'] = null; // Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1);
// 'Delete always'
// This setting reflects if mail should be always deleted
// when moving to Trash fails. This is necessary in some setups
// when user is over quota and Trash is included in the quota.
$config['delete_always'] = false;
// Directly delete messages in Junk instead of moving to Trash
// Directly delete messages in Junk instead of moving to Trash
$config['delete_junk'] = false;
$config['delete_junk'] = false;
Aleksander Machniak
