Configuration file: Difference between revisions

Latest revision as of 13:47, 14 May 2013

The name for Moodle's configuration file is config.php. The file is located in the moodle directory. It is not included in the Moodle download packages and is created by the installation process from the template file config-dist.php (which is included in Moodle packages).

config-dist.php

Although the installation process creates the config.php file for you, there may be times when you want to do this yourself. A sample config file, called config-dist.php, is shipped with Moodle.

To get started simply copy config-dist.php to config.php, then edit config.php with you favourite editor. The file is very well commented. The important options (which you must supply) are all nearer the top. Other less common options are further down.

Setting $CFG->wwwroot correctly

This setting must be a fixed URL (a string constant) that points to your site. Do not try to set this with any PHP code that can generate a variable URL. This is not supported, can cause strange problems and will stop command line scripts working completely. If your site is accessed from different IP addresses this should be done with a split DNS, see Masquerading

Enabling password salting

See Password salting.

Including passwords in backups

Hashed user passwords are no longer saved in backup files containing user data.

If you really need passwords to be saved (in the rare case of restoring a backup with user data to a different site), the following line may be added to config.php:

$CFG->includeuserpasswordsinbackup

Note regarding restoring Moodle 2.5 backups to sites with old PHP versions:

Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.

Changing default block layout for new courses

See Block layout.

Changing default theme directory location

The location of theme directories may be altered, using the variables $CFG->themewww and $CFG->themedir. Themes placed in the directory specified by these variables will then be available for selection using the theme selector.

For example, should you wish to place themes in a subdirectory called 'my_moodle_themes', your config.php might look like this:

$CFG->wwwroot   = 'http://my.moodle.site.edu';
$CFG->dirroot   = '/var/www/my.moodle.site.edu/public_html';
$CFG->themewww  = $CFG->wwwroot . '/my_moodle_themes';
$CFG->themedir  = $CFG->dirroot . '/my_moodle_themes';

Disabling update notifications

See Notifications.

Enabling debugging

See Debugging.

@@ Line 1: / Line 1: @@
+{{Installing Moodle}}
 The name for Moodle's configuration file is config.php. The file is located in the moodle directory. It is not included in the Moodle download packages and is created by the installation process from the template file config-dist.php (which is included in Moodle packages).
-==Sample config.php file==
+==config-dist.php==
-Although the installation process creates the config.php file for you, there may be times when you want to do this yourself. Here is a sample config.php file to work from.
+Although the installation process creates the config.php file for you, there may be times when you want to do this yourself. A sample config file, called config-dist.php, is shipped with Moodle.
-'''WARNING''': You may want to edit the config.php file directly if, for example, you change you database password or change servers completely. If you do so, be very careful that there are no spaces or line breaks after the final "?>" in the file. If there are such spaces, you may get blank pages.
+To get started simply copy config-dist.php to config.php, then edit config.php with you favourite editor. The file is very well commented. The important options (which you must supply) are all nearer the top. Other less common options are further down.
-<pre><?php  /// Moodle Configuration File
+==Setting $CFG->wwwroot correctly==
+This setting must be a fixed URL (a string constant) that points to your site. Do not try to set this with any PHP code that can generate a variable URL. This is not supported, can cause strange problems and will stop command line scripts working completely. If your site is accessed from different IP addresses this should be done with a split DNS, see [[Masquerading]]
-unset($CFG);
-$CFG->dbtype    = 'mysql';
-$CFG->dbhost    = 'localhost';
-$CFG->dbname    = 'moodle17';
-$CFG->dbuser    = 'moodleuser';
-$CFG->dbpass    = 'xxxxxx';
-$CFG->dbpersist =  false;
-$CFG->prefix    = 'mdl_';
-$CFG->wwwroot   = 'http://www.mymoodle.com/moodle';
-$CFG->dirroot   = '/var/www/moodle';
-$CFG->dataroot  = '/var/moodledata';
-$CFG->admin     = 'admin';
-$CFG->directorypermissions = 00777;  // try 02777 on a server in Safe Mode
-$CFG->unicodedb = true;  // Database is utf8
-require_once("$CFG->dirroot/lib/setup.php");
-// MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
-// RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
-?></pre>
 ==Enabling password salting==
@@ Line 39: / Line 17: @@
 ==Including passwords in backups==
-Hashed user passwords are no longer saved in backup files containing user data in Moodle 1.8.11 and 1.9.7 onwards.
+Hashed user passwords are no longer saved in backup files containing user data.
-If you really need passwords to be saved (in the rare case of restoring a backup with user data to a different site), the following line may be added to config.php:
+If you really need passwords to be saved (in the rare case of restoring a [[Backup of user data|backup with user data]] to a different site), the following line may be added to config.php:
-  $CFG->includeuserpasswordsinbackups
+  $CFG->includeuserpasswordsinbackup
+Note regarding restoring Moodle 2.5 backups to sites with old PHP versions:
+Because bcrypt is not supported in PHP versions below 5.3.7, course backups made using the $CFG->includeuserpasswordsinbackup setting on a site using PHP version 5.3.7+ that are subsequently restored to a site with PHP version < 5.3.7 will require a password reset.
 ==Changing default block layout for new courses==
@@ Line 50: / Line 32: @@
 ==Changing default theme directory location==
-The location of theme directorys may be altered, using the variables ''$CFG->themewww'' and ''$CFG->themedir''. Themes from placed in the directory specified by these variables will then be available for selection using the theme selector.
+The location of theme directories may be altered, using the variables ''$CFG->themewww'' and ''$CFG->themedir''. Themes placed in the directory specified by these variables will then be available for selection using the theme selector.
 For example, should you wish to place themes in a subdirectory called 'my_moodle_themes', your config.php might look like this:
@@ Line 60: / Line 42: @@
 </pre>
-==The config-dist.php file==
+==Disabling update notifications==
-The config-dist.php file http://cvs.moodle.org/moodle/config-dist.php?view=markup is the template file. It contains the usual settings of a config.php file, with lots of additional settings that don't currently have a UI for them. To use these settings you have to add them to the configuration file.
+See [[Notifications]].
+==Enabling debugging==
+See [[Debugging]].
 ==See also==
 * Using Moodle [http://moodle.org/mod/forum/discuss.php?d=137889 Moodle Salting] forum discussion
-[[Category: Administrator]]
 [[de:Konfigurationsdatei]]
+[[es:config.php]]
 [[fr:Fichier de configuration]]
 [[ja:設定ファイル]]

Documentation