Moodle release 3.5.17
[moodle.git] / config-dist.php
blob16477683ef20d97919f982b81d7076535fb69eaa
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', 'mariadb', 'mysqli', 'sqlsrv' 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 'dbhandlesoptions' => false,// On PostgreSQL poolers like pgbouncer don't
63 // support advanced options on connection.
64 // If you set those in the database then
65 // the advanced settings will not be sent.
66 'dbcollation' => 'utf8mb4_unicode_ci', // MySQL has partial and full UTF-8
67 // support. If you wish to use partial UTF-8
68 // (three bytes) then set this option to
69 // 'utf8_unicode_ci', otherwise this option
70 // can be removed for MySQL (by default it will
71 // use 'utf8mb4_unicode_ci'. This option should
72 // be removed for all other databases.
73 // 'fetchbuffersize' => 100000, // On PostgreSQL, this option sets a limit
74 // on the number of rows that are fetched into
75 // memory when doing a large recordset query
76 // (e.g. search indexing). Default is 100000.
77 // Uncomment and set to a value to change it,
78 // or zero to turn off the limit. You need to
79 // set to zero if you are using pg_bouncer in
80 // 'transaction' mode (it is fine in 'session'
81 // mode).
85 //=========================================================================
86 // 2. WEB SITE LOCATION
87 //=========================================================================
88 // Now you need to tell Moodle where it is located. Specify the full
89 // web address to where moodle has been installed. If your web site
90 // is accessible via multiple URLs then choose the most natural one
91 // that your students would use. Do not include a trailing slash
93 // If you need both intranet and Internet access please read
94 // http://docs.moodle.org/en/masquerading
96 $CFG->wwwroot = 'http://example.com/moodle';
99 //=========================================================================
100 // 3. DATA FILES LOCATION
101 //=========================================================================
102 // Now you need a place where Moodle can save uploaded files. This
103 // directory should be readable AND WRITEABLE by the web server user
104 // (usually 'nobody' or 'apache'), but it should not be accessible
105 // directly via the web.
107 // - On hosting systems you might need to make sure that your "group" has
108 // no permissions at all, but that "others" have full permissions.
110 // - On Windows systems you might specify something like 'c:\moodledata'
112 $CFG->dataroot = '/home/example/moodledata';
115 //=========================================================================
116 // 4. DATA FILES PERMISSIONS
117 //=========================================================================
118 // The following parameter sets the permissions of new directories
119 // created by Moodle within the data directory. The format is in
120 // octal format (as used by the Unix utility chmod, for example).
121 // The default is usually OK, but you may want to change it to 0750
122 // if you are concerned about world-access to the files (you will need
123 // to make sure the web server process (eg Apache) can access the files.
124 // NOTE: the prefixed 0 is important, and don't use quotes.
126 $CFG->directorypermissions = 02777;
129 //=========================================================================
130 // 5. DIRECTORY LOCATION (most people can just ignore this setting)
131 //=========================================================================
132 // A very few webhosts use /admin as a special URL for you to access a
133 // control panel or something. Unfortunately this conflicts with the
134 // standard location for the Moodle admin pages. You can work around this
135 // by renaming the admin directory in your installation, and putting that
136 // new name here. eg "moodleadmin". This should fix all admin links in Moodle.
137 // After any change you need to visit your new admin directory
138 // and purge all caches.
140 $CFG->admin = 'admin';
143 //=========================================================================
144 // 6. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
145 //=========================================================================
147 // These are additional tweaks for which no GUI exists in Moodle yet.
149 // Starting in PHP 5.3 administrators should specify default timezone
150 // in PHP.ini, you can also specify it here if needed.
151 // See details at: http://php.net/manual/en/function.date-default-timezone-set.php
152 // List of time zones at: http://php.net/manual/en/timezones.php
153 // date_default_timezone_set('Australia/Perth');
155 // Change the key pair lifetime for Moodle Networking
156 // The default is 28 days. You would only want to change this if the key
157 // was not getting regenerated for any reason. You would probably want
158 // make it much longer. Note that you'll need to delete and manually update
159 // any existing key.
160 // $CFG->mnetkeylifetime = 28;
162 // Not recommended: Set the following to true to allow the use
163 // off non-Moodle standard characters in usernames.
164 // $CFG->extendedusernamechars = true;
166 // Allow user passwords to be included in backup files. Very dangerous
167 // setting as far as it publishes password hashes that can be unencrypted
168 // if the backup file is publicy available. Use it only if you can guarantee
169 // that all your backup files remain only privacy available and are never
170 // shared out from your site/institution!
171 // $CFG->includeuserpasswordsinbackup = true;
173 // Completely disable user creation when restoring a course, bypassing any
174 // permissions granted via roles and capabilities. Enabling this setting
175 // results in the restore process stopping when a user attempts to restore a
176 // course requiring users to be created.
177 // $CFG->disableusercreationonrestore = true;
179 // Keep the temporary directories used by backup and restore without being
180 // deleted at the end of the process. Use it if you want to debug / view
181 // all the information stored there after the process has ended. Note that
182 // those directories may be deleted (after some ttl) both by cron and / or
183 // by new backup / restore invocations.
184 // $CFG->keeptempdirectoriesonbackup = true;
186 // Modify the restore process in order to force the "user checks" to assume
187 // that the backup originated from a different site, so detection of matching
188 // users is performed with different (more "relaxed") rules. Note that this is
189 // only useful if the backup file has been created using Moodle < 1.9.4 and the
190 // site has been rebuilt from scratch using backup files (not the best way btw).
191 // If you obtain user conflicts on restore, rather than enabling this setting
192 // permanently, try restoring the backup on a different site, back it up again
193 // and then restore on the target server.
194 // $CFG->forcedifferentsitecheckingusersonrestore = true;
196 // Force the backup system to continue to create backups in the legacy zip
197 // format instead of the new tgz format. Does not affect restore, which
198 // auto-detects the underlying file format.
199 // $CFG->usezipbackups = true;
201 // Prevent stats processing and hide the GUI
202 // $CFG->disablestatsprocessing = true;
204 // Setting this to true will enable admins to edit any post at any time
205 // $CFG->admineditalways = true;
207 // These variables define DEFAULT block variables for new courses
208 // If this one is set it overrides all others and is the only one used.
209 // $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
211 // These variables define the specific settings for defined course formats.
212 // They override any settings defined in the formats own config file.
213 // $CFG->defaultblocks_site = 'site_main_menu,course_list:course_summary,calendar_month';
214 // $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,course_list';
215 // $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
216 // $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
218 // These blocks are used when no other default setting is found.
219 // $CFG->defaultblocks = 'participants,activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
221 // You can specify a different class to be created for the $PAGE global, and to
222 // compute which blocks appear on each page. However, I cannot think of any good
223 // reason why you would need to change that. It just felt wrong to hard-code the
224 // the class name. You are strongly advised not to use these to settings unless
225 // you are absolutely sure you know what you are doing.
226 // $CFG->moodlepageclass = 'moodle_page';
227 // $CFG->moodlepageclassfile = "$CFG->dirroot/local/myplugin/mypageclass.php";
228 // $CFG->blockmanagerclass = 'block_manager';
229 // $CFG->blockmanagerclassfile = "$CFG->dirroot/local/myplugin/myblockamanagerclass.php";
231 // Seconds for files to remain in caches. Decrease this if you are worried
232 // about students being served outdated versions of uploaded files.
233 // $CFG->filelifetime = 60*60*6;
235 // Some web servers can offload the file serving from PHP process,
236 // comment out one the following options to enable it in Moodle:
237 // $CFG->xsendfile = 'X-Sendfile'; // Apache {@see https://tn123.org/mod_xsendfile/}
238 // $CFG->xsendfile = 'X-LIGHTTPD-send-file'; // Lighttpd {@see http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file}
239 // $CFG->xsendfile = 'X-Accel-Redirect'; // Nginx {@see http://wiki.nginx.org/XSendfile}
240 // If your X-Sendfile implementation (usually Nginx) uses directory aliases specify them
241 // in the following array setting:
242 // $CFG->xsendfilealiases = array(
243 // '/dataroot/' => $CFG->dataroot,
244 // '/cachedir/' => '/var/www/moodle/cache', // for custom $CFG->cachedir locations
245 // '/localcachedir/' => '/var/local/cache', // for custom $CFG->localcachedir locations
246 // '/tempdir/' => '/var/www/moodle/temp', // for custom $CFG->tempdir locations
247 // '/filedir' => '/var/www/moodle/filedir', // for custom $CFG->filedir locations
248 // );
250 // YUI caching may be sometimes improved by slasharguments:
251 // $CFG->yuislasharguments = 1;
252 // Some servers may need a special rewrite rule to work around internal path length limitations:
253 // RewriteRule (^.*/theme/yui_combo\.php)(/.*) $1?file=$2
256 // Following settings may be used to select session driver, uncomment only one of the handlers.
257 // Database session handler (not compatible with MyISAM):
258 // $CFG->session_handler_class = '\core\session\database';
259 // $CFG->session_database_acquire_lock_timeout = 120;
261 // File session handler (file system locking required):
262 // $CFG->session_handler_class = '\core\session\file';
263 // $CFG->session_file_save_path = $CFG->dataroot.'/sessions';
265 // Memcached session handler (requires memcached server and extension):
266 // $CFG->session_handler_class = '\core\session\memcached';
267 // $CFG->session_memcached_save_path = '127.0.0.1:11211';
268 // $CFG->session_memcached_prefix = 'memc.sess.key.';
269 // $CFG->session_memcached_acquire_lock_timeout = 120;
270 // $CFG->session_memcached_lock_expire = 7200; // Ignored if PECL memcached is below version 2.2.0
271 // $CFG->session_memcached_lock_retry_sleep = 150; // Spin-lock retry sleeptime (msec). Only effective
272 // // for tuning php-memcached 3.0.x (PHP 7)
274 // Redis session handler (requires redis server and redis extension):
275 // $CFG->session_handler_class = '\core\session\redis';
276 // $CFG->session_redis_host = '127.0.0.1';
277 // $CFG->session_redis_port = 6379; // Optional.
278 // $CFG->session_redis_database = 0; // Optional, default is db 0.
279 // $CFG->session_redis_auth = ''; // Optional, default is don't set one.
280 // $CFG->session_redis_prefix = ''; // Optional, default is don't set one.
281 // $CFG->session_redis_acquire_lock_timeout = 120;
282 // $CFG->session_redis_lock_expire = 7200;
283 // Use the igbinary serializer instead of the php default one. Note that phpredis must be compiled with
284 // igbinary support to make the setting to work. Also, if you change the serializer you have to flush the database!
285 // $CFG->session_redis_serializer_use_igbinary = false; // Optional, default is PHP builtin serializer.
287 // Memcache session handler (requires memcached server and memcache extension):
288 // $CFG->session_handler_class = '\core\session\memcache';
289 // $CFG->session_memcache_save_path = '127.0.0.1:11211';
290 // $CFG->session_memcache_acquire_lock_timeout = 120;
291 // ** NOTE: Memcache extension has less features than memcached and may be
292 // less reliable. Use memcached where possible or if you encounter
293 // session problems. **
295 // Please be aware that when selecting either Memcached or Memcache for sessions that it is advised to use a dedicated
296 // memcache server. The memcache and memcached extensions do not provide isolated environments for individual uses.
297 // Using the same server for other purposes (MUC for example) can lead to sessions being prematurely removed should
298 // the other uses of the server purge the cache.
300 // Following setting allows you to alter how frequently is timemodified updated in sessions table.
301 // $CFG->session_update_timemodified_frequency = 20; // In seconds.
303 // If this setting is set to true, then Moodle will track the IP of the
304 // current user to make sure it hasn't changed during a session. This
305 // will prevent the possibility of sessions being hijacked via XSS, but it
306 // may break things for users coming using proxies that change all the time,
307 // like AOL.
308 // $CFG->tracksessionip = true;
310 // The following lines are for handling email bounces.
311 // $CFG->handlebounces = true;
312 // $CFG->minbounces = 10;
313 // $CFG->bounceratio = .20;
314 // The next lines are needed both for bounce handling and any other email to module processing.
315 // mailprefix must be EXACTLY four characters.
316 // Uncomment and customise this block for Postfix
317 // $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
318 // $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
319 // $CFG->maildomain = 'youremaildomain.com';
321 // Enable when setting up advanced reverse proxy load balancing configurations,
322 // it may be also necessary to enable this when using port forwarding.
323 // $CFG->reverseproxy = true;
325 // Enable when using external SSL appliance for performance reasons.
326 // Please note that site may be accessible via http: or https:, but not both!
327 // $CFG->sslproxy = true;
329 // This setting will cause the userdate() function not to fix %d in
330 // date strings, and just let them show with a zero prefix.
331 // $CFG->nofixday = true;
333 // This setting will make some graphs (eg user logs) use lines instead of bars
334 // $CFG->preferlinegraphs = true;
336 // This setting allows you to specify a class to rewrite outgoing urls
337 // enabling 'clean urls' in conjunction with an apache / nginx handler.
338 // The handler must implement \core\output\url_rewriter.
339 // $CFG->urlrewriteclass = '\local_cleanurls\url_rewriter';
341 // Enabling this will allow custom scripts to replace existing moodle scripts.
342 // For example: if $CFG->customscripts/course/view.php exists then
343 // it will be used instead of $CFG->wwwroot/course/view.php
344 // At present this will only work for files that include config.php and are called
345 // as part of the url (index.php is implied).
346 // Some examples are:
347 // http://my.moodle.site/course/view.php
348 // http://my.moodle.site/index.php
349 // http://my.moodle.site/admin (index.php implied)
350 // Custom scripts should not include config.php
351 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
352 // be compatible with upgrades. Use this option only if you are aware of the risks
353 // involved.
354 // Specify the full directory path to the custom scripts
355 // $CFG->customscripts = '/home/example/customscripts';
357 // Performance profiling
359 // If you set Debug to "Yes" in the Configuration->Variables page some
360 // performance profiling data will show up on your footer (in default theme).
361 // With these settings you get more granular control over the capture
362 // and printout of the data
364 // Capture performance profiling data
365 // define('MDL_PERF' , true);
367 // Capture additional data from DB
368 // define('MDL_PERFDB' , true);
370 // Print to log (for passive profiling of production servers)
371 // define('MDL_PERFTOLOG' , true);
373 // Print to footer (works with the default theme)
374 // define('MDL_PERFTOFOOT', true);
376 // Enable earlier profiling that causes more code to be covered
377 // on every request (db connections, config load, other inits...).
378 // Requires extra configuration to be defined in config.php like:
379 // profilingincluded, profilingexcluded, profilingautofrec,
380 // profilingallowme, profilingallowall, profilinglifetime
381 // $CFG->earlyprofilingenabled = true;
383 // Force displayed usernames
384 // A little hack to anonymise user names for all students. If you set these
385 // then all non-teachers will always see these for every person.
386 // $CFG->forcefirstname = 'Bruce';
387 // $CFG->forcelastname = 'Simpson';
389 // The following setting will turn on username logging into Apache log. For full details regarding setting
390 // up of this function please refer to the install section of the document.
391 // $CFG->apacheloguser = 0; // Turn this feature off. Default value.
392 // $CFG->apacheloguser = 1; // Log user id.
393 // $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
394 // $CFG->apacheloguser = 3; // Log username.
395 // To get the values logged in Apache's log, add to your httpd.conf
396 // the following statements. In the General part put:
397 // LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
398 // And in the part specific to your Moodle install / virtualhost:
399 // CustomLog "/your/path/to/log" moodleformat
401 // Alternatively for other webservers such as nginx, you can instead have the username sent via a http header
402 // 'X-MOODLEUSER' which can be saved in the logfile and then stripped out before being sent to the browser:
403 // $CFG->headerloguser = 0; // Turn this feature off. Default value.
404 // $CFG->headerloguser = 1; // Log user id.
405 // $CFG->headerloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
406 // $CFG->headerloguser = 3; // Log username.
408 // CAUTION: Use of this option will expose usernames in the Apache / nginx log,
409 // If you are going to publish your log, or the output of your web stats analyzer
410 // this will weaken the security of your website.
412 // Email database connection errors to someone. If Moodle cannot connect to the
413 // database, then email this address with a notice.
415 // $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
417 // Set the priority of themes from highest to lowest. This is useful (for
418 // example) in sites where the user theme should override all other theme
419 // settings for accessibility reasons. You can also disable types of themes
420 // (other than site) by removing them from the array. The default setting is:
422 // $CFG->themeorder = array('course', 'category', 'session', 'user', 'cohort', 'site');
424 // NOTE: course, category, session, user, cohort themes still require the
425 // respective settings to be enabled
427 // It is possible to add extra themes directory stored outside of $CFG->dirroot.
428 // This local directory does not have to be accessible from internet.
430 // $CFG->themedir = '/location/of/extra/themes';
432 // It is possible to specify different cache and temp directories, use local fast filesystem
433 // for normal web servers. Server clusters MUST use shared filesystem for cachedir!
434 // Localcachedir is intended for server clusters, it does not have to be shared by cluster nodes.
435 // The directories must not be accessible via web.
437 // $CFG->tempdir = '/var/www/moodle/temp'; // Directory MUST BE SHARED by all cluster nodes.
438 // $CFG->cachedir = '/var/www/moodle/cache'; // Directory MUST BE SHARED by all cluster nodes, locking required.
439 // $CFG->localcachedir = '/var/local/cache'; // Intended for local node caching.
441 // It is possible to specify a different backup temp directory, use local fast filesystem
442 // for normal web servers. Server clusters MUST use shared filesystem for backuptempdir!
443 // The directory must not be accessible via web.
445 // $CFG->backuptempdir = '/var/www/moodle/backuptemp'; // Directory MUST BE SHARED by all cluster nodes.
447 // Some filesystems such as NFS may not support file locking operations.
448 // Locking resolves race conditions and is strongly recommended for production servers.
449 // $CFG->preventfilelocking = false;
451 // Site default language can be set via standard administration interface. If you
452 // want to have initial error messages for eventual database connection problems
453 // localized too, you have to set your language code here.
455 // $CFG->lang = 'yourlangcode'; // for example 'cs'
457 // When Moodle is about to perform an intensive operation it raises PHP's memory
458 // limit. The following setting should be used on large sites to set the raised
459 // memory limit to something higher.
460 // The value for the settings should be a valid PHP memory value. e.g. 512M, 1G
462 // $CFG->extramemorylimit = '1024M';
464 // Moodle 2.4 introduced a new cache API.
465 // The cache API stores a configuration file within the Moodle data directory and
466 // uses that rather than the database in order to function in a stand-alone manner.
467 // Using altcacheconfigpath you can change the location where this config file is
468 // looked for.
469 // It can either be a directory in which to store the file, or the full path to the
470 // file if you want to take full control. Either way it must be writable by the
471 // webserver.
473 // $CFG->altcacheconfigpath = '/var/www/shared/moodle.cache.config.php
475 // Use the following flag to completely disable the Available update notifications
476 // feature and hide it from the server administration UI.
478 // $CFG->disableupdatenotifications = true;
480 // Use the following flag to completely disable the installation of plugins
481 // (new plugins, available updates and missing dependencies) and related
482 // features (such as cancelling the plugin installation or upgrade) via the
483 // server administration web interface.
485 // $CFG->disableupdateautodeploy = true;
487 // Use the following flag to disable the warning on the system notifications page
488 // about present development libraries. This flag will not disable the warning within
489 // the security overview report. Use this flag only if you really have prohibited web
490 // access to the development libraries in your webserver configuration.
492 // $CFG->disabledevlibdirscheck = true;
494 // Use the following flag to disable modifications to scheduled tasks
495 // whilst still showing the state of tasks.
497 // $CFG->preventscheduledtaskchanges = true;
499 // As of version 2.4 Moodle serves icons as SVG images if the users browser appears
500 // to support SVG.
501 // For those wanting to control the serving of SVG images the following setting can
502 // be defined in your config.php.
503 // If it is not defined then the default (browser detection) will occur.
505 // To ensure they are always used when available:
506 // $CFG->svgicons = true;
508 // To ensure they are never used even when available:
509 // $CFG->svgicons = false;
511 // Some administration options allow setting the path to executable files. This can
512 // potentially cause a security risk. Set this option to true to disable editing
513 // those config settings via the web. They will need to be set explicitly in the
514 // config.php file
515 // $CFG->preventexecpath = true;
517 // Use the following flag to set userid for noreply user. If not set then moodle will
518 // create dummy user and use -ve value as user id.
519 // $CFG->noreplyuserid = -10;
521 // As of version 2.6 Moodle supports admin to set support user. If not set, all mails
522 // will be sent to supportemail.
523 // $CFG->supportuserid = -20;
525 // Moodle 2.7 introduces a locking api for critical tasks (e.g. cron).
526 // The default locking system to use is DB locking for Postgres, and file locking for
527 // MySQL, Oracle and SQLServer. If $CFG->preventfilelocking is set, then the default
528 // will always be DB locking. It can be manually set to one of the lock
529 // factory classes listed below, or one of your own custom classes implementing the
530 // \core\lock\lock_factory interface.
532 // $CFG->lock_factory = "auto";
534 // The list of available lock factories is:
536 // "\\core\\lock\\file_lock_factory" - File locking
537 // Uses lock files stored by default in the dataroot. Whether this
538 // works on clusters depends on the file system used for the dataroot.
540 // "\\core\\lock\\db_record_lock_factory" - DB locking based on table rows.
542 // "\\core\\lock\\postgres_lock_factory" - DB locking based on postgres advisory locks.
544 // Settings used by the lock factories
546 // Location for lock files used by the File locking factory. This must exist
547 // on a shared file system that supports locking.
548 // $CFG->lock_file_root = $CFG->dataroot . '/lock';
550 // Moodle 2.9 allows administrators to customise the list of supported file types.
551 // To add a new filetype or override the definition of an existing one, set the
552 // customfiletypes variable like this:
554 // $CFG->customfiletypes = array(
555 // (object)array(
556 // 'extension' => 'frog',
557 // 'icon' => 'archive',
558 // 'type' => 'application/frog',
559 // 'customdescription' => 'Amphibian-related file archive'
560 // )
561 // );
563 // The extension, icon, and type fields are required. The icon field can refer to
564 // any icon inside the pix/f folder. You can also set the customdescription field
565 // (shown above) and (for advanced use) the groups, string, and defaulticon fields.
567 // Upgrade key
569 // If the upgrade key is defined here, then the value must be provided every time
570 // the site is being upgraded though the web interface, regardless of whether the
571 // administrator is logged in or not. This prevents anonymous access to the upgrade
572 // screens where the real authentication and authorization mechanisms can not be
573 // relied on.
575 // It is strongly recommended to use a value different from your real account
576 // password.
578 // $CFG->upgradekey = 'put_some_password-like_value_here';
580 // Font used in exported PDF files. When generating a PDF, Moodle embeds a subset of
581 // the font in the PDF file so it will be readable on the widest range of devices.
582 // The default font is 'freesans' which is part of the GNU FreeFont collection.
584 // $CFG->pdfexportfont = 'freesans';
586 // Disable login token validation for login pages. Login token validation is enabled
587 // by default unless $CFG->alternateloginurl is set.
589 // $CFG->disablelogintoken = true;
591 // Document conversion limit
593 // How many times the background task should attempt to convert a given attempt
594 // before removing it from the queue. Currently this limit is only used by the
595 // mod_assign conversion task.
597 // $CFG->conversionattemptlimit = 3;
599 //=========================================================================
600 // 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
601 //=========================================================================
603 // Force a debugging mode regardless the settings in the site administration
604 // @error_reporting(E_ALL | E_STRICT); // NOT FOR PRODUCTION SERVERS!
605 // @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
606 // $CFG->debug = (E_ALL | E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS!
607 // $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS!
609 // You can specify a comma separated list of user ids that that always see
610 // debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay
611 // for these users only.
612 // $CFG->debugusers = '2';
614 // Prevent theme caching
615 // $CFG->themedesignermode = true; // NOT FOR PRODUCTION SERVERS!
617 // Enable verbose debug information during fetching of email messages from IMAP server.
618 // $CFG->debugimap = true;
620 // Prevent JS caching
621 // $CFG->cachejs = false; // NOT FOR PRODUCTION SERVERS!
623 // Restrict which YUI logging statements are shown in the browser console.
624 // For details see the upstream documentation:
625 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logInclude
626 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logExclude
627 // $CFG->yuiloginclude = array(
628 // 'moodle-core-dock-loader' => true,
629 // 'moodle-course-categoryexpander' => true,
630 // );
631 // $CFG->yuilogexclude = array(
632 // 'moodle-core-dock' => true,
633 // 'moodle-core-notification' => true,
634 // );
636 // Set the minimum log level for YUI logging statements.
637 // For details see the upstream documentation:
638 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logLevel
639 // $CFG->yuiloglevel = 'debug';
641 // Prevent core_string_manager application caching
642 // $CFG->langstringcache = false; // NOT FOR PRODUCTION SERVERS!
644 // When working with production data on test servers, no emails or other messages
645 // should ever be send to real users
646 // $CFG->noemailever = true; // NOT FOR PRODUCTION SERVERS!
648 // Divert all outgoing emails to this address to test and debug emailing features
649 // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
651 // Except for certain email addresses you want to let through for testing. Accepts
652 // a comma separated list of regexes.
653 // $CFG->divertallemailsexcept = 'tester@dev.com, fred(\+.*)?@example.com'; // NOT FOR PRODUCTION SERVERS!
655 // Uncomment if you want to allow empty comments when modifying install.xml files.
656 // $CFG->xmldbdisablecommentchecking = true; // NOT FOR PRODUCTION SERVERS!
658 // Since 2.0 sql queries are not shown during upgrade by default.
659 // Please note that this setting may produce very long upgrade page on large sites.
660 // $CFG->upgradeshowsql = true; // NOT FOR PRODUCTION SERVERS!
662 // Add SQL queries to the output of cron, just before their execution
663 // $CFG->showcronsql = true;
665 // Force developer level debug and add debug info to the output of cron
666 // $CFG->showcrondebugging = true;
668 //=========================================================================
669 // 8. FORCED SETTINGS
670 //=========================================================================
671 // It is possible to specify normal admin settings here, the point is that
672 // they can not be changed through the standard admin settings pages any more.
674 // Core settings are specified directly via assignment to $CFG variable.
675 // Example:
676 // $CFG->somecoresetting = 'value';
678 // Plugin settings have to be put into a special array.
679 // Example:
680 // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'secondsetting' => 'othervalue'),
681 // 'otherplugin' => array('mysetting' => 'myvalue', 'thesetting' => 'thevalue'));
682 // Module default settings with advanced/locked checkboxes can be set too. To do this, add
683 // an extra config with '_adv' or '_locked' as a suffix and set the value to true or false.
684 // Example:
685 // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'settingname_locked' => true, 'settingname_adv' => true));
687 //=========================================================================
688 // 9. PHPUNIT SUPPORT
689 //=========================================================================
690 // $CFG->phpunit_prefix = 'phpu_';
691 // $CFG->phpunit_dataroot = '/home/example/phpu_moodledata';
692 // $CFG->phpunit_directorypermissions = 02777; // optional
693 // $CFG->phpunit_profilingenabled = true; // optional to profile PHPUnit runs.
696 //=========================================================================
697 // 10. SECRET PASSWORD SALT
698 //=========================================================================
699 // A site-wide password salt is no longer used in new installations.
700 // If upgrading from 2.6 or older, keep all existing salts in config.php file.
702 // $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1';
704 // You may also have some alternative salts to allow migration from previously
705 // used salts.
707 // $CFG->passwordsaltalt1 = '';
708 // $CFG->passwordsaltalt2 = '';
709 // $CFG->passwordsaltalt3 = '';
710 // ....
711 // $CFG->passwordsaltalt19 = '';
712 // $CFG->passwordsaltalt20 = '';
715 //=========================================================================
716 // 11. BEHAT SUPPORT
717 //=========================================================================
718 // Behat test site needs a unique www root, data directory and database prefix:
720 // $CFG->behat_wwwroot = 'http://127.0.0.1/moodle';
721 // $CFG->behat_prefix = 'bht_';
722 // $CFG->behat_dataroot = '/home/example/bht_moodledata';
724 // You can override default Moodle configuration for Behat and add your own
725 // params; here you can add more profiles, use different Mink drivers than Selenium...
726 // These params would be merged with the default Moodle behat.yml, giving priority
727 // to the ones specified here. The array format is YAML, following the Behat
728 // params hierarchy. More info: http://docs.behat.org/guides/7.config.html
729 // Example:
730 // $CFG->behat_config = array(
731 // 'Mac-Firefox' => array(
732 // 'suites' => array (
733 // 'default' => array(
734 // 'filters' => array(
735 // 'tags' => '~@_file_upload'
736 // ),
737 // ),
738 // ),
739 // 'extensions' => array(
740 // 'Behat\MinkExtension' => array(
741 // 'selenium2' => array(
742 // 'browser' => 'firefox',
743 // 'capabilities' => array(
744 // 'platform' => 'OS X 10.6',
745 // 'version' => 20
746 // )
747 // )
748 // )
749 // )
750 // ),
751 // 'Mac-Safari' => array(
752 // 'extensions' => array(
753 // 'Behat\MinkExtension' => array(
754 // 'selenium2' => array(
755 // 'browser' => 'safari',
756 // 'capabilities' => array(
757 // 'platform' => 'OS X 10.8',
758 // 'version' => 6
759 // )
760 // )
761 // )
762 // )
763 // )
764 // );
765 // You can also use the following config to override default Moodle configuration for Behat.
766 // This config is limited to default suite and will be supported in later versions.
767 // It will have precedence over $CFG->behat_config.
768 // $CFG->behat_profiles = array(
769 // 'phantomjs' => array(
770 // 'browser' => 'phantomjs',
771 // 'tags' => '~@_file_upload&&~@_alert&&~@_bug_phantomjs',
772 // 'wd_host' => 'http://127.0.0.1:4443/wd/hub',
773 // 'capabilities' => array(
774 // 'platform' => 'Linux',
775 // 'version' => 2.1
776 // )
777 // ),
778 // );
780 // All this page's extra Moodle settings are compared against a white list of allowed settings
781 // (the basic and behat_* ones) to avoid problems with production environments. This setting can be
782 // used to expand the default white list with an array of extra settings.
783 // Example:
784 // $CFG->behat_extraallowedsettings = array('somecoresetting', ...);
786 // You should explicitly allow the usage of the deprecated behat steps, otherwise an exception will
787 // be thrown when using them. The setting is disabled by default.
788 // Example:
789 // $CFG->behat_usedeprecated = true;
791 // If you are using a slow machine, it may help to increase the timeouts that Behat uses. The
792 // following example will increase timeouts by a factor of 3 (using 30 seconds instead of 10
793 // seconds, for instance).
794 // Example:
795 // $CFG->behat_increasetimeout = 3;
797 // Including feature files from directories outside the dirroot is possible if required. The setting
798 // requires that the running user has executable permissions on all parent directories in the paths.
799 // Example:
800 // $CFG->behat_additionalfeatures = array('/home/developer/code/wipfeatures');
802 // You can make behat save several dumps when a scenario fails. The dumps currently saved are:
803 // * a dump of the DOM in it's state at the time of failure; and
804 // * a screenshot (JavaScript is required for the screenshot functionality, so not all browsers support this option)
805 // Example:
806 // $CFG->behat_faildump_path = '/my/path/to/save/failure/dumps';
808 // You can make behat pause upon failure to help you diagnose and debug problems with your tests.
810 // $CFG->behat_pause_on_fail = true;
812 // You can specify db, selenium wd_host etc. for behat parallel run by setting following variable.
813 // Example:
814 // $CFG->behat_parallel_run = array (
815 // array (
816 // 'dbtype' => 'mysqli',
817 // 'dblibrary' => 'native',
818 // 'dbhost' => 'localhost',
819 // 'dbname' => 'moodletest',
820 // 'dbuser' => 'moodle',
821 // 'dbpass' => 'moodle',
822 // 'behat_prefix' => 'mdl_',
823 // 'wd_host' => 'http://127.0.0.1:4444/wd/hub',
824 // 'behat_wwwroot' => 'http://127.0.0.1/moodle',
825 // 'behat_dataroot' => '/home/example/bht_moodledata'
826 // ),
827 // );
829 // To change name of behat parallel run site, define BEHAT_PARALLEL_SITE_NAME and parallel run sites will be suffixed
830 // with this value
831 // Example:
832 // define('BEHAT_PARALLEL_SITE_NAME', 'behatparallelsite');
834 // Command line output for parallel behat install is limited to 80 chars, if you are installing more then 4 sites and
835 // want to expand output to more then 80 chars, then define BEHAT_MAX_CMD_LINE_OUTPUT
836 // Example:
837 // define('BEHAT_MAX_CMD_LINE_OUTPUT', 120);
839 // Behat feature files will be distributed randomly between the processes by default. If you have timing file or want
840 // to create timing file then define BEHAT_FEATURE_TIMING_FILE with path to timing file. It will be updated for each
841 // run with latest time taken to execute feature.
842 // Example:
843 // define('BEHAT_FEATURE_TIMING_FILE', '/PATH_TO_TIMING_FILE/timing.json');
845 // If you don't have timing file and want some stable distribution of features, then you can use step counts to
846 // distribute the features. You can generate step file by executing php admin/tool/behat/cli/util.php --updatesteps
847 // this will update step file which is defined by BEHAT_FEATURE_STEP_FILE.
848 // Example:
849 // define('BEHAT_FEATURE_STEP_FILE', '/PATH_TO_FEATURE_STEP_COUNT_FILE/stepcount.json');
851 // Feature distribution for each process is displayed as histogram. you can disable it by setting
852 // BEHAT_DISABLE_HISTOGRAM
853 // Example:
854 // define('BEHAT_DISABLE_HISTOGRAM', true);
856 //=========================================================================
857 // 12. DEVELOPER DATA GENERATOR
858 //=========================================================================
860 // The developer data generator tool is intended to be used only in development or testing sites and
861 // it's usage in production environments is not recommended; if it is used to create JMeter test plans
862 // is even less recommended as JMeter needs to log in as site course users. JMeter needs to know the
863 // users passwords but would be dangerous to have a default password as everybody would know it, which would
864 // be specially dangerouse if somebody uses this tool in a production site, so in order to prevent unintended
865 // uses of the tool and undesired accesses as well, is compulsory to set a password for the users
866 // generated by this tool, but only in case you want to generate a JMeter test. The value should be a string.
867 // Example:
868 // $CFG->tool_generator_users_password = 'examplepassword';
870 //=========================================================================
871 // 13. SYSTEM PATHS (You need to set following, depending on your system)
872 //=========================================================================
873 // Ghostscript path.
874 // On most Linux installs, this can be left as '/usr/bin/gs'.
875 // On Windows it will be something like 'c:\gs\bin\gswin32c.exe' (make sure
876 // there are no spaces in the path - if necessary copy the files 'gswin32c.exe'
877 // and 'gsdll32.dll' to a new folder without a space in the path)
878 // $CFG->pathtogs = '/usr/bin/gs';
880 // Path to PHP CLI.
881 // Probably something like /usr/bin/php. If you enter this, cron scripts can be
882 // executed from admin web interface.
883 // $CFG->pathtophp = '';
885 // Path to du.
886 // Probably something like /usr/bin/du. If you enter this, pages that display
887 // directory contents will run much faster for directories with a lot of files.
888 // $CFG->pathtodu = '';
890 // Path to aspell.
891 // To use spell-checking within the editor, you MUST have aspell 0.50 or later
892 // installed on your server, and you must specify the correct path to access the
893 // aspell binary. On Unix/Linux systems, this path is usually /usr/bin/aspell,
894 // but it might be something else.
895 // $CFG->aspellpath = '';
897 // Path to dot.
898 // Probably something like /usr/bin/dot. To be able to generate graphics from
899 // DOT files, you must have installed the dot executable and point to it here.
900 // Note that, for now, this only used by the profiling features
901 // (Development->Profiling) built into Moodle.
902 // $CFG->pathtodot = '';
904 // Path to unoconv.
905 // Probably something like /usr/bin/unoconv. Used as a fallback to convert between document formats.
906 // Unoconv is used convert between file formats supported by LibreOffice.
907 // Use a recent version of unoconv ( >= 0.7 ), older versions have trouble running from a webserver.
908 // $CFG->pathtounoconv = '';
910 //=========================================================================
911 // 14. ALTERNATIVE FILE SYSTEM SETTINGS
912 //=========================================================================
914 // Alternative file system.
915 // Since 3.3 it is possible to override file_storage and file_system API and use alternative storage systems (e.g. S3,
916 // Rackspace Cloud Files, Google Cloud Storage, Azure Storage, etc.).
917 // To set the alternative file storage system in config.php you can use the following setting, providing the
918 // alternative system class name that will be auto-loaded by file_storage API.
920 // $CFG->alternative_file_system_class = '\\local_myfilestorage\\file_system';
922 //=========================================================================
923 // ALL DONE! To continue installation, visit your main page with a browser
924 //=========================================================================
926 require_once(__DIR__ . '/lib/setup.php'); // Do not edit
928 // There is no php closing tag in this file,
929 // it is intentional because it prevents trailing whitespace problems!