System Configuration Overrides¶

allow_avatar_uploads¶

Set whether members can upload their own avatar.

Example Usage:

$config['allow_avatar_uploads'] = 'y';

Also found in CP: Members ‣ Preferences: Allow members to upload their own avatars

allow_dictionary_pw¶

Set whether words commonly found in the dictionary can be used as passwords. Must be used in combination with name_of_dictionary_file.

Example Usage:

$config['allow_dictionary_pw'] = 'y';

Also found in CP: Design ‣ Security and Privacy ‣ Security and Sessions: Allow Dictionary Words as Passwords

allow_extensions¶

Set whether extensions are enabled in the system. Disabling extensions will not uninstall extensions.

Example Usage:

$config['allow_extensions'] = 'y';

Also found in CP: Add-Ons ‣ Extensions: Disable Extensions?

allow_member_localization¶

Set whether dates and times are localized to each members’ own localization preferences.

Example Usage:

$config['allow_member_localization'] = 'y';

Also found in CP: Members ‣ Preferences ‣ Security and Sessions: Allow members to set their own localization preferences

allow_member_registration¶

Set whether site visitors are allowed to register for accounts.

Example Usage:

$config['allow_member_registration'] = 'y';

Also found in CP: Members ‣ Preferences: Allow New Member Registrations

allow_multi_logins¶

Set whether an account can have multiple active sessions at one time.

Example Usage:

$config['allow_multi_logins'] = 'y';

Also found in CP: Design ‣ Security and Privacy ‣ Security and Sessions: Allow multiple log-ins from a single account

allow_pending_login¶

Set whether members of the Pending member group can log in or not. By default, Pending members cannot log in.

Example Usage:

$config['allow_pending_login'] = 'y';

allow_signatures¶

Set whether member signatures are enabled.

Example Usage:

$config['allow_signatures'] = 'y';

Also found in CP: Members ‣ Preferences: Allow Users to have Signatures

allow_textarea_tabs¶

Set whether a tab keystroke produces a tab in Publish Page and Template Editor textareas. This is the default behavior.

Example Usage:

$config['allow_textarea_tabs'] = 'y';

allow_username_change¶

Set whether members can change their own usernames after registration.

Example Usage:

$config['allow_username_change'] = 'y';

Also found in CP: Design ‣ Security and Privacy ‣ Security and Sessions: Allow members to change their username

app_version¶

The installation’s ExpressionEngine version.

auto_assign_cat_parents¶

Set whether to assign an entry to both the selected category and its parent category.

Example Usage:

$config['auto_assign_cat_parents'] = 'y';

Also found in CP: Admin ‣ Channel Administration ‣ Global Channel Preferences: Auto-Assign Category Parents

autosave_interval_seconds¶

Set the interval between autosaves on the Publish Page.

Example Usage:

$config['autosave_interval_seconds'] = '30';

autosave_prune_hours¶

Set the age at which Channel Entry autosaves are automatically deleted.

Example Usage:

$config['autosave_prune_hours'] = '4';

avatar_max_height¶

Set the maximum height (in pixels) allowed for user-uploaded avatars.

Example Usage:

$config['avatar_max_height'] = '120';

Also found in CP: Members ‣ Preferences: Avatar Maximum Height

avatar_max_kb¶

Set the maximum file size (in kilobytes) allowed for user-uploaded avatars.

Example Usage:

$config['avatar_max_kb'] = '200';

Also found in CP: Members ‣ Preferences: Avatar Maximum Size

avatar_max_width¶

Set the maximum width (in pixels) allowed for user-uploaded avatars.

Example Usage:

$config['avatar_max_width'] = '120';

Also found in CP: Members ‣ Preferences: Avatar Maximum Width

avatar_path¶

Set the server path to the avatar directory.

Example Usage:

$config['avatar_path'] = '/path/images/avatars/';

Also found in CP: Members ‣ Preferences: Server Path to Avatar Folder

avatar_url¶

Set the URL to the avatar directory.

Example Usage:

$config['avatar_url'] = 'http://example.com/images/avatars';

Also found in CP: Members ‣ Preferences: URL to Avatar Folder

ban_action¶

Set the action to be taken when a visitor with a banned IP address attempts access.

Example Usage:

$config['ban_action'] = 'message';

Also found in CP: Members ‣ User Banning: When a banned IP tries to access the site

ban_destination¶

Set the redirect destination for visitors with banned IP addresses. Must be used in conjunction with ban_action set to bounce.

Example Usage:

$config['ban_destination'] = 'http://www.example.com';

Also found in CP: Members ‣ User Banning: When a banned IP tries to access the site

ban_message¶

Set the message shown to visitors with banned IP addresses. Must be used in conjunction with ban_action set to message.

Example Usage:

$config['ban_message'] = 'This site is currently unavailable.';

Also found in CP: Members ‣ User Banning: When a banned IP tries to access the site

banish_masked_ips¶

Set the system to deny a visitor access if the user’s IP address cannot be determined while throttling is enabled.

Example Usage:

$config['banish_masked_ips'] = 'y';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Deny Access if No IP Address is Present

banishment_message¶

Set a custom message to show throttled visitors. Throttling must be enabled and banishment_type must be set to message.

Example Usage:

$config['banishment_message'] = 'You have exceeded the allowed page load frequency.';

Also found in CP: Admin ‣ Security and Privacy ‣ Throttling Preferences: Custom Message

banishment_type¶

Set the system’s method for handling throttled web requests.

Example Usage:

$config['banishment_type'] = 'message';

Also found in CP: Members ‣ Security and Privacy ‣ Throttling Preferences: Action to Take

banishment_url¶

Set a URL to serve as the redirect destination for throttled visitors. Throttling must be enabled and banishment_type must be set to redirect.

Example Usage:

$config['banishment_url'] = 'http://www.yahoo.com';

