Merge branch 'MDL-65864' of git://github.com/timhunt/moodle
[moodle.git] / config-dist.php
blob5f4258a3b16449ed3b70e3845b0f489085c9ad55
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 // Please be aware that when selecting Memcached for sessions that it is advised to use a dedicated
288 // memcache server. The memcached extension does not provide isolated environments for individual uses.
289 // Using the same server for other purposes (MUC for example) can lead to sessions being prematurely removed should
290 // the other uses of the server purge the cache.
292 // Following setting allows you to alter how frequently is timemodified updated in sessions table.
293 // $CFG->session_update_timemodified_frequency = 20; // In seconds.
295 // If this setting is set to true, then Moodle will track the IP of the
296 // current user to make sure it hasn't changed during a session. This
297 // will prevent the possibility of sessions being hijacked via XSS, but it
298 // may break things for users coming using proxies that change all the time,
299 // like AOL.
300 // $CFG->tracksessionip = true;
302 // The following lines are for handling email bounces.
303 // $CFG->handlebounces = true;
304 // $CFG->minbounces = 10;
305 // $CFG->bounceratio = .20;
306 // The next lines are needed both for bounce handling and any other email to module processing.
307 // mailprefix must be EXACTLY four characters.
308 // Uncomment and customise this block for Postfix
309 // $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
310 // $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
311 // $CFG->maildomain = 'youremaildomain.com';
313 // Enable when setting up advanced reverse proxy load balancing configurations,
314 // it may be also necessary to enable this when using port forwarding.
315 // $CFG->reverseproxy = true;
317 // Enable when using external SSL appliance for performance reasons.
318 // Please note that site may be accessible via http: or https:, but not both!
319 // $CFG->sslproxy = true;
321 // This setting will cause the userdate() function not to fix %d in
322 // date strings, and just let them show with a zero prefix.
323 // $CFG->nofixday = true;
325 // This setting will make some graphs (eg user logs) use lines instead of bars
326 // $CFG->preferlinegraphs = true;
328 // This setting allows you to specify a class to rewrite outgoing urls
329 // enabling 'clean urls' in conjunction with an apache / nginx handler.
330 // The handler must implement \core\output\url_rewriter.
331 // $CFG->urlrewriteclass = '\local_cleanurls\url_rewriter';
333 // Enabling this will allow custom scripts to replace existing moodle scripts.
334 // For example: if $CFG->customscripts/course/view.php exists then
335 // it will be used instead of $CFG->wwwroot/course/view.php
336 // At present this will only work for files that include config.php and are called
337 // as part of the url (index.php is implied).
338 // Some examples are:
339 // http://my.moodle.site/course/view.php
340 // http://my.moodle.site/index.php
341 // http://my.moodle.site/admin (index.php implied)
342 // Custom scripts should not include config.php
343 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
344 // be compatible with upgrades. Use this option only if you are aware of the risks
345 // involved.
346 // Specify the full directory path to the custom scripts
347 // $CFG->customscripts = '/home/example/customscripts';
349 // Performance profiling
351 // If you set Debug to "Yes" in the Configuration->Variables page some
352 // performance profiling data will show up on your footer (in default theme).
353 // With these settings you get more granular control over the capture
354 // and printout of the data
356 // Capture performance profiling data
357 // define('MDL_PERF' , true);
359 // Capture additional data from DB
360 // define('MDL_PERFDB' , true);
362 // Print to log (for passive profiling of production servers)
363 // define('MDL_PERFTOLOG' , true);
365 // Print to footer (works with the default theme)
366 // define('MDL_PERFTOFOOT', true);
368 // Enable earlier profiling that causes more code to be covered
369 // on every request (db connections, config load, other inits...).
370 // Requires extra configuration to be defined in config.php like:
371 // profilingincluded, profilingexcluded, profilingautofrec,
372 // profilingallowme, profilingallowall, profilinglifetime
373 // $CFG->earlyprofilingenabled = true;
375 // Disable database storage for profile data.
376 // When using an exernal plugin to store profiling data it is often
377 // desirable to not store the data in the database.
379 // $CFG->disableprofilingtodatabase = true;
381 // Force displayed usernames
382 // A little hack to anonymise user names for all students. If you set these
383 // then all non-teachers will always see these for every person.
384 // $CFG->forcefirstname = 'Bruce';
385 // $CFG->forcelastname = 'Simpson';
387 // The following setting will turn on username logging into Apache log. For full details regarding setting
388 // up of this function please refer to the install section of the document.
389 // $CFG->apacheloguser = 0; // Turn this feature off. Default value.
390 // $CFG->apacheloguser = 1; // Log user id.
391 // $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
392 // $CFG->apacheloguser = 3; // Log username.
393 // To get the values logged in Apache's log, add to your httpd.conf
394 // the following statements. In the General part put:
395 // LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
396 // And in the part specific to your Moodle install / virtualhost:
397 // CustomLog "/your/path/to/log" moodleformat
399 // Alternatively for other webservers such as nginx, you can instead have the username sent via a http header
400 // 'X-MOODLEUSER' which can be saved in the logfile and then stripped out before being sent to the browser:
401 // $CFG->headerloguser = 0; // Turn this feature off. Default value.
402 // $CFG->headerloguser = 1; // Log user id.
403 // $CFG->headerloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
404 // $CFG->headerloguser = 3; // Log username.
406 // CAUTION: Use of this option will expose usernames in the Apache / nginx log,
407 // If you are going to publish your log, or the output of your web stats analyzer
408 // this will weaken the security of your website.
410 // Email database connection errors to someone. If Moodle cannot connect to the
411 // database, then email this address with a notice.
413 // $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
415 // Set the priority of themes from highest to lowest. This is useful (for
416 // example) in sites where the user theme should override all other theme
417 // settings for accessibility reasons. You can also disable types of themes
418 // (other than site) by removing them from the array. The default setting is:
420 // $CFG->themeorder = array('course', 'category', 'session', 'user', 'cohort', 'site');
422 // NOTE: course, category, session, user, cohort themes still require the
423 // respective settings to be enabled
425 // It is possible to add extra themes directory stored outside of $CFG->dirroot.
426 // This local directory does not have to be accessible from internet.
428 // $CFG->themedir = '/location/of/extra/themes';
430 // It is possible to specify different cache and temp directories, use local fast filesystem
431 // for normal web servers. Server clusters MUST use shared filesystem for cachedir!
432 // Localcachedir is intended for server clusters, it does not have to be shared by cluster nodes.
433 // The directories must not be accessible via web.
435 // $CFG->tempdir = '/var/www/moodle/temp'; // Directory MUST BE SHARED by all cluster nodes.
436 // $CFG->cachedir = '/var/www/moodle/cache'; // Directory MUST BE SHARED by all cluster nodes, locking required.
437 // $CFG->localcachedir = '/var/local/cache'; // Intended for local node caching.
439 // It is possible to specify a different backup temp directory, use local fast filesystem
440 // for normal web servers. Server clusters MUST use shared filesystem for backuptempdir!
441 // The directory must not be accessible via web.
443 // $CFG->backuptempdir = '/var/www/moodle/backuptemp'; // Directory MUST BE SHARED by all cluster nodes.
445 // Some filesystems such as NFS may not support file locking operations.
446 // Locking resolves race conditions and is strongly recommended for production servers.
447 // $CFG->preventfilelocking = false;
449 // Site default language can be set via standard administration interface. If you
450 // want to have initial error messages for eventual database connection problems
451 // localized too, you have to set your language code here.
453 // $CFG->lang = 'yourlangcode'; // for example 'cs'
455 // When Moodle is about to perform an intensive operation it raises PHP's memory
456 // limit. The following setting should be used on large sites to set the raised
457 // memory limit to something higher.
458 // The value for the settings should be a valid PHP memory value. e.g. 512M, 1G
460 // $CFG->extramemorylimit = '1024M';
462 // Moodle 2.4 introduced a new cache API.
463 // The cache API stores a configuration file within the Moodle data directory and
464 // uses that rather than the database in order to function in a stand-alone manner.
465 // Using altcacheconfigpath you can change the location where this config file is
466 // looked for.
467 // It can either be a directory in which to store the file, or the full path to the
468 // file if you want to take full control. Either way it must be writable by the
469 // webserver.
471 // $CFG->altcacheconfigpath = '/var/www/shared/moodle.cache.config.php
473 // Use the following flag to completely disable the Available update notifications
474 // feature and hide it from the server administration UI.
476 // $CFG->disableupdatenotifications = true;
478 // Use the following flag to completely disable the installation of plugins
479 // (new plugins, available updates and missing dependencies) and related
480 // features (such as cancelling the plugin installation or upgrade) via the
481 // server administration web interface.
483 // $CFG->disableupdateautodeploy = true;
485 // Use the following flag to disable the warning on the system notifications page
486 // about present development libraries. This flag will not disable the warning within
487 // the security overview report. Use this flag only if you really have prohibited web
488 // access to the development libraries in your webserver configuration.
490 // $CFG->disabledevlibdirscheck = true;
492 // Use the following flag to disable modifications to scheduled tasks
493 // whilst still showing the state of tasks.
495 // $CFG->preventscheduledtaskchanges = true;
497 // As of version 2.4 Moodle serves icons as SVG images if the users browser appears
498 // to support SVG.
499 // For those wanting to control the serving of SVG images the following setting can
500 // be defined in your config.php.
501 // If it is not defined then the default (browser detection) will occur.
503 // To ensure they are always used when available:
504 // $CFG->svgicons = true;
506 // To ensure they are never used even when available:
507 // $CFG->svgicons = false;
509 // Some administration options allow setting the path to executable files. This can
510 // potentially cause a security risk. Set this option to true to disable editing
511 // those config settings via the web. They will need to be set explicitly in the
512 // config.php file
513 // $CFG->preventexecpath = true;
515 // Use the following flag to set userid for noreply user. If not set then moodle will
516 // create dummy user and use -ve value as user id.
517 // $CFG->noreplyuserid = -10;
519 // As of version 2.6 Moodle supports admin to set support user. If not set, all mails
520 // will be sent to supportemail.
521 // $CFG->supportuserid = -20;
523 // Moodle 2.7 introduces a locking api for critical tasks (e.g. cron).
524 // The default locking system to use is DB locking for Postgres, and file locking for
525 // MySQL, Oracle and SQLServer. If $CFG->preventfilelocking is set, then the default
526 // will always be DB locking. It can be manually set to one of the lock
527 // factory classes listed below, or one of your own custom classes implementing the
528 // \core\lock\lock_factory interface.
530 // $CFG->lock_factory = "auto";
532 // The list of available lock factories is:
534 // "\\core\\lock\\file_lock_factory" - File locking
535 // Uses lock files stored by default in the dataroot. Whether this
536 // works on clusters depends on the file system used for the dataroot.
538 // "\\core\\lock\\db_record_lock_factory" - DB locking based on table rows.
540 // "\\core\\lock\\postgres_lock_factory" - DB locking based on postgres advisory locks.
542 // Settings used by the lock factories
544 // Location for lock files used by the File locking factory. This must exist
545 // on a shared file system that supports locking.
546 // $CFG->lock_file_root = $CFG->dataroot . '/lock';
549 // Alternative task logging.
550 // Since Moodle 3.7 the output of al scheduled and adhoc tasks is stored in the database and it is possible to use an
551 // alternative task logging mechanism.
552 // To set the alternative task logging mechanism in config.php you can use the following settings, providing the
553 // alternative class name that will be auto-loaded.
555 // $CFG->task_log_class = '\\local_mytasklogger\\logger';
557 // Moodle 2.9 allows administrators to customise the list of supported file types.
558 // To add a new filetype or override the definition of an existing one, set the
559 // customfiletypes variable like this:
561 // $CFG->customfiletypes = array(
562 // (object)array(
563 // 'extension' => 'frog',
564 // 'icon' => 'archive',
565 // 'type' => 'application/frog',
566 // 'customdescription' => 'Amphibian-related file archive'
567 // )
568 // );
570 // The extension, icon, and type fields are required. The icon field can refer to
571 // any icon inside the pix/f folder. You can also set the customdescription field
572 // (shown above) and (for advanced use) the groups, string, and defaulticon fields.
574 // Upgrade key
576 // If the upgrade key is defined here, then the value must be provided every time
577 // the site is being upgraded though the web interface, regardless of whether the
578 // administrator is logged in or not. This prevents anonymous access to the upgrade
579 // screens where the real authentication and authorization mechanisms can not be
580 // relied on.
582 // It is strongly recommended to use a value different from your real account
583 // password.
585 // $CFG->upgradekey = 'put_some_password-like_value_here';
587 // Document conversion limit
589 // How many times the background task should attempt to convert a given attempt
590 // before removing it from the queue. Currently this limit is only used by the
591 // mod_assign conversion task.
593 // $CFG->conversionattemptlimit = 3;
595 // Font used in exported PDF files. When generating a PDF, Moodle embeds a subset of
596 // the font in the PDF file so it will be readable on the widest range of devices.
597 // The default font is 'freesans' which is part of the GNU FreeFont collection.
599 // $CFG->pdfexportfont = 'freesans';
601 // Use the following flag to enable messagingallusers and set the default preference
602 // value for existing users to allow them to be contacted by other site users.
604 // $CFG->keepmessagingallusersenabled = true;
606 // Disable login token validation for login pages. Login token validation is enabled
607 // by default unless $CFG->alternateloginurl is set.
609 // $CFG->disablelogintoken = true;
611 // Moodle 3.7+ checks that cron is running frequently. If the time between cron runs
612 // is greater than this value (in seconds), you get a warning on the admin page. (This
613 // setting only controls whether or not the warning appears, it has no other effect.)
615 // $CFG->expectedcronfrequency = 200;
617 // Session lock warning threshold. Long running pages should release the session using \core\session\manager::write_close().
618 // Set this threshold to any value greater than 0 to add developer warnings when a page locks the session for too long.
619 // The session should rarely be locked for more than 1 second. The input should be in seconds and may be a float.
621 // $CFG->debugsessionlock = 5;
623 //=========================================================================
624 // 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!!
625 //=========================================================================
627 // Force a debugging mode regardless the settings in the site administration
628 // @error_reporting(E_ALL | E_STRICT); // NOT FOR PRODUCTION SERVERS!
629 // @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS!
630 // $CFG->debug = (E_ALL | E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS!
631 // $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS!
633 // You can specify a comma separated list of user ids that that always see
634 // debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay
635 // for these users only.
636 // $CFG->debugusers = '2';
638 // Prevent theme caching
639 // $CFG->themedesignermode = true; // NOT FOR PRODUCTION SERVERS!
641 // Enable verbose debug information during fetching of email messages from IMAP server.
642 // $CFG->debugimap = true;
644 // Prevent JS caching
645 // $CFG->cachejs = false; // NOT FOR PRODUCTION SERVERS!
647 // Restrict which YUI logging statements are shown in the browser console.
648 // For details see the upstream documentation:
649 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logInclude
650 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logExclude
651 // $CFG->yuiloginclude = array(
652 // 'moodle-course-categoryexpander' => true,
653 // );
654 // $CFG->yuilogexclude = array(
655 // 'moodle-core-notification' => true,
656 // );
658 // Set the minimum log level for YUI logging statements.
659 // For details see the upstream documentation:
660 // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logLevel
661 // $CFG->yuiloglevel = 'debug';
663 // Prevent core_string_manager application caching
664 // $CFG->langstringcache = false; // NOT FOR PRODUCTION SERVERS!
666 // When working with production data on test servers, no emails or other messages
667 // should ever be send to real users
668 // $CFG->noemailever = true; // NOT FOR PRODUCTION SERVERS!
670 // Divert all outgoing emails to this address to test and debug emailing features
671 // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS!
673 // Except for certain email addresses you want to let through for testing. Accepts
674 // a comma separated list of regexes.
675 // $CFG->divertallemailsexcept = 'tester@dev.com, fred(\+.*)?@example.com'; // NOT FOR PRODUCTION SERVERS!
677 // Uncomment if you want to allow empty comments when modifying install.xml files.
678 // $CFG->xmldbdisablecommentchecking = true; // NOT FOR PRODUCTION SERVERS!
680 // Since 2.0 sql queries are not shown during upgrade by default.
681 // Please note that this setting may produce very long upgrade page on large sites.
682 // $CFG->upgradeshowsql = true; // NOT FOR PRODUCTION SERVERS!
684 // Add SQL queries to the output of cron, just before their execution
685 // $CFG->showcronsql = true;
687 // Force developer level debug and add debug info to the output of cron
688 // $CFG->showcrondebugging = true;
690 //=========================================================================
691 // 8. FORCED SETTINGS
692 //=========================================================================
693 // It is possible to specify normal admin settings here, the point is that
694 // they can not be changed through the standard admin settings pages any more.
696 // Core settings are specified directly via assignment to $CFG variable.
697 // Example:
698 // $CFG->somecoresetting = 'value';
700 // Plugin settings have to be put into a special array.
701 // Example:
702 // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'secondsetting' => 'othervalue'),
703 // 'otherplugin' => array('mysetting' => 'myvalue', 'thesetting' => 'thevalue'));
704 // Module default settings with advanced/locked checkboxes can be set too. To do this, add
705 // an extra config with '_adv' or '_locked' as a suffix and set the value to true or false.
706 // Example:
707 // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'settingname_locked' => true, 'settingname_adv' => true));
709 //=========================================================================
710 // 9. PHPUNIT SUPPORT
711 //=========================================================================
712 // $CFG->phpunit_prefix = 'phpu_';
713 // $CFG->phpunit_dataroot = '/home/example/phpu_moodledata';
714 // $CFG->phpunit_directorypermissions = 02777; // optional
715 // $CFG->phpunit_profilingenabled = true; // optional to profile PHPUnit runs.
718 //=========================================================================
719 // 10. SECRET PASSWORD SALT
720 //=========================================================================
721 // A site-wide password salt is no longer used in new installations.
722 // If upgrading from 2.6 or older, keep all existing salts in config.php file.
724 // $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1';
726 // You may also have some alternative salts to allow migration from previously
727 // used salts.
729 // $CFG->passwordsaltalt1 = '';
730 // $CFG->passwordsaltalt2 = '';
731 // $CFG->passwordsaltalt3 = '';
732 // ....
733 // $CFG->passwordsaltalt19 = '';
734 // $CFG->passwordsaltalt20 = '';
737 //=========================================================================
738 // 11. BEHAT SUPPORT
739 //=========================================================================
740 // Behat test site needs a unique www root, data directory and database prefix:
742 // $CFG->behat_wwwroot = 'http://127.0.0.1/moodle';
743 // $CFG->behat_prefix = 'bht_';
744 // $CFG->behat_dataroot = '/home/example/bht_moodledata';
746 // You can override default Moodle configuration for Behat and add your own
747 // params; here you can add more profiles, use different Mink drivers than Selenium...
748 // These params would be merged with the default Moodle behat.yml, giving priority
749 // to the ones specified here. The array format is YAML, following the Behat
750 // params hierarchy. More info: http://docs.behat.org/guides/7.config.html
751 // Example:
752 // $CFG->behat_config = array(
753 // 'Mac-Firefox' => array(
754 // 'suites' => array (
755 // 'default' => array(
756 // 'filters' => array(
757 // 'tags' => '~@_file_upload'
758 // ),
759 // ),
760 // ),
761 // 'extensions' => array(
762 // 'Behat\MinkExtension' => array(
763 // 'selenium2' => array(
764 // 'browser' => 'firefox',
765 // 'capabilities' => array(
766 // 'platform' => 'OS X 10.6',
767 // 'version' => 20
768 // )
769 // )
770 // )
771 // )
772 // ),
773 // 'Mac-Safari' => array(
774 // 'extensions' => array(
775 // 'Behat\MinkExtension' => array(
776 // 'selenium2' => array(
777 // 'browser' => 'safari',
778 // 'capabilities' => array(
779 // 'platform' => 'OS X 10.8',
780 // 'version' => 6
781 // )
782 // )
783 // )
784 // )
785 // )
786 // );
787 // You can also use the following config to override default Moodle configuration for Behat.
788 // This config is limited to default suite and will be supported in later versions.
789 // It will have precedence over $CFG->behat_config.
790 // $CFG->behat_profiles = array(
791 // 'phantomjs' => array(
792 // 'browser' => 'phantomjs',
793 // 'tags' => '~@_file_upload&&~@_alert&&~@_bug_phantomjs',
794 // 'wd_host' => 'http://127.0.0.1:4443/wd/hub',
795 // 'capabilities' => array(
796 // 'platform' => 'Linux',
797 // 'version' => 2.1
798 // )
799 // ),
800 // );
802 // You can force the browser session (not user's sessions) to restart after N seconds. This could
803 // be useful if you are using a cloud-based service with time restrictions in the browser side.
804 // Setting this value the browser session that Behat is using will be restarted. Set the time in
805 // seconds. Is not recommended to use this setting if you don't explicitly need it.
806 // Example:
807 // $CFG->behat_restart_browser_after = 7200; // Restarts the browser session after 2 hours
809 // All this page's extra Moodle settings are compared against a white list of allowed settings
810 // (the basic and behat_* ones) to avoid problems with production environments. This setting can be
811 // used to expand the default white list with an array of extra settings.
812 // Example:
813 // $CFG->behat_extraallowedsettings = array('somecoresetting', ...);
815 // You should explicitly allow the usage of the deprecated behat steps, otherwise an exception will
816 // be thrown when using them. The setting is disabled by default.
817 // Example:
818 // $CFG->behat_usedeprecated = true;
820 // If you are using a slow machine, it may help to increase the timeouts that Behat uses. The
821 // following example will increase timeouts by a factor of 3 (using 30 seconds instead of 10
822 // seconds, for instance).
823 // Example:
824 // $CFG->behat_increasetimeout = 3;
826 // Including feature files from directories outside the dirroot is possible if required. The setting
827 // requires that the running user has executable permissions on all parent directories in the paths.
828 // Example:
829 // $CFG->behat_additionalfeatures = array('/home/developer/code/wipfeatures');
831 // You can make behat save several dumps when a scenario fails. The dumps currently saved are:
832 // * a dump of the DOM in it's state at the time of failure; and
833 // * a screenshot (JavaScript is required for the screenshot functionality, so not all browsers support this option)
834 // Example:
835 // $CFG->behat_faildump_path = '/my/path/to/save/failure/dumps';
837 // You can specify db, selenium wd_host etc. for behat parallel run by setting following variable.
838 // Example:
839 // $CFG->behat_parallel_run = array (
840 // array (
841 // 'dbtype' => 'mysqli',
842 // 'dblibrary' => 'native',
843 // 'dbhost' => 'localhost',
844 // 'dbname' => 'moodletest',
845 // 'dbuser' => 'moodle',
846 // 'dbpass' => 'moodle',
847 // 'behat_prefix' => 'mdl_',
848 // 'wd_host' => 'http://127.0.0.1:4444/wd/hub',
849 // 'behat_wwwroot' => 'http://127.0.0.1/moodle',
850 // 'behat_dataroot' => '/home/example/bht_moodledata'
851 // ),
852 // );
854 // To change name of behat parallel run site, define BEHAT_PARALLEL_SITE_NAME and parallel run sites will be suffixed
855 // with this value
856 // Example:
857 // define('BEHAT_PARALLEL_SITE_NAME', 'behatparallelsite');
859 // Command line output for parallel behat install is limited to 80 chars, if you are installing more then 4 sites and
860 // want to expand output to more then 80 chars, then define BEHAT_MAX_CMD_LINE_OUTPUT
861 // Example:
862 // define('BEHAT_MAX_CMD_LINE_OUTPUT', 120);
864 // Behat feature files will be distributed randomly between the processes by default. If you have timing file or want
865 // to create timing file then define BEHAT_FEATURE_TIMING_FILE with path to timing file. It will be updated for each
866 // run with latest time taken to execute feature.
867 // Example:
868 // define('BEHAT_FEATURE_TIMING_FILE', '/PATH_TO_TIMING_FILE/timing.json');
870 // If you don't have timing file and want some stable distribution of features, then you can use step counts to
871 // distribute the features. You can generate step file by executing php admin/tool/behat/cli/util.php --updatesteps
872 // this will update step file which is defined by BEHAT_FEATURE_STEP_FILE.
873 // Example:
874 // define('BEHAT_FEATURE_STEP_FILE', '/PATH_TO_FEATURE_STEP_COUNT_FILE/stepcount.json');
876 // Feature distribution for each process is displayed as histogram. you can disable it by setting
877 // BEHAT_DISABLE_HISTOGRAM
878 // Example:
879 // define('BEHAT_DISABLE_HISTOGRAM', true);
881 // Mobile app Behat testing requires this option, pointing to a developer Moodle Mobile directory:
882 // $CFG->behat_ionic_dirroot = '/where/I/keep/my/git/checkouts/moodlemobile2';
884 // The following option can be used to indicate a running Ionic server (otherwise Behat will start
885 // one automatically for each test run, which is convenient but takes ages):
886 // $CFG->behat_ionic_wwwroot = 'http://localhost:8100';
888 //=========================================================================
889 // 12. DEVELOPER DATA GENERATOR
890 //=========================================================================
892 // The developer data generator tool is intended to be used only in development or testing sites and
893 // it's usage in production environments is not recommended; if it is used to create JMeter test plans
894 // is even less recommended as JMeter needs to log in as site course users. JMeter needs to know the
895 // users passwords but would be dangerous to have a default password as everybody would know it, which would
896 // be specially dangerouse if somebody uses this tool in a production site, so in order to prevent unintended
897 // uses of the tool and undesired accesses as well, is compulsory to set a password for the users
898 // generated by this tool, but only in case you want to generate a JMeter test. The value should be a string.
899 // Example:
900 // $CFG->tool_generator_users_password = 'examplepassword';
902 //=========================================================================
903 // 13. SYSTEM PATHS (You need to set following, depending on your system)
904 //=========================================================================
905 // Ghostscript path.
906 // On most Linux installs, this can be left as '/usr/bin/gs'.
907 // On Windows it will be something like 'c:\gs\bin\gswin32c.exe' (make sure
908 // there are no spaces in the path - if necessary copy the files 'gswin32c.exe'
909 // and 'gsdll32.dll' to a new folder without a space in the path)
910 // $CFG->pathtogs = '/usr/bin/gs';
912 // Path to PHP CLI.
913 // Probably something like /usr/bin/php. If you enter this, cron scripts can be
914 // executed from admin web interface.
915 // $CFG->pathtophp = '';
917 // Path to du.
918 // Probably something like /usr/bin/du. If you enter this, pages that display
919 // directory contents will run much faster for directories with a lot of files.
920 // $CFG->pathtodu = '';
922 // Path to aspell.
923 // To use spell-checking within the editor, you MUST have aspell 0.50 or later
924 // installed on your server, and you must specify the correct path to access the
925 // aspell binary. On Unix/Linux systems, this path is usually /usr/bin/aspell,
926 // but it might be something else.
927 // $CFG->aspellpath = '';
929 // Path to dot.
930 // Probably something like /usr/bin/dot. To be able to generate graphics from
931 // DOT files, you must have installed the dot executable and point to it here.
932 // Note that, for now, this only used by the profiling features
933 // (Development->Profiling) built into Moodle.
934 // $CFG->pathtodot = '';
936 // Path to unoconv.
937 // Probably something like /usr/bin/unoconv. Used as a fallback to convert between document formats.
938 // Unoconv is used convert between file formats supported by LibreOffice.
939 // Use a recent version of unoconv ( >= 0.7 ), older versions have trouble running from a webserver.
940 // $CFG->pathtounoconv = '';
942 //=========================================================================
943 // 14. ALTERNATIVE FILE SYSTEM SETTINGS
944 //=========================================================================
946 // Alternative file system.
947 // Since 3.3 it is possible to override file_storage and file_system API and use alternative storage systems (e.g. S3,
948 // Rackspace Cloud Files, Google Cloud Storage, Azure Storage, etc.).
949 // To set the alternative file storage system in config.php you can use the following setting, providing the
950 // alternative system class name that will be auto-loaded by file_storage API.
952 // $CFG->alternative_file_system_class = '\\local_myfilestorage\\file_system';
954 //=========================================================================
955 // ALL DONE! To continue installation, visit your main page with a browser
956 //=========================================================================
958 require_once(__DIR__ . '/lib/setup.php'); // Do not edit
960 // There is no php closing tag in this file,
961 // it is intentional because it prevents trailing whitespace problems!