MDL-17843 - db unit tests are now always included again; lang string not needed anymore
[moodle.git] / config-dist.php
CommitLineData
6077020a 1<?PHP // $Id$
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
d27a349b 57// $CFG->unittest_prefix = 'tst_'; // Prefix used for unit test tables. Needs to be un-commented for test tables installation to proceed
6077020a 58
1e55ed26 59$CFG->dbpersist = false; // Should database connections be reused?
eb2042f6 60 // "false" is the most stable setting
61 // "true" can improve performance sometimes
1e55ed26 62
6077020a 63
64//=========================================================================
65// 2. WEB SITE LOCATION
66//=========================================================================
67// Now you need to tell Moodle where it is located. Specify the full
eb2042f6 68// web address to where moodle has been installed. If your web site
69// is accessible via multiple URLs then choose the most natural one
6077020a 70// that your students would use. Do not include a trailing slash
11e7b506 71//
72// If you need both intranet and Internet access please read
73// http://docs.moodle.org/en/masquerading
6077020a 74
75$CFG->wwwroot = 'http://example.com/moodle';
76
77
78//=========================================================================
79// 3. SERVER FILES LOCATION
80//=========================================================================
81// Next, specify the full OS directory path to this same location
82// Make sure the upper/lower case is correct. Some examples:
83//
7f21ed0a 84// $CFG->dirroot = 'c:\program files\easyphp\www\moodle'; // Windows
6077020a 85// $CFG->dirroot = '/var/www/html/moodle'; // Redhat Linux
5ec98a94 86// $CFG->dirroot = '/home/example/public_html/moodle'; // Cpanel host
6077020a 87
5ec98a94 88$CFG->dirroot = '/home/example/public_html/moodle';
6077020a 89
90
91//=========================================================================
92// 4. DATA FILES LOCATION
93//=========================================================================
94// Now you need a place where Moodle can save uploaded files. This
eb2042f6 95// directory should be readable AND WRITEABLE by the web server user
96// (usually 'nobody' or 'apache'), but it should not be accessible
6077020a 97// directly via the web.
98//
99// - On hosting systems you might need to make sure that your "group" has
100// no permissions at all, but that "others" have full permissions.
101//
102// - On Windows systems you might specify something like 'c:\moodledata'
103
104$CFG->dataroot = '/home/example/moodledata';
105
106
107//=========================================================================
108// 5. DATA FILES PERMISSIONS
109//=========================================================================
110// The following parameter sets the permissions of new directories
eb2042f6 111// created by Moodle within the data directory. The format is in
6077020a 112// octal format (as used by the Unix utility chmod, for example).
eb2042f6 113// The default is usually OK, but you may want to change it to 0750
6077020a 114// if you are concerned about world-access to the files (you will need
115// to make sure the web server process (eg Apache) can access the files.
116// NOTE: the prefixed 0 is important, and don't use quotes.
117
d99bab2d 118$CFG->directorypermissions = 02777;
6077020a 119
120
121//=========================================================================
122// 6. DIRECTORY LOCATION (most people can just ignore this setting)
123//=========================================================================
eb2042f6 124// A very few webhosts use /admin as a special URL for you to access a
125// control panel or something. Unfortunately this conflicts with the
126// standard location for the Moodle admin pages. You can fix this by
127// renaming the admin directory in your installation, and putting that
6077020a 128// new name here. eg "moodleadmin". This will fix admin links in Moodle.
129
130$CFG->admin = 'admin';
131
132
133//=========================================================================
92848614 134// 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
21d1d077 135//=========================================================================
136//
c9ca1fa5 137// These are additional tweaks for which no GUI exists in Moodle yet.
138//
139//
1ed96821 140// Change the key pair lifetime for Moodle Networking
141// The default is 28 days. You would only want to change this if the key
142// was not getting regenerated for any reason. You would probably want
143// make it much longer. Note that you'll need to delete and manually update
144// any existing key.
145// $CFG->mnetkeylifetime = 28;
146//
92848614 147// Prevent scheduled backups from operating (and hide the GUI for them)
148// Useful for webhost operators who have alternate methods of backups
149// $CFG->disablescheduledbackups = true;
21d1d077 150//
72df7e1e 151// Prevent stats processing and hide the GUI
152// $CFG->disablestatsprocessing = true;
153//
7758d00f 154// Setting this to true will enable admins to edit any post at any time
155// $CFG->admineditalways = true;
cec0a0fc 156//
5fd1a5d8 157// These variables define DEFAULT block variables for new courses
158// If this one is set it overrides all others and is the only one used.
3eecaaf4 159// $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
160//
161// These variables define the specific settings for defined course formats.
5fd1a5d8 162// They override any settings defined in the formats own config file.
163// $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
3eecaaf4 164// $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
165// $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
166// $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
167//
5fd1a5d8 168// These blocks are used when no other default setting is found.
169// $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
3eecaaf4 170//
c81c6d0e 171//
6b29ba60 172// Seconds for files to remain in caches. Decrease this if you are worried
173// about students being served outdated versions of uploaded files.
e55b73fd 174// $CFG->filelifetime = 86400;
88fea1ca 175//
176// This setting will prevent the 'My Courses' page being displayed when a student
177// logs in. The site front page will always show the same (logged-out) view.
e55b73fd 178// $CFG->disablemycourses = true;
c57e9015 179//
180// If this setting is set to true, then Moodle will track the IP of the
181// current user to make sure it hasn't changed during a session. This
182// will prevent the possibility of sessions being hijacked via XSS, but it
366dfa60 183// may break things for users coming using proxies that change all the time,
184// like AOL.
185// $CFG->tracksessionip = true;
bb64b51a 186//
187//
188// The following lines are for handling email bounces.
5fd1a5d8 189// $CFG->handlebounces = true;
190// $CFG->minbounces = 10;
191// $CFG->bounceratio = .20;
bb64b51a 192// The next lines are needed both for bounce handling and any other email to module processing.
193// mailprefix must be EXACTLY four characters.
c57e9015 194// Uncomment and customise this block for Postfix
5fd1a5d8 195// $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
c57e9015 196// $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
5fd1a5d8 197// $CFG->maildomain = 'youremaildomain.com';
f93426cf 198//
11e7b506 199// Enable when setting up advanced reverse proxy load balancing configurations.
200// $CFG->reverseproxy = true;
201//
202// Enable when using external SSL appliance for performance reasons.
203// Please note that site may be accessible via https: or https:, but not both!
204// $CFG->sslproxy = true;
205//
c57e9015 206// The following setting will tell Moodle to respect your PHP session
f93426cf 207// settings. Use this if you want to control session configuration
c57e9015 208// from php.ini, httpd.conf or .htaccess files.
5fd1a5d8 209// $CFG->respectsessionsettings = true;
1ac7ee24 210//
c57e9015 211// This setting will cause the userdate() function not to fix %d in
1ac7ee24 212// date strings, and just let them show with a zero prefix.
213// $CFG->nofixday = true;
ce5e431b 214//
215// This setting will make some graphs (eg user logs) use lines instead of bars
216// $CFG->preferlinegraphs = true;
9d5ef892 217//
18259d4f 218// Enabling this will allow custom scripts to replace existing moodle scripts.
9677eb79 219// For example: if $CFG->customscripts/course/view.php exists then
18259d4f 220// it will be used instead of $CFG->wwwroot/course/view.php
221// At present this will only work for files that include config.php and are called
222// as part of the url (index.php is implied).
223// Some examples are:
224// http://my.moodle.site/course/view.php
225// http://my.moodle.site/index.php
226// http://my.moodle.site/admin (index.php implied)
227// Custom scripts should not include config.php
228// Warning: Replacing standard moodle scripts may pose security risks and/or may not
229// be compatible with upgrades. Use this option only if you are aware of the risks
c57e9015 230// involved.
9677eb79 231// Specify the full directory path to the custom scripts
232// $CFG->customscripts = '/home/example/customscripts';
18259d4f 233//
c57e9015 234// Performance profiling
235//
853df85e 236// If you set Debug to "Yes" in the Configuration->Variables page some
237// performance profiling data will show up on your footer (in default theme).
238// With these settings you get more granular control over the capture
239// and printout of the data
240//
241// Capture performance profiling data
242// define('MDL_PERF' , true);
243//
244// Capture additional data from DB
245// define('MDL_PERFDB' , true);
246//
247// Print to log (for passive profiling of production servers)
248// define('MDL_PERFTOLOG' , true);
249//
250// Print to footer (works with the default theme)
251// define('MDL_PERFTOFOOT', true);
252//
4c202228 253// Force displayed usernames
c57e9015 254// A little hack to anonymise user names for all students. If you set these
4c202228 255// then all non-teachers will always see these for every person.
256// $CFG->forcefirstname = 'Bruce';
257// $CFG->forcelastname = 'Simpson';
acd2279e 258//
259// The following setting will turn SQL Error logging on. This will output an
260// entry in apache error log indicating the position of the error and the statement
261// called. This option will action disregarding error_reporting setting.
262// $CFG->dblogerror = true;
5c5c16bb 263//
13534ef7
ML
264// The following setting will log every database query to a table called adodb_logsql.
265// Use this setting on a development server only, the table grows quickly!
266// $CFG->logsql = true;
267//
5c5c16bb 268// The following setting will turn on username logging into Apache log. For full details regarding setting
269// up of this function please refer to the install section of the document.
270// $CFG->apacheloguser = 0; // Turn this feature off. Default value.
271// $CFG->apacheloguser = 1; // Log user id.
272// $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
c57e9015 273// $CFG->apacheloguser = 3; // Log username.
bd10cc11 274// To get the values logged in Apache's log, add to your httpd.conf
275// the following statements. In the General part put:
220776ac 276// LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
bd10cc11 277// And in the part specific to your Moodle install / virtualhost:
278// CustomLog "/your/path/to/log" moodleformat
279// CAUTION: Use of this option will expose usernames in the Apache log,
280// If you are going to publish your log, or the output of your web stats analyzer
281// this will weaken the security of your website.
c57e9015 282//
283// Email database connection errors to someone. If Moodle cannot connect to the
880a6f6b 284// database, then email this address with a notice.
285//
6b25f553 286// $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
c57e9015 287//
243a4e75 288// NOTE: if you are using custompix in your theme, see /fixpix.php.
c57e9015 289//
c68e9d06 290// special magic evil developer only wanting to edit the xmldb files manually
4d248a2e 291// AND don't use the XMLDBEditor nor the prev/next stuff at all (Mahara and others)
292// Uncomment these if you're lazy like Penny
c68e9d06 293// $CFG->xmldbdisablecommentchecking = true;
294// $CFG->xmldbdisablenextprevchecking = true;
295//
4d248a2e 296// special magig evil developer only wanting to edit xmldb files manually
297// AND allowing the XMLDBEditor to recostruct the prev/next elements every
298// time one file is loaded and saved (Moodle).
299// Uncomment this if you're lazy like Petr
300// $CFG->xmldbreconstructprevnext = true;
301//
6f93e96c 302// Set the priority of themes from highest to lowest. This is useful (for
303// example) in sites where the user theme should override all other theme
304// settings for accessibility reasons. You can also disable types of themes
305// by removing them from the array. The default setting is:
306// $CFG->themeorder = array('page', 'course', 'category', 'session', 'user', 'site');
307// NOTE: course, category, session, user themes still require the
308// respective settings to be enabled
309//
f4fa5a63 310// When working with production data on test servers, no emails should ever be send to real users
311// $CFG->noemailever = true;
312//
313//
6077020a 314//=========================================================================
315// ALL DONE! To continue installation, visit your main page with a browser
316//=========================================================================
c781942f 317if ($CFG->wwwroot == 'http://example.com/moodle') {
318 echo "<p>Error detected in configuration file</p>";
319 echo "<p>Your server address can not be: \$CFG->wwwroot = 'http://example.com/moodle';</p>";
320 die;
321}
322
6077020a 323if (file_exists("$CFG->dirroot/lib/setup.php")) { // Do not edit
324 include_once("$CFG->dirroot/lib/setup.php");
325} else {
326 if ($CFG->dirroot == dirname(__FILE__)) {
327 echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
328 echo "<p>Are you sure all your files have been uploaded?</p>";
329 } else {
330 echo "<p>Error detected in config.php</p>";
331 echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
332 echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
333 }
334 die;
335}
eb2042f6 336// MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
6077020a 337// RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
338?>