weekly release 2.3dev
[moodle.git] / config-dist.php
CommitLineData
dfede59d 1<?PHP
6077020a 2///////////////////////////////////////////////////////////////////////////
3// //
4// Moodle configuration file //
5// //
6// This file should be renamed "config.php" in the top-level directory //
7// //
8///////////////////////////////////////////////////////////////////////////
9// //
10// NOTICE OF COPYRIGHT //
11// //
12// Moodle - Modular Object-Oriented Dynamic Learning Environment //
c6b456f6 13// http://moodle.org //
6077020a 14// //
3b365361 15// Copyright (C) 1999 onwards Martin Dougiamas http://moodle.com //
6077020a 16// //
17// This program is free software; you can redistribute it and/or modify //
18// it under the terms of the GNU General Public License as published by //
554a3c4c 19// the Free Software Foundation; either version 3 of the License, or //
6077020a 20// (at your option) any later version. //
21// //
22// This program is distributed in the hope that it will be useful, //
23// but WITHOUT ANY WARRANTY; without even the implied warranty of //
24// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
25// GNU General Public License for more details: //
26// //
27// http://www.gnu.org/copyleft/gpl.html //
28// //
29///////////////////////////////////////////////////////////////////////////
30unset($CFG); // Ignore this line
b30fa335 31global $CFG; // This is necessary here for PHPUnit execution
c57e9015 32$CFG = new stdClass();
6077020a 33
34//=========================================================================
35// 1. DATABASE SETUP
36//=========================================================================
37// First, you need to configure the database where all Moodle data //
38// will be stored. This database must already have been created //
39// and a username/password created to access it. //
6077020a 40
d0bf00e0
DM
41$CFG->dbtype = 'pgsql'; // 'pgsql', 'mysqli', 'mssql' or 'oci'
42$CFG->dblibrary = 'native'; // 'native' only at the moment
43$CFG->dbhost = 'localhost'; // eg 'localhost' or 'db.isp.com' or IP
44$CFG->dbname = 'moodle'; // database name, eg moodle
45$CFG->dbuser = 'username'; // your database username
46$CFG->dbpass = 'password'; // your database password
47$CFG->prefix = 'mdl_'; // prefix to use for all table names
48$CFG->dboptions = array(
49 'dbpersist' => false, // should persistent database connections be
50 // used? set to 'false' for the most stable
51 // setting, 'true' can improve performance
52 // sometimes
3c1293fe
PS
53 'dbsocket' => false, // should connection via UNIX socket be used?
54 // if you set it to 'true' or custom path
55 // here set dbhost to 'localhost',
56 // (please note mysql is always using socket
57 // if dbhost is 'localhost' - if you need
58 // local port connection use '127.0.0.1')
d0bf00e0
DM
59 'dbport' => '', // the TCP port number to use when connecting
60 // to the server. keep empty string for the
61 // default port
62);
1e55ed26 63
6077020a 64
9d975de4 65//=========================================================================
3b5ff37f 66// 2. SECRET PASSWORD SALT
9d975de4
PS
67//=========================================================================
68// User password salt is very important security feature, it is created
69// automatically in installer, you have to uncomment and modify value
70// on the next line if you are creating config.php manually.
71//
5cc1e1eb 72// $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1';
9d975de4
PS
73//
74// After changing the main salt you have to copy old value into one
75// of the following settings - this allows migration to the new salt
76// during the next login of each user.
77//
78// $CFG->passwordsaltalt1 = '';
79// $CFG->passwordsaltalt2 = '';
80// $CFG->passwordsaltalt3 = '';
81// ....
82// $CFG->passwordsaltalt19 = '';
83// $CFG->passwordsaltalt20 = '';
84
85
6077020a 86//=========================================================================
3b5ff37f 87// 3. WEB SITE LOCATION
6077020a 88//=========================================================================
89// Now you need to tell Moodle where it is located. Specify the full
eb2042f6 90// web address to where moodle has been installed. If your web site
91// is accessible via multiple URLs then choose the most natural one
6077020a 92// that your students would use. Do not include a trailing slash
11e7b506 93//
94// If you need both intranet and Internet access please read
95// http://docs.moodle.org/en/masquerading
6077020a 96
97$CFG->wwwroot = 'http://example.com/moodle';
98
99
6077020a 100//=========================================================================
101// 4. DATA FILES LOCATION
102//=========================================================================
103// Now you need a place where Moodle can save uploaded files. This
eb2042f6 104// directory should be readable AND WRITEABLE by the web server user
105// (usually 'nobody' or 'apache'), but it should not be accessible
6077020a 106// directly via the web.
107//
108// - On hosting systems you might need to make sure that your "group" has
109// no permissions at all, but that "others" have full permissions.
110//
111// - On Windows systems you might specify something like 'c:\moodledata'
112
113$CFG->dataroot = '/home/example/moodledata';
114
115
116//=========================================================================
117// 5. DATA FILES PERMISSIONS
118//=========================================================================
119// The following parameter sets the permissions of new directories
eb2042f6 120// created by Moodle within the data directory. The format is in
6077020a 121// octal format (as used by the Unix utility chmod, for example).
eb2042f6 122// The default is usually OK, but you may want to change it to 0750
6077020a 123// if you are concerned about world-access to the files (you will need
124// to make sure the web server process (eg Apache) can access the files.
125// NOTE: the prefixed 0 is important, and don't use quotes.
126
d99bab2d 127$CFG->directorypermissions = 02777;
6077020a 128
129
130//=========================================================================
131// 6. DIRECTORY LOCATION (most people can just ignore this setting)
132//=========================================================================
eb2042f6 133// A very few webhosts use /admin as a special URL for you to access a
134// control panel or something. Unfortunately this conflicts with the
135// standard location for the Moodle admin pages. You can fix this by
136// renaming the admin directory in your installation, and putting that
6077020a 137// new name here. eg "moodleadmin". This will fix admin links in Moodle.
138
139$CFG->admin = 'admin';
140
141
142//=========================================================================
92848614 143// 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
21d1d077 144//=========================================================================
145//
c9ca1fa5 146// These are additional tweaks for which no GUI exists in Moodle yet.
147//
9c733e86 148// Starting in PHP 5.3 administrators should specify default timezone
149// in PHP.ini, you can also specify it here if needed.
150// See details at: http://php.net/manual/en/function.date-default-timezone-set.php
151// List of time zones at: http://php.net/manual/en/timezones.php
152// date_default_timezone_set('Australia/Perth');
c9ca1fa5 153//
1ed96821 154// Change the key pair lifetime for Moodle Networking
155// The default is 28 days. You would only want to change this if the key
156// was not getting regenerated for any reason. You would probably want
157// make it much longer. Note that you'll need to delete and manually update
158// any existing key.
159// $CFG->mnetkeylifetime = 28;
160//
29ba20ac
MD
161// Allow user passwords to be included in backup files. Very dangerous
162// setting as far as it publishes password hashes that can be unencrypted
163// if the backup file is publicy available. Use it only if you can guarantee
164// that all your backup files remain only privacy available and are never
165// shared out from your site/institution!
166// $CFG->includeuserpasswordsinbackup = true;
167//
b0ccfc5c
HF
168// Completely disable user creation when restoring a course, bypassing any
169// permissions granted via roles and capabilities. Enabling this setting
170// results in the restore process stopping when a user attempts to restore a
171// course requiring users to be created.
5e934890
EL
172// $CFG->disableusercreationonrestore = true;
173//
2de3539b
EL
174// Keep the temporary directories used by backup and restore without being
175// deleted at the end of the process. Use it if you want to debug / view
176// all the information stored there after the process has ended. Note that
177// those directories may be deleted (after some ttl) both by cron and / or
178// by new backup / restore invocations.
179// $CFG->keeptempdirectoriesonbackup = true;
180//
5e934890 181// Modify the restore process in order to force the "user checks" to assume
b0ccfc5c
HF
182// that the backup originated from a different site, so detection of matching
183// users is performed with different (more "relaxed") rules. Note that this is
184// only useful if the backup file has been created using Moodle < 1.9.4 and the
185// site has been rebuilt from scratch using backup files (not the best way btw).
186// If you obtain user conflicts on restore, rather than enabling this setting
187// permanently, try restoring the backup on a different site, back it up again
188// and then restore on the target server.
5e934890
EL
189// $CFG->forcedifferentsitecheckingusersonrestore = true;
190//
72df7e1e 191// Prevent stats processing and hide the GUI
192// $CFG->disablestatsprocessing = true;
193//
7758d00f 194// Setting this to true will enable admins to edit any post at any time
195// $CFG->admineditalways = true;
cec0a0fc 196//
5fd1a5d8 197// These variables define DEFAULT block variables for new courses
198// If this one is set it overrides all others and is the only one used.
9574c2ef 199// $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
3eecaaf4 200//
201// These variables define the specific settings for defined course formats.
5fd1a5d8 202// They override any settings defined in the formats own config file.
9574c2ef
PS
203// $CFG->defaultblocks_site = 'site_main_menu,course_list:course_summary,calendar_month';
204// $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,course_list';
205// $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
206// $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
3eecaaf4 207//
5fd1a5d8 208// These blocks are used when no other default setting is found.
9574c2ef 209// $CFG->defaultblocks = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
3eecaaf4 210//
86b5ea0f 211// You can specify a different class to be created for the $PAGE global, and to
212// compute which blocks appear on each page. However, I cannot think of any good
213// reason why you would need to change that. It just felt wrong to hard-code the
214// the class name. You are stronly advised not to use these to settings unless
215// you are absolutely sure you know what you are doing.
216// $CFG->moodlepageclass = 'moodle_page';
217// $CFG->blockmanagerclass = 'block_manager';
c81c6d0e 218//
6b29ba60 219// Seconds for files to remain in caches. Decrease this if you are worried
220// about students being served outdated versions of uploaded files.
e55b73fd 221// $CFG->filelifetime = 86400;
88fea1ca 222//
223// This setting will prevent the 'My Courses' page being displayed when a student
224// logs in. The site front page will always show the same (logged-out) view.
e55b73fd 225// $CFG->disablemycourses = true;
c57e9015 226//
227// If this setting is set to true, then Moodle will track the IP of the
228// current user to make sure it hasn't changed during a session. This
229// will prevent the possibility of sessions being hijacked via XSS, but it
366dfa60 230// may break things for users coming using proxies that change all the time,
231// like AOL.
232// $CFG->tracksessionip = true;
bb64b51a 233//
bb64b51a 234// The following lines are for handling email bounces.
5fd1a5d8 235// $CFG->handlebounces = true;
236// $CFG->minbounces = 10;
237// $CFG->bounceratio = .20;
bb64b51a 238// The next lines are needed both for bounce handling and any other email to module processing.
239// mailprefix must be EXACTLY four characters.
c57e9015 240// Uncomment and customise this block for Postfix
5fd1a5d8 241// $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
c57e9015 242// $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
5fd1a5d8 243// $CFG->maildomain = 'youremaildomain.com';
f93426cf 244//
f11f8ba2
PS
245// Enable when setting up advanced reverse proxy load balancing configurations,
246// it may be also necessary to enable this when using port forwarding.
11e7b506 247// $CFG->reverseproxy = true;
248//
249// Enable when using external SSL appliance for performance reasons.
250// Please note that site may be accessible via https: or https:, but not both!
251// $CFG->sslproxy = true;
252//
c57e9015 253// This setting will cause the userdate() function not to fix %d in
1ac7ee24 254// date strings, and just let them show with a zero prefix.
255// $CFG->nofixday = true;
ce5e431b 256//
257// This setting will make some graphs (eg user logs) use lines instead of bars
258// $CFG->preferlinegraphs = true;
9d5ef892 259//
18259d4f 260// Enabling this will allow custom scripts to replace existing moodle scripts.
9677eb79 261// For example: if $CFG->customscripts/course/view.php exists then
18259d4f 262// it will be used instead of $CFG->wwwroot/course/view.php
263// At present this will only work for files that include config.php and are called
264// as part of the url (index.php is implied).
265// Some examples are:
266// http://my.moodle.site/course/view.php
267// http://my.moodle.site/index.php
268// http://my.moodle.site/admin (index.php implied)
269// Custom scripts should not include config.php
270// Warning: Replacing standard moodle scripts may pose security risks and/or may not
271// be compatible with upgrades. Use this option only if you are aware of the risks
c57e9015 272// involved.
9677eb79 273// Specify the full directory path to the custom scripts
274// $CFG->customscripts = '/home/example/customscripts';
18259d4f 275//
c57e9015 276// Performance profiling
277//
853df85e 278// If you set Debug to "Yes" in the Configuration->Variables page some
279// performance profiling data will show up on your footer (in default theme).
280// With these settings you get more granular control over the capture
281// and printout of the data
282//
283// Capture performance profiling data
284// define('MDL_PERF' , true);
285//
286// Capture additional data from DB
287// define('MDL_PERFDB' , true);
288//
289// Print to log (for passive profiling of production servers)
290// define('MDL_PERFTOLOG' , true);
291//
292// Print to footer (works with the default theme)
293// define('MDL_PERFTOFOOT', true);
294//
c646dd26
EL
295// Enable earlier profiling that causes more code to be covered
296// on every request (db connections, config load, other inits...).
297// Requires extra configuration to be defined in config.php like:
298// profilingincluded, profilingexcluded, profilingautofrec,
299// profilingallowme, profilingallowall, profilinglifetime
300// $CFG->earlyprofilingenabled = true;
301//
4c202228 302// Force displayed usernames
c57e9015 303// A little hack to anonymise user names for all students. If you set these
4c202228 304// then all non-teachers will always see these for every person.
305// $CFG->forcefirstname = 'Bruce';
306// $CFG->forcelastname = 'Simpson';
acd2279e 307//
308// The following setting will turn SQL Error logging on. This will output an
309// entry in apache error log indicating the position of the error and the statement
310// called. This option will action disregarding error_reporting setting.
311// $CFG->dblogerror = true;
5c5c16bb 312//
13534ef7
ML
313// The following setting will log every database query to a table called adodb_logsql.
314// Use this setting on a development server only, the table grows quickly!
315// $CFG->logsql = true;
316//
5c5c16bb 317// The following setting will turn on username logging into Apache log. For full details regarding setting
318// up of this function please refer to the install section of the document.
319// $CFG->apacheloguser = 0; // Turn this feature off. Default value.
320// $CFG->apacheloguser = 1; // Log user id.
321// $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
c57e9015 322// $CFG->apacheloguser = 3; // Log username.
bd10cc11 323// To get the values logged in Apache's log, add to your httpd.conf
324// the following statements. In the General part put:
220776ac 325// LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
bd10cc11 326// And in the part specific to your Moodle install / virtualhost:
327// CustomLog "/your/path/to/log" moodleformat
328// CAUTION: Use of this option will expose usernames in the Apache log,
329// If you are going to publish your log, or the output of your web stats analyzer
330// this will weaken the security of your website.
c57e9015 331//
332// Email database connection errors to someone. If Moodle cannot connect to the
880a6f6b 333// database, then email this address with a notice.
334//
6b25f553 335// $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
c57e9015 336//
6f93e96c 337// Set the priority of themes from highest to lowest. This is useful (for
338// example) in sites where the user theme should override all other theme
339// settings for accessibility reasons. You can also disable types of themes
b7009474 340// (other than site) by removing them from the array. The default setting is:
341// $CFG->themeorder = array('course', 'category', 'session', 'user', 'site');
6f93e96c 342// NOTE: course, category, session, user themes still require the
343// respective settings to be enabled
344//
73e504bc
PS
345// It is possible to add extra themes directory stored outside of $CFG->dirroot.
346// This local directory does not have to be accessible from internet.
347//
348// $CFG->themedir = '/location/of/extra/themes';
349//
32db0f0d
PS
350// It is possible to specify different cache and temp directories, use local fast filesystem.
351// The directories must not be accessible via web.
352//
353// $CFG->tempdir = '/var/www/moodle/temp';
354// $CFG->cachedir = '/var/www/moodle/cache';
355//
c198593b
DM
356// If $CFG->langstringcache is enabled (which should always be in production
357// environment), Moodle keeps aggregated strings in its own internal format
358// optimised for performance. By default, this on-disk cache is created in
365bec4c 359// $CFG->cachedir/lang. In cluster environment, you may wish to specify
c198593b
DM
360// an alternative location of this cache so that each web server in the cluster
361// uses its own local cache and does not need to access the shared dataroot.
362// Make sure that the web server process has write permission to this location
363// and that it has permission to remove the folder, too (so that the cache can
364// be pruned).
365//
366// $CFG->langcacheroot = '/var/www/moodle/htdocs/altcache/lang';
367//
a9cbd19b
DM
368// If $CFG->langcache is enabled (which should always be in production
369// environment), Moodle stores the list of available languages in a cache file.
370// By default, the file $CFG->dataroot/languages is used. You may wish to
371// specify an alternative location of this cache file.
372//
373// $CFG->langmenucachefile = '/var/www/moodle/htdocs/altcache/languages';
374//
56fb6963
DM
375// Site default language can be set via standard administration interface. If you
376// want to have initial error messages for eventual database connection problems
377// localized too, you have to set your language code here.
378//
379// $CFG->lang = 'yourlangcode'; // for example 'cs'
380//
49084fe1
SH
381// When Moodle is about to perform an intensive operation it raises PHP's memory
382// limit. The following setting should be used on large sites to set the raised
383// memory limit to something higher.
384// The value for the settings should be a valid PHP memory value. e.g. 512M, 1G
e99033b0 385//
d8a30af8 386// $CFG->extramemorylimit = '1G';
e99033b0 387//
1d1d807e
SH
388// The CSS files the Moodle produces can be extremely large and complex, especially
389// if you are using a custom theme that builds upon several other themes.
ff8e5d47 390// In Moodle 2.3 a CSS optimiser was added as an experimental feature for advanced
1d1d807e
SH
391// users. The CSS optimiser organises the CSS in order to reduce the overall number
392// of rules and styles being sent to the client. It does this by collating the
393// CSS before it is cached removing excess styles and rules and stripping out any
394// extraneous content such as comments and empty rules.
395// The following settings are used to enable and control the optimisation.
396//
397// Enable the CSS optimiser. This will only optimise the CSS if themedesignermode
6bbd4858
SH
398// is not enabled. This can be set through the UI however it is noted here as well
399// because the other CSS optimiser settings can not be set through the UI.
1d1d807e 400//
6bbd4858 401// $CFG->enablecssoptimiser = true;
1d1d807e
SH
402//
403// If set the CSS optimiser will add stats about the optimisation to the top of
404// the optimised CSS file. You can then inspect the CSS to see the affect the CSS
405// optimiser is having.
406//
6bbd4858 407// $CFG->cssoptimiserstats = true;
1d1d807e 408//
6bbd4858 409// If set the CSS that is optimised will still retain a minimalistic formatting
1d1d807e
SH
410// so that anyone wanting to can still clearly read it.
411//
6bbd4858 412// $CFG->cssoptimiserpretty = true;
1d1d807e 413//
84ebf08d 414//=========================================================================
415// 8. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
416//=========================================================================
f4fa5a63 417//
91ee8a67
DM
418// Force a debugging mode regardless the settings in the site administration
419// @error_reporting(1023); // NOT FOR PRODUCTION SERVERS!
420// @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
421// $CFG->debug = 38911; // DEBUG_DEVELOPER // NOT FOR PRODUCTION SERVERS!
422// $CFG->debugdisplay = true; // NOT FOR PRODUCTION SERVERS!
423//
0ed26d12
PS
424// You can specify a comma separated list of user ids that that always see
425// debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay
426// for these users only.
427// $CFG->debugusers = '2';
428//
91ee8a67
DM
429// Prevent theme caching
430// $CFG->themerev = -1; // NOT FOR PRODUCTION SERVERS!
431//
f53fde9f 432// Prevent core_string_manager on-disk cache
e799e819 433// $CFG->langstringcache = false; // NOT FOR PRODUCTION SERVERS!
f53fde9f 434//
38d93cb0
PS
435// When working with production data on test servers, no emails or other messages
436// should ever be send to real users
91ee8a67 437// $CFG->noemailever = true; // NOT FOR PRODUCTION SERVERS!
49da4a5f
DM
438//
439// Divert all outgoing emails to this address to test and debug emailing features
91ee8a67 440// $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
1045a007 441//
84ebf08d 442// Specify prefix for fake unit test tables. If not specified only tests
1045a007 443// that do not need fake tables will be executed.
91ee8a67 444// $CFG->unittestprefix = 'tst_'; // NOT FOR PRODUCTION SERVERS!
84ebf08d 445//
446// special magic evil developer only wanting to edit the xmldb files manually
447// AND don't use the XMLDBEditor nor the prev/next stuff at all (Mahara and others)
448// Uncomment these if you're lazy like Penny
91ee8a67
DM
449// $CFG->xmldbdisablecommentchecking = true; // NOT FOR PRODUCTION SERVERS!
450// $CFG->xmldbdisablenextprevchecking = true; // NOT FOR PRODUCTION SERVERS!
84ebf08d 451//
1045a007 452// Special magic - evil developer only wanting to edit xmldb files manually
b646340f 453// AND allowing the XMLDBEditor to reconstruct the prev/next elements every
84ebf08d 454// time one file is loaded and saved (Moodle).
455// Uncomment this if you're lazy like Petr
91ee8a67 456// $CFG->xmldbreconstructprevnext = true; // NOT FOR PRODUCTION SERVERS!
1045a007 457//
458// Since 2.0 sql queries are not shown during upgrade by default.
459// Please note that this setting may produce very long upgrade page on large sites.
91ee8a67 460// $CFG->upgradeshowsql = true; // NOT FOR PRODUCTION SERVERS!
12bb0c3e 461//
ddd11b6c
PS
462// Add SQL queries to the output of cron, just before their execution
463// $CFG->showcronsql = true;
464//
465// Force developer level debug and add debug info to the output of cron
466// $CFG->showcrondebugging = true;
467//
12bb0c3e
PS
468//=========================================================================
469// 9. FORCED SETTINGS
470//=========================================================================
471// It is possible to specify normal admin settings here, the point is that
472// they can not be changed through the standard admin settings pages any more.
473//
474// Core settings are specified directly via assignment to $CFG variable.
475// Example:
476// $CFG->somecoresetting = 'value';
477//
478// Plugin settings have to be put into a special array.
479// Example:
480// $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'secondsetting' => 'othervalue'),
481// 'otherplugin' => array('mysetting' => 'myvalue', 'thesetting' => 'thevalue'));
1045a007 482
84ebf08d 483
6077020a 484//=========================================================================
485// ALL DONE! To continue installation, visit your main page with a browser
486//=========================================================================
c781942f 487
d440bcfa 488require_once(dirname(__FILE__) . '/lib/setup.php'); // Do not edit
3b5ff37f 489
fa4556c5 490// There is no php closing tag in this file,
491// it is intentional because it prevents trailing whitespace problems!