From 5a323f7fe3b8683f2e15df9c4fc8b060a46dd979 Mon Sep 17 00:00:00 2001 From: David Alexander Date: Tue, 9 Jun 2015 16:53:20 +1200 Subject: [PATCH] Update 03_Environment_Management.md --- .../03_Environment_Management.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/en/00_Getting_Started/03_Environment_Management.md b/docs/en/00_Getting_Started/03_Environment_Management.md index 5b6f2e943..b3f50ad7e 100644 --- a/docs/en/00_Getting_Started/03_Environment_Management.md +++ b/docs/en/00_Getting_Started/03_Environment_Management.md @@ -105,21 +105,21 @@ This is my `_ss_environment.php` file. I have it placed in `/var`, as each of th | 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 *silverstripe-cache* in the webroot, and falls back to *sys_get_temp_dir()*. See *getTempFolder()* in *framework/core/TempPath.php* | -| `SS_DATABASE_CLASS` | The database class to use, MySQLDatabase, MSSQLDatabase, etc. defaults to MySQLDatabase| -| `SS_DATABASE_SERVER`| The database server to use, defaulting to localhost| -| `SS_DATABASE_USERNAME`| The database username (mandatory)| -| `SS_DATABASE_PASSWORD`| The database password (mandatory)| -| `SS_DATABASE_PORT`| The database port| +| `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 *silverstripe-cache* in the webroot, and falls back to *sys_get_temp_dir()*. See *getTempFolder()* in *framework/core/TempPath.php*.| +| `SS_DATABASE_CLASS` | The database class to use, MySQLDatabase, MSSQLDatabase, etc. defaults to MySQLDatabase.| +| `SS_DATABASE_SERVER`| The database server to use, defaulting to localhost.| +| `SS_DATABASE_USERNAME`| The database username (mandatory).| +| `SS_DATABASE_PASSWORD`| The database password (mandatory).| +| `SS_DATABASE_PORT`| The database port.| | `SS_DATABASE_SUFFIX`| A suffix to add to the database name.| | `SS_DATABASE_PREFIX`| A prefix to add to the database name.| | `SS_DATABASE_TIMEZONE`| Set the database timezone to something other than the system timezone. | `SS_DATABASE_NAME` | Set the database name. Assumes the `$database` global variable in your config is missing or empty. | -| `SS_DATABASE_CHOOSE_NAME`| Boolean/Int. If set, then the system will choose a default database name for you if one isn't give in the $database variable. The database name will be "SS_" followed by the name of the folder into which you have installed SilverStripe. If this is enabled, it means that the phpinstaller will work out of the box without the installer needing to alter any files. This helps prevent accidental changes to the environment. If `SS_DATABASE_CHOOSE_NAME` is an integer greater than one, then an ancestor folder will be used for the database name. This is handy for a site that's hosted from /sites/examplesite/www or /buildbot/allmodules-2.3/build. If it's 2, the parent folder will be chosen; if it's 3 the grandparent, and so on.| +| `SS_DATABASE_CHOOSE_NAME`| Boolean/Int. If defined, then the system will choose a default database name for you if one isn't give in the $database variable. The database name will be "SS_" followed by the name of the folder into which you have installed SilverStripe. If this is enabled, it means that the phpinstaller will work out of the box without the installer needing to alter any files. This helps prevent accidental changes to the environment. If `SS_DATABASE_CHOOSE_NAME` is an integer greater than one, then an ancestor folder will be used for the database name. This is handy for a site that's hosted from /sites/examplesite/www or /buildbot/allmodules-2.3/build. If it's 2, the parent folder will be chosen; if it's 3 the grandparent, and so on.| | `SS_ENVIRONMENT_TYPE`| The environment type: dev, test or live.| | `SS_DEFAULT_ADMIN_USERNAME`| The username of the default admin. This is a user with administrative privileges.| | `SS_DEFAULT_ADMIN_PASSWORD`| The password of the default admin. This will not be stored in the database.| | `SS_USE_BASIC_AUTH`| Protect the site with basic auth (good for test sites).
When using CGI/FastCGI with Apache, you will have to add the `RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]` rewrite rule to your `.htaccess` file| -| `SS_SEND_ALL_EMAILS_TO`| If you set this define, all emails will be redirected to this address.| -| `SS_SEND_ALL_EMAILS_FROM`| If you set this define, all emails will be send from this address.| -| `SS_ERROR_LOG` | Relative path to the log file | +| `SS_SEND_ALL_EMAILS_TO`| If you define this constant, all emails will be redirected to this address.| +| `SS_SEND_ALL_EMAILS_FROM`| If you define this constant, all emails will be sent from this address.| +| `SS_ERROR_LOG` | Relative path to the log file. |