adding capabilities
[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// //
c6b456f6 15// Copyright (C) 1999-2004 Martin Dougiamas http://dougiamas.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
31
32//=========================================================================
33// 1. DATABASE SETUP
34//=========================================================================
35// First, you need to configure the database where all Moodle data //
36// will be stored. This database must already have been created //
37// and a username/password created to access it. //
38// //
39// mysql - the prefix is optional, but useful when installing //
40// into databases that already contain tables. //
41//
42// postgres7 - the prefix is REQUIRED, regardless of whether the //
43// database already contains tables. //
44// //
45// A special case exists when using PostgreSQL databases via sockets. //
46// Define dbhost as follows, leaving dbname, dbuser, dbpass BLANK!: //
47// $CFG->dbhost = " user='muser' password='mpass' dbname='mdata'"; //
eb2042f6 48//
6077020a 49
50$CFG->dbtype = 'mysql'; // mysql or postgres7 (for now)
eb2042f6 51$CFG->dbhost = 'localhost'; // eg localhost or db.isp.com
6077020a 52$CFG->dbname = 'moodle'; // database name, eg moodle
53$CFG->dbuser = 'username'; // your database username
54$CFG->dbpass = 'password'; // your database password
6077020a 55$CFG->prefix = 'mdl_'; // Prefix to use for all table names
56
1e55ed26 57$CFG->dbpersist = false; // Should database connections be reused?
eb2042f6 58 // "false" is the most stable setting
59 // "true" can improve performance sometimes
1e55ed26 60
6077020a 61
62//=========================================================================
63// 2. WEB SITE LOCATION
64//=========================================================================
65// Now you need to tell Moodle where it is located. Specify the full
eb2042f6 66// web address to where moodle has been installed. If your web site
67// is accessible via multiple URLs then choose the most natural one
6077020a 68// that your students would use. Do not include a trailing slash
69
70$CFG->wwwroot = 'http://example.com/moodle';
71
72
73//=========================================================================
74// 3. SERVER FILES LOCATION
75//=========================================================================
76// Next, specify the full OS directory path to this same location
77// Make sure the upper/lower case is correct. Some examples:
78//
7f21ed0a 79// $CFG->dirroot = 'c:\program files\easyphp\www\moodle'; // Windows
6077020a 80// $CFG->dirroot = '/var/www/html/moodle'; // Redhat Linux
5ec98a94 81// $CFG->dirroot = '/home/example/public_html/moodle'; // Cpanel host
6077020a 82
5ec98a94 83$CFG->dirroot = '/home/example/public_html/moodle';
6077020a 84
85
86//=========================================================================
87// 4. DATA FILES LOCATION
88//=========================================================================
89// Now you need a place where Moodle can save uploaded files. This
eb2042f6 90// directory should be readable AND WRITEABLE by the web server user
91// (usually 'nobody' or 'apache'), but it should not be accessible
6077020a 92// directly via the web.
93//
94// - On hosting systems you might need to make sure that your "group" has
95// no permissions at all, but that "others" have full permissions.
96//
97// - On Windows systems you might specify something like 'c:\moodledata'
98
99$CFG->dataroot = '/home/example/moodledata';
100
101
102//=========================================================================
103// 5. DATA FILES PERMISSIONS
104//=========================================================================
105// The following parameter sets the permissions of new directories
eb2042f6 106// created by Moodle within the data directory. The format is in
6077020a 107// octal format (as used by the Unix utility chmod, for example).
eb2042f6 108// The default is usually OK, but you may want to change it to 0750
6077020a 109// if you are concerned about world-access to the files (you will need
110// to make sure the web server process (eg Apache) can access the files.
111// NOTE: the prefixed 0 is important, and don't use quotes.
112
d99bab2d 113$CFG->directorypermissions = 02777;
6077020a 114
115
116//=========================================================================
117// 6. DIRECTORY LOCATION (most people can just ignore this setting)
118//=========================================================================
eb2042f6 119// A very few webhosts use /admin as a special URL for you to access a
120// control panel or something. Unfortunately this conflicts with the
121// standard location for the Moodle admin pages. You can fix this by
122// renaming the admin directory in your installation, and putting that
6077020a 123// new name here. eg "moodleadmin". This will fix admin links in Moodle.
124
125$CFG->admin = 'admin';
126
127
128//=========================================================================
92848614 129// 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
21d1d077 130//=========================================================================
131//
c9ca1fa5 132// These are additional tweaks for which no GUI exists in Moodle yet.
133//
134//
21d1d077 135// Prevent users from updating their profile images
eb2042f6 136// $CFG->disableuserimages = true;
21d1d077 137//
92848614 138// Prevent scheduled backups from operating (and hide the GUI for them)
139// Useful for webhost operators who have alternate methods of backups
140// $CFG->disablescheduledbackups = true;
21d1d077 141//
72df7e1e 142// Prevent stats processing and hide the GUI
143// $CFG->disablestatsprocessing = true;
144//
af5be70c 145// Set global password for "Login as", teacher is prompted only once in each session.
146// Set your own password and tell it only to teachers that should have access to this feature.
147// $CFG->loginaspassword = 'yoursharedpassword';
148//
7758d00f 149// Setting this to true will enable admins to edit any post at any time
150// $CFG->admineditalways = true;
cec0a0fc 151//
5fd1a5d8 152// These variables define DEFAULT block variables for new courses
153// If this one is set it overrides all others and is the only one used.
3eecaaf4 154// $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
155//
156// These variables define the specific settings for defined course formats.
5fd1a5d8 157// They override any settings defined in the formats own config file.
158// $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
3eecaaf4 159// $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
160// $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
161// $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
162//
5fd1a5d8 163// These blocks are used when no other default setting is found.
164// $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
3eecaaf4 165//
c81c6d0e 166//
46b81130 167// This setting will put Moodle in Unicode mode. Please note that database must support it.
168// Do not enable this if your database in not converted to UTF-8!
169// $CFG->unicodedb = true;
170//
171// Allow unicode characters in uploaded files, generated reports, etc.
172// This setting is new and not much tested, there are known problems
173// with backup/restore that will not be solved, because native infozip
174// binaries are doing some weird conversions - use internal PHP zipping instead.
cec0a0fc 175// NOT RECOMMENDED FOR PRODUCTION SITES
46b81130 176// $CFG->unicodecleanfilename = true;
8a33e371 177//
6b29ba60 178// Seconds for files to remain in caches. Decrease this if you are worried
179// about students being served outdated versions of uploaded files.
e55b73fd 180// $CFG->filelifetime = 86400;
88fea1ca 181//
182// This setting will prevent the 'My Courses' page being displayed when a student
183// logs in. The site front page will always show the same (logged-out) view.
e55b73fd 184// $CFG->disablemycourses = true;
21f01485 185//
366dfa60 186// If this setting is set to true, then Moodle will track the IP of the
187// current user to make sure it hasn't changed during a session. This
188// will prevent the possibility of sessions being hijacked via XSS, but it
189// may break things for users coming using proxies that change all the time,
190// like AOL.
191// $CFG->tracksessionip = true;
bb64b51a 192//
193//
194// The following lines are for handling email bounces.
5fd1a5d8 195// $CFG->handlebounces = true;
196// $CFG->minbounces = 10;
197// $CFG->bounceratio = .20;
bb64b51a 198// The next lines are needed both for bounce handling and any other email to module processing.
199// mailprefix must be EXACTLY four characters.
200// Uncomment and customise this block for Postfix
5fd1a5d8 201// $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
b96f1ad6 202// $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
5fd1a5d8 203// $CFG->maildomain = 'youremaildomain.com';
f93426cf 204//
205// The following setting will tell Moodle to respect your PHP session
206// settings. Use this if you want to control session configuration
207// from php.ini, httpd.conf or .htaccess files.
5fd1a5d8 208// $CFG->respectsessionsettings = true;
1ac7ee24 209//
210// This setting will cause the userdate() function not to fix %d in
211// date strings, and just let them show with a zero prefix.
212// $CFG->nofixday = true;
ce5e431b 213//
214// This setting will make some graphs (eg user logs) use lines instead of bars
215// $CFG->preferlinegraphs = true;
9d5ef892 216//
18259d4f 217// Enabling this will allow custom scripts to replace existing moodle scripts.
9677eb79 218// For example: if $CFG->customscripts/course/view.php exists then
18259d4f 219// it will be used instead of $CFG->wwwroot/course/view.php
220// At present this will only work for files that include config.php and are called
221// as part of the url (index.php is implied).
222// Some examples are:
223// http://my.moodle.site/course/view.php
224// http://my.moodle.site/index.php
225// http://my.moodle.site/admin (index.php implied)
226// Custom scripts should not include config.php
227// Warning: Replacing standard moodle scripts may pose security risks and/or may not
228// be compatible with upgrades. Use this option only if you are aware of the risks
229// involved.
9677eb79 230// Specify the full directory path to the custom scripts
231// $CFG->customscripts = '/home/example/customscripts';
18259d4f 232//
853df85e 233// Performance profiling
234//
235// If you set Debug to "Yes" in the Configuration->Variables page some
236// performance profiling data will show up on your footer (in default theme).
237// With these settings you get more granular control over the capture
238// and printout of the data
239//
240// Capture performance profiling data
241// define('MDL_PERF' , true);
242//
243// Capture additional data from DB
244// define('MDL_PERFDB' , true);
245//
246// Print to log (for passive profiling of production servers)
247// define('MDL_PERFTOLOG' , true);
248//
249// Print to footer (works with the default theme)
250// define('MDL_PERFTOFOOT', true);
251//
4c202228 252// Force displayed usernames
253// A little hack to anonymise user names for all students. If you set these
254// then all non-teachers will always see these for every person.
255// $CFG->forcefirstname = 'Bruce';
256// $CFG->forcelastname = 'Simpson';
acd2279e 257//
258// The following setting will turn SQL Error logging on. This will output an
259// entry in apache error log indicating the position of the error and the statement
260// called. This option will action disregarding error_reporting setting.
261// $CFG->dblogerror = true;
5c5c16bb 262//
263// The following setting will turn on username logging into Apache log. For full details regarding setting
264// up of this function please refer to the install section of the document.
265// $CFG->apacheloguser = 0; // Turn this feature off. Default value.
266// $CFG->apacheloguser = 1; // Log user id.
267// $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
bd10cc11 268// $CFG->apacheloguser = 3; // Log username.
269// To get the values logged in Apache's log, add to your httpd.conf
270// the following statements. In the General part put:
220776ac 271// LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
bd10cc11 272// And in the part specific to your Moodle install / virtualhost:
273// CustomLog "/your/path/to/log" moodleformat
274// CAUTION: Use of this option will expose usernames in the Apache log,
275// If you are going to publish your log, or the output of your web stats analyzer
276// this will weaken the security of your website.
277//
880a6f6b 278// Email database connection errors to someone. If Moodle cannot connect to the
279// database, then email this address with a notice.
280//
6b25f553 281// $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
880a6f6b 282//
418b4e5a 283// Restore pre-1.6 behaviour where courses could still be available
284// even if the category they were in was hidden
285// $CFG->allowvisiblecoursesinhiddencategories = true;
880a6f6b 286//
243a4e75 287// NOTE: if you are using custompix in your theme, see /fixpix.php.
6077020a 288
289//=========================================================================
290// ALL DONE! To continue installation, visit your main page with a browser
291//=========================================================================
c781942f 292if ($CFG->wwwroot == 'http://example.com/moodle') {
293 echo "<p>Error detected in configuration file</p>";
294 echo "<p>Your server address can not be: \$CFG->wwwroot = 'http://example.com/moodle';</p>";
295 die;
296}
297
6077020a 298if (file_exists("$CFG->dirroot/lib/setup.php")) { // Do not edit
299 include_once("$CFG->dirroot/lib/setup.php");
300} else {
301 if ($CFG->dirroot == dirname(__FILE__)) {
302 echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
303 echo "<p>Are you sure all your files have been uploaded?</p>";
304 } else {
305 echo "<p>Error detected in config.php</p>";
306 echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
307 echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
308 }
309 die;
310}
eb2042f6 311// MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
6077020a 312// RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
313?>