Common configuration through _config.php

Introduction

SilverStripe doesn't have a global configuration-array or an interface with all available configuration-options. As all SilverStripe logic is contained in classes, the appropriate place to configure their behaviour is directly in the class itself.

This lack of a configuration-GUI is on purpose, as we'd like to keep developer-level options where they belong (into code), without cluttering up the interface. See this core forum discussion "The role of the CMS" for further reasoning.

In addition to these principle, some settings are

Author-level configuration like interface language or date/time formats can be performed in the CMS "My Profile" section (admin/myprofile).
Group-related configuration like [api:HTMLEditorField] settings can be found in the "Security" section (admin/security).
Site-wide settings like page titles can be set (and extended) on the root tree element in the CMS "Content" section (through the siteconfig API).

_ss_environment.php

See environment-management.

mysite/_config.php

This file is detected in each folder by [api:ManifestBuilder]. This way, every toplevel-folder (=module) can have independent configuration-rules.

Please note that this is the only place where you can put in procedural code - all other functionality is wrapped in classes (see common-problems).

You can call most static methods from _config.php - classes will be loaded as required. Here's a list - this is incomplete - please add to it Try to keep it in alphabetical order too! :)

| Call | | ---- | | Authenticator::register_authenticator($authenticator);| | Authenticator::set_default_authenticator($a | BBCodeParser::disable_autolink_urls(); | | BlogEntry::allow_wysiwyg_editing(); | | ContentNegotiator::set_encoding(string $encoding) | ContentNegotiator::disable() | | | Debug::send_errors_to(string $email) | Director::set_environment_type(string | Director::set_dev_servers(array('localhost', | Director::addRules(int priority, array rules) | | Email::setAdminEmail(string $adminemail) | | Email::send_all_emails_to(string $email) | | Email::cc_all_emails_to(string $email) | | Email::bcc_all_emails_to(string $email) | | MathSpamProtection::setEnabled() | | PageComment::enableModeration(); | | Requirements::set_suffix_requirements(false); | | Security::encrypt_passwords($encrypt_passwords); | | Security::set_password_encryption_algorithm($algorithm, | Security::setDefaultAdmin('admin',& | SSAkismet::setAPIKey(string $key) | | SSViewer::set_theme(string $themename) | | Description |
| ----------- |
| Enable an authentication method (for more details see security). |
uthenticator); | | Modify tab-order on login-form.|
| Disables plain hyperlinks from being turned into links when bbcode is parsed. |
| Enable rich text editing for blog posts. |
| | The encoding charset to use - UTF-8 by default |
Disables the negotiation of content type -usually used to stop it from rewriting the DOCTYPE of the document
| | Send live errors on your site to this address (site has to be in 'live' mode using Director::set_environment_type(live) for this to occur |
dev,test,live) | | Sets the environment type (e.g. dev site will show errors, live site hides them and displays a 500 error instead) | 'dev.mysite.com)) | | Set servers that should be run in dev mode (see debugging) |
| Create a number of URL rules to be checked against when SilverStripe tries to figure out how to display a page. See cms/_config.php for some examples. Note: Using ->something/ as the value for one of these will redirect the user to the something/ page. |
| Sets the admin email for the site, used if there is no From address specified, or when you call Email::getAdminEmail() |
| Sends all emails to this address. Useful for debugging your email sending functions |
| Useful for CC'ing all emails to someone checking correspondence |
| BCC all emails to this address, similar to CC'ing emails (above) |
| Adds a math spam question to all page comment forms |
| Enables comment moderation |
| Disable appending the current date to included files |
| Specify if you want store your passwords in clear text or encrypted (for more details see security) |
$use_salt);| | If you choose to encrypt your passwords, you can choose which algorithm is used to and if a salt should be used to increase the security level even more (for more details see security). |
#39;password'); | | Set default admin email and password, helpful for recovering your password |
| Enables use of the Akismet spam filter. The key must be a valid WordPress API key. |
| Choose the default theme for your site |

Constants

Some constants are user-defineable within _ss_environment.php.

| Name | | Description | | ---- | | ----------- | | TEMP_FOLDER | | Absolute file path to store temporary files such as cached templates or the class manifest. Needs to be writeable by the webserver user. Defaults to sys_get_temp_dir(), and falls back to silverstripe-cache in the webroot. See getTempFolder() in sapphire/core/Core.php |

User-level: Member-object

All user-related preferences are stored as a property of the [api:Member]-class (and as a database-column in the Member-table). You can "mix in" your custom preferences by using [api:DataObject] for details.

Permissions

See security and permission

Resource Usage (Memory and CPU)

SilverStripe tries to keep its resource usage within the documented limits (see our server requirements). These limits are defined through memory_limit and max_execution_time in the PHP configuration. They can be overwritten through ini_set(), unless PHP is running with the Suhoshin Patches or in "safe mode". Most shared hosting providers will have maximum values that can't be altered.

For certain tasks like synchronizing a large assets/ folder with all file and folder entries in the database, more resources are required temporarily. In general, we recommend running resource intensive tasks through the commandline, where configuration defaults for these settings are higher or even unlimited.

SilverStripe can request more resources through increase_memory_limit_to() and increase_time_limit_to(). If you are concerned about resource usage on a dedicated server (without restrictions imposed through shared hosting providers), you can set a hard limit to these increases through set_increase_memory_limit_max() and set_increase_time_limit_max(). These values will just be used for specific scripts (e.g. [api:Filesystem::sync()]), to raise the limits for all executed scripts please use ini_set('memory_limit', <value>) and ini_set('max_execution_time', <value>) in your own _config.php.

8.5 KiB Raw Blame History