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