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