Overview
A complete list of all settings in SugarCRM
How it works
When you first install SugarCRM, all of your settings will be specified in config.php. As you being changing settings, the settings will be stored in config_override.php.
When using the application, settings in config.php will be overridden with the settings in config_override.php
Settings
addAjaxBannedModules
Performance and page-rendering times are improved in AJAX UI-enabled modules because full page refreshes are not required in those modules. If you are experiencing display issues with modules that are not compatible with AJAX, the AJAX UI for those modules can be disabled.
Type: Array of strings: module names
Versions: 6.3.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.3.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['addAjaxBannedModules'][] = 'Accounts';admin_access_control
Removes: Sugar Updates, Upgrade Wizard, Backups and Module Builder from the Admin menu. These restrictions can be found in ./include/MVC/Controller/file_access_control_map.php and overriden in ./custom/include/MVC/Controller/file_access_control_map.php.
Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['admin_access_control'] = true;admin_export_only
Allow only users with administrative privileges to export data.
Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['admin_export_only'] = true;allow_pop_inbound
Inbound email accounts are setup to work with IMAP protocols by default. If your email provider required POP3 access instead ofIMAP, you can enables POP3 as an available inbound email protocol. Please note that mailboxes configured with a POP3 connection are not supported and may cause unintended consequences. IMAP is the recommended protocol to use for inbound email accounts.
Type: Boolean: true, false
Versions: 5.5.1RC+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.5.1RC+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['allow_pop_inbound'] = true;allow_sendmail_outbound
Enables the option of choosing sendmail as an SMTP server in Admin > Email Settings. Note: sendmail must be enabled on the server for this option to work.
Type: Boolean: true, false
Versions: 5.5.1RC+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.5.1RC+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['allow_sendmail_outbound'] = true;authenticationClass
Class to use for user authentication.
Type: String: Authentication class name - ‘SAMLAuthenticate’
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: SugarAuthenticate
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: SugarAuthenticate
Override Example:
$sugar_config['authenticationClass'] = 'SAMLAuthenticate';cache_dir
This is the directory SugarCRM will store all cached files. Can be relative to Sugar root directory.
Type: String: Path to desired cache directory
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: cache/
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: cache/
Override Example:
$sugar_config['cache_dir'] = 'cache/';cache_expire_timeout
How long the cached values should be kept in the cache in seconds.
Type: Integer: In seconds
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['cache_expire_timeout'] = 36000;calendar
An array that defines all of the Calendar enhancements.
Type: Array
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar'] = array();calendar.day_timestep
Default day step size.
Type: Integer: 15, 30 and 60
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['day_timestep'] = 15;calendar.default_view
Changes the default view in calendar module.
Type: String: ‘day’, ‘week’, ‘month’ and ‘share’
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['default_view'] = 'week';calendar.editview_height
Default quick edit popup height in pixels.
Type: Integer: Represented in pixels
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['editview_height'] = 480;calendar.editview_width
Default quick edit popup width in pixels.
Type: Integer: Represented in pixels
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['editview_width'] = 990;calendar.items_draggable
Enable/Disable drag-and-drop feature to move calendar items.
Type: Boolean: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['items_draggable'] = true;calendar.month_timestep
Default month step size.
Type: Integer: 15, 30 and 60
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['month_timestep'] = 60;calendar.mouseover_expand (deprecated)
Enable/Disable additional detail icon on calendar items.
Type: Boolean: true, false
Versions: 6.4.0RC1 - 6.4.6
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1 - 6.4.6
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['mouseover_expand'] = true;calendar.show_calls_by_default
Display/Hide calls by default.
Type: Boolean: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['show_calls_by_default'] = true;calendar.show_tasks_by_default
Display/Hide tasks by default.
Type: Boolean: true, false
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['show_tasks_by_default'] = true;calendar.week_timestep
Default week step size.
Type: Integer: 15, 30 and 60
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['calendar']['week_timestep'] = 30;campaign_banner_id_generation
Determines the ID generation for campaign banners. If the value is not set to use ‘md5’ a default guid is generated.
Type: String: ID Generation type.
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: md5
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: md5
Override Example:
$sugar_config['campaign_banner_id_generation'] = 'md5';chartEngine
Determines the file to use for loading Chart resources. Scans in custom/include/SugarCharts or include/SugarCharts (see SugarChartFactory::getInstance).
Type: String: ID of chart engine.
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: Jit
Override Example:
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: Jit
Override Example:
$sugar_config['chartEngine'] = 'D3';check_query
Validates queries when adding limits.
Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['check_query'] = true;check_query_cost
Sets the maximum cost limit of a query.
Type: Integer
Versions: 5.2.0+
Editions: Ent, and Ult
Default Value: 10
Override Example:
Versions: 5.2.0+
Editions: Ent, and Ult
Default Value: 10
Override Example:
$sugar_config['check_query_cost'] = 10;check_query_log
Determines whether a bad query is logged as ‘fatal’ or ‘warn’. If set to true, the bad query is logged as ‘fatal’.
Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['check_query_log'] = true;common_ml_dir
Used in conjunction with the parameter ‘use_common_ml_dir’ to restrict Module Loader to read modules from only a specific directory on the server and disable the ability to upload new modules into the Module Loader.
Type: String: path to new directory
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['common_ml_dir'] = '/path/to/new/directory';create_default_user
Used in PopulateSeedData.php - determines the assigned user for all demo data. If the user does not exist or this value is not set, we default to admin user
Type: String: user_name of the desired user
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['create_default_user'] = 'jim';cron
Array that defines all of the cron parameters.
Type: Array
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['cron'] = aray();cron.max_cron_jobs
Maximum jobs per cron run. Default is 10. If you are using a version prior to 6.5.14, you will need to also populate max_jobs to set this value due to bug #62936 ( http://bugs.sugarcrm.com/?bug_number=62936 ).
Type: Integer
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 10
Override Example:
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 10
Override Example:
$sugar_config['cron']['max_cron_jobs'] = 10;cron.max_cron_runtime
Maximum time per cron run in seconds. Default is 60.
Type: Integer: In seconds
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 60
Override Example:
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 60
Override Example:
$sugar_config['cron']['max_cron_runtime'] = 60;cron.min_cron_interval
Minimum time between cron runs. Setting this to 0 will disable throttling completely.
Type: Integer: In seconds
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 30
Override Example:
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: 30
Override Example:
$sugar_config['cron']['min_cron_interval'] = 30;dashlet_auto_refresh_min
This is the minimum value one can choose to have dashlets auto-refresh. Setting to ‘Never’ (-1) disables auto-refreshing of dashlets entirely.
Type: String: ’-1’ (Never), ‘30’, ‘60’, ‘180’, ‘300’ and ‘600'
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 6.2.0RC1+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dashlet_auto_refresh_min'] = '30';dbconfig
Array that defines all of the connection parameters for the database server.
Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig'] = array();dbconfig.db_host_instance
Part of the ‘dbconfig’ array. Defines the host instance for MSSQL connections only.
Type: String: host instance used on the database server. Used only by SQL Server now.
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_host_instance'] = 'SQLEXPRESS';dbconfig.db_host_name
Part of the ‘dbconfig’ array. Defines the host name of the database server.
Type: String: host name of database server
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_host_name'] = 'localhost';dbconfig.db_manager
Part of the ‘dbconfig’ array. Defines the specific library used to connect with your database.
Type: String: class name of the DB driver, e.g.: ‘MysqlManager’, ‘MysqliManager’, ‘FreeTDSManager’, ‘MssqlManager’, ‘SqlsrvManager’
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.4.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['dbconfig']['db_manager'] = 'MysqliManager';dbconfig.db_name
Part of the ‘dbconfig’ array. Defines the database name to connect to on the database server.
Type: String: database name
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_name'] = 'sugar_db';dbconfig.db_password
Part of the ‘dbconfig’ array. Defines the password that correlates to the db_user_name parameter.
Type: String: password of the user defined in db_user_name
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_password'] = 'sql_password';dbconfig.db_port
Part of the ‘dbconfig’ array. Defines the port number on the server to connect to for authentication and transactions.
Type: String: port number to connect to on the database server
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_port'] = '3306';dbconfig.db_type
Part of the ‘dbconfig’ array. Defines the type of database used with Sugar.
Type: String: database engine name
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_type'] = 'mysql';dbconfig.db_user_name
Part of the ‘dbconfig’ array. Defines the user to connect to the database.
Type: String: user name to connect to database
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfig']['db_user_name'] = 'sql_user';dbconfigoption
This defines options used to connect to the database.
Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['dbconfigoption'] = array();dbconfigoption.persistent
Part of the dbconfig array. Determines whether Sugar should use persistent connection when possible to connect to the database.
Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: TRUE
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Default Value: TRUE
Override Example:
$sugar_config['dbconfigoption']['persistent'] = 'sql_user';default_module_favicon
If you are in a module with an icon, use the module’s icon as the favicon, instead of the theme’s favicon, in the browser tab. Set in UIvia Admin->System Settings.
Type: Boolean: true, false
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.5.0RC4+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['default_module_favicon'] = true;default_permissions
Array that defines the ownership and permissions for directories and files created naturally by the application.
Type: Array
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['default_permissions'] = array();default_permissions.dir_mode
Part of the ‘default_permissions’ array. Used in UNIX-based systems only to define the permissions on newly created directories. The value is stored in decimal notation while UNIX file permissions are octal. For example, a value of 1528 in this setting equates to 2770 permissions.
Type: Integer
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['default_permissions']['dir_mode'] = 1528;default_permissions.file_mode
Part of the ‘default_permissions’ array. Used in UNIX-based systems only to define the permissions on newly created files. The value is stored in decimal notation while UNIX file permissions are octal. For example, a value of 432 in this setting equates to 660 permissions.
Type: Integer
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['default_permissions']['file_mode'] = 432;default_permissions.group
Part of the ‘default_permissions’ array. Used in UNIX-based systems only to define the group membership of any newly created directories and files. This value should be a group that the Apache user is a member of to help ensure proper functionality.
Type: String: Group for the Apache user
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['default_permissions']['group'] = 'apache';default_permissions.user
Part of the ‘default_permissions’ array. Used in UNIX-based systems only to define the ownership of any newly created directories and files. This value should be the Apache user.
Type: String: Apache user
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['default_permissions']['user'] = 'apache';defaultSubPanelExpandCollapse
Ignore the cookie that remembers whether the panel is expanded or collapsed. Setting this to true ill ensure the subpanel is expanded.
Type: Boolean: true, false
Versions: 6.5.3+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: FALSE
Override Example:
Versions: 6.5.3+
Editions: CE, Pro, Corp, Ent, and Ult
Default Value: FALSE
Override Example:
$sugar_config['defaultSubPanelExpandCollapse'] = true;developerMode
Rebuilds all cached files when a page is accessed. Set in the UI via Admin->System Settings.
Type: Boolean: true, false
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
Versions: 5.2.0+
Editions: CE, Pro, Ent, Corp, and Ult
Override Example:
$sugar_config['developerMode'] = true;disable_convert_lead
If a lead has already been converted, enabling this option will remove the convert lead action.
Type: Boolean: true, false
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
Versions: 6.5.0RC1+
Editions: CE, Pro, Corp, Ent, and Ult
Override Example:
$sugar_config['disable_convert_lead'] = true;