Also found in CP: Members ‣ Security and Privacy ‣ Throttling Preferences: URL for Redirect

banned_emails¶

Specify email addresses to ban from site registration and login. Use wildcards for partial email addresses.

Example Usage:

$config['banned_emails'] = '[email protected]|[email protected]|*@spammydomain.com';

Also found in CP: Members ‣ User Banning: Banned Email Addresses

banned_ips¶

Specify IP addresses to ban from site registration and login. Use wildcards to ban blocks of IP addresses.

Example Usage:

$config['banned_ips'] = '123.456.789.1|123.321.*';

Also found in CP: Members ‣ User Banning: Banned IP Address

banned_screen_names¶

Specify screen names that cannot be used for member accounts, which can be handy for reserving certain screen names for your own use.

Example Usage:

$config['banned_screen_names'] = 'Garfield|Snoopy|Hobbes';

Also found in CP: Members ‣ User Banning: Restricted Screen Names

banned_usernames¶

Specify usernames that cannot be used for member accounts, which can be handy for reserving certain usernames for your own use.

Example Usage:

$config['banned_usernames'] = 'garfield|snoopy|hobbes';

Also found in CP: Members ‣ User Banning: Restricted Usernames

cache_driver¶

Specify a different caching driver to use.

Example Usage:

$config['cache_driver'] = 'memcached';

cache_driver_backup¶

Specify a backup caching driver to use in case the one specified in cache_driver isn’t available. Same values accepted and same default as cache_driver.

Example Usage:

$config['cache_driver_backup'] = 'file';

cache_path¶

Set the path to the system’s cache directory. Leave blank to use the system default system/expressionengine/cache/.

Example Usage:

$config['cache_path'] = '/path/to/cache/folder/';

captcha_font¶

Set whether TrueType fonts should be used for CAPTCHA images.

Example Usage:

$config['captcha_font'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ CAPTCHA Preferences: Use TrueType Font for CAPTCHA

captcha_path¶

Set the path to the directory containing CAPTCHA images.

Example Usage:

$config['captcha_path'] = '/path/to/captcha/folder/';

Also found in CP: Admin ‣ Security and Privacy ‣ CAPTCHA Preferences: Server Path to CAPTCHA Folder

captcha_rand¶

Specify whether to add a random three-digit number to the end of each generated CAPTCHA word. This makes it more difficult for scripts to guess or brute-force the form submission.

Example Usage:

$config['captcha_rand'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ CAPTCHA Preferences: Add Random Number to CAPTCHA Word

captcha_require_members¶

Specify whether to require logged-in members to pass CAPTCHA validation to post comments, assuming the CAPTCHA is already enabled for comments.

Example Usage:

$config['captcha_require_members'] = 'y';

Also found in CP: Admin ‣ Security and Privacy ‣ CAPTCHA Preferences: Require CAPTCHA with logged-in members

captcha_url¶

Set the full URL to the directory containing CAPTCHA images.

Example Usage:

$config['captcha_url'] = 'http://www.example.com/images/captchas';

Also found in CP: Admin ‣ Security and Privacy ‣ CAPTCHA Preferences: Full URL to CAPTCHA Folder

censor_replacement¶

You may optionally specify a word or phrase to be used when replacing censored words. For example, if you set “tisk tisk” as your replacement word, and “shucks” is in your censored list, then anytime “shucks” is used it will be replaced with “tisk tisk”. If you do not set this preference, a pound symbol will be used for each character that is censored, so “shucks” would be converted to “######”.

Example Usage:

$config['censor_replacement'] = 'tisk tisk';

Also found in CP: Admin ‣ Security and Privacy ‣ Word Censoring: Censoring Replacement Word

censored_words¶

Specify a list of words to censor. Wildcards are allowed. For example, test* would censor the words “test”, “testing”, and “tester”, while *gress would censor the words “progress” and “congress”.

Example Usage:

$config['censored_words'] = 'dagnabbit|consarnit|golly gee willikers';

Also found in CP: Admin ‣ Security and Privacy ‣ Word Censoring: Censored Words

charset¶

Specify which character set for the system to use by default.

Example Usage:

$config['charset'] = 'UTF-8';

comment_edit_time_limit¶

Set the length of time in seconds that members have to edit their comments on the front end of the site. Set to 0 for no limit. Members in the Super Admin group are exempt from this time limit.

Example Usage:

$config['comment_edit_time_limit'] = '120';

Also found in CP: Add-Ons ‣ Modules ‣ Comment: Comment Editing Time Limit

comment_moderation_override¶

By default, comments are no longer accepted for entries after their comment expiration date has passed. Set this preference to override that behavior and allow moderated comments on entries after comment expiration.

Example Usage:

$config['comment_moderation_override'] = 'y';

Also found in CP: Add-Ons ‣ Modules ‣ Comment: Moderate expired entries

comment_word_censoring¶

Apply word censoring to comments, even if censoring is not enabled system-wide.

Example Usage:

$config['comment_word_censoring'] = 'y';

Also found in CP: Add-Ons ‣ Modules ‣ Comment: Force word censoring for comments

cookie_domain¶

Optionally specify a domain the cookie is available to. By default, the exact hostname of the requested page is set as the cookie domain. For example, if the page at http://www.example.com/blog/an-entry-title is loaded and the cookie domain is left blank in ExpressionEngine’s configuration, the browser will use www.example.com as the cookie domain. The browser will only make these cookies available when the page’s hostname is exactly www.example.com.

If the cookie domain is explicitly specified, however, the browser will make the cookie available whenever the requested page’s hostname contains the cookie domain. For example, setting the cookie domain to .example.com will ensure the cookie is shared whenever the requested page’s hostname includes example.com, www.example.com, admin.example.com, blog.example.com, and so on.

If you’re running multiple subdomains on a single ExpressionEngine installation and want member sessions to be valid across all subdomains, you should explicitly set the cookie domain.

Example Usage:

$config['cookie_domain'] = '.example.com';

Also found in CP: Admin ‣ Security and Privacy ‣ Cookie Settings: Cookie Domain

cookie_httponly¶

Set the HttpOnly flag when setting a cookie. The HttpOnly flag is a security feature for cookies that prevents a client side script from accessing or deleting the cookie (if the browser supports it, as most modern browsers do). Learn more.

Example Usage:

$config['cookie_httponly'] = 'n';

cookie_path¶

Optionally specify a cookie path. When a cookie path is set, the browser will only share cookies with ExpressionEngine when the beginning of the URL path matches the cookie path. For example, if the cookie path is set to /blog/, a cookie for the domain example.com will only be sent by the browser if the URL begins with http://example.com/blog/. This can be useful if you have ExpressionEngine installed in a sub-directory and want to ensure that only that particular installation has access to the cookies it sets.

Example Usage:

$config['cookie_path'] = '/blog/';

Also found in CP: Admin ‣ Security and Privacy ‣ Cookie Settings: Cookie Path

cookie_prefix¶

Specify a prefix for the cookie name set by ExpressionEngine. This protects against collisions from separate ExpressionEngine installations on the same cookie domain.

Example Usage:

$config['cookie_prefix'] = 'site1';

Also found in CP: Admin ‣ Security and Privacy ‣ Cookie Settings: Cookie Prefix

cookie_secure¶

Require a secure connection (HTTPS) for ExpressionEngine to set cookies.

Example Usage:

$config['cookie_secure'] = 'y';

cp_session_type¶

Set the method for session handling in the Control Panel.

Example Usage:

$config['cp_session_type'] = 's';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Control Panel Session Type

cp_theme¶

Set the default theme that users will see when logged-in to the Control Panel.

Example Usage:

$config['cp_theme'] = 'default';

Also found in CP: Admin ‣ General Configuration: Default Control Panel Theme

cp_url¶

Set the full URL to your Control Panel.

Example Usage:

$config['cp_url'] = 'http://example.com/admin.php';

Also available for use in the site index file, index.php, and the CP index file, admin.php. Example Usage:

$assign_to_config['cp_url'] = 'http://domain2.com/admin.php';

Also found in CP: Admin ‣ General Configuration: URL to your Control Panel index page

date_format¶

Set the default format for displaying dates. If allow_member_localization is enabled and a member has their own localization preference set, that will override this setting.

Example Usage:

$config['date_format'] = '%F %d %Y';

debug¶

Set display preferences for PHP and database error messages.

Example Usage:

$config['debug'] = '1';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: Debug Preference

default_member_group¶

Set the member group to which new users will be assigned.

Example Usage:

$config['default_member_group'] = '6';

Also found in CP: Members ‣ Preferences: Default Member Group Assigned to New Members

default_site_timezone¶

Set the default timezone. All dates and times displayed by ExpressionEngine will be localized to this timezone unless overridden by a member’s own localization preferences.

Example Usage:

$config['default_site_timezone'] = 'America/Los_Angeles';

Also found in CP: Admin ‣ Localization Settings: Site Timezone

deft_lang¶

Set the default language. ExpressionEngine ships with English, and additional language packs are available for download.

Example Usage:

$config['deft_lang'] = 'french';

deny_duplicate_data¶

Set whether to reject duplicate data submissions. This feature blocks a comment if an identical one already exists on the site.

Example Usage:

$config['deny_duplicate_data'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Deny Duplicate Data

disable_all_tracking¶

This is an emergency override which will disable all tracking when enabled. This is useful for server administrators who need a way to respond immediately to table locks during a traffic spike to keep the site running smoothly.

Example Usage:

$config['disable_all_tracking'] = 'y';

disable_csrf_protection¶

CSRF protection prevents automated scripts (the most common way spam is generated) from repeatedly submitting comments or other form data. A submission is only allowed when a user manually loads a page and submits the form from your site.

Example Usage:

$config['disable_csrf_protection'] = 'y';

disable_tag_caching¶

Disables tag caching, which if used unwisely on a high traffic site can lead to disastrous disk i/o. This setting allows quick thinking admins to temporarily disable it without hacking or modifying folder permissions.

Example Usage:

$config['disable_tag_caching'] = 'y';

doc_url¶

Set the URL to the ExpressionEngine User Guide, used in the Control Panel to provide a direct link to the documentation.

Example Usage:

$config['doc_url'] = 'https://ellislab.com/expressionengine/user-guide/';

Also found in CP: Admin ‣ General Configuration: URL to Documentation Directory

dynamic_tracking_disabling¶

Set a value for the maximum number of online visitors to track. Once this value is exceeded, all of the tracking features will be temporarily disabled until the number of online visitors drops below the indicated value. Recommended values for this feature will vary based on your hosting environment. Check with your server administrator to discuss reasonable limits for your site.

Example Usage:

$config['dynamic_tracking_disabling'] = '350';

Also found in CP: Admin ‣ Security and Privacy ‣ Tracking Preferences: Suspend ALL tracking when number of online visitors exceeds:

email_batch_size¶

Set the number of emails to be sent in each batch. The batch size you should use depend on many things; among them the email protocol you have chosen, the server configuration, and the server power, so you may need to experiment a little to get it right.

If you are using one of the more robust mail protocols, like Sendmail or SMTP, you can set a greater batch total, possibly as high as several hundred or even more if you are on a dedicated server. A batch size of 300 in these cases is a good starting point. If you are having good success you can increase it until you begin experiencing time-outs.

Example Usage:

$config['email_batch_size'] = '300';

Also found in CP: Admin ‣ Email Configuration: Number of Emails Per Batch

email_batchmode¶

Set whether to send email via the Communicate section of the Control Panel in batches.

This mode splits up large numbers of emails into small batches which are sent at short intervals. This gives you the ability to send email to very large mailing lists without running up against your server’s execution time limit. By default, PHP limits any process to 30 seconds, which is not enough time to send a large amount of email. Enabling the batch mode can prevent server time-outs. A secondary benefit is that it is less taxing on your mail server and, in the case of people on shared hosting accounts, less likely to cause problems with your server administrator.

Example Usage:

$config['email_batchmode'] = 'y';

Also found in CP: Admin ‣ Email Configuration: Use Batch Mode

email_charset¶

Set the character encoding used on the content of outgoing messages.

Example Usage:

$config['email_charset'] = 'utf-8';

Also found in CP: Admin ‣ Email Configuration: Email Character Encoding

email_console_timelock¶

Set the number of minutes that must lapse before a member is allowed to send another email.

Example Usage:

$config['email_console_timelock'] = '300';

Also found in CP: Admin ‣ Email Configuration: Email Console Timelock

email_crlf¶

If set, this overrides the core Email class setting for crlf characters in quoted-printable encoded emails (Email class $crlf property).

Example Usage:

$config['email_crlf'] = "\r\n";

email_debug¶

When enabled, detailed debugging information will be displayed whenever you send an email using the Communicate page. This information can be useful in helping to track down any problems you may be experiencing.

Example Usage:

$config['email_debug'] = 'y';

Also found in CP: Admin ‣ Email Configuration: Enable Email Debugging

email_module_captchas¶

When enabled, users will need to fill out a CAPTCHA when using the Tell-a-Friend or Contact email forms. You will need to ensure that your tags for those forms contain the appropriate CAPTCHA code.

Example Usage:

$config['email_module_captchas'] = 'y';

Also found in CP: Admin ‣ Email Configuration: Enable CAPTCHAs for Tell-a-Friend and Contact emails

email_newline¶

If set, overrides the core Email class setting for newline characters (Email class $newline property).

Example Usage:

$config['email_newline'] = "\r\n";

email_smtp_crypto¶

Cryptographic protocol (Secure Sockets Layer or Transport Layer Security allowed) for SMTP, when a secure connection is required.

Example Usage:

$config['email_smtp_crypto'] = 'tls';

emoticon_url¶

Set the URL to the base folder where smiley graphics are stored.

Example Usage:

$config['emoticon_url'] = 'http://example.com/images/smileys/';

Also found in CP: Admin ‣ System Administration ‣ Emoticon Preferences: URL to the folder containing your smileys

enable_avatars¶

If enabled, users can associate an image with their account that you can optionally display with entries, comments, and forum posts.

Example Usage:

$config['enable_avatars'] = 'n';

Also found in CP: Members ‣ Preferences: Enable Avatars

enable_censoring¶

If enabled, the system will censor any specified words in channel entries, comments, forum posts, etc. Censored words will be replaced with the censoring replacement word.

Example Usage:

$config['enable_censoring'] = 'y';

Also found in CP: Members ‣ Security and Privacy ‣ Word Censoring: Enable Word Censoring

enable_db_caching¶

If enabled, the system will cache the output of database queries to text files.

Example Usage:

$config['enable_db_caching'] = 'y';

enable_emoticons¶

If enabled, smileys entered as text will be displayed with graphic representations.

Example Usage:

$config['enable_emoticons'] = 'y';

Also found in CP: Members ‣ System Administration ‣ Emoticon Preferences: Display Smileys

enable_entry_view_tracking¶

If enabled, the Entry “Views” Tracking Tag feature of the Channel module is available for use.

Example Usage:

$config['enable_entry_view_tracking'] = 'y';

Also found in CP: Members ‣ Security and Privacy ‣ Tracking Preferences: Enable Channel Entry View Tracking

enable_hit_tracking¶

If enabled, the hit will be tracked each time a template is loaded.

Example Usage:

$config['enable_hit_tracking'] = 'y';

Also found in CP: Members ‣ Security and Privacy ‣ Tracking Preferences: Enable Template Hit Tracking

enable_online_user_tracking¶

If enabled, online user statistics are tracked and the user-based variables in the Statistics module are available for use.

Example Usage:

$config['enable_online_user_tracking'] = 'y';

Also found in CP: Members ‣ Security and Privacy ‣ Tracking Preferences: Enable Online User Tracking

enable_photos¶

If enabled, users can upload an image to be displayed in their member profile area.

Example Usage:

$config['enable_photos'] = 'y';

Also found in CP: Members ‣ Preferences: Enable Member Photos

enable_search_log¶

If enabled, each searched term will be logged and can be viewed in the Search Log.

Example Usage:

$config['enable_search_log'] = 'n';

Also found in CP: Admin ‣ System Administration ‣ Search Log Configuration: Enable Search Term Logging

enable_sql_caching¶

Improves the speed at which the Channel Entries tag is rendered by caching queries that are normally executed dynamically.

Example Usage:

$config['enable_sql_caching'] = 'n';

Also found in CP: Admin ‣ Channel Administration ‣ Global Preferences: Cache Dynamic Channel Queries

enable_template_routes¶

This setting toggles whether or not Template Routes are used. If this is set to no, templates will not be accessible by their routes. When disabled the Template Route options will not appear in the Template Manager.

Example Usage:

$config['enable_template_routes'] = 'y';

Also found in CP: Design ‣ Templates ‣ Global Template Preferences: Enable Template Routes

enable_throttling¶

If enabled, the system will throttle excessive web requests from potentially malicious users.

Example Usage:

$config['enable_throttling'] = 'y';

Also found in CP: Admin ‣ Security and Privacy ‣ Throttling Preferences: Enable Throttling

encode_removed_text¶

If set and $this->encode_email is set to FALSE in the Template class—which is not the default—this text will replace all instances of the encode global variable.

Example Usage:

$config['encode_removed_text'] = 'Encoded emails not allowed';

encryption_key¶

May be used by third parties as part of encoding and decoding encrypted data. The recommended length of the key is 32 characters (128 bits). The key should include numbers and uppercase and lowercase letters.

Example Usage:

$config['encryption_key'] = 'sy22k6QK6JzH38u4nLZ65bHOdK6VL89d';

expire_session_on_browser_close¶

Set the system to end a user’s session when the browser is closed. (In the case of Mac OS X, this means quitting the browser application.)

Example Usage:

$config['expire_session_on_browser_close'] = 'y';

filename_increment¶

Forces filenames of uploaded files to be unique. Secondary uploads of existing files or uploads that share a filename with an existing file will have an incrementing number appended to the filename.

Example Usage:

$config['filename_increment'] = 'y';

force_query_string¶

If enabled, ExpressionEngine will render URLs with a question mark following index.php in order to pass along segment information as a standard query string:

http://example.com/index.php?/channel/joe/

This is necessary for only a few types of web servers to process ExpressionEngine’s URLs correctly. ExpressionEngine’s default is a much more search-engine friendly format:

http://example.com/index.php/channel/joe/

In rare circumstances, you may need to use this variable in conjunction with editing the $qtype variable in your main site index.php file.

Example Usage:

$config['force_query_string'] = 'y';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: Force URL query strings

forum_is_installed¶

Automatically enabled when the Discussion Forum module is installed.

Example Usage:

$config['forum_is_installed'] = 'y';

forum_trigger¶

Sets the forum triggering word if the Discussion Forum module is installed.

Example Usage:

$config['forum_trigger'] = 'eerox';

Also found in CP: Add-Ons ‣ Modules ‣ Discussion Forum ‣ Default Preferences: Forum Triggering Word

gzip_output¶

Set the system to serve compressed front-end pages for faster load times as long as the requesting browser supports gzip compression, PHP’s zlib extension is loaded, and the web server is not already serving compressed pages. It’s a good idea to enable this setting in most production environments.

Example Usage:

$config['gzip_output'] = 'y';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: Enable GZIP Output

hidden_template_indicator¶

Specify the character(s) that denote a hidden template when used to prefix a template name. The default is an underscore, e.g. _my_hidden_template.

Example Usage:

$config['hidden_template_indicator'] = '.';

hidden_template_404¶

Set the system to show either a 404 page or the template group’s index page when a hidden template is directly loaded in a browser.

Example Usage:

$config['hidden_template_404'] = 'y';

htaccess_path¶

Set the server path used by the Blacklist/Whitelist module to write rules to your .htaccess file.

Example Usage:

$config['htaccess_path'] = '/server/path/to/your/.htaccess/';

image_library_path¶

Set the path to the selected image library.

Example Usage:

$config['image_library_path'] = '/usr/bin/';

Also found in CP: Admin ‣ System Administration ‣ Image Resizing Preferences: Image Converter Path

image_resize_protocol¶

Specify the image manipulation library to use. You may need to contact your web host or sysadmin to determine which protocols are installed and available on your server.

Example Usage:

$config['image_resize_protocol'] = 'netpbm';

Also found in CP: Admin ‣ System Administration ‣ Image Resizing Preferences: Image Resizing Protocol

include_seconds¶

Set the system to include seconds when time is displayed in the interface.

Example Usage:

$config['include_seconds'] = 'y';

ip2nation¶

Enable checks against the IP to Nation database.

Example Usage:

$config['ip2nation'] = 'n';

is_site_on¶

Specify whether the site should be viewable by the general public or taken offline. This can be helpful when performing maintenance on only one of several MSM sites.

Example Usage:

$config['is_site_on'] = 'n';

Also available for use in the site index file, index.php. Example Usage:

$assign_to_config['is_site_on'] = 'n';

Also found in CP: Admin ‣ General Configuration: Is site on?

is_system_on¶

Specify whether the system’s front-end should be viewable by the general public or taken offline. This can be helpful when performing maintenance.

Example Usage:

$config['is_system_on'] = 'y';

Also found in CP: Admin ‣ General Configuration: Is system on?

license_contact¶

Specify the email address for the license holder. Does not have to be specifically tied to your EllisLab.com account.

Example Usage:

$config['license_contact'] = '[email protected]';

Also found in CP: Admin ‣ Software License: License Holder Contact Email

license_number¶

Specify the software license number. You can find a record of your license number in your EllisLab.com account.

Example Usage:

$config['license_number'] = '1234-1234-1234-1234';

Also found in CP: Admin ‣ Software License: License Number

lockout_time¶

Set the length of time a throttled visitor will be locked out of the site.

Example Usage:

$config['lockout_time'] = '30';

Also found in CP: Admin ‣ Security and Privacy ‣ Throttling Preferences: Lockout Time

log_date_format¶

Set the timestamp format for all items added to the log file.

Example Usage:

$config['log_date_format'] = 'Y-m-d H:i:s';

log_email_console_msgs¶

Enable logging of all messages sent via the email console in the member profile pages.

Example Usage:

$config['log_email_console_msgs'] = 'n';

Also found in CP: Admin ‣ Email Configuration: Log Email Console Messages

log_path¶

Set the path to the system log directory. Use a full server path with trailing slash.

Example Usage:

$config['log_path'] = '/path/to/location/';

log_referrers¶

Enable referrer tracking. When enabled, one additional database access query will be performed for each page load so that the statistics can be generated.

Example Usage:

$config['log_referrers'] = 'n';

log_search_terms¶

Unused in first party files, this configuration item exists to allow backwards compatibility for any third party add-ons using it.

log_threshold¶

Set an error threshold to determine how much information is logged.

Example Usage:

$config['log_threshold'] = '1';

mail_format¶

Set the default mail format selection for emails sent via the Communicate section.

Example Usage:

$config['mail_format'] = 'plain';

Also found in CP: Admin ‣ Email Configuration: Default Mail Format

mail_protocol¶

Set the system’s method for sending email.

Example Usage:

$config['mail_protocol'] = 'smtp';

Also found in CP: Admin ‣ Email Configuration: Email Protocol

mailinglist_enabled¶

Enable the mailing list.

Example Usage:

$config['mailinglist_enabled'] = 'y';

Also found in CP: Add-Ons ‣ Modules ‣ Mailing List ‣ Mailing List Preferences: Mailing List is Enabled

mailinglist_notify¶

Enable notification of a given recipient list when new subscribers sign up.

Example Usage:

$config['mailinglist_notify'] = 'y';

Also found in CP: Add-Ons ‣ Modules ‣ Mailing List ‣ Mailing List Preferences: Enable recipient list for notification of new mailing list sign-ups

mailinglist_notify_emails¶

List of email addresses to notify when new subscribers sign up for the mailing list.

Example Usage:

$config['mailinglist_notify_emails'] = '[email protected], [email protected]';

Also found in CP: Add-Ons ‣ Modules ‣ Mailing List ‣ Mailing List Preferences: Email Address of Notification Recipient(s)

max_logged_searches¶

Set the maximum number of most recent search terms to save in the search log.

Example Usage:

$config['max_logged_searches'] = '500';

Also found in CP: Admin ‣ System Administration ‣ Search Log Configuration: Maximum number of recent search terms to save

max_page_loads¶

Set the maximum number of times a visitor is allowed to load your web pages within a given time interval before being locked out. If you set this preference to 5 page loads within 10 seconds, a user can not browse more than 5 pages within a 10 second interval or the throttling feature will be triggered, locking them out for the given lockout time.

Example Usage:

$config['max_page_loads'] = '10';

Also found in CP: Admin ‣ Security and Privacy ‣ Throttling Preferences: Maximum Number of Page Loads

max_tmpl_revisions¶

Set the maximum number of template revisions to save if template revisions are enabled.

Example Usage:

$config['max_tmpl_revisions'] = '10';

Also found in CP: Design ‣ Templates ‣ Global Template Preferences: Maximum Number of Revisions to Keep

max_url_segments¶

Set the maximum number of URL segments allows in requests made to your site.

Example Usage:

$config['max_url_segments'] = '12';

mbr_notification_emails¶

List of email addresses to notify if notification is enabled for new member registrations.

Example Usage:

$config['mbr_notification_emails'] = '[email protected], [email protected]';

Also found in CP: Members ‣ Preferences: Email address for notifications

memcached¶

If Memcached is the specified cache_driver, allows configuration of multiple Memcached servers to be used for cache storage.

Example Usage:

$config['memcached'] = array(
  array(
    'host' => '192.168.1.100',
    'port' => 11211,
    'weight' => 2,
  ),
  array(
    'host' => '192.168.1.101',
    'port' => 11211,
    'weight' => 1,
  )
);

member_theme¶

Set the default member profile theme.

Example Usage:

$config['member_theme'] = 'default';

Also found in CP: Members ‣ Preferences: Default Member Profile Theme

memberlist_order_by¶

Set the default sorting criteria for the member list.

Example Usage:

$config['memberlist_order_by'] = 'total_posts';

Also found in CP: Members ‣ Preferences: Member List - Sort By

mime_whitelist_additions¶

With an array, add Mime Types to the whitelist.

Example Usage:

$config['mime_whitelist_additions'] = array(
  'image/vnd.adobe.photoshop'
);

mime_whitelist_member_exception¶

Specify member IDs to exclude from Mime Type whitelist restrictions.

Example Usage:

$config['mime_whitelist_member_exception'] = '3, 14, 83';

mime_whitelist_member_group_exception¶

Specify member group IDs to exclude from Mime Type whitelist restrictions.

Example Usage:

$config['mime_whitelist_member_group_exception'] = '2, 5';

moblog_allow_nontextareas¶

Remove Moblog’s textarea-only restriction for Channel Fields.

Example Usage:

$config['moblog_allow_nontextareas'] = 'y';

memberlist_row_limit¶

Set the default number of rows for the member list to display.

Example Usage:

$config['memberlist_row_limit'] = '20';

Also found in CP: Members ‣ Preferences: Member List - Rows

memberlist_sort_order¶

Set the default member list sort order.

Example Usage:

$config['memberlist_sort_order'] = 'desc';

Also found in CP: Members ‣ Preferences: Member List - Order

multiple_sites_enabled¶

Enable Multiple Site Manager.

Example Usage:

$config['multiple_sites_enabled'] = 'y';

Also found in CP: Admin ‣ General Configuration: Enable Multiple Site Manager

name_of_dictionary_file¶

Filename for the dictionary file. The official dictionary file is available for download. Must be used in combination with allow_dictionary_pw.

Example Usage:

$config['name_of_dictionary_file'] = 'dictionary.txt';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Name of Dictionary File

new_member_notification¶

Enables notification of a given notification list for new member registrations.

Example Usage:

$config['new_member_notification'] = 'n';

Also found in CP: Members ‣ Preferences: Send new member notifications

new_posts_clear_caches¶

Set caches to clear when new entries are posted.

Example Usage:

$config['new_posts_clear_caches'] = 'n';

Also found in CP: Admin ‣ Channel Administration ‣ Global Channel Preferences: Clear all caches when new entries are posted

new_version_check¶

Set ExpressionEngine to periodically check for available updates.

Example Usage:

$config['new_version_check'] = 'n';

Also found in CP: Admin ‣ General Configuration: New Version Auto Check

newrelic_app_name¶

Sets the application name that is reported in the New Relic dashboard. If you’re using New Relic to monitor the performance of multiple ExpressionEngine installations, you’ll likely want those installations to show up separately in your New Relic dashboard.

Example Usage:

$config['newrelic_app_name'] = 'My Site';

Also available for use in the site index file, index.php, and the CP index file, admin.php. Example Usage:

$assign_to_config['newrelic_app_name'] = 'My Second Site';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: New Relic Application Name

newrelic_include_version_number¶

Whether or not to append the version number to the Application name in the New Relic dashboard.

Example Usage:

$config['newrelic_include_version_number'] = 'y';

password_lockout¶

If enabled, the system will lock a member account if more than four invalid login attempts are made within a specified time period. This is designed to deter hackers from using collision attacks to guess poorly chosen passwords. The account remains locked for the duration of the password lockout time period.

Example Usage:

$config['password_lockout'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Enable Password Lockout

password_lockout_interval¶

Set the time period for measuring invalid login attempts and locking accounts.

Example Usage:

$config['password_lockout_interval'] = '2.5';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Time Interval for Lockout

path_third_themes¶

Set the path to the third-party add-ons’ themes directory. Should be used in conjunction with url_third_themes.

Example Usage:

$config['path_third_themes'] = '/valid/path/to/directory/';

photo_max_height¶

Set the maximum height (in pixels) allowed for user-uploaded member photos.

Example Usage:

$config['photo_max_height'] = '100';

Also found in CP: Members ‣ Preferences: Photo Maximum Height

photo_max_kb¶

Set the maximum file size (in kilobytes) allowed for user-uploaded member photos.

Example Usage:

$config['photo_max_kb'] = '50';

Also found in CP: Members ‣ Preferences: Photo Maximum Size (in Kilobytes)

photo_max_width¶

Set the maximum width (in pixels) allowed for user-uploaded member photos.

Example Usage:

$config['photo_max_width'] = '150';

Also found in CP: Members ‣ Preferences: Photo Maximum Width

photo_path¶

Set the server path to the member photo directory.

Example Usage:

$config['photo_path'] = '/path/images/member_photos/';

Also found in CP: Members ‣ Preferences: Server Path to Photo Folder

photo_url¶

Set the URL to the member photo directory.

Example Usage:

$config['photo_url'] = 'http://example.com/images/member_photos/';

Also found in CP: Members ‣ Preferences: URL to Photos Folder

popup_link¶

Specify whether links created by the Typography class open in a new window.

Example Usage:

$config['popup_link'] = 'y';

profile_trigger¶

Set the triggering word for the front-end members section. The default is “member”, and the word you set cannot be the name of an existing template group.

Example Usage:

$config['profile_trigger'] = 'accounts';

Also found in CP: Members ‣ Preferences: Profile Triggering Word

proxy_ips¶

Whitelist of reverse proxy servers that may forward the visitor’s IP address.

Example Usage:

$config['proxy_ips'] = '10.0.1.25, 10.0.1.26';

prv_msg_throttling_period¶

Set the length of time users must wait between sending private messages.

Example Usage:

$config['prv_msg_throttling_period'] = '60';

prv_msg_upload_path¶

Set the server path to the private messages uploads directory.

Example Usage:

$config['prv_msg_upload_path'] = '/path/images/pm_attachments/';

Also found in CP: Members ‣ Preferences: Server Path for Attachment Upload Directory

prv_msg_waiting_period¶

Set the length of time members must wait after registration before being allowed to send private messages.

Example Usage:

$config['prv_msg_waiting_period'] = '4';

publish_page_title_focus¶

Specify whether the title field should gain focus when the publish page is loaded.

Example Usage:

$config['publish_page_title_focus'] = 'n';

pw_min_len¶

Set the minimum number of characters allowed for member passwords.

Example Usage:

$config['pw_min_len'] = '8';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Minimum Password Length

recount_batch_total¶

Set the batch size for recounting statistics.

Because the recounting of statistics can impose some load on your server, the recounting is performed in batches. This setting allows you to define how large each processing batch should be. For most servers, a value of 1000 works well. For high-performance or dedicated servers you can increase this number and if your server is low on resources you may need to lower the number.

Example Usage:

$config['recount_batch_total'] = '200';

Also found in CP: Tools ‣ Data ‣ Recount Statistics ‣ Recount Preferences: Total number of database rows processed per batch

redirect_method¶

Set the method the system uses for page redirection.

Example Usage:

$config['redirect_method'] = 'redirect';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: Redirection Method

redirect_submitted_links¶

Apply rank denial to user-submitted links. This feature rewrites links submitted in comments so they first point to an intermediate redirect page, helping deter comment spammers by preventing linked sites from gaining a search engine page rank advantage.

Example Usage:

$config['redirect_submitted_links'] = 'y';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Apply Rank Denial to User-submitted Links

redis¶

If Redis is the specified cache_driver, allows configuration of a Redis server to be used for cache storage.

Example Usage:

$config['redis'] = array(
  'host' => '127.0.0.1',
  'password' => NULL,
  'port' => 6379,
  'timeout' => 0
);

relaxed_track_views¶

Allow Entry Views Tracking to work for ANY combination that results in only one entry being returned by the tag, including Channel query caching.

Example Usage:

$config['relaxed_track_views'] = 'y';

remove_close_all_button¶

Remove the button to close all HTML tags from the publish page and user-side HTML formatting buttons. Most browsers no longer need it.

Example Usage:

$config['remove_close_all_button'] = 'y';

remove_unparsed_vars¶

Remove unparsed ExpressionEngine variables upon output when the debug has been set to 0.

Example Usage:

$config['remove_unparsed_vars'] = 'y';

req_mbr_activation¶

Specify whether new member activation is automatic, requires email verification, or requires an administrator’s approval.

Example Usage:

$config['req_mbr_activation'] = 'none';

Also found in CP: Members ‣ Preferences: Require Member Account Activation

require_ip_for_login¶

Require users have a valid IP address and browser user agent when logging in. This helps prevent hackers from logging in using direct socket connections or trying to access the system with a masked IP address.

Example Usage:

$config['require_ip_for_login'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Require IP Address and User Agent for Login

require_ip_for_posting¶

Require users have a valid IP address and browser user agent when posting comments or Channel Form entries.

Example Usage:

$config['require_ip_for_posting'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Require IP Address and User Agent for posting

require_secure_passwords¶

Require users’ passwords to contain at least one uppercase character, one lowercase character, and one numeric character. Passwords that follow this basic formula are much more difficult to guess.

Example Usage:

$config['require_secure_passwords'] = 'n';

Also found in CP: Admin ‣ Security and Privacy ‣ Security and Sessions: Require Secure Passwords

require_terms_of_service¶

Require new members to agree to your terms of service upon registration.

Example Usage:

$config['require_terms_of_service'] = 'n';

Also found in CP: Member ‣ Preferences: Require Terms of Service

reserved_category_word¶

If use_category_name is enabled, specify a word to use in category URLs to indicate to the system that the following segment is the category URL title. For example, if the indicator is set to “category” and the category URL title is “blogging”:

http://example.com/index.php/site/category/blogging/

The word you set cannot be the name of an existing template group or template.

Example Usage:

$config['reserved_category_word'] = 'category';

Also found in CP: Admin ‣ Channel Administration ‣ Global Channel Preferences: Category URL Indicator

rte_default_toolset_id¶

Set the default RTE toolset shown for any member that has not specifically chosen one in Rich Text Editor Preferences.

Example Usage:

$config['rte_default_toolset_id'] = '2';

Also found in CP: Add-Ons ‣ Modules ‣ Rich Text Editor: Default Toolset

rte_enabled¶

If enabled, the Rich Text Editor will be applied to any Textarea (Rich Text) Channel Field. Otherwise, the field will appear as a normal textarea instead.

Example Usage:

$config['rte_enabled'] = 'y';

Also found in CP: Add-Ons ‣ Modules ‣ Rich Text Editor: Enable Rich Text Editor

save_tmpl_files¶

Enable the saving of templates as files.

Example Usage:

$config['save_tmpl_files'] = 'y';

Also found in CP: Design ‣ Templates ‣ Global Template Preferences: Save Templates as Files

save_tmpl_revisions¶

Enable template revisions. Template history is saved when changes are made within the template editor.

Example Usage:

$config['save_tmpl_revisions'] = 'y';

Also found in CP: Design ‣ Templates ‣ Global Template Preferences: Save Template Revisions

sc_certificate_id¶

Specify the unique ID that is supplied by PayPal after providing them with a public certificate.

Example Usage:

$config['sc_certificate_id'] = 'SX4DT7FDO1234';

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: ID Given to Public Certificate by PayPal

sc_encrypt_buttons¶

Enable encryption for PayPal purchase links and buttons created by Simple Commerce.

Example Usage:

$config['sc_encrypt_buttons'] = 'y';

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: Encrypt PayPal Buttons and Links?

sc_paypal_account¶

Specify the primary email address associated with the PayPal account processing payments for store purchases.

Example Usage:

$config['sc_paypal_account'] = '[email protected]';

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: PayPal Account

sc_paypal_certificate¶

Specify the path to the PayPal-provided certificate file. Please read the section on Encrypted Website Payments for full details.

Example Usage:

$config['sc_paypal_certificate'] = "/path/to/paypal_certificate.pem";

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: PayPal Certificate Path

sc_private_key¶

Specify the path to the private key file. Please read the section on Encrypted Website Payments for full details.

Example Usage:

$config['sc_private_key'] = "/path/to/private_key.pem";

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: Private Key Path

sc_public_certificate¶

Specify the path to the public certificate file. Please read the section on Encrypted Website Payments for full details.

Example Usage:

$config['sc_public_certificate'] = "/path/to/public_certificate.pem";

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: Public Certificate Path

sc_temp_path¶

Specify the path to the temporarily stored encrypted files. Please read the section on Encrypted Website Payments for full details.

Example Usage:

$config['sc_temp_path'] = "/path/to/tmp";

Also found in CP: Add-Ons ‣ Modules ‣ Simple Commerce: Temporary Encrypted Files Path

send_headers¶

Specify whether the system should automatically send HTTP page headers when it serves pages to a visitor.

Example Usage:

$config['send_headers'] = 'n';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: Generate HTTP Page Headers

server_offset¶

When a server’s clock is off and you are unable to correct it at the server level, use this preference to correct the disparity. Use a positive integer to correct a server clock that is too slow, and a negative integer to correct a server clock that is too fast.

Example Usage:

$config['server_offset'] = '-15';

show_profiler¶

Enable Output Profiler. When enabled, Super Admins will see benchmark results, SQL queries, and submitted form data displayed at the bottom of the browser window.

Example Usage:

$config['show_profiler'] = 'y';

Also found in CP: Admin ‣ System Administration ‣ Output and Debugging: Display Output Profiler

sig_allow_img_hotlink¶

Specify whether members can link to images hosted on other websites as their signature image.

Example Usage:

$config['sig_allow_img_hotlink'] = 'n';

Also found in CP: Members ‣ Preferences: Allow image hot linking in signatures

sig_allow_img_upload¶

Set whether members can upload their own signature image.

Example Usage:

$config['sig_allow_img_upload'] = 'y';

Also found in CP: Members ‣ Preferences: Allow users to upload an image in their signature

sig_img_max_height¶

Set the maximum height (in pixels) allowed for user-uploaded signature images.

Example Usage:

$config['sig_img_max_height'] = '150';

Also found in CP: Members ‣ Preferences: Maximum Height of Signature Image

sig_img_max_kb¶

Set the maximum file size (in kilobytes) allowed for user-uploaded signature images.

Example Usage:

$config['sig_img_max_kb'] = '50';

Also found in CP: Members ‣ Preferences: Maximum Size (in Kilobytes) of Signature Image

sig_img_max_width¶

Set the maximum width (in pixels) allowed for user-uploaded signature images.

Example Usage: