Added two configuration variables to the config page.
[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'"; //
48//
49
50$CFG->dbtype = 'mysql'; // mysql or postgres7 (for now)
51$CFG->dbhost = 'localhost'; // eg localhost or db.isp.com
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?
7f21ed0a 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
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
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
81// $CFG->dirroot = '/home/example/www/moodle'; // Cpanel host
82
83$CFG->dirroot = '/home/example/www/moodle';
84
85
86//=========================================================================
87// 4. DATA FILES LOCATION
88//=========================================================================
89// Now you need a place where Moodle can save uploaded files. This
90// directory should be readable AND WRITEABLE by the web server user
91// (usually 'nobody' or 'apache'), but it should not be accessible
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
106// created by Moodle within the data directory. The format is in
107// octal format (as used by the Unix utility chmod, for example).
108// The default is usually OK, but you may want to change it to 0750
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
113$CFG->directorypermissions = 0777;
114
115
116//=========================================================================
117// 6. DIRECTORY LOCATION (most people can just ignore this setting)
118//=========================================================================
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
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
136// $CFG->disableuserimages = true;
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//
142// Restrict certain usernames from doing things that may mess up a site
143// This is especially useful for demonstration teacher accounts
144// $CFG->restrictusers = 'teacher,fred,jim';
145//
609a2b13 146// Turning this on will make Moodle filter more than usual, including
147// forum subjects, activity names and so on (in ADDITION to the normal
148// texts like forum postings, journals etc). This is mostly only useful
149// when using the multilang filter. This feature may not be complete.
150// $CFG->filterall = true;
7758d00f 151//
152// Setting this to true will enable admins to edit any post at any time
153// $CFG->admineditalways = true;
cec0a0fc 154//
c81c6d0e 155// Setting this to true will force a non-guest login to see the user pages
156// eg the teachers linked from course descriptions or site news
c9ca1fa5 157// $CFG->forceloginforprofiles = true;
158//
159// Setting this variable will make Moodle allow anything as a username,
160// rather than alphanumerical characters only.
161// $CFG->extendedusernamechars = true;
c81c6d0e 162//
cec0a0fc 163// This setting will put Moodle in Unicode mode. It's very new and
164// most likely doesn't work yet. THIS IS FOR DEVELOPERS ONLY, IT IS
165// NOT RECOMMENDED FOR PRODUCTION SITES
166// $CFG->unicode = true;
21d1d077 167
6077020a 168
169
170//=========================================================================
171// ALL DONE! To continue installation, visit your main page with a browser
172//=========================================================================
173if (file_exists("$CFG->dirroot/lib/setup.php")) { // Do not edit
174 include_once("$CFG->dirroot/lib/setup.php");
175} else {
176 if ($CFG->dirroot == dirname(__FILE__)) {
177 echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
178 echo "<p>Are you sure all your files have been uploaded?</p>";
179 } else {
180 echo "<p>Error detected in config.php</p>";
181 echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
182 echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
183 }
184 die;
185}
186// MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
187// RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
188?>