MDL-26096 added missing return
[moodle.git] / config-dist.php
1 <?PHP
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 3 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 global $CFG;  // This is necessary here for PHPUnit execution
32 $CFG = new stdClass();
34 //=========================================================================
35 // 1. DATABASE SETUP
36 //=========================================================================
37 // First, you need to configure the database where all Moodle data       //
38 // will be stored.  This database must already have been created         //
39 // and a username/password created to access it.                         //
41 $CFG->dbtype    = 'pgsql';      // 'pgsql', 'mysqli', 'mssql' or 'oci'
42 $CFG->dblibrary = 'native';     // 'native' only at the moment
43 $CFG->dbhost    = 'localhost';  // eg 'localhost' or 'db.isp.com' or IP
44 $CFG->dbname    = 'moodle';     // database name, eg moodle
45 $CFG->dbuser    = 'username';   // your database username
46 $CFG->dbpass    = 'password';   // your database password
47 $CFG->prefix    = 'mdl_';       // prefix to use for all table names
48 $CFG->dboptions = array(
49     'dbpersist' => false,       // should persistent database connections be
50                                 //  used? set to 'false' for the most stable
51                                 //  setting, 'true' can improve performance
52                                 //  sometimes
53     'dbsocket'  => false,       // should connection via UNIX socket be used?
54                                 //  if you set it to 'true' or custom path
55                                 //  here set dbhost to 'localhost',
56                                 //  (please note mysql is always using socket
57                                 //  if dbhost is 'localhost' - if you need
58                                 //  local port connection use '127.0.0.1')
59     'dbport'    => '',          // the TCP port number to use when connecting
60                                 //  to the server. keep empty string for the
61                                 //  default port
62 );
65 //=========================================================================
66 // 2. SECRET PASSWORD SALT
67 //=========================================================================
68 // User password salt is very important security feature, it is created
69 // automatically in installer, you have to uncomment and modify value
70 // on the next line if you are creating config.php manually.
71 //
72 // $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1';
73 //
74 // After changing the main salt you have to copy old value into one
75 // of the following settings - this allows migration to the new salt
76 // during the next login of each user.
77 //
78 // $CFG->passwordsaltalt1 = '';
79 // $CFG->passwordsaltalt2 = '';
80 // $CFG->passwordsaltalt3 = '';
81 // ....
82 // $CFG->passwordsaltalt19 = '';
83 // $CFG->passwordsaltalt20 = '';
86 //=========================================================================
87 // 3. WEB SITE LOCATION
88 //=========================================================================
89 // Now you need to tell Moodle where it is located. Specify the full
90 // web address to where moodle has been installed.  If your web site
91 // is accessible via multiple URLs then choose the most natural one
92 // that your students would use.  Do not include a trailing slash
93 //
94 // If you need both intranet and Internet access please read
95 // http://docs.moodle.org/en/masquerading
97 $CFG->wwwroot   = 'http://example.com/moodle';
100 //=========================================================================
101 // 4. DATA FILES LOCATION
102 //=========================================================================
103 // Now you need a place where Moodle can save uploaded files.  This
104 // directory should be readable AND WRITEABLE by the web server user
105 // (usually 'nobody' or 'apache'), but it should not be accessible
106 // directly via the web.
107 //
108 // - On hosting systems you might need to make sure that your "group" has
109 //   no permissions at all, but that "others" have full permissions.
110 //
111 // - On Windows systems you might specify something like 'c:\moodledata'
113 $CFG->dataroot  = '/home/example/moodledata';
116 //=========================================================================
117 // 5. DATA FILES PERMISSIONS
118 //=========================================================================
119 // The following parameter sets the permissions of new directories
120 // created by Moodle within the data directory.  The format is in
121 // octal format (as used by the Unix utility chmod, for example).
122 // The default is usually OK, but you may want to change it to 0750
123 // if you are concerned about world-access to the files (you will need
124 // to make sure the web server process (eg Apache) can access the files.
125 // NOTE: the prefixed 0 is important, and don't use quotes.
127 $CFG->directorypermissions = 02777;
130 //=========================================================================
131 // 6. DIRECTORY LOCATION  (most people can just ignore this setting)
132 //=========================================================================
133 // A very few webhosts use /admin as a special URL for you to access a
134 // control panel or something.  Unfortunately this conflicts with the
135 // standard location for the Moodle admin pages.  You can fix this by
136 // renaming the admin directory in your installation, and putting that
137 // new name here.  eg "moodleadmin".  This will fix admin links in Moodle.
139 $CFG->admin = 'admin';
142 //=========================================================================
143 // 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
144 //=========================================================================
145 //
146 // These are additional tweaks for which no GUI exists in Moodle yet.
147 //
148 // Starting in PHP 5.3 administrators should specify default timezone
149 // in PHP.ini, you can also specify it here if needed.
150 // See details at: http://php.net/manual/en/function.date-default-timezone-set.php
151 // List of time zones at: http://php.net/manual/en/timezones.php
152 //     date_default_timezone_set('Australia/Perth');
153 //
154 // Change the key pair lifetime for Moodle Networking
155 // The default is 28 days. You would only want to change this if the key
156 // was not getting regenerated for any reason. You would probably want
157 // make it much longer. Note that you'll need to delete and manually update
158 // any existing key.
159 //      $CFG->mnetkeylifetime = 28;
160 //
161 // Allow user passwords to be included in backup files. Very dangerous
162 // setting as far as it publishes password hashes that can be unencrypted
163 // if the backup file is publicy available. Use it only if you can guarantee
164 // that all your backup files remain only privacy available and are never
165 // shared out from your site/institution!
166 //      $CFG->includeuserpasswordsinbackup = true;
167 //
168 // Completely disable user creation when restoring a course, bypassing any
169 // permissions granted via roles and capabilities. Enabling this setting
170 // results in the restore process stopping when a user attempts to restore a
171 // course requiring users to be created.
172 //     $CFG->disableusercreationonrestore = true;
173 //
174 // Keep the temporary directories used by backup and restore without being
175 // deleted at the end of the process. Use it if you want to debug / view
176 // all the information stored there after the process has ended. Note that
177 // those directories may be deleted (after some ttl) both by cron and / or
178 // by new backup / restore invocations.
179 //     $CFG->keeptempdirectoriesonbackup = true;
180 //
181 // Modify the restore process in order to force the "user checks" to assume
182 // that the backup originated from a different site, so detection of matching
183 // users is performed with different (more "relaxed") rules. Note that this is
184 // only useful if the backup file has been created using Moodle < 1.9.4 and the
185 // site has been rebuilt from scratch using backup files (not the best way btw).
186 // If you obtain user conflicts on restore, rather than enabling this setting
187 // permanently, try restoring the backup on a different site, back it up again
188 // and then restore on the target server.
189 //    $CFG->forcedifferentsitecheckingusersonrestore = true;
190 //
191 // Prevent stats processing and hide the GUI
192 //      $CFG->disablestatsprocessing = true;
193 //
194 // Setting this to true will enable admins to edit any post at any time
195 //      $CFG->admineditalways = true;
196 //
197 // These variables define DEFAULT block variables for new courses
198 // If this one is set it overrides all others and is the only one used.
199 //      $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
200 //
201 // These variables define the specific settings for defined course formats.
202 // They override any settings defined in the formats own config file.
203 //      $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
204 //      $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
205 //      $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
206 //      $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
207 //
208 // These blocks are used when no other default setting is found.
209 //      $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
210 //
211 // The blocks in this list will be protected from deletion, and this is primarily
212 // used to protect the navigation and settings blocks which can be very hard to
213 // get back if accidentally delete.
214 //      $CFG->undeletableblocktypes = 'navigation,settings';
215 //
216 // You can specify a different class to be created for the $PAGE global, and to
217 // compute which blocks appear on each page. However, I cannot think of any good
218 // reason why you would need to change that. It just felt wrong to hard-code the
219 // the class name. You are stronly advised not to use these to settings unless
220 // you are absolutely sure you know what you are doing.
221 //      $CFG->moodlepageclass = 'moodle_page';
222 //      $CFG->blockmanagerclass = 'block_manager';
223 //
224 // Seconds for files to remain in caches. Decrease this if you are worried
225 // about students being served outdated versions of uploaded files.
226 //     $CFG->filelifetime = 86400;
227 //
228 // This setting will prevent the 'My Courses' page being displayed when a student
229 // logs in. The site front page will always show the same (logged-out) view.
230 //     $CFG->disablemycourses = true;
231 //
232 // If this setting is set to true, then Moodle will track the IP of the
233 // current user to make sure it hasn't changed during a session.  This
234 // will prevent the possibility of sessions being hijacked via XSS, but it
235 // may break things for users coming using proxies that change all the time,
236 // like AOL.
237 //      $CFG->tracksessionip = true;
238 //
239 // The following lines are for handling email bounces.
240 //      $CFG->handlebounces = true;
241 //      $CFG->minbounces = 10;
242 //      $CFG->bounceratio = .20;
243 // The next lines are needed both for bounce handling and any other email to module processing.
244 // mailprefix must be EXACTLY four characters.
245 // Uncomment and customise this block for Postfix
246 //      $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
247 //      $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
248 //      $CFG->maildomain = 'youremaildomain.com';
249 //
250 // Enable when setting up advanced reverse proxy load balancing configurations,
251 // it may be also necessary to enable this when using port forwarding.
252 //      $CFG->reverseproxy = true;
253 //
254 // Enable when using external SSL appliance for performance reasons.
255 // Please note that site may be accessible via https: or https:, but not both!
256 //      $CFG->sslproxy = true;
257 //
258 // This setting will cause the userdate() function not to fix %d in
259 // date strings, and just let them show with a zero prefix.
260 //      $CFG->nofixday = true;
261 //
262 // This setting will make some graphs (eg user logs) use lines instead of bars
263 //      $CFG->preferlinegraphs = true;
264 //
265 // Enabling this will allow custom scripts to replace existing moodle scripts.
266 // For example: if $CFG->customscripts/course/view.php exists then
267 // it will be used instead of $CFG->wwwroot/course/view.php
268 // At present this will only work for files that include config.php and are called
269 // as part of the url (index.php is implied).
270 // Some examples are:
271 //      http://my.moodle.site/course/view.php
272 //      http://my.moodle.site/index.php
273 //      http://my.moodle.site/admin            (index.php implied)
274 // Custom scripts should not include config.php
275 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
276 // be compatible with upgrades. Use this option only if you are aware of the risks
277 // involved.
278 // Specify the full directory path to the custom scripts
279 //      $CFG->customscripts = '/home/example/customscripts';
280 //
281 // Performance profiling
282 //
283 //   If you set Debug to "Yes" in the Configuration->Variables page some
284 //   performance profiling data will show up on your footer (in default theme).
285 //   With these settings you get more granular control over the capture
286 //   and printout of the data
287 //
288 //   Capture performance profiling data
289 //   define('MDL_PERF'  , true);
290 //
291 //   Capture additional data from DB
292 //   define('MDL_PERFDB'  , true);
293 //
294 //   Print to log (for passive profiling of production servers)
295 //   define('MDL_PERFTOLOG'  , true);
296 //
297 //   Print to footer (works with the default theme)
298 //   define('MDL_PERFTOFOOT', true);
299 //
300 // Force displayed usernames
301 //   A little hack to anonymise user names for all students.  If you set these
302 //   then all non-teachers will always see these for every person.
303 //       $CFG->forcefirstname = 'Bruce';
304 //       $CFG->forcelastname  = 'Simpson';
305 //
306 // The following setting will turn SQL Error logging on. This will output an
307 // entry in apache error log indicating the position of the error and the statement
308 // called. This option will action disregarding error_reporting setting.
309 //     $CFG->dblogerror = true;
310 //
311 // The following setting will log every database query to a table called adodb_logsql.
312 // Use this setting on a development server only, the table grows quickly!
313 //     $CFG->logsql = true;
314 //
315 // The following setting will turn on username logging into Apache log. For full details regarding setting
316 // up of this function please refer to the install section of the document.
317 //     $CFG->apacheloguser = 0; // Turn this feature off. Default value.
318 //     $CFG->apacheloguser = 1; // Log user id.
319 //     $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
320 //     $CFG->apacheloguser = 3; // Log username.
321 // To get the values logged in Apache's log, add to your httpd.conf
322 // the following statements. In the General part put:
323 //     LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
324 // And in the part specific to your Moodle install / virtualhost:
325 //     CustomLog "/your/path/to/log" moodleformat
326 // CAUTION: Use of this option will expose usernames in the Apache log,
327 // If you are going to publish your log, or the output of your web stats analyzer
328 // this will weaken the security of your website.
329 //
330 // Email database connection errors to someone.  If Moodle cannot connect to the
331 // database, then email this address with a notice.
332 //
333 //     $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
334 //
335 // Set the priority of themes from highest to lowest. This is useful (for
336 // example) in sites where the user theme should override all other theme
337 // settings for accessibility reasons. You can also disable types of themes
338 // (other than site)  by removing them from the array. The default setting is:
339 //      $CFG->themeorder = array('course', 'category', 'session', 'user', 'site');
340 // NOTE: course, category, session, user themes still require the
341 // respective settings to be enabled
342 //
343 // It is possible to add extra themes directory stored outside of $CFG->dirroot.
344 // This local directory does not have to be accessible from internet.
345 //
346 //     $CFG->themedir = '/location/of/extra/themes';
347 //
348 // Site default language can be set via standard administration interface. If you
349 // want to have initial error messages for eventual database connection problems
350 // localized too, you have to set your language code here.
351 //
352 //     $CFG->lang = 'yourlangcode'; // for example 'cs'
353 //
354 // When Moodle is about to perform an intensive operation it raises PHP's memory
355 // limit. The following setting should be used on large sites to set the raised
356 // memory limit to something higher.
357 // The value for the settings should be a valid PHP memory value. e.g. 512M, 1G
358 //
359 //     $CFG->extramemorylimit = 1G;
360 //
361 //=========================================================================
362 // 8. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
363 //=========================================================================
364 //
365 // Force a debugging mode regardless the settings in the site administration
366 // @error_reporting(1023);  // NOT FOR PRODUCTION SERVERS!
367 // @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
368 // $CFG->debug = 38911;  // DEBUG_DEVELOPER // NOT FOR PRODUCTION SERVERS!
369 // $CFG->debugdisplay = true;   // NOT FOR PRODUCTION SERVERS!
370 //
371 // You can specify a comma separated list of user ids that that always see
372 // debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay
373 // for these users only.
374 // $CFG->debugusers = '2';
375 //
376 // Prevent theme caching
377 // $CFG->themerev = -1; // NOT FOR PRODUCTION SERVERS!
378 //
379 // Prevent core_string_manager on-disk cache
380 // $CFG->langstringcache = false; // NOT FOR PRODUCTION SERVERS!
381 //
382 // When working with production data on test servers, no emails should ever be send to real users
383 // $CFG->noemailever = true;    // NOT FOR PRODUCTION SERVERS!
384 //
385 // Divert all outgoing emails to this address to test and debug emailing features
386 // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
387 //
388 // Specify prefix for fake unit test tables. If not specified only tests
389 // that do not need fake tables will be executed.
390 // $CFG->unittestprefix = 'tst_';   // NOT FOR PRODUCTION SERVERS!
391 //
392 // special magic evil developer only wanting to edit the xmldb files manually
393 // AND don't use the XMLDBEditor nor the prev/next stuff at all (Mahara and others)
394 // Uncomment these if you're lazy like Penny
395 // $CFG->xmldbdisablecommentchecking = true;    // NOT FOR PRODUCTION SERVERS!
396 // $CFG->xmldbdisablenextprevchecking = true;   // NOT FOR PRODUCTION SERVERS!
397 //
398 // Special magic - evil developer only wanting to edit xmldb files manually
399 // AND allowing the XMLDBEditor to reconstruct the prev/next elements every
400 // time one file is loaded and saved (Moodle).
401 // Uncomment this if you're lazy like Petr
402 // $CFG->xmldbreconstructprevnext = true;   // NOT FOR PRODUCTION SERVERS!
403 //
404 // Since 2.0 sql queries are not shown during upgrade by default.
405 // Please note that this setting may produce very long upgrade page on large sites.
406 // $CFG->upgradeshowsql = true; // NOT FOR PRODUCTION SERVERS!
407 //
408 // Add SQL queries to the output of cron, just before their execution
409 // $CFG->showcronsql = true;
410 //
411 // Force developer level debug and add debug info to the output of cron
412 // $CFG->showcrondebugging = true;
413 //
414 //=========================================================================
415 // 9. FORCED SETTINGS
416 //=========================================================================
417 // It is possible to specify normal admin settings here, the point is that
418 // they can not be changed through the standard admin settings pages any more.
419 //
420 // Core settings are specified directly via assignment to $CFG variable.
421 // Example:
422 //   $CFG->somecoresetting = 'value';
423 //
424 // Plugin settings have to be put into a special array.
425 // Example:
426 //   $CFG->forced_plugin_settings = array('pluginname'  => array('settingname' => 'value', 'secondsetting' => 'othervalue'),
427 //                                        'otherplugin' => array('mysetting' => 'myvalue', 'thesetting' => 'thevalue'));
430 //=========================================================================
431 // ALL DONE!  To continue installation, visit your main page with a browser
432 //=========================================================================
434 require_once(dirname(__FILE__) . '/lib/setup.php'); // Do not edit
436 // There is no php closing tag in this file,
437 // it is intentional because it prevents trailing whitespace problems!