MDL-17457 migrated all modules to new db/install.php; added upgrade.txt file for...
[moodle.git] / config-dist.php
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         //
13 //          http://moodle.org                                            //
14 //                                                                       //
15 // Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com       //
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 ///////////////////////////////////////////////////////////////////////////
30 unset($CFG);  // Ignore this line
31 $CFG = new stdClass();
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'";    //
49 //
51 $CFG->dbtype    = 'mysql';       // mysql or postgres7 (for now)
52 $CFG->dbhost    = 'localhost';   // eg localhost or db.isp.com
53 $CFG->dbname    = 'moodle';      // database name, eg moodle
54 $CFG->dbuser    = 'username';    // your database username
55 $CFG->dbpass    = 'password';    // your database password
56 $CFG->prefix    = 'mdl_';        // Prefix to use for all table names
58 $CFG->dbpersist = false;         // Should database connections be reused?
59                  // "false" is the most stable setting
60                  // "true" can improve performance sometimes
63 //=========================================================================
64 // 2. WEB SITE LOCATION
65 //=========================================================================
66 // Now you need to tell Moodle where it is located. Specify the full
67 // web address to where moodle has been installed.  If your web site
68 // is accessible via multiple URLs then choose the most natural one
69 // that your students would use.  Do not include a trailing slash
70 //
71 // If you need both intranet and Internet access please read
72 // http://docs.moodle.org/en/masquerading
74 $CFG->wwwroot   = 'http://example.com/moodle';
77 //=========================================================================
78 // 3. SERVER FILES LOCATION
79 //=========================================================================
80 // Next, specify the full OS directory path to this same location
81 // Make sure the upper/lower case is correct.  Some examples:
82 //
83 //    $CFG->dirroot = 'c:\program files\easyphp\www\moodle';    // Windows
84 //    $CFG->dirroot = '/var/www/html/moodle';     // Redhat Linux
85 //    $CFG->dirroot = '/home/example/public_html/moodle'; // Cpanel host
87 $CFG->dirroot   = '/home/example/public_html/moodle';
90 //=========================================================================
91 // 4. DATA FILES LOCATION
92 //=========================================================================
93 // Now you need a place where Moodle can save uploaded files.  This
94 // directory should be readable AND WRITEABLE by the web server user
95 // (usually 'nobody' or 'apache'), but it should not be accessible
96 // directly via the web.
97 //
98 // - On hosting systems you might need to make sure that your "group" has
99 //   no permissions at all, but that "others" have full permissions.
100 //
101 // - On Windows systems you might specify something like 'c:\moodledata'
103 $CFG->dataroot  = '/home/example/moodledata';
106 //=========================================================================
107 // 5. DATA FILES PERMISSIONS
108 //=========================================================================
109 // The following parameter sets the permissions of new directories
110 // created by Moodle within the data directory.  The format is in
111 // octal format (as used by the Unix utility chmod, for example).
112 // The default is usually OK, but you may want to change it to 0750
113 // if you are concerned about world-access to the files (you will need
114 // to make sure the web server process (eg Apache) can access the files.
115 // NOTE: the prefixed 0 is important, and don't use quotes.
117 $CFG->directorypermissions = 02777;
120 //=========================================================================
121 // 6. DIRECTORY LOCATION  (most people can just ignore this setting)
122 //=========================================================================
123 // A very few webhosts use /admin as a special URL for you to access a
124 // control panel or something.  Unfortunately this conflicts with the
125 // standard location for the Moodle admin pages.  You can fix this by
126 // renaming the admin directory in your installation, and putting that
127 // new name here.  eg "moodleadmin".  This will fix admin links in Moodle.
129 $CFG->admin = 'admin';
132 //=========================================================================
133 // 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
134 //=========================================================================
135 //
136 // These are additional tweaks for which no GUI exists in Moodle yet.
137 //
138 //
139 // Change the key pair lifetime for Moodle Networking
140 // The default is 28 days. You would only want to change this if the key
141 // was not getting regenerated for any reason. You would probably want
142 // make it much longer. Note that you'll need to delete and manually update
143 // any existing key.
144 //      $CFG->mnetkeylifetime = 28;
145 //
146 // Prevent scheduled backups from operating (and hide the GUI for them)
147 // Useful for webhost operators who have alternate methods of backups
148 //      $CFG->disablescheduledbackups = true;
149 //
150 // Prevent stats processing and hide the GUI
151 //      $CFG->disablestatsprocessing = true;
152 //
153 // Setting this to true will enable admins to edit any post at any time
154 //      $CFG->admineditalways = true;
155 //
156 // These variables define DEFAULT block variables for new courses
157 // If this one is set it overrides all others and is the only one used.
158 //      $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
159 //
160 // These variables define the specific settings for defined course formats.
161 // They override any settings defined in the formats own config file.
162 //      $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
163 //      $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
164 //      $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
165 //      $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
166 //
167 // These blocks are used when no other default setting is found.
168 //      $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
169 //
170 //
171 // Seconds for files to remain in caches. Decrease this if you are worried
172 // about students being served outdated versions of uploaded files.
173 //     $CFG->filelifetime = 86400;
174 //
175 // This setting will prevent the 'My Courses' page being displayed when a student
176 // logs in. The site front page will always show the same (logged-out) view.
177 //     $CFG->disablemycourses = true;
178 //
179 // If this setting is set to true, then Moodle will track the IP of the
180 // current user to make sure it hasn't changed during a session.  This
181 // will prevent the possibility of sessions being hijacked via XSS, but it
182 // may break things for users coming using proxies that change all the time,
183 // like AOL.
184 //      $CFG->tracksessionip = true;
185 //
186 //
187 // The following lines are for handling email bounces.
188 //      $CFG->handlebounces = true;
189 //      $CFG->minbounces = 10;
190 //      $CFG->bounceratio = .20;
191 // The next lines are needed both for bounce handling and any other email to module processing.
192 // mailprefix must be EXACTLY four characters.
193 // Uncomment and customise this block for Postfix
194 //      $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
195 //      $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
196 //      $CFG->maildomain = 'youremaildomain.com';
197 //
198 // Enable when setting up advanced reverse proxy load balancing configurations.
199 //      $CFG->reverseproxy = true;
200 //
201 // Enable when using external SSL appliance for performance reasons.
202 // Please note that site may be accessible via https: or https:, but not both!
203 //      $CFG->sslproxy = true;
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.
208 //      $CFG->respectsessionsettings = true;
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;
213 //
214 // This setting will make some graphs (eg user logs) use lines instead of bars
215 //      $CFG->preferlinegraphs = true;
216 //
217 // Enabling this will allow custom scripts to replace existing moodle scripts.
218 // For example: if $CFG->customscripts/course/view.php exists then
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.
230 // Specify the full directory path to the custom scripts
231 //      $CFG->customscripts = '/home/example/customscripts';
232 //
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 //
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';
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;
262 //
263 // The following setting will log every database query to a table called adodb_logsql.
264 // Use this setting on a development server only, the table grows quickly!
265 //     $CFG->logsql = true;
266 //
267 // The following setting will turn on username logging into Apache log. For full details regarding setting
268 // up of this function please refer to the install section of the document.
269 //     $CFG->apacheloguser = 0; // Turn this feature off. Default value.
270 //     $CFG->apacheloguser = 1; // Log user id.
271 //     $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
272 //     $CFG->apacheloguser = 3; // Log username.
273 // To get the values logged in Apache's log, add to your httpd.conf
274 // the following statements. In the General part put:
275 //     LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
276 // And in the part specific to your Moodle install / virtualhost:
277 //     CustomLog "/your/path/to/log" moodleformat
278 // CAUTION: Use of this option will expose usernames in the Apache log,
279 // If you are going to publish your log, or the output of your web stats analyzer
280 // this will weaken the security of your website.
281 //
282 // Email database connection errors to someone.  If Moodle cannot connect to the
283 // database, then email this address with a notice.
284 //
285 //     $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
286 //
287 // NOTE: if you are using custompix in your theme, see /fixpix.php.
288 //
289 // Set the priority of themes from highest to lowest. This is useful (for
290 // example) in sites where the user theme should override all other theme
291 // settings for accessibility reasons. You can also disable types of themes
292 // by removing them from the array. The default setting is:
293 //      $CFG->themeorder = array('page', 'course', 'category', 'session', 'user', 'site');
294 // NOTE: course, category, session, user themes still require the
295 // respective settings to be enabled
296 //
298 //=========================================================================
299 // 8. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
300 //=========================================================================
301 //
302 // When working with production data on test servers, no emails should ever be send to real users
303 // $CFG->noemailever = true;
304 //
305 // Specify prefix for fake unit test tables. If not specified only tests
306 // that do not need fake tables will be executed.
307 // $CFG->unittestprefix = 'tst_';
308 //
309 // special magic evil developer only wanting to edit the xmldb files manually
310 // AND don't use the XMLDBEditor nor the prev/next stuff at all (Mahara and others)
311 // Uncomment these if you're lazy like Penny
312 // $CFG->xmldbdisablecommentchecking = true;
313 // $CFG->xmldbdisablenextprevchecking = true;
314 //
315 // Special magic - evil developer only wanting to edit xmldb files manually
316 // AND allowing the XMLDBEditor to recostruct the prev/next elements every
317 // time one file is loaded and saved (Moodle).
318 // Uncomment this if you're lazy like Petr
319 // $CFG->xmldbreconstructprevnext = true;
320 //
321 //
322 // Since 2.0 sql queries are not shown during upgrade by default.
323 // Please note that this setting may produce very long upgrade page on large sites.
324 // $CFG->upgradeshowsql = true;
328 //=========================================================================
329 // ALL DONE!  To continue installation, visit your main page with a browser
330 //=========================================================================
331 if ($CFG->wwwroot == 'http://example.com/moodle') {
332     echo "<p>Error detected in configuration file</p>";
333     echo "<p>Your server address can not be: \$CFG->wwwroot = 'http://example.com/moodle';</p>";
334     die;
337 if (file_exists("$CFG->dirroot/lib/setup.php"))  {       // Do not edit
338     include_once("$CFG->dirroot/lib/setup.php");
339 } else {
340     if ($CFG->dirroot == dirname(__FILE__)) {
341         echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
342         echo "<p>Are you sure all your files have been uploaded?</p>";
343     } else {
344         echo "<p>Error detected in config.php</p>";
345         echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
346         echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
347     }
348     die;
350 // MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
351 // RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
352 ?>