Moodle release 3.9.3
[moodle.git] / config-dist.php
blobecd56b6b6fa3f84a592511d86d7bb4327756c3af
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).
83 'connecttimeout' => null, // Set connect timeout in seconds. Not all drivers support it.
84 'readonly' => [ // Set to read-only slave details, to get safe reads
85 // from there instead of the master node. Optional.
86 // Currently supported by pgsql and mysqli variety classes.
87 // If not supported silently ignored.
88 'instance' => [ // Readonly slave connection parameters
90 'dbhost' => 'slave.dbhost',
91 'dbport' => '', // Defaults to master port
92 'dbuser' => '', // Defaults to master user
93 'dbpass' => '', // Defaults to master password
95 [...],
98 Instance(s) can alternatively be specified as:
100 'instance' => 'slave.dbhost',
101 'instance' => ['slave.dbhost1', 'slave.dbhost2'],
102 'instance' => ['dbhost' => 'slave.dbhost', 'dbport' => '', 'dbuser' => '', 'dbpass' => ''],
104 'connecttimeout' => 2, // Set read-only slave connect timeout in seconds. See above.
105 'latency' => 0.5, // Set read-only slave sync latency in seconds.
106 // When 'latency' seconds have lapsed after an update to a table
107 // it is deemed safe to use readonly slave for reading from the table.
108 // It is optional. If omitted once written to a table it will always
109 // use master handle for reading.
110 // Lower values increase the performance, but setting it too low means
111 // missing the master-slave sync.
112 'exclude_tables' => [ // Tables to exclude from read-only slave feature.
113 'table1', // Should not be used, unless in rare cases when some area of the system
114 'table2', // is malfunctioning and you still want to use readonly feature.
115 ], // Then one can exclude offending tables while investigating.
117 More info available in lib/dml/moodle_read_slave_trait.php where the feature is implemented.
120 // For all database config settings see https://docs.moodle.org/en/Database_settings
124 //=========================================================================
125 // 2. WEB SITE LOCATION
126 //=========================================================================
127 // Now you need to tell Moodle where it is located. Specify the full
128 // web address to where moodle has been installed. If your web site
129 // is accessible via multiple URLs then choose the most natural one
130 // that your students would use. Do not include a trailing slash
132 // If you need both intranet and Internet access please read
133 // http://docs.moodle.org/en/masquerading
135 $CFG->wwwroot = 'http://example.com/moodle';
138 //=========================================================================
139 // 3. DATA FILES LOCATION
140 //=========================================================================
141 // Now you need a place where Moodle can save uploaded files. This
142 // directory should be readable AND WRITEABLE by the web server user
143 // (usually 'nobody' or 'apache'), but it should not be accessible
144 // directly via the web.
146 // - On hosting systems you might need to make sure that your "group" has
147 // no permissions at all, but that "others" have full permissions.
149 // - On Windows systems you might specify something like 'c:\moodledata'
151 $CFG->dataroot = '/home/example/moodledata';
154 //=========================================================================
155 // 4. DATA FILES PERMISSIONS
156 //=========================================================================
157 // The following parameter sets the permissions of new directories
158 // created by Moodle within the data directory. The format is in
159 // octal format (as used by the Unix utility chmod, for example).
160 // The default is usually OK, but you may want to change it to 0750
161 // if you are concerned about world-access to the files (you will need
162 // to make sure the web server process (eg Apache) can access the files.
163 // NOTE: the prefixed 0 is important, and don't use quotes.
165 $CFG->directorypermissions = 02777;
168 //=========================================================================
169 // 5. DIRECTORY LOCATION (most people can just ignore this setting)
170 //=========================================================================
171 // A very few webhosts use /admin as a special URL for you to access a
172 // control panel or something. Unfortunately this conflicts with the
173 // standard location for the Moodle admin pages. You can work around this
174 // by renaming the admin directory in your installation, and putting that
175 // new name here. eg "moodleadmin". This should fix all admin links in Moodle.
176 // After any change you need to visit your new admin directory
177 // and purge all caches.
179 $CFG->admin = 'admin';
182 //=========================================================================
183 // 6. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
184 //=========================================================================
186 // These are additional tweaks for which no GUI exists in Moodle yet.
188 // Starting in PHP 5.3 administrators should specify default timezone
189 // in PHP.ini, you can also specify it here if needed.
190 // See details at: http://php.net/manual/en/function.date-default-timezone-set.php
191 // List of time zones at: http://php.net/manual/en/timezones.php
192 // date_default_timezone_set('Australia/Perth');
194 // Change the key pair lifetime for Moodle Networking
195 // The default is 28 days. You would only want to change this if the key
196 // was not getting regenerated for any reason. You would probably want
197 // make it much longer. Note that you'll need to delete and manually update
198 // any existing key.
199 // $CFG->mnetkeylifetime = 28;
201 // Not recommended: Set the following to true to allow the use
202 // off non-Moodle standard characters in usernames.
203 // $CFG->extendedusernamechars = true;
205 // Allow user passwords to be included in backup files. Very dangerous
206 // setting as far as it publishes password hashes that can be unencrypted
207 // if the backup file is publicy available. Use it only if you can guarantee
208 // that all your backup files remain only privacy available and are never
209 // shared out from your site/institution!
210 // $CFG->includeuserpasswordsinbackup = true;
212 // Completely disable user creation when restoring a course, bypassing any
213 // permissions granted via roles and capabilities. Enabling this setting
214 // results in the restore process stopping when a user attempts to restore a
215 // course requiring users to be created.
216 // $CFG->disableusercreationonrestore = true;
218 // Keep the temporary directories used by backup and restore without being
219 // deleted at the end of the process. Use it if you want to debug / view
220 // all the information stored there after the process has ended. Note that
221 // those directories may be deleted (after some ttl) both by cron and / or
222 // by new backup / restore invocations.
223 // $CFG->keeptempdirectoriesonbackup = true;
225 // Modify the restore process in order to force the "user checks" to assume
226 // that the backup originated from a different site, so detection of matching
227 // users is performed with different (more "relaxed") rules. Note that this is
228 // only useful if the backup file has been created using Moodle < 1.9.4 and the
229 // site has been rebuilt from scratch using backup files (not the best way btw).
230 // If you obtain user conflicts on restore, rather than enabling this setting
231 // permanently, try restoring the backup on a different site, back it up again
232 // and then restore on the target server.
233 // $CFG->forcedifferentsitecheckingusersonrestore = true;
235 // Force the backup system to continue to create backups in the legacy zip
236 // format instead of the new tgz format. Does not affect restore, which
237 // auto-detects the underlying file format.
238 // $CFG->usezipbackups = true;
240 // Prevent stats processing and hide the GUI
241 // $CFG->disablestatsprocessing = true;
243 // Setting this to true will enable admins to edit any post at any time
244 // $CFG->admineditalways = true;
246 // These variables define DEFAULT block variables for new courses
247 // If this one is set it overrides all others and is the only one used.
248 // $CFG->defaultblocks_override = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
250 // These variables define the specific settings for defined course formats.
251 // They override any settings defined in the formats own config file.
252 // $CFG->defaultblocks_site = 'site_main_menu,course_list:course_summary,calendar_month';
253 // $CFG->defaultblocks_social = 'search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,course_list';
254 // $CFG->defaultblocks_topics = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
255 // $CFG->defaultblocks_weeks = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
257 // These blocks are used when no other default setting is found.
258 // $CFG->defaultblocks = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity';
260 // You can specify a different class to be created for the $PAGE global, and to
261 // compute which blocks appear on each page. However, I cannot think of any good
262 // reason why you would need to change that. It just felt wrong to hard-code the
263 // the class name. You are strongly advised not to use these to settings unless
264 // you are absolutely sure you know what you are doing.
265 // $CFG->moodlepageclass = 'moodle_page';
266 // $CFG->moodlepageclassfile = "$CFG->dirroot/local/myplugin/mypageclass.php";
267 // $CFG->blockmanagerclass = 'block_manager';
268 // $CFG->blockmanagerclassfile = "$CFG->dirroot/local/myplugin/myblockamanagerclass.php";
270 // Seconds for files to remain in caches. Decrease this if you are worried
271 // about students being served outdated versions of uploaded files.
272 // $CFG->filelifetime = 60*60*6;
274 // Some web servers can offload the file serving from PHP process,
275 // comment out one the following options to enable it in Moodle:
276 // $CFG->xsendfile = 'X-Sendfile'; // Apache {@see https://tn123.org/mod_xsendfile/}
277 // $CFG->xsendfile = 'X-LIGHTTPD-send-file'; // Lighttpd {@see http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file}
278 // $CFG->xsendfile = 'X-Accel-Redirect'; // Nginx {@see http://wiki.nginx.org/XSendfile}
279 // If your X-Sendfile implementation (usually Nginx) uses directory aliases specify them
280 // in the following array setting:
281 // $CFG->xsendfilealiases = array(
282 // '/dataroot/' => $CFG->dataroot,
283 // '/cachedir/' => '/var/www/moodle/cache', // for custom $CFG->cachedir locations
284 // '/localcachedir/' => '/var/local/cache', // for custom $CFG->localcachedir locations
285 // '/tempdir/' => '/var/www/moodle/temp', // for custom $CFG->tempdir locations
286 // '/filedir' => '/var/www/moodle/filedir', // for custom $CFG->filedir locations
287 // );
289 // YUI caching may be sometimes improved by slasharguments:
290 // $CFG->yuislasharguments = 1;
291 // Some servers may need a special rewrite rule to work around internal path length limitations:
292 // RewriteRule (^.*/theme/yui_combo\.php)(/.*) $1?file=$2
295 // Following settings may be used to select session driver, uncomment only one of the handlers.
296 // Database session handler (not compatible with MyISAM):
297 // $CFG->session_handler_class = '\core\session\database';
298 // $CFG->session_database_acquire_lock_timeout = 120;
300 // File session handler (file system locking required):
301 // $CFG->session_handler_class = '\core\session\file';
302 // $CFG->session_file_save_path = $CFG->dataroot.'/sessions';
304 // Memcached session handler (requires memcached server and extension):
305 // $CFG->session_handler_class = '\core\session\memcached';
306 // $CFG->session_memcached_save_path = '127.0.0.1:11211';
307 // $CFG->session_memcached_prefix = 'memc.sess.key.';
308 // $CFG->session_memcached_acquire_lock_timeout = 120;
309 // $CFG->session_memcached_lock_expire = 7200; // Ignored if PECL memcached is below version 2.2.0
310 // $CFG->session_memcached_lock_retry_sleep = 150; // Spin-lock retry sleeptime (msec). Only effective
311 // // for tuning php-memcached 3.0.x (PHP 7)
313 // Redis session handler (requires redis server and redis extension):
314 // $CFG->session_handler_class = '\core\session\redis';
315 // $CFG->session_redis_host = '127.0.0.1';
316 // $CFG->session_redis_port = 6379; // Optional.
317 // $CFG->session_redis_database = 0; // Optional, default is db 0.
318 // $CFG->session_redis_auth = ''; // Optional, default is don't set one.
319 // $CFG->session_redis_prefix = ''; // Optional, default is don't set one.
320 // $CFG->session_redis_acquire_lock_timeout = 120;
321 // $CFG->session_redis_lock_expire = 7200;
322 // $CFG->session_redis_lock_retry = 100; // Optional wait between lock attempts in ms, default is 100.
323 // // After 5 seconds it will throttle down to once per second.
324 // Use the igbinary serializer instead of the php default one. Note that phpredis must be compiled with
325 // igbinary support to make the setting to work. Also, if you change the serializer you have to flush the database!
326 // $CFG->session_redis_serializer_use_igbinary = false; // Optional, default is PHP builtin serializer.
328 // Please be aware that when selecting Memcached for sessions that it is advised to use a dedicated
329 // memcache server. The memcached extension does not provide isolated environments for individual uses.
330 // Using the same server for other purposes (MUC for example) can lead to sessions being prematurely removed should
331 // the other uses of the server purge the cache.
333 // Following setting allows you to alter how frequently is timemodified updated in sessions table.
334 // $CFG->session_update_timemodified_frequency = 20; // In seconds.
336 // If this setting is set to true, then Moodle will track the IP of the
337 // current user to make sure it hasn't changed during a session. This
338 // will prevent the possibility of sessions being hijacked via XSS, but it
339 // may break things for users coming using proxies that change all the time,
340 // like AOL.
341 // $CFG->tracksessionip = true;
343 // The following lines are for handling email bounces.
344 // $CFG->handlebounces = true;
345 // $CFG->minbounces = 10;
346 // $CFG->bounceratio = .20;
347 // The next lines are needed both for bounce handling and any other email to module processing.
348 // mailprefix must be EXACTLY four characters.
349 // Uncomment and customise this block for Postfix
350 // $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
351 // $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
352 // $CFG->maildomain = 'youremaildomain.com';
354 // Enable when setting up advanced reverse proxy load balancing configurations,
355 // it may be also necessary to enable this when using port forwarding.
356 // $CFG->reverseproxy = true;
358 // Enable when using external SSL appliance for performance reasons.
359 // Please note that site may be accessible via http: or https:, but not both!
360 // $CFG->sslproxy = true;
362 // This setting will cause the userdate() function not to fix %d in
363 // date strings, and just let them show with a zero prefix.
364 // $CFG->nofixday = true;
366 // This setting will make some graphs (eg user logs) use lines instead of bars
367 // $CFG->preferlinegraphs = true;
369 // This setting allows you to specify a class to rewrite outgoing urls
370 // enabling 'clean urls' in conjunction with an apache / nginx handler.
371 // The handler must implement \core\output\url_rewriter.
372 // $CFG->urlrewriteclass = '\local_cleanurls\url_rewriter';
374 // Enabling this will allow custom scripts to replace existing moodle scripts.
375 // For example: if $CFG->customscripts/course/view.php exists then
376 // it will be used instead of $CFG->wwwroot/course/view.php
377 // At present this will only work for files that include config.php and are called
378 // as part of the url (index.php is implied).
379 // Some examples are:
380 // http://my.moodle.site/course/view.php
381 // http://my.moodle.site/index.php
382 // http://my.moodle.site/admin (index.php implied)
383 // Custom scripts should not include config.php
384 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
385 // be compatible with upgrades. Use this option only if you are aware of the risks
386 // involved.
387 // Specify the full directory path to the custom scripts
388 // $CFG->customscripts = '/home/example/customscripts';
390 // Performance profiling
392 // If you set Debug to "Yes" in the Configuration->Variables page some
393 // performance profiling data will show up on your footer (in default theme).
394 // With these settings you get more granular control over the capture
395 // and printout of the data
397 // Capture performance profiling data
398 // define('MDL_PERF' , true);
400 // Capture additional data from DB
401 // define('MDL_PERFDB' , true);
403 // Print to log (for passive profiling of production servers)
404 // define('MDL_PERFTOLOG' , true);
406 // Print to footer (works with the default theme)
407 // define('MDL_PERFTOFOOT', true);
409 // Enable earlier profiling that causes more code to be covered
410 // on every request (db connections, config load, other inits...).
411 // Requires extra configuration to be defined in config.php like:
412 // profilingincluded, profilingexcluded, profilingautofrec,
413 // profilingallowme, profilingallowall, profilinglifetime
414 // $CFG->earlyprofilingenabled = true;
416 // Disable database storage for profile data.
417 // When using an exernal plugin to store profiling data it is often
418 // desirable to not store the data in the database.
420 // $CFG->disableprofilingtodatabase = true;
422 // Force displayed usernames
423 // A little hack to anonymise user names for all students. If you set these
424 // then all non-teachers will always see these for every person.
425 // $CFG->forcefirstname = 'Bruce';
426 // $CFG->forcelastname = 'Simpson';
428 // The following setting will turn on username logging into Apache log. For full details regarding setting
429 // up of this function please refer to the install section of the document.
430 // $CFG->apacheloguser = 0; // Turn this feature off. Default value.
431 // $CFG->apacheloguser = 1; // Log user id.
432 // $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
433 // $CFG->apacheloguser = 3; // Log username.
434 // To get the values logged in Apache's log, add to your httpd.conf
435 // the following statements. In the General part put:
436 // LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
437 // And in the part specific to your Moodle install / virtualhost:
438 // CustomLog "/your/path/to/log" moodleformat
440 // Alternatively for other webservers such as nginx, you can instead have the username sent via a http header
441 // 'X-MOODLEUSER' which can be saved in the logfile and then stripped out before being sent to the browser:
442 // $CFG->headerloguser = 0; // Turn this feature off. Default value.
443 // $CFG->headerloguser = 1; // Log user id.
444 // $CFG->headerloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
445 // $CFG->headerloguser = 3; // Log username.
447 // CAUTION: Use of this option will expose usernames in the Apache / nginx log,
448 // If you are going to publish your log, or the output of your web stats analyzer
449 // this will weaken the security of your website.
451 // Email database connection errors to someone. If Moodle cannot connect to the
452 // database, then email this address with a notice.
454 // $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
456 // Set the priority of themes from highest to lowest. This is useful (for
457 // example) in sites where the user theme should override all other theme
458 // settings for accessibility reasons. You can also disable types of themes
459 // (other than site) by removing them from the array. The default setting is:
461 // $CFG->themeorder = array('course', 'category', 'session', 'user', 'cohort', 'site');
463 // NOTE: course, category, session, user, cohort themes still require the
464 // respective settings to be enabled
466 // It is possible to add extra themes directory stored outside of $CFG->dirroot.
467 // This local directory does not have to be accessible from internet.
469 // $CFG->themedir = '/location/of/extra/themes';
471 // It is possible to specify different cache and temp directories, use local fast filesystem
472 // for normal web servers. Server clusters MUST use shared filesystem for cachedir!
473 // Localcachedir is intended for server clusters, it does not have to be shared by cluster nodes.
474 // The directories must not be accessible via web.
476 // $CFG->tempdir = '/var/www/moodle/temp'; // Directory MUST BE SHARED by all cluster nodes.
477 // $CFG->cachedir = '/var/www/moodle/cache'; // Directory MUST BE SHARED by all cluster nodes, locking required.
478 // $CFG->localcachedir = '/var/local/cache'; // Intended for local node caching.
480 // It is possible to specify a different backup temp directory, use local fast filesystem
481 // for normal web servers. Server clusters MUST use shared filesystem for backuptempdir!
482 // The directory must not be accessible via web.
484 // $CFG->backuptempdir = '/var/www/moodle/backuptemp'; // Directory MUST BE SHARED by all cluster nodes.
486 // Some filesystems such as NFS may not support file locking operations.
487 // Locking resolves race conditions and is strongly recommended for production servers.
488 // $CFG->preventfilelocking = false;
490 // Site default language can be set via standard administration interface. If you
491 // want to have initial error messages for eventual database connection problems
492 // localized too, you have to set your language code here.
494 // $CFG->lang = 'yourlangcode'; // for example 'cs'
496 // When Moodle is about to perform an intensive operation it raises PHP's memory
497 // limit. The following setting should be used on large sites to set the raised
498 // memory limit to something higher.
499 // The value for the settings should be a valid PHP memory value. e.g. 512M, 1G
501 // $CFG->extramemorylimit = '1024M';
503 // Moodle 2.4 introduced a new cache API.
504 // The cache API stores a configuration file within the Moodle data directory and
505 // uses that rather than the database in order to function in a stand-alone manner.
506 // Using altcacheconfigpath you can change the location where this config file is
507 // looked for.
508 // It can either be a directory in which to store the file, or the full path to the
509 // file if you want to take full control. Either way it must be writable by the
510 // webserver.
512 // $CFG->altcacheconfigpath = '/var/www/shared/moodle.cache.config.php
514 // Use the following flag to completely disable the Available update notifications
515 // feature and hide it from the server administration UI.
517 // $CFG->disableupdatenotifications = true;
519 // Use the following flag to completely disable the installation of plugins
520 // (new plugins, available updates and missing dependencies) and related
521 // features (such as cancelling the plugin installation or upgrade) via the
522 // server administration web interface.
524 // $CFG->disableupdateautodeploy = true;
526 // Use the following flag to disable the warning on the system notifications page
527 // about present development libraries. This flag will not disable the warning within
528 // the security overview report. Use this flag only if you really have prohibited web
529 // access to the development libraries in your webserver configuration.
531 // $CFG->disabledevlibdirscheck = true;
533 // Use the following flag to disable modifications to scheduled tasks
534 // whilst still showing the state of tasks.
536 // $CFG->preventscheduledtaskchanges = true;
538 // As of version 2.4 Moodle serves icons as SVG images if the users browser appears
539 // to support SVG.
540 // For those wanting to control the serving of SVG images the following setting can
541 // be defined in your config.php.
542 // If it is not defined then the default (browser detection) will occur.
544 // To ensure they are always used when available:
545 // $CFG->svgicons = true;
547 // To ensure they are never used even when available:
548 // $CFG->svgicons = false;
550 // Some administration options allow setting the path to executable files. This can
551 // potentially cause a security risk. Set this option to true to disable editing
552 // those config settings via the web. They will need to be set explicitly in the
553 // config.php file
554 // $CFG->preventexecpath = true;
556 // Use the following flag to set userid for noreply user. If not set then moodle will
557 // create dummy user and use -ve value as user id.
558 // $CFG->noreplyuserid = -10;
560 // As of version 2.6 Moodle supports admin to set support user. If not set, all mails
561 // will be sent to supportemail.
562 // $CFG->supportuserid = -20;
564 // Moodle 2.7 introduces a locking api for critical tasks (e.g. cron).
565 // The default locking system to use is DB locking for Postgres, MySQL, MariaDB and
566 // file locking for Oracle and SQLServer. If $CFG->preventfilelocking is set, then the
567 // default will always be DB locking. It can be manually set to one of the lock
568 // factory classes listed below, or one of your own custom classes implementing the
569 // \core\lock\lock_factory interface.
571 // $CFG->lock_factory = "auto";
573 // The list of available lock factories is:
575 // "\\core\\lock\\file_lock_factory" - File locking
576 // Uses lock files stored by default in the dataroot. Whether this
577 // works on clusters depends on the file system used for the dataroot.
579 // "\\core\\lock\\db_record_lock_factory" - DB locking based on table rows.
581 // "\\core\\lock\\mysql_lock_factory" - DB locking based on MySQL / MariaDB locks.
583 // "\\core\\lock\\postgres_lock_factory" - DB locking based on postgres advisory locks.
585 // Settings used by the lock factories
587 // Location for lock files used by the File locking factory. This must exist
588 // on a shared file system that supports locking.
589 // $CFG->file_lock_root = $CFG->dataroot . '/lock';
592 // Alternative task logging.
593 // Since Moodle 3.7 the output of al scheduled and adhoc tasks is stored in the database and it is possible to use an
594 // alternative task logging mechanism.
595 // To set the alternative task logging mechanism in config.php you can use the following settings, providing the
596 // alternative class name that will be auto-loaded.
598 // $CFG->task_log_class = '\\local_mytasklogger\\logger';
600 // Moodle 2.9 allows administrators to customise the list of supported file types.
601 // To add a new filetype or override the definition of an existing one, set the
602 // customfiletypes variable like this:
604 // $CFG->customfiletypes = array(
605 // (object)array(
606 // 'extension' => 'frog',
607 // 'icon' => 'archive',
608 // 'type' => 'application/frog',
609 // 'customdescription' => 'Amphibian-related file archive'
610 // )
611 // );
613 // The extension, icon, and type fields are required. The icon field can refer to
614 // any icon inside the pix/f folder. You can also set the customdescription field
615 // (shown above) and (for advanced use) the groups, string, and defaulticon fields.
617 // Upgrade key
619 // If the upgrade key is defined here, then the value must be provided every time
620 // the site is being upgraded though the web interface, regardless of whether the
621 // administrator is logged in or not. This prevents anonymous access to the upgrade
622 // screens where the real authentication and authorization mechanisms can not be
623 // relied on.
625 // It is strongly recommended to use a value different from your real account
626 // password.
628 // $CFG->upgradekey = 'put_some_password-like_value_here';
630 // Document conversion limit
632 // How many times the background task should attempt to convert a given attempt
633 // before removing it from the queue. Currently this limit is only used by the
634 // mod_assign conversion task.
636 // $CFG->conversionattemptlimit = 3;
638 // Font used in exported PDF files. When generating a PDF, Moodle embeds a subset of
639 // the font in the PDF file so it will be readable on the widest range of devices.
640 // The default font is 'freesans' which is part of the GNU FreeFont collection.
642 // $CFG->pdfexportfont = 'freesans';
644 // Use the following flag to enable messagingallusers and set the default preference
645 // value for existing users to allow them to be contacted by other site users.
647 // $CFG->keepmessagingallusersenabled = true;
649 // Disable login token validation for login pages. Login token validation is enabled
650 // by default unless $CFG->alternateloginurl is set.
652 // $CFG->disablelogintoken = true;
654 // Moodle 3.7+ checks that cron is running frequently. If the time between cron runs
655 // is greater than this value (in seconds), you get a warning on the admin page. (This
656 // setting only controls whether or not the warning appears, it has no other effect.)
658 // $CFG->expectedcronfrequency = 200;
660 // Moodle 3.9+ checks how old tasks are in the ad hoc queue and warns at 10 minutes
661 // and errors at 4 hours. Set these to override these limits:
663 // $CFG->adhoctaskagewarn = 10 * 60;
664 // $CFG->adhoctaskageerror = 4 * 60 * 60;
666 // Session lock warning threshold. Long running pages should release the session using \core\session\manager::write_close().
667 // Set this threshold to any value greater than 0 to add developer warnings when a page locks the session for too long.
668 // The session should rarely be locked for more than 1 second. The input should be in seconds and may be a float.
670 // $CFG->debugsessionlock = 5;
672 // There are times when a session lock is not required during a request. For a page/service to opt-in whether or not a
673 // session lock is required this setting must first be set to 'true'.
674 // This is an experimental issue. The session store can not be in the session, please
675 // see https://docs.moodle.org/en/Session_handling#Read_only_sessions.
677 // $CFG->enable_read_only_sessions = true;
679 // Uninstall plugins from CLI only. This stops admins from uninstalling plugins from the graphical admin
680 // user interface, and forces plugins to be uninstalled from the Command Line tool only, found at
681 // admin/cli/plugin_uninstall.php.
683 // $CFG->uninstallclionly = true;
686 // Customise question bank display
688 // The display of Moodle's question bank is made up of a number of columns.
689 // You can customise this display by giving a comma-separated list of column class
690 // names here. Each class must be a subclass of \core_question\bank\column_base.
691 // For example you might define a class like
692 // class \local_qbank_extensions\my_column extends \core_question\bank\column_base
693 // in a local plugin, then add it to the list here. At the time of writing,
694 // the default question bank display is equivalent to the following, but you might like
695 // to check the latest default in question/classes/bank/view.php before setting this.
697 // $CFG->questionbankcolumns = 'checkbox_column,question_type_column,'
698 // . 'question_name_idnumber_tags_column,edit_menu_column,'
699 // . 'tags_action_column,edit_action_column,copy_action_column,'
700 // . 'preview_action_column,delete_action_column,export_xml_action_column,'
701 // . 'creator_name_column,modifier_name_column';
703 // Forum summary report
705 // In order for the forum summary report to calculate word count and character count data, those details are now stored
706 // for each post in the database when posts are created or updated. For posts that existed prior to a Moodle 3.8 upgrade,
707 // these are calculated by the refresh_forum_post_counts ad-hoc task in chunks of 5000 posts per batch by default.
708 // That default can be overridden by setting an integer value for $CFG->forumpostcountchunksize.
710 // $CFG->forumpostcountchunksize = 5000;
712 //=========================================================================
713 // 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
714 //=========================================================================
716 // Force a debugging mode regardless the settings in the site administration
717 // @error_reporting(E_ALL | E_STRICT); // NOT FOR PRODUCTION SERVERS!
718 // @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
719 // $CFG->debug = (E_ALL | E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS!
720 // $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS!
722 // You can specify a comma separated list of user ids that that always see
723 // debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay
724 // for these users only.
725 // $CFG->debugusers = '2';
727 // Prevent theme caching
728 // $CFG->themedesignermode = true; // NOT FOR PRODUCTION SERVERS!
730 // Enable verbose debug information during fetching of email messages from IMAP server.
731 // $CFG->debugimap = true;
733 // Enable verbose debug information during sending of email messages to SMTP server.
734 // Note: also requires $CFG->debug set to DEBUG_DEVELOPER.
735 // $CFG->debugsmtp = true;
737 // Prevent JS caching
738 // $CFG->cachejs = false; // NOT FOR PRODUCTION SERVERS!
740 // Prevent Template caching
741 // $CFG->cachetemplates = false; // NOT FOR PRODUCTION SERVERS!
743 // Restrict which YUI logging statements are shown in the browser console.
744 // For details see the upstream documentation:
745 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logInclude
746 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logExclude
747 // $CFG->yuiloginclude = array(
748 // 'moodle-course-categoryexpander' => true,
749 // );
750 // $CFG->yuilogexclude = array(
751 // 'moodle-core-notification' => true,
752 // );
754 // Set the minimum log level for YUI logging statements.
755 // For details see the upstream documentation:
756 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logLevel
757 // $CFG->yuiloglevel = 'debug';
759 // Prevent core_string_manager application caching
760 // $CFG->langstringcache = false; // NOT FOR PRODUCTION SERVERS!
762 // When working with production data on test servers, no emails or other messages
763 // should ever be send to real users
764 // $CFG->noemailever = true; // NOT FOR PRODUCTION SERVERS!
766 // Divert all outgoing emails to this address to test and debug emailing features
767 // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
769 // Except for certain email addresses you want to let through for testing. Accepts
770 // a comma separated list of regexes.
771 // $CFG->divertallemailsexcept = 'tester@dev.com, fred(\+.*)?@example.com'; // NOT FOR PRODUCTION SERVERS!
773 // Uncomment if you want to allow empty comments when modifying install.xml files.
774 // $CFG->xmldbdisablecommentchecking = true; // NOT FOR PRODUCTION SERVERS!
776 // Since 2.0 sql queries are not shown during upgrade by default.
777 // Please note that this setting may produce very long upgrade page on large sites.
778 // $CFG->upgradeshowsql = true; // NOT FOR PRODUCTION SERVERS!
780 // Add SQL queries to the output of cron, just before their execution
781 // $CFG->showcronsql = true;
783 // Force developer level debug and add debug info to the output of cron
784 // $CFG->showcrondebugging = true;
786 // Force result of checks used to determine whether a site is considered "public" or not (such as for site registration).
787 // $CFG->site_is_public = false;
789 //=========================================================================
790 // 8. FORCED SETTINGS
791 //=========================================================================
792 // It is possible to specify normal admin settings here, the point is that
793 // they can not be changed through the standard admin settings pages any more.
795 // Core settings are specified directly via assignment to $CFG variable.
796 // Example:
797 // $CFG->somecoresetting = 'value';
799 // Plugin settings have to be put into a special array.
800 // Example:
801 // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'secondsetting' => 'othervalue'),
802 // 'otherplugin' => array('mysetting' => 'myvalue', 'thesetting' => 'thevalue'));
803 // Module default settings with advanced/locked checkboxes can be set too. To do this, add
804 // an extra config with '_adv' or '_locked' as a suffix and set the value to true or false.
805 // Example:
806 // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'settingname_locked' => true, 'settingname_adv' => true));
808 //=========================================================================
809 // 9. PHPUNIT SUPPORT
810 //=========================================================================
811 // $CFG->phpunit_prefix = 'phpu_';
812 // $CFG->phpunit_dataroot = '/home/example/phpu_moodledata';
813 // $CFG->phpunit_directorypermissions = 02777; // optional
814 // $CFG->phpunit_profilingenabled = true; // optional to profile PHPUnit runs.
817 //=========================================================================
818 // 10. SECRET PASSWORD SALT
819 //=========================================================================
820 // A site-wide password salt is no longer used in new installations.
821 // If upgrading from 2.6 or older, keep all existing salts in config.php file.
823 // $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1';
825 // You may also have some alternative salts to allow migration from previously
826 // used salts.
828 // $CFG->passwordsaltalt1 = '';
829 // $CFG->passwordsaltalt2 = '';
830 // $CFG->passwordsaltalt3 = '';
831 // ....
832 // $CFG->passwordsaltalt19 = '';
833 // $CFG->passwordsaltalt20 = '';
836 //=========================================================================
837 // 11. BEHAT SUPPORT
838 //=========================================================================
839 // Behat test site needs a unique www root, data directory and database prefix:
841 // $CFG->behat_wwwroot = 'http://127.0.0.1/moodle';
842 // $CFG->behat_prefix = 'bht_';
843 // $CFG->behat_dataroot = '/home/example/bht_moodledata';
845 // You can override default Moodle configuration for Behat and add your own
846 // params; here you can add more profiles, use different Mink drivers than Selenium...
847 // These params would be merged with the default Moodle behat.yml, giving priority
848 // to the ones specified here. The array format is YAML, following the Behat
849 // params hierarchy. More info: http://docs.behat.org/guides/7.config.html
850 // Example:
851 // $CFG->behat_config = array(
852 // 'Mac-Firefox' => array(
853 // 'suites' => array (
854 // 'default' => array(
855 // 'filters' => array(
856 // 'tags' => '~@_file_upload'
857 // ),
858 // ),
859 // ),
860 // 'extensions' => array(
861 // 'Behat\MinkExtension' => array(
862 // 'selenium2' => array(
863 // 'browser' => 'firefox',
864 // 'capabilities' => array(
865 // 'platform' => 'OS X 10.6',
866 // 'version' => 20
867 // )
868 // )
869 // )
870 // )
871 // ),
872 // 'Mac-Safari' => array(
873 // 'extensions' => array(
874 // 'Behat\MinkExtension' => array(
875 // 'selenium2' => array(
876 // 'browser' => 'safari',
877 // 'capabilities' => array(
878 // 'platform' => 'OS X 10.8',
879 // 'version' => 6
880 // )
881 // )
882 // )
883 // )
884 // )
885 // );
886 // You can also use the following config to override default Moodle configuration for Behat.
887 // This config is limited to default suite and will be supported in later versions.
888 // It will have precedence over $CFG->behat_config.
889 // $CFG->behat_profiles = array(
890 // 'phantomjs' => array(
891 // 'browser' => 'phantomjs',
892 // 'tags' => '~@_file_upload&&~@_alert&&~@_bug_phantomjs',
893 // 'wd_host' => 'http://127.0.0.1:4443/wd/hub',
894 // 'capabilities' => array(
895 // 'platform' => 'Linux',
896 // 'version' => 2.1
897 // )
898 // ),
899 // );
901 // All this page's extra Moodle settings are compared against a white list of allowed settings
902 // (the basic and behat_* ones) to avoid problems with production environments. This setting can be
903 // used to expand the default white list with an array of extra settings.
904 // Example:
905 // $CFG->behat_extraallowedsettings = array('somecoresetting', ...);
907 // You should explicitly allow the usage of the deprecated behat steps, otherwise an exception will
908 // be thrown when using them. The setting is disabled by default.
909 // Example:
910 // $CFG->behat_usedeprecated = true;
912 // If you are using a slow machine, it may help to increase the timeouts that Behat uses. The
913 // following example will increase timeouts by a factor of 3 (using 30 seconds instead of 10
914 // seconds, for instance).
915 // Example:
916 // $CFG->behat_increasetimeout = 3;
918 // Including feature files from directories outside the dirroot is possible if required. The setting
919 // requires that the running user has executable permissions on all parent directories in the paths.
920 // Example:
921 // $CFG->behat_additionalfeatures = array('/home/developer/code/wipfeatures');
923 // You can make behat save several dumps when a scenario fails. The dumps currently saved are:
924 // * a dump of the DOM in it's state at the time of failure; and
925 // * a screenshot (JavaScript is required for the screenshot functionality, so not all browsers support this option)
926 // Example:
927 // $CFG->behat_faildump_path = '/my/path/to/save/failure/dumps';
929 // You can make behat pause upon failure to help you diagnose and debug problems with your tests.
931 // $CFG->behat_pause_on_fail = true;
933 // You can specify db, selenium wd_host etc. for behat parallel run by setting following variable.
934 // Example:
935 // $CFG->behat_parallel_run = array (
936 // array (
937 // 'dbtype' => 'mysqli',
938 // 'dblibrary' => 'native',
939 // 'dbhost' => 'localhost',
940 // 'dbname' => 'moodletest',
941 // 'dbuser' => 'moodle',
942 // 'dbpass' => 'moodle',
943 // 'behat_prefix' => 'mdl_',
944 // 'wd_host' => 'http://127.0.0.1:4444/wd/hub',
945 // 'behat_wwwroot' => 'http://127.0.0.1/moodle',
946 // 'behat_dataroot' => '/home/example/bht_moodledata'
947 // ),
948 // );
950 // To change name of behat parallel run site, define BEHAT_PARALLEL_SITE_NAME and parallel run sites will be suffixed
951 // with this value
952 // Example:
953 // define('BEHAT_PARALLEL_SITE_NAME', 'behatparallelsite');
955 // Command line output for parallel behat install is limited to 80 chars, if you are installing more then 4 sites and
956 // want to expand output to more then 80 chars, then define BEHAT_MAX_CMD_LINE_OUTPUT
957 // Example:
958 // define('BEHAT_MAX_CMD_LINE_OUTPUT', 120);
960 // Behat feature files will be distributed randomly between the processes by default. If you have timing file or want
961 // to create timing file then define BEHAT_FEATURE_TIMING_FILE with path to timing file. It will be updated for each
962 // run with latest time taken to execute feature.
963 // Example:
964 // define('BEHAT_FEATURE_TIMING_FILE', '/PATH_TO_TIMING_FILE/timing.json');
966 // If you don't have timing file and want some stable distribution of features, then you can use step counts to
967 // distribute the features. You can generate step file by executing php admin/tool/behat/cli/util.php --updatesteps
968 // this will update step file which is defined by BEHAT_FEATURE_STEP_FILE.
969 // Example:
970 // define('BEHAT_FEATURE_STEP_FILE', '/PATH_TO_FEATURE_STEP_COUNT_FILE/stepcount.json');
972 // Feature distribution for each process is displayed as histogram. you can disable it by setting
973 // BEHAT_DISABLE_HISTOGRAM
974 // Example:
975 // define('BEHAT_DISABLE_HISTOGRAM', true);
977 // Mobile app Behat testing requires this option, pointing to a developer Moodle app directory:
978 // $CFG->behat_ionic_dirroot = '/where/I/keep/my/git/checkouts/moodleapp';
980 // The following option can be used to indicate a running Ionic server (otherwise Behat will start
981 // one automatically for each test run, which is convenient but takes ages):
982 // $CFG->behat_ionic_wwwroot = 'http://localhost:8100';
984 //=========================================================================
985 // 12. DEVELOPER DATA GENERATOR
986 //=========================================================================
988 // The developer data generator tool is intended to be used only in development or testing sites and
989 // it's usage in production environments is not recommended; if it is used to create JMeter test plans
990 // is even less recommended as JMeter needs to log in as site course users. JMeter needs to know the
991 // users passwords but would be dangerous to have a default password as everybody would know it, which would
992 // be specially dangerouse if somebody uses this tool in a production site, so in order to prevent unintended
993 // uses of the tool and undesired accesses as well, is compulsory to set a password for the users
994 // generated by this tool, but only in case you want to generate a JMeter test. The value should be a string.
995 // Example:
996 // $CFG->tool_generator_users_password = 'examplepassword';
998 //=========================================================================
999 // 13. SYSTEM PATHS (You need to set following, depending on your system)
1000 //=========================================================================
1001 // Ghostscript path.
1002 // On most Linux installs, this can be left as '/usr/bin/gs'.
1003 // On Windows it will be something like 'c:\gs\bin\gswin32c.exe' (make sure
1004 // there are no spaces in the path - if necessary copy the files 'gswin32c.exe'
1005 // and 'gsdll32.dll' to a new folder without a space in the path)
1006 // $CFG->pathtogs = '/usr/bin/gs';
1008 // Path to PHP CLI.
1009 // Probably something like /usr/bin/php. If you enter this, cron scripts can be
1010 // executed from admin web interface.
1011 // $CFG->pathtophp = '';
1013 // Path to du.
1014 // Probably something like /usr/bin/du. If you enter this, pages that display
1015 // directory contents will run much faster for directories with a lot of files.
1016 // $CFG->pathtodu = '';
1018 // Path to aspell.
1019 // To use spell-checking within the editor, you MUST have aspell 0.50 or later
1020 // installed on your server, and you must specify the correct path to access the
1021 // aspell binary. On Unix/Linux systems, this path is usually /usr/bin/aspell,
1022 // but it might be something else.
1023 // $CFG->aspellpath = '';
1025 // Path to dot.
1026 // Probably something like /usr/bin/dot. To be able to generate graphics from
1027 // DOT files, you must have installed the dot executable and point to it here.
1028 // Note that, for now, this only used by the profiling features
1029 // (Development->Profiling) built into Moodle.
1030 // $CFG->pathtodot = '';
1032 // Path to unoconv.
1033 // Probably something like /usr/bin/unoconv. Used as a fallback to convert between document formats.
1034 // Unoconv is used convert between file formats supported by LibreOffice.
1035 // Use a recent version of unoconv ( >= 0.7 ), older versions have trouble running from a webserver.
1036 // $CFG->pathtounoconv = '';
1038 //=========================================================================
1039 // 14. ALTERNATIVE FILE SYSTEM SETTINGS
1040 //=========================================================================
1042 // Alternative file system.
1043 // Since 3.3 it is possible to override file_storage and file_system API and use alternative storage systems (e.g. S3,
1044 // Rackspace Cloud Files, Google Cloud Storage, Azure Storage, etc.).
1045 // To set the alternative file storage system in config.php you can use the following setting, providing the
1046 // alternative system class name that will be auto-loaded by file_storage API.
1048 // $CFG->alternative_file_system_class = '\\local_myfilestorage\\file_system';
1050 //=========================================================================
1051 // 15. CAMPAIGN CONTENT
1052 //=========================================================================
1054 // We have added a campaign content to the notifications page, in case you want to hide that from your site you just
1055 // need to set showcampaigncontent setting to false.
1057 // $CFG->showcampaigncontent = true;
1059 //=========================================================================
1060 // ALL DONE! To continue installation, visit your main page with a browser
1061 //=========================================================================
1063 require_once(__DIR__ . '/lib/setup.php'); // Do not edit
1065 // There is no php closing tag in this file,
1066 // it is intentional because it prevents trailing whitespace problems!