Commit | Line | Data |
---|---|---|
a084ac0d | 1 | <?php |
6077020a | 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 // | |
c6b456f6 | 13 | // http://moodle.org // |
6077020a | 14 | // // |
3b365361 | 15 | // Copyright (C) 1999 onwards Martin Dougiamas http://moodle.com // |
6077020a | 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 // | |
554a3c4c | 19 | // the Free Software Foundation; either version 3 of the License, or // |
6077020a | 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 | |
b30fa335 | 31 | global $CFG; // This is necessary here for PHPUnit execution |
c57e9015 | 32 | $CFG = new stdClass(); |
6077020a | 33 | |
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. // | |
6077020a | 40 | |
9552a027 | 41 | $CFG->dbtype = 'pgsql'; // 'pgsql', 'mariadb', 'mysqli', 'auroramysql', 'sqlsrv' or 'oci' |
d0bf00e0 DM |
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 | |
3c1293fe PS |
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') | |
d0bf00e0 DM |
59 | 'dbport' => '', // the TCP port number to use when connecting |
60 | // to the server. keep empty string for the | |
61 | // default port | |
f834a8f5 RS |
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. | |
0bbefd81 AG |
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. | |
0131c3be MS |
73 | // 'versionfromdb' => false, // On MySQL and MariaDB, this can force |
74 | // the DB version to be evaluated using | |
75 | // the VERSION function instead of the version | |
76 | // provided by the PHP client which could be | |
77 | // wrong based on the DB server infrastructure, | |
78 | // e.g. PaaS on Azure. Default is false/unset. | |
79 | // Uncomment and set to true to force MySQL and | |
80 | // MariaDB to use 'SELECT VERSION();'. | |
f8537ffe M |
81 | // 'extrainfo' => [], // Extra information for the DB driver, e.g. SQL Server, |
82 | // has additional configuration according to its environment, | |
83 | // which the administrator can specify to alter and | |
84 | // override any connection options. | |
34aeacad | 85 | // 'fetchbuffersize' => 100000, // On PostgreSQL, this option sets a limit |
86 | // on the number of rows that are fetched into | |
87 | // memory when doing a large recordset query | |
88 | // (e.g. search indexing). Default is 100000. | |
89 | // Uncomment and set to a value to change it, | |
90 | // or zero to turn off the limit. You need to | |
91 | // set to zero if you are using pg_bouncer in | |
92 | // 'transaction' mode (it is fine in 'session' | |
93 | // mode). | |
46cfde3d S |
94 | /* |
95 | 'connecttimeout' => null, // Set connect timeout in seconds. Not all drivers support it. | |
96 | 'readonly' => [ // Set to read-only slave details, to get safe reads | |
97 | // from there instead of the master node. Optional. | |
98 | // Currently supported by pgsql and mysqli variety classes. | |
99 | // If not supported silently ignored. | |
100 | 'instance' => [ // Readonly slave connection parameters | |
101 | [ | |
102 | 'dbhost' => 'slave.dbhost', | |
103 | 'dbport' => '', // Defaults to master port | |
104 | 'dbuser' => '', // Defaults to master user | |
105 | 'dbpass' => '', // Defaults to master password | |
106 | ], | |
107 | [...], | |
108 | ], | |
109 | ||
110 | Instance(s) can alternatively be specified as: | |
111 | ||
112 | 'instance' => 'slave.dbhost', | |
113 | 'instance' => ['slave.dbhost1', 'slave.dbhost2'], | |
114 | 'instance' => ['dbhost' => 'slave.dbhost', 'dbport' => '', 'dbuser' => '', 'dbpass' => ''], | |
115 | ||
116 | 'connecttimeout' => 2, // Set read-only slave connect timeout in seconds. See above. | |
117 | 'latency' => 0.5, // Set read-only slave sync latency in seconds. | |
118 | // When 'latency' seconds have lapsed after an update to a table | |
119 | // it is deemed safe to use readonly slave for reading from the table. | |
d8baf295 S |
120 | // It is optional, defaults to 1 second. If you want once written to a table |
121 | // to always use master handle for reading set it to something ridiculosly big, | |
122 | // eg 10. | |
46cfde3d S |
123 | // Lower values increase the performance, but setting it too low means |
124 | // missing the master-slave sync. | |
125 | 'exclude_tables' => [ // Tables to exclude from read-only slave feature. | |
126 | 'table1', // Should not be used, unless in rare cases when some area of the system | |
127 | 'table2', // is malfunctioning and you still want to use readonly feature. | |
128 | ], // Then one can exclude offending tables while investigating. | |
129 | ||
130 | More info available in lib/dml/moodle_read_slave_trait.php where the feature is implemented. | |
131 | ] | |
132 | */ | |
133 | // For all database config settings see https://docs.moodle.org/en/Database_settings | |
d0bf00e0 | 134 | ); |
1e55ed26 | 135 | |
6077020a | 136 | |
9d975de4 | 137 | //========================================================================= |
ec2d8ceb | 138 | // 2. WEB SITE LOCATION |
6077020a | 139 | //========================================================================= |
140 | // Now you need to tell Moodle where it is located. Specify the full | |
eb2042f6 | 141 | // web address to where moodle has been installed. If your web site |
142 | // is accessible via multiple URLs then choose the most natural one | |
6077020a | 143 | // that your students would use. Do not include a trailing slash |
11e7b506 | 144 | // |
145 | // If you need both intranet and Internet access please read | |
146 | // http://docs.moodle.org/en/masquerading | |
6077020a | 147 | |
148 | $CFG->wwwroot = 'http://example.com/moodle'; | |
149 | ||
150 | ||
6077020a | 151 | //========================================================================= |
ec2d8ceb | 152 | // 3. DATA FILES LOCATION |
6077020a | 153 | //========================================================================= |
154 | // Now you need a place where Moodle can save uploaded files. This | |
eb2042f6 | 155 | // directory should be readable AND WRITEABLE by the web server user |
156 | // (usually 'nobody' or 'apache'), but it should not be accessible | |
6077020a | 157 | // directly via the web. |
158 | // | |
159 | // - On hosting systems you might need to make sure that your "group" has | |
160 | // no permissions at all, but that "others" have full permissions. | |
161 | // | |
162 | // - On Windows systems you might specify something like 'c:\moodledata' | |
163 | ||
164 | $CFG->dataroot = '/home/example/moodledata'; | |
165 | ||
166 | ||
167 | //========================================================================= | |
ec2d8ceb | 168 | // 4. DATA FILES PERMISSIONS |
6077020a | 169 | //========================================================================= |
170 | // The following parameter sets the permissions of new directories | |
eb2042f6 | 171 | // created by Moodle within the data directory. The format is in |
6077020a | 172 | // octal format (as used by the Unix utility chmod, for example). |
eb2042f6 | 173 | // The default is usually OK, but you may want to change it to 0750 |
6077020a | 174 | // if you are concerned about world-access to the files (you will need |
175 | // to make sure the web server process (eg Apache) can access the files. | |
176 | // NOTE: the prefixed 0 is important, and don't use quotes. | |
177 | ||
d99bab2d | 178 | $CFG->directorypermissions = 02777; |
6077020a | 179 | |
180 | ||
181 | //========================================================================= | |
c83e637f | 182 | // 5. ADMIN DIRECTORY LOCATION (deprecated) |
6077020a | 183 | //========================================================================= |
c83e637f AN |
184 | // Please note: Support from this feature has been deprecated and it will be |
185 | // removed after Moodle 4.2. | |
186 | // | |
eb2042f6 | 187 | // A very few webhosts use /admin as a special URL for you to access a |
188 | // control panel or something. Unfortunately this conflicts with the | |
a36d42a5 PS |
189 | // standard location for the Moodle admin pages. You can work around this |
190 | // by renaming the admin directory in your installation, and putting that | |
191 | // new name here. eg "moodleadmin". This should fix all admin links in Moodle. | |
192 | // After any change you need to visit your new admin directory | |
193 | // and purge all caches. | |
6077020a | 194 | |
195 | $CFG->admin = 'admin'; | |
196 | ||
197 | ||
198 | //========================================================================= | |
ec2d8ceb | 199 | // 6. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations) |
21d1d077 | 200 | //========================================================================= |
201 | // | |
c9ca1fa5 | 202 | // These are additional tweaks for which no GUI exists in Moodle yet. |
203 | // | |
9c733e86 | 204 | // Starting in PHP 5.3 administrators should specify default timezone |
205 | // in PHP.ini, you can also specify it here if needed. | |
206 | // See details at: http://php.net/manual/en/function.date-default-timezone-set.php | |
207 | // List of time zones at: http://php.net/manual/en/timezones.php | |
208 | // date_default_timezone_set('Australia/Perth'); | |
c9ca1fa5 | 209 | // |
1ed96821 | 210 | // Change the key pair lifetime for Moodle Networking |
211 | // The default is 28 days. You would only want to change this if the key | |
212 | // was not getting regenerated for any reason. You would probably want | |
213 | // make it much longer. Note that you'll need to delete and manually update | |
214 | // any existing key. | |
215 | // $CFG->mnetkeylifetime = 28; | |
216 | // | |
77218e4a | 217 | // Not recommended: Set the following to true to allow the use |
218 | // off non-Moodle standard characters in usernames. | |
219 | // $CFG->extendedusernamechars = true; | |
220 | // | |
29ba20ac MD |
221 | // Allow user passwords to be included in backup files. Very dangerous |
222 | // setting as far as it publishes password hashes that can be unencrypted | |
223 | // if the backup file is publicy available. Use it only if you can guarantee | |
224 | // that all your backup files remain only privacy available and are never | |
225 | // shared out from your site/institution! | |
226 | // $CFG->includeuserpasswordsinbackup = true; | |
227 | // | |
b0ccfc5c HF |
228 | // Completely disable user creation when restoring a course, bypassing any |
229 | // permissions granted via roles and capabilities. Enabling this setting | |
230 | // results in the restore process stopping when a user attempts to restore a | |
231 | // course requiring users to be created. | |
5e934890 EL |
232 | // $CFG->disableusercreationonrestore = true; |
233 | // | |
2de3539b EL |
234 | // Keep the temporary directories used by backup and restore without being |
235 | // deleted at the end of the process. Use it if you want to debug / view | |
236 | // all the information stored there after the process has ended. Note that | |
237 | // those directories may be deleted (after some ttl) both by cron and / or | |
238 | // by new backup / restore invocations. | |
239 | // $CFG->keeptempdirectoriesonbackup = true; | |
240 | // | |
5e934890 | 241 | // Modify the restore process in order to force the "user checks" to assume |
b0ccfc5c HF |
242 | // that the backup originated from a different site, so detection of matching |
243 | // users is performed with different (more "relaxed") rules. Note that this is | |
244 | // only useful if the backup file has been created using Moodle < 1.9.4 and the | |
245 | // site has been rebuilt from scratch using backup files (not the best way btw). | |
246 | // If you obtain user conflicts on restore, rather than enabling this setting | |
247 | // permanently, try restoring the backup on a different site, back it up again | |
248 | // and then restore on the target server. | |
5e934890 EL |
249 | // $CFG->forcedifferentsitecheckingusersonrestore = true; |
250 | // | |
c803fa68 EM |
251 | // Force the backup system to continue to create backups in the legacy zip |
252 | // format instead of the new tgz format. Does not affect restore, which | |
253 | // auto-detects the underlying file format. | |
254 | // $CFG->usezipbackups = true; | |
255 | // | |
72df7e1e | 256 | // Prevent stats processing and hide the GUI |
257 | // $CFG->disablestatsprocessing = true; | |
258 | // | |
7758d00f | 259 | // Setting this to true will enable admins to edit any post at any time |
260 | // $CFG->admineditalways = true; | |
cec0a0fc | 261 | // |
5fd1a5d8 | 262 | // These variables define DEFAULT block variables for new courses |
263 | // If this one is set it overrides all others and is the only one used. | |
1ce19cc3 | 264 | // $CFG->defaultblocks_override = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity'; |
3eecaaf4 | 265 | // |
266 | // These variables define the specific settings for defined course formats. | |
5fd1a5d8 | 267 | // They override any settings defined in the formats own config file. |
9574c2ef | 268 | // $CFG->defaultblocks_site = 'site_main_menu,course_list:course_summary,calendar_month'; |
1ce19cc3 AB |
269 | // $CFG->defaultblocks_social = 'search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,course_list'; |
270 | // $CFG->defaultblocks_topics = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity'; | |
271 | // $CFG->defaultblocks_weeks = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity'; | |
3eecaaf4 | 272 | // |
5fd1a5d8 | 273 | // These blocks are used when no other default setting is found. |
1ce19cc3 | 274 | // $CFG->defaultblocks = 'activity_modules,search_forums,course_list:news_items,calendar_upcoming,recent_activity'; |
3eecaaf4 | 275 | // |
86b5ea0f | 276 | // You can specify a different class to be created for the $PAGE global, and to |
277 | // compute which blocks appear on each page. However, I cannot think of any good | |
278 | // reason why you would need to change that. It just felt wrong to hard-code the | |
3edc37cb | 279 | // the class name. You are strongly advised not to use these to settings unless |
86b5ea0f | 280 | // you are absolutely sure you know what you are doing. |
281 | // $CFG->moodlepageclass = 'moodle_page'; | |
3edc37cb | 282 | // $CFG->moodlepageclassfile = "$CFG->dirroot/local/myplugin/mypageclass.php"; |
86b5ea0f | 283 | // $CFG->blockmanagerclass = 'block_manager'; |
3edc37cb | 284 | // $CFG->blockmanagerclassfile = "$CFG->dirroot/local/myplugin/myblockamanagerclass.php"; |
c81c6d0e | 285 | // |
6b29ba60 | 286 | // Seconds for files to remain in caches. Decrease this if you are worried |
287 | // about students being served outdated versions of uploaded files. | |
0c431257 | 288 | // $CFG->filelifetime = 60*60*6; |
88fea1ca | 289 | // |
d5dd0540 PS |
290 | // Some web servers can offload the file serving from PHP process, |
291 | // comment out one the following options to enable it in Moodle: | |
292 | // $CFG->xsendfile = 'X-Sendfile'; // Apache {@see https://tn123.org/mod_xsendfile/} | |
293 | // $CFG->xsendfile = 'X-LIGHTTPD-send-file'; // Lighttpd {@see http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file} | |
294 | // $CFG->xsendfile = 'X-Accel-Redirect'; // Nginx {@see http://wiki.nginx.org/XSendfile} | |
f7d26a05 PS |
295 | // If your X-Sendfile implementation (usually Nginx) uses directory aliases specify them |
296 | // in the following array setting: | |
297 | // $CFG->xsendfilealiases = array( | |
298 | // '/dataroot/' => $CFG->dataroot, | |
299 | // '/cachedir/' => '/var/www/moodle/cache', // for custom $CFG->cachedir locations | |
85b38061 | 300 | // '/localcachedir/' => '/var/local/cache', // for custom $CFG->localcachedir locations |
f7d26a05 PS |
301 | // '/tempdir/' => '/var/www/moodle/temp', // for custom $CFG->tempdir locations |
302 | // '/filedir' => '/var/www/moodle/filedir', // for custom $CFG->filedir locations | |
303 | // ); | |
304 | // | |
7953149e PS |
305 | // YUI caching may be sometimes improved by slasharguments: |
306 | // $CFG->yuislasharguments = 1; | |
307 | // Some servers may need a special rewrite rule to work around internal path length limitations: | |
308 | // RewriteRule (^.*/theme/yui_combo\.php)(/.*) $1?file=$2 | |
f7d26a05 | 309 | // |
d5dd0540 | 310 | // |
d79d5ac2 PS |
311 | // Following settings may be used to select session driver, uncomment only one of the handlers. |
312 | // Database session handler (not compatible with MyISAM): | |
313 | // $CFG->session_handler_class = '\core\session\database'; | |
314 | // $CFG->session_database_acquire_lock_timeout = 120; | |
315 | // | |
316 | // File session handler (file system locking required): | |
317 | // $CFG->session_handler_class = '\core\session\file'; | |
318 | // $CFG->session_file_save_path = $CFG->dataroot.'/sessions'; | |
319 | // | |
320 | // Memcached session handler (requires memcached server and extension): | |
321 | // $CFG->session_handler_class = '\core\session\memcached'; | |
322 | // $CFG->session_memcached_save_path = '127.0.0.1:11211'; | |
323 | // $CFG->session_memcached_prefix = 'memc.sess.key.'; | |
6ec361c6 | 324 | // $CFG->session_memcached_acquire_lock_timeout = 120; |
774c00c7 | 325 | // $CFG->session_memcached_lock_expire = 7200; // Ignored if PECL memcached is below version 2.2.0 |
bd035b98 FW |
326 | // $CFG->session_memcached_lock_retry_sleep = 150; // Spin-lock retry sleeptime (msec). Only effective |
327 | // // for tuning php-memcached 3.0.x (PHP 7) | |
d79d5ac2 | 328 | // |
7f8a816a RS |
329 | // Redis session handler (requires redis server and redis extension): |
330 | // $CFG->session_handler_class = '\core\session\redis'; | |
331 | // $CFG->session_redis_host = '127.0.0.1'; | |
e032ac93 BH |
332 | // $CFG->session_redis_port = 6379; // Optional. |
333 | // $CFG->session_redis_database = 0; // Optional, default is db 0. | |
334 | // $CFG->session_redis_auth = ''; // Optional, default is don't set one. | |
335 | // $CFG->session_redis_prefix = ''; // Optional, default is don't set one. | |
336 | // $CFG->session_redis_acquire_lock_timeout = 120; // Default is 2 minutes. | |
337 | // $CFG->session_redis_acquire_lock_warn = 0; // If set logs early warning if a lock has not been acquried. | |
338 | // $CFG->session_redis_lock_expire = 7200; // Optional, defaults to session timeout. | |
339 | // $CFG->session_redis_lock_retry = 100; // Optional wait between lock attempts in ms, default is 100. | |
340 | // // After 5 seconds it will throttle down to once per second. | |
341 | // | |
88671590 | 342 | // Use the igbinary serializer instead of the php default one. Note that phpredis must be compiled with |
343 | // igbinary support to make the setting to work. Also, if you change the serializer you have to flush the database! | |
344 | // $CFG->session_redis_serializer_use_igbinary = false; // Optional, default is PHP builtin serializer. | |
e032ac93 BH |
345 | // $CFG->session_redis_compressor = 'none'; // Optional, possible values are: |
346 | // // 'gzip' - PHP GZip compression | |
347 | // // 'zstd' - PHP Zstandard compression | |
7f8a816a | 348 | // |
89aff0d8 AN |
349 | // Please be aware that when selecting Memcached for sessions that it is advised to use a dedicated |
350 | // memcache server. The memcached extension does not provide isolated environments for individual uses. | |
2c0eb5e6 SH |
351 | // Using the same server for other purposes (MUC for example) can lead to sessions being prematurely removed should |
352 | // the other uses of the server purge the cache. | |
353 | // | |
d79d5ac2 PS |
354 | // Following setting allows you to alter how frequently is timemodified updated in sessions table. |
355 | // $CFG->session_update_timemodified_frequency = 20; // In seconds. | |
46a86dbb | 356 | // |
c57e9015 | 357 | // If this setting is set to true, then Moodle will track the IP of the |
358 | // current user to make sure it hasn't changed during a session. This | |
359 | // will prevent the possibility of sessions being hijacked via XSS, but it | |
366dfa60 | 360 | // may break things for users coming using proxies that change all the time, |
361 | // like AOL. | |
362 | // $CFG->tracksessionip = true; | |
bb64b51a | 363 | // |
bb64b51a | 364 | // The following lines are for handling email bounces. |
5fd1a5d8 | 365 | // $CFG->handlebounces = true; |
366 | // $CFG->minbounces = 10; | |
367 | // $CFG->bounceratio = .20; | |
bb64b51a | 368 | // The next lines are needed both for bounce handling and any other email to module processing. |
369 | // mailprefix must be EXACTLY four characters. | |
c57e9015 | 370 | // Uncomment and customise this block for Postfix |
5fd1a5d8 | 371 | // $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix. |
c57e9015 | 372 | // $CFG->mailprefix = 'mdl-'; // - is the separator for qmail |
5fd1a5d8 | 373 | // $CFG->maildomain = 'youremaildomain.com'; |
f93426cf | 374 | // |
f11f8ba2 PS |
375 | // Enable when setting up advanced reverse proxy load balancing configurations, |
376 | // it may be also necessary to enable this when using port forwarding. | |
11e7b506 | 377 | // $CFG->reverseproxy = true; |
378 | // | |
379 | // Enable when using external SSL appliance for performance reasons. | |
750688c7 | 380 | // Please note that site may be accessible via http: or https:, but not both! |
11e7b506 | 381 | // $CFG->sslproxy = true; |
382 | // | |
c57e9015 | 383 | // This setting will cause the userdate() function not to fix %d in |
1ac7ee24 | 384 | // date strings, and just let them show with a zero prefix. |
385 | // $CFG->nofixday = true; | |
ce5e431b | 386 | // |
387 | // This setting will make some graphs (eg user logs) use lines instead of bars | |
388 | // $CFG->preferlinegraphs = true; | |
9d5ef892 | 389 | // |
2ab797c9 BH |
390 | // This setting allows you to specify a class to rewrite outgoing urls |
391 | // enabling 'clean urls' in conjunction with an apache / nginx handler. | |
392 | // The handler must implement \core\output\url_rewriter. | |
393 | // $CFG->urlrewriteclass = '\local_cleanurls\url_rewriter'; | |
394 | // | |
18259d4f | 395 | // Enabling this will allow custom scripts to replace existing moodle scripts. |
9677eb79 | 396 | // For example: if $CFG->customscripts/course/view.php exists then |
18259d4f | 397 | // it will be used instead of $CFG->wwwroot/course/view.php |
398 | // At present this will only work for files that include config.php and are called | |
399 | // as part of the url (index.php is implied). | |
400 | // Some examples are: | |
401 | // http://my.moodle.site/course/view.php | |
402 | // http://my.moodle.site/index.php | |
403 | // http://my.moodle.site/admin (index.php implied) | |
404 | // Custom scripts should not include config.php | |
405 | // Warning: Replacing standard moodle scripts may pose security risks and/or may not | |
406 | // be compatible with upgrades. Use this option only if you are aware of the risks | |
c57e9015 | 407 | // involved. |
9677eb79 | 408 | // Specify the full directory path to the custom scripts |
409 | // $CFG->customscripts = '/home/example/customscripts'; | |
18259d4f | 410 | // |
c57e9015 | 411 | // Performance profiling |
412 | // | |
853df85e | 413 | // If you set Debug to "Yes" in the Configuration->Variables page some |
414 | // performance profiling data will show up on your footer (in default theme). | |
415 | // With these settings you get more granular control over the capture | |
416 | // and printout of the data | |
417 | // | |
418 | // Capture performance profiling data | |
419 | // define('MDL_PERF' , true); | |
420 | // | |
421 | // Capture additional data from DB | |
422 | // define('MDL_PERFDB' , true); | |
423 | // | |
424 | // Print to log (for passive profiling of production servers) | |
425 | // define('MDL_PERFTOLOG' , true); | |
426 | // | |
427 | // Print to footer (works with the default theme) | |
428 | // define('MDL_PERFTOFOOT', true); | |
429 | // | |
a65476d5 PH |
430 | // Print additional data to log of included files |
431 | // define('MDL_PERFINC', true); | |
432 | // | |
c646dd26 EL |
433 | // Enable earlier profiling that causes more code to be covered |
434 | // on every request (db connections, config load, other inits...). | |
435 | // Requires extra configuration to be defined in config.php like: | |
436 | // profilingincluded, profilingexcluded, profilingautofrec, | |
437 | // profilingallowme, profilingallowall, profilinglifetime | |
438 | // $CFG->earlyprofilingenabled = true; | |
439 | // | |
05f6ed00 PG |
440 | // Disable database storage for profile data. |
441 | // When using an exernal plugin to store profiling data it is often | |
442 | // desirable to not store the data in the database. | |
443 | // | |
444 | // $CFG->disableprofilingtodatabase = true; | |
445 | // | |
4c202228 | 446 | // Force displayed usernames |
c57e9015 | 447 | // A little hack to anonymise user names for all students. If you set these |
4c202228 | 448 | // then all non-teachers will always see these for every person. |
449 | // $CFG->forcefirstname = 'Bruce'; | |
450 | // $CFG->forcelastname = 'Simpson'; | |
acd2279e | 451 | // |
5c5c16bb | 452 | // The following setting will turn on username logging into Apache log. For full details regarding setting |
453 | // up of this function please refer to the install section of the document. | |
454 | // $CFG->apacheloguser = 0; // Turn this feature off. Default value. | |
455 | // $CFG->apacheloguser = 1; // Log user id. | |
456 | // $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader. | |
c57e9015 | 457 | // $CFG->apacheloguser = 3; // Log username. |
bd10cc11 | 458 | // To get the values logged in Apache's log, add to your httpd.conf |
459 | // the following statements. In the General part put: | |
220776ac | 460 | // LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat |
bd10cc11 | 461 | // And in the part specific to your Moodle install / virtualhost: |
462 | // CustomLog "/your/path/to/log" moodleformat | |
c31a35b5 BH |
463 | // |
464 | // Alternatively for other webservers such as nginx, you can instead have the username sent via a http header | |
465 | // 'X-MOODLEUSER' which can be saved in the logfile and then stripped out before being sent to the browser: | |
466 | // $CFG->headerloguser = 0; // Turn this feature off. Default value. | |
467 | // $CFG->headerloguser = 1; // Log user id. | |
468 | // $CFG->headerloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader. | |
469 | // $CFG->headerloguser = 3; // Log username. | |
470 | // | |
471 | // CAUTION: Use of this option will expose usernames in the Apache / nginx log, | |
bd10cc11 | 472 | // If you are going to publish your log, or the output of your web stats analyzer |
473 | // this will weaken the security of your website. | |
c57e9015 | 474 | // |
475 | // Email database connection errors to someone. If Moodle cannot connect to the | |
880a6f6b | 476 | // database, then email this address with a notice. |
477 | // | |
6b25f553 | 478 | // $CFG->emailconnectionerrorsto = 'your@emailaddress.com'; |
c57e9015 | 479 | // |
6f93e96c | 480 | // Set the priority of themes from highest to lowest. This is useful (for |
481 | // example) in sites where the user theme should override all other theme | |
482 | // settings for accessibility reasons. You can also disable types of themes | |
b7009474 | 483 | // (other than site) by removing them from the array. The default setting is: |
88cb8b78 SA |
484 | // |
485 | // $CFG->themeorder = array('course', 'category', 'session', 'user', 'cohort', 'site'); | |
486 | // | |
487 | // NOTE: course, category, session, user, cohort themes still require the | |
6f93e96c | 488 | // respective settings to be enabled |
489 | // | |
73e504bc PS |
490 | // It is possible to add extra themes directory stored outside of $CFG->dirroot. |
491 | // This local directory does not have to be accessible from internet. | |
492 | // | |
493 | // $CFG->themedir = '/location/of/extra/themes'; | |
494 | // | |
2752739c PS |
495 | // It is possible to specify different cache and temp directories, use local fast filesystem |
496 | // for normal web servers. Server clusters MUST use shared filesystem for cachedir! | |
85b38061 | 497 | // Localcachedir is intended for server clusters, it does not have to be shared by cluster nodes. |
32db0f0d PS |
498 | // The directories must not be accessible via web. |
499 | // | |
ef844148 | 500 | // $CFG->tempdir = '/var/www/moodle/temp'; // Directory MUST BE SHARED by all cluster nodes. |
85b38061 PS |
501 | // $CFG->cachedir = '/var/www/moodle/cache'; // Directory MUST BE SHARED by all cluster nodes, locking required. |
502 | // $CFG->localcachedir = '/var/local/cache'; // Intended for local node caching. | |
9fabe1dd | 503 | // $CFG->localrequestdir = '/tmp'; // Intended for local only temporary files. The defaults uses sys_get_temp_dir(). |
32db0f0d | 504 | // |
ef844148 MS |
505 | // It is possible to specify a different backup temp directory, use local fast filesystem |
506 | // for normal web servers. Server clusters MUST use shared filesystem for backuptempdir! | |
507 | // The directory must not be accessible via web. | |
508 | // | |
509 | // $CFG->backuptempdir = '/var/www/moodle/backuptemp'; // Directory MUST BE SHARED by all cluster nodes. | |
510 | // | |
f0bf9ffe PS |
511 | // Some filesystems such as NFS may not support file locking operations. |
512 | // Locking resolves race conditions and is strongly recommended for production servers. | |
513 | // $CFG->preventfilelocking = false; | |
514 | // | |
56fb6963 DM |
515 | // Site default language can be set via standard administration interface. If you |
516 | // want to have initial error messages for eventual database connection problems | |
517 | // localized too, you have to set your language code here. | |
518 | // | |
519 | // $CFG->lang = 'yourlangcode'; // for example 'cs' | |
520 | // | |
49084fe1 SH |
521 | // When Moodle is about to perform an intensive operation it raises PHP's memory |
522 | // limit. The following setting should be used on large sites to set the raised | |
523 | // memory limit to something higher. | |
524 | // The value for the settings should be a valid PHP memory value. e.g. 512M, 1G | |
e99033b0 | 525 | // |
0a08cb40 | 526 | // $CFG->extramemorylimit = '1024M'; |
e99033b0 | 527 | // |
bb250f02 SH |
528 | // Moodle 2.4 introduced a new cache API. |
529 | // The cache API stores a configuration file within the Moodle data directory and | |
530 | // uses that rather than the database in order to function in a stand-alone manner. | |
531 | // Using altcacheconfigpath you can change the location where this config file is | |
532 | // looked for. | |
533 | // It can either be a directory in which to store the file, or the full path to the | |
534 | // file if you want to take full control. Either way it must be writable by the | |
535 | // webserver. | |
536 | // | |
537 | // $CFG->altcacheconfigpath = '/var/www/shared/moodle.cache.config.php | |
538 | // | |
5aab24ef DM |
539 | // Use the following flag to completely disable the Available update notifications |
540 | // feature and hide it from the server administration UI. | |
541 | // | |
542 | // $CFG->disableupdatenotifications = true; | |
543 | // | |
9137a89a | 544 | // Use the following flag to completely disable the installation of plugins |
b0fc7898 DM |
545 | // (new plugins, available updates and missing dependencies) and related |
546 | // features (such as cancelling the plugin installation or upgrade) via the | |
547 | // server administration web interface. | |
c2c4f722 | 548 | // |
b0fc7898 | 549 | // $CFG->disableupdateautodeploy = true; |
c2c4f722 | 550 | // |
f3807433 AB |
551 | // Use the following flag to disable the warning on the system notifications page |
552 | // about present development libraries. This flag will not disable the warning within | |
553 | // the security overview report. Use this flag only if you really have prohibited web | |
554 | // access to the development libraries in your webserver configuration. | |
555 | // | |
556 | // $CFG->disabledevlibdirscheck = true; | |
557 | // | |
f12f3416 AN |
558 | // Use the following flag to disable modifications to scheduled tasks |
559 | // whilst still showing the state of tasks. | |
560 | // | |
561 | // $CFG->preventscheduledtaskchanges = true; | |
562 | // | |
436dbeec SH |
563 | // As of version 2.4 Moodle serves icons as SVG images if the users browser appears |
564 | // to support SVG. | |
565 | // For those wanting to control the serving of SVG images the following setting can | |
566 | // be defined in your config.php. | |
567 | // If it is not defined then the default (browser detection) will occur. | |
568 | // | |
569 | // To ensure they are always used when available: | |
570 | // $CFG->svgicons = true; | |
571 | // | |
572 | // To ensure they are never used even when available: | |
573 | // $CFG->svgicons = false; | |
574 | // | |
9a2b5e0b HD |
575 | // Some administration options allow setting the path to executable files. This can |
576 | // potentially cause a security risk. Set this option to true to disable editing | |
577 | // those config settings via the web. They will need to be set explicitly in the | |
578 | // config.php file | |
579 | // $CFG->preventexecpath = true; | |
580 | // | |
3bcf6b3c RT |
581 | // Use the following flag to set userid for noreply user. If not set then moodle will |
582 | // create dummy user and use -ve value as user id. | |
583 | // $CFG->noreplyuserid = -10; | |
584 | // | |
585 | // As of version 2.6 Moodle supports admin to set support user. If not set, all mails | |
586 | // will be sent to supportemail. | |
587 | // $CFG->supportuserid = -20; | |
588 | // | |
9843e5ec | 589 | // Moodle 2.7 introduces a locking api for critical tasks (e.g. cron). |
262061d6 BH |
590 | // The default locking system to use is DB locking for Postgres, MySQL, MariaDB and |
591 | // file locking for Oracle and SQLServer. If $CFG->preventfilelocking is set, then the | |
592 | // default will always be DB locking. It can be manually set to one of the lock | |
9843e5ec DW |
593 | // factory classes listed below, or one of your own custom classes implementing the |
594 | // \core\lock\lock_factory interface. | |
595 | // | |
596 | // $CFG->lock_factory = "auto"; | |
597 | // | |
598 | // The list of available lock factories is: | |
599 | // | |
600 | // "\\core\\lock\\file_lock_factory" - File locking | |
601 | // Uses lock files stored by default in the dataroot. Whether this | |
602 | // works on clusters depends on the file system used for the dataroot. | |
603 | // | |
308e481c | 604 | // "\\core\\lock\\db_record_lock_factory" - DB locking based on table rows. |
9843e5ec | 605 | // |
262061d6 BH |
606 | // "\\core\\lock\\mysql_lock_factory" - DB locking based on MySQL / MariaDB locks. |
607 | // | |
9843e5ec DW |
608 | // "\\core\\lock\\postgres_lock_factory" - DB locking based on postgres advisory locks. |
609 | // | |
9843e5ec DW |
610 | // Settings used by the lock factories |
611 | // | |
612 | // Location for lock files used by the File locking factory. This must exist | |
613 | // on a shared file system that supports locking. | |
092acd53 | 614 | // $CFG->file_lock_root = $CFG->dataroot . '/lock'; |
9843e5ec | 615 | // |
4b71596f AN |
616 | // |
617 | // Alternative task logging. | |
618 | // Since Moodle 3.7 the output of al scheduled and adhoc tasks is stored in the database and it is possible to use an | |
619 | // alternative task logging mechanism. | |
620 | // To set the alternative task logging mechanism in config.php you can use the following settings, providing the | |
621 | // alternative class name that will be auto-loaded. | |
622 | // | |
623 | // $CFG->task_log_class = '\\local_mytasklogger\\logger'; | |
624 | // | |
91fed57a | 625 | // Moodle 2.9 allows administrators to customise the list of supported file types. |
626 | // To add a new filetype or override the definition of an existing one, set the | |
627 | // customfiletypes variable like this: | |
628 | // | |
629 | // $CFG->customfiletypes = array( | |
630 | // (object)array( | |
631 | // 'extension' => 'frog', | |
632 | // 'icon' => 'archive', | |
633 | // 'type' => 'application/frog', | |
634 | // 'customdescription' => 'Amphibian-related file archive' | |
635 | // ) | |
636 | // ); | |
637 | // | |
638 | // The extension, icon, and type fields are required. The icon field can refer to | |
639 | // any icon inside the pix/f folder. You can also set the customdescription field | |
640 | // (shown above) and (for advanced use) the groups, string, and defaulticon fields. | |
641 | // | |
98b32c9e DM |
642 | // Upgrade key |
643 | // | |
df15a718 DP |
644 | // If the upgrade key is defined here, then the value must be provided every time |
645 | // the site is being upgraded though the web interface, regardless of whether the | |
646 | // administrator is logged in or not. This prevents anonymous access to the upgrade | |
647 | // screens where the real authentication and authorization mechanisms can not be | |
648 | // relied on. | |
98b32c9e DM |
649 | // |
650 | // It is strongly recommended to use a value different from your real account | |
651 | // password. | |
652 | // | |
653 | // $CFG->upgradekey = 'put_some_password-like_value_here'; | |
654 | // | |
490e48a4 DW |
655 | // Font used in exported PDF files. When generating a PDF, Moodle embeds a subset of |
656 | // the font in the PDF file so it will be readable on the widest range of devices. | |
657 | // The default font is 'freesans' which is part of the GNU FreeFont collection. | |
9e725bc1 TT |
658 | // The font used to export can be set per-course - a drop down list in the course |
659 | // settings shows all the options specified in the array here. The key must be the | |
660 | // font name (e.g., "kozminproregular") and the value is a friendly name, (e.g., | |
661 | // "Kozmin Pro Regular"). | |
490e48a4 | 662 | // |
9e725bc1 | 663 | // $CFG->pdfexportfont = ['freesans' => 'FreeSans']; |
490e48a4 | 664 | // |
32791416 SA |
665 | // Use the following flag to enable messagingallusers and set the default preference |
666 | // value for existing users to allow them to be contacted by other site users. | |
667 | // | |
668 | // $CFG->keepmessagingallusersenabled = true; | |
669 | // | |
6dfe4283 DW |
670 | // Disable login token validation for login pages. Login token validation is enabled |
671 | // by default unless $CFG->alternateloginurl is set. | |
672 | // | |
673 | // $CFG->disablelogintoken = true; | |
674 | // | |
ff13ae59 | 675 | // Moodle 3.7+ checks that cron is running frequently. If the time between cron runs |
676 | // is greater than this value (in seconds), you get a warning on the admin page. (This | |
677 | // setting only controls whether or not the warning appears, it has no other effect.) | |
678 | // | |
679 | // $CFG->expectedcronfrequency = 200; | |
680 | // | |
59a44a5b BH |
681 | // Moodle 3.9+ checks how old tasks are in the ad hoc queue and warns at 10 minutes |
682 | // and errors at 4 hours. Set these to override these limits: | |
683 | // | |
684 | // $CFG->adhoctaskagewarn = 10 * 60; | |
685 | // $CFG->adhoctaskageerror = 4 * 60 * 60; | |
686 | // | |
0b733266 | 687 | // Moodle 4.2+ checks how long tasks have been running for at warns at 12 hours |
791e56d3 QC |
688 | // and errors at 24 hours. Set these to override these limits: |
689 | // | |
690 | // $CFG->taskruntimewarn = 12 * 60 * 60; | |
691 | // $CFG->taskruntimeerror = 24 * 60 * 60; | |
692 | // | |
693 | // This is not to be confused with $CFG->task_adhoc_max_runtime which is how long the | |
694 | // php process should be allowed to run for, not each specific task. | |
695 | // | |
fdb9c321 TM |
696 | // Session lock warning threshold. Long running pages should release the session using \core\session\manager::write_close(). |
697 | // Set this threshold to any value greater than 0 to add developer warnings when a page locks the session for too long. | |
698 | // The session should rarely be locked for more than 1 second. The input should be in seconds and may be a float. | |
699 | // | |
700 | // $CFG->debugsessionlock = 5; | |
701 | // | |
4400ed3e MN |
702 | // There are times when a session lock is not required during a request. For a page/service to opt-in whether or not a |
703 | // session lock is required this setting must first be set to 'true'. | |
a8c0258b | 704 | // The session store can not be in the session, please see https://docs.moodle.org/en/Session_handling#Read_only_sessions. |
4400ed3e MN |
705 | // |
706 | // $CFG->enable_read_only_sessions = true; | |
707 | // | |
1dadeaeb BH |
708 | // To help expose all the edge cases bugs a debug mode is available which shows the same |
709 | // runtime write during readonly errors without actually turning on the readonly sessions: | |
710 | // | |
711 | // $CFG->enable_read_only_sessions_debug = true; | |
712 | // | |
442eeac3 PB |
713 | // Uninstall plugins from CLI only. This stops admins from uninstalling plugins from the graphical admin |
714 | // user interface, and forces plugins to be uninstalled from the Command Line tool only, found at | |
715 | // admin/cli/plugin_uninstall.php. | |
716 | // | |
717 | // $CFG->uninstallclionly = true; | |
718 | // | |
10db3a0b NN |
719 | // Course and category sorting |
720 | // | |
721 | // If the number of courses in a category exceeds $CFG->maxcoursesincategory (10000 by default), it may lead to duplicate | |
722 | // sort orders of courses in separated categories. For example: | |
723 | // - Category A has the sort order of 10000, and has 10000 courses. The last course will have the sort order of 20000. | |
724 | // - Category B has the sort order of 20000, and has a course with the sort order of 20001. | |
725 | // - If we add another course in category A, it will have a sort order of 20001, | |
726 | // which is the same as the course in category B | |
727 | // The duplicate will cause sorting issue and hence we need to increase $CFG->maxcoursesincategory | |
728 | // to fix the duplicate sort order | |
729 | // Please also make sure $CFG->maxcoursesincategory * MAX_COURSE_CATEGORIES less than max integer. | |
730 | // | |
731 | // $CFG->maxcoursesincategory = 10000; | |
732 | // | |
ddbafce0 | 733 | // Admin setting encryption |
734 | // | |
735 | // $CFG->secretdataroot = '/var/www/my_secret_folder'; | |
736 | // | |
737 | // Location to store encryption keys. By default this is $CFG->dataroot/secret; set this if | |
738 | // you want to use a different location for increased security (e.g. if too many people have access | |
739 | // to the main dataroot, or if you want to avoid using shared storage). Your web server user needs | |
740 | // read access to this location, and write access unless you manually create the keys. | |
741 | // | |
742 | // $CFG->nokeygeneration = false; | |
743 | // | |
744 | // If you change this to true then the server will give an error if keys don't exist, instead of | |
745 | // automatically generating them. This is only needed if you want to ensure that keys are consistent | |
746 | // across a cluster when not using shared storage. If you stop the server generating keys, you will | |
747 | // need to manually generate them by running 'php admin/cli/generate_key.php'. | |
4c7bf9eb MG |
748 | // |
749 | // H5P crossorigin | |
750 | // | |
751 | // $CFG->h5pcrossorigin = 'anonymous'; | |
752 | // | |
753 | // Settings this to anonymous will enable CORS requests for media elements to have the credentials | |
754 | // flag set to 'same-origin'. This may be needed when using tool_objectfs as an alternative file | |
755 | // system with CloudFront configured. | |
a6cad23b DM |
756 | // |
757 | // Enrolments sync interval | |
758 | // | |
759 | // The minimum time in seconds between re-synchronization of enrollment via enrol_check_plugins which is | |
760 | // a potentially expensive operation and otherwise happens every time a user is authenticated. This only | |
761 | // applies to web requests without a session such as webservice calls, tokenpluginfile.php and rss links | |
762 | // where the user is re-authenticated on every request. Set it to 0 to force enrollment checking constantly | |
763 | // and increase this number to improve performance at the cost of adding a latency for enrollment updates. | |
764 | // Defaults to 60 minutes. | |
765 | // | |
766 | // $CFG->enrolments_sync_interval = 3600 | |
ddbafce0 | 767 | |
84ebf08d | 768 | //========================================================================= |
ec2d8ceb | 769 | // 7. SETTINGS FOR DEVELOPMENT SERVERS - not intended for production use!!! |
84ebf08d | 770 | //========================================================================= |
f4fa5a63 | 771 | // |
91ee8a67 | 772 | // Force a debugging mode regardless the settings in the site administration |
d9d61fa3 PS |
773 | // @error_reporting(E_ALL | E_STRICT); // NOT FOR PRODUCTION SERVERS! |
774 | // @ini_set('display_errors', '1'); // NOT FOR PRODUCTION SERVERS! | |
775 | // $CFG->debug = (E_ALL | E_STRICT); // === DEBUG_DEVELOPER - NOT FOR PRODUCTION SERVERS! | |
776 | // $CFG->debugdisplay = 1; // NOT FOR PRODUCTION SERVERS! | |
91ee8a67 | 777 | // |
0ed26d12 PS |
778 | // You can specify a comma separated list of user ids that that always see |
779 | // debug messages, this overrides the debug flag in $CFG->debug and $CFG->debugdisplay | |
780 | // for these users only. | |
781 | // $CFG->debugusers = '2'; | |
782 | // | |
91ee8a67 | 783 | // Prevent theme caching |
770a25c6 | 784 | // $CFG->themedesignermode = true; // NOT FOR PRODUCTION SERVERS! |
91ee8a67 | 785 | // |
644f44cf BH |
786 | // Enable verbose debug information during fetching of email messages from IMAP server. |
787 | // $CFG->debugimap = true; | |
788 | // | |
22dfa6d3 DM |
789 | // Enable verbose debug information during sending of email messages to SMTP server. |
790 | // Note: also requires $CFG->debug set to DEBUG_DEVELOPER. | |
791 | // $CFG->debugsmtp = true; | |
792 | // | |
a45e8fd3 | 793 | // Prevent JS caching |
770a25c6 | 794 | // $CFG->cachejs = false; // NOT FOR PRODUCTION SERVERS! |
a45e8fd3 | 795 | // |
5beb3885 MN |
796 | // Prevent Template caching |
797 | // $CFG->cachetemplates = false; // NOT FOR PRODUCTION SERVERS! | |
798 | // | |
fa64202a AN |
799 | // Restrict which YUI logging statements are shown in the browser console. |
800 | // For details see the upstream documentation: | |
801 | // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logInclude | |
802 | // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logExclude | |
803 | // $CFG->yuiloginclude = array( | |
fa64202a AN |
804 | // 'moodle-course-categoryexpander' => true, |
805 | // ); | |
806 | // $CFG->yuilogexclude = array( | |
fa64202a AN |
807 | // 'moodle-core-notification' => true, |
808 | // ); | |
809 | // | |
810 | // Set the minimum log level for YUI logging statements. | |
811 | // For details see the upstream documentation: | |
812 | // http://yuilibrary.com/yui/docs/api/classes/config.html#property_logLevel | |
813 | // $CFG->yuiloglevel = 'debug'; | |
814 | // | |
598a82c9 | 815 | // Prevent core_string_manager application caching |
e799e819 | 816 | // $CFG->langstringcache = false; // NOT FOR PRODUCTION SERVERS! |
f53fde9f | 817 | // |
38d93cb0 PS |
818 | // When working with production data on test servers, no emails or other messages |
819 | // should ever be send to real users | |
91ee8a67 | 820 | // $CFG->noemailever = true; // NOT FOR PRODUCTION SERVERS! |
49da4a5f DM |
821 | // |
822 | // Divert all outgoing emails to this address to test and debug emailing features | |
91ee8a67 | 823 | // $CFG->divertallemailsto = 'root@localhost.local'; // NOT FOR PRODUCTION SERVERS! |
1045a007 | 824 | // |
eca8cf67 BH |
825 | // Except for certain email addresses you want to let through for testing. Accepts |
826 | // a comma separated list of regexes. | |
827 | // $CFG->divertallemailsexcept = 'tester@dev.com, fred(\+.*)?@example.com'; // NOT FOR PRODUCTION SERVERS! | |
828 | // | |
76f2fcde | 829 | // Uncomment if you want to allow empty comments when modifying install.xml files. |
91ee8a67 | 830 | // $CFG->xmldbdisablecommentchecking = true; // NOT FOR PRODUCTION SERVERS! |
1045a007 | 831 | // |
832 | // Since 2.0 sql queries are not shown during upgrade by default. | |
833 | // Please note that this setting may produce very long upgrade page on large sites. | |
91ee8a67 | 834 | // $CFG->upgradeshowsql = true; // NOT FOR PRODUCTION SERVERS! |
12bb0c3e | 835 | // |
ddd11b6c PS |
836 | // Add SQL queries to the output of cron, just before their execution |
837 | // $CFG->showcronsql = true; | |
838 | // | |
839 | // Force developer level debug and add debug info to the output of cron | |
840 | // $CFG->showcrondebugging = true; | |
841 | // | |
16f05b5c PH |
842 | // Force result of checks used to determine whether a site is considered "public" or not (such as for site registration). |
843 | // $CFG->site_is_public = false; | |
844 | // | |
12bb0c3e | 845 | //========================================================================= |
ec2d8ceb | 846 | // 8. FORCED SETTINGS |
12bb0c3e PS |
847 | //========================================================================= |
848 | // It is possible to specify normal admin settings here, the point is that | |
849 | // they can not be changed through the standard admin settings pages any more. | |
850 | // | |
851 | // Core settings are specified directly via assignment to $CFG variable. | |
852 | // Example: | |
853 | // $CFG->somecoresetting = 'value'; | |
854 | // | |
855 | // Plugin settings have to be put into a special array. | |
856 | // Example: | |
857 | // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'secondsetting' => 'othervalue'), | |
858 | // 'otherplugin' => array('mysetting' => 'myvalue', 'thesetting' => 'thevalue')); | |
3c88a678 DW |
859 | // Module default settings with advanced/locked checkboxes can be set too. To do this, add |
860 | // an extra config with '_adv' or '_locked' as a suffix and set the value to true or false. | |
861 | // Example: | |
862 | // $CFG->forced_plugin_settings = array('pluginname' => array('settingname' => 'value', 'settingname_locked' => true, 'settingname_adv' => true)); | |
5bd40408 PS |
863 | // |
864 | //========================================================================= | |
ec2d8ceb | 865 | // 9. PHPUNIT SUPPORT |
5bd40408 PS |
866 | //========================================================================= |
867 | // $CFG->phpunit_prefix = 'phpu_'; | |
868 | // $CFG->phpunit_dataroot = '/home/example/phpu_moodledata'; | |
869 | // $CFG->phpunit_directorypermissions = 02777; // optional | |
8f7dcb34 | 870 | // $CFG->phpunit_profilingenabled = true; // optional to profile PHPUnit runs. |
a09534f4 | 871 | // |
ec2d8ceb SC |
872 | // |
873 | //========================================================================= | |
874 | // 10. SECRET PASSWORD SALT | |
875 | //========================================================================= | |
6780a1d3 PŠ |
876 | // A site-wide password salt is no longer used in new installations. |
877 | // If upgrading from 2.6 or older, keep all existing salts in config.php file. | |
ec2d8ceb SC |
878 | // |
879 | // $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1'; | |
880 | // | |
881 | // You may also have some alternative salts to allow migration from previously | |
882 | // used salts. | |
883 | // | |
884 | // $CFG->passwordsaltalt1 = ''; | |
885 | // $CFG->passwordsaltalt2 = ''; | |
886 | // $CFG->passwordsaltalt3 = ''; | |
887 | // .... | |
888 | // $CFG->passwordsaltalt19 = ''; | |
889 | // $CFG->passwordsaltalt20 = ''; | |
890 | // | |
891 | // | |
a09534f4 DM |
892 | //========================================================================= |
893 | // 11. BEHAT SUPPORT | |
894 | //========================================================================= | |
60129d5d | 895 | // Behat test site needs a unique www root, data directory and database prefix: |
f8cb3e62 | 896 | // |
60129d5d | 897 | // $CFG->behat_wwwroot = 'http://127.0.0.1/moodle'; |
f8cb3e62 PS |
898 | // $CFG->behat_prefix = 'bht_'; |
899 | // $CFG->behat_dataroot = '/home/example/bht_moodledata'; | |
15c7a4bd OA |
900 | // $CFG->behat_dbname = 'behat'; // optional |
901 | // $CFG->behat_dbuser = 'username'; // optional | |
902 | // $CFG->behat_dbpass = 'password'; // optional | |
903 | // $CFG->behat_dbhost = 'localhost'; // optional | |
f8cb3e62 | 904 | // |
d6abac76 DM |
905 | // You can override default Moodle configuration for Behat and add your own |
906 | // params; here you can add more profiles, use different Mink drivers than Selenium... | |
096858ed DM |
907 | // These params would be merged with the default Moodle behat.yml, giving priority |
908 | // to the ones specified here. The array format is YAML, following the Behat | |
d6abac76 DM |
909 | // params hierarchy. More info: http://docs.behat.org/guides/7.config.html |
910 | // Example: | |
bd770617 | 911 | // $CFG->behat_config = array( |
ae689a96 | 912 | // 'Mac-Firefox' => array( |
42ad096f RT |
913 | // 'suites' => array ( |
914 | // 'default' => array( | |
915 | // 'filters' => array( | |
916 | // 'tags' => '~@_file_upload' | |
917 | // ), | |
918 | // ), | |
919 | // ), | |
ae689a96 | 920 | // 'extensions' => array( |
42ad096f | 921 | // 'Behat\MinkExtension' => array( |
230896b7 | 922 | // 'webddriver' => array( |
ae689a96 DM |
923 | // 'browser' => 'firefox', |
924 | // 'capabilities' => array( | |
925 | // 'platform' => 'OS X 10.6', | |
926 | // 'version' => 20 | |
927 | // ) | |
928 | // ) | |
929 | // ) | |
930 | // ) | |
931 | // ), | |
932 | // 'Mac-Safari' => array( | |
933 | // 'extensions' => array( | |
42ad096f | 934 | // 'Behat\MinkExtension' => array( |
230896b7 | 935 | // 'webddriver' => array( |
ae689a96 DM |
936 | // 'browser' => 'safari', |
937 | // 'capabilities' => array( | |
938 | // 'platform' => 'OS X 10.8', | |
939 | // 'version' => 6 | |
940 | // ) | |
941 | // ) | |
942 | // ) | |
943 | // ) | |
d6abac76 DM |
944 | // ) |
945 | // ); | |
0e1c34e5 RT |
946 | // You can also use the following config to override default Moodle configuration for Behat. |
947 | // This config is limited to default suite and will be supported in later versions. | |
948 | // It will have precedence over $CFG->behat_config. | |
949 | // $CFG->behat_profiles = array( | |
950 | // 'phantomjs' => array( | |
951 | // 'browser' => 'phantomjs', | |
952 | // 'tags' => '~@_file_upload&&~@_alert&&~@_bug_phantomjs', | |
953 | // 'wd_host' => 'http://127.0.0.1:4443/wd/hub', | |
954 | // 'capabilities' => array( | |
955 | // 'platform' => 'Linux', | |
956 | // 'version' => 2.1 | |
957 | // ) | |
958 | // ), | |
959 | // ); | |
d6abac76 | 960 | // |
401f60d5 DM |
961 | // All this page's extra Moodle settings are compared against a white list of allowed settings |
962 | // (the basic and behat_* ones) to avoid problems with production environments. This setting can be | |
963 | // used to expand the default white list with an array of extra settings. | |
964 | // Example: | |
d0c2bc64 | 965 | // $CFG->behat_extraallowedsettings = array('somecoresetting', ...); |
1325d493 | 966 | // |
c3a40dea DM |
967 | // You should explicitly allow the usage of the deprecated behat steps, otherwise an exception will |
968 | // be thrown when using them. The setting is disabled by default. | |
969 | // Example: | |
970 | // $CFG->behat_usedeprecated = true; | |
971 | // | |
05a5d547 | 972 | // If you are using a slow machine, it may help to increase the timeouts that Behat uses. The |
973 | // following example will increase timeouts by a factor of 3 (using 30 seconds instead of 10 | |
974 | // seconds, for instance). | |
975 | // Example: | |
976 | // $CFG->behat_increasetimeout = 3; | |
977 | // | |
2d62323d AN |
978 | // Yon can specify a window size modifier for Behat, which is applied to any window szie changes. |
979 | // For example, if a window size of 640x768 is specified, with a modifier of 2, then the final size is 1280x1536. | |
980 | // This is particularly useful for behat reruns to eliminate issues with window sizing. | |
981 | // Example: | |
982 | // $CFG->behat_window_size_modifier = 1; | |
983 | // | |
ddb0a1b0 AB |
984 | // Including feature files from directories outside the dirroot is possible if required. The setting |
985 | // requires that the running user has executable permissions on all parent directories in the paths. | |
986 | // Example: | |
987 | // $CFG->behat_additionalfeatures = array('/home/developer/code/wipfeatures'); | |
988 | // | |
a964ead0 AN |
989 | // You can make behat save several dumps when a scenario fails. The dumps currently saved are: |
990 | // * a dump of the DOM in it's state at the time of failure; and | |
991 | // * a screenshot (JavaScript is required for the screenshot functionality, so not all browsers support this option) | |
5c0dfe32 | 992 | // Example: |
a964ead0 | 993 | // $CFG->behat_faildump_path = '/my/path/to/save/failure/dumps'; |
5c0dfe32 | 994 | // |
0b07ea42 AN |
995 | // You can make behat pause upon failure to help you diagnose and debug problems with your tests. |
996 | // | |
997 | // $CFG->behat_pause_on_fail = true; | |
998 | // | |
3c71c15c RT |
999 | // You can specify db, selenium wd_host etc. for behat parallel run by setting following variable. |
1000 | // Example: | |
1001 | // $CFG->behat_parallel_run = array ( | |
1002 | // array ( | |
1003 | // 'dbtype' => 'mysqli', | |
1004 | // 'dblibrary' => 'native', | |
1005 | // 'dbhost' => 'localhost', | |
1006 | // 'dbname' => 'moodletest', | |
1007 | // 'dbuser' => 'moodle', | |
1008 | // 'dbpass' => 'moodle', | |
1009 | // 'behat_prefix' => 'mdl_', | |
5b9e6b55 RT |
1010 | // 'wd_host' => 'http://127.0.0.1:4444/wd/hub', |
1011 | // 'behat_wwwroot' => 'http://127.0.0.1/moodle', | |
1012 | // 'behat_dataroot' => '/home/example/bht_moodledata' | |
3c71c15c RT |
1013 | // ), |
1014 | // ); | |
1015 | // | |
52acb7c9 RT |
1016 | // To change name of behat parallel run site, define BEHAT_PARALLEL_SITE_NAME and parallel run sites will be suffixed |
1017 | // with this value | |
1018 | // Example: | |
1019 | // define('BEHAT_PARALLEL_SITE_NAME', 'behatparallelsite'); | |
1020 | // | |
1021 | // Command line output for parallel behat install is limited to 80 chars, if you are installing more then 4 sites and | |
1022 | // want to expand output to more then 80 chars, then define BEHAT_MAX_CMD_LINE_OUTPUT | |
1023 | // Example: | |
1024 | // define('BEHAT_MAX_CMD_LINE_OUTPUT', 120); | |
1025 | // | |
1026 | // Behat feature files will be distributed randomly between the processes by default. If you have timing file or want | |
1027 | // to create timing file then define BEHAT_FEATURE_TIMING_FILE with path to timing file. It will be updated for each | |
1028 | // run with latest time taken to execute feature. | |
1029 | // Example: | |
1030 | // define('BEHAT_FEATURE_TIMING_FILE', '/PATH_TO_TIMING_FILE/timing.json'); | |
1031 | // | |
1032 | // If you don't have timing file and want some stable distribution of features, then you can use step counts to | |
1033 | // distribute the features. You can generate step file by executing php admin/tool/behat/cli/util.php --updatesteps | |
1034 | // this will update step file which is defined by BEHAT_FEATURE_STEP_FILE. | |
1035 | // Example: | |
1036 | // define('BEHAT_FEATURE_STEP_FILE', '/PATH_TO_FEATURE_STEP_COUNT_FILE/stepcount.json'); | |
1037 | // | |
1038 | // Feature distribution for each process is displayed as histogram. you can disable it by setting | |
1039 | // BEHAT_DISABLE_HISTOGRAM | |
1040 | // Example: | |
1041 | // define('BEHAT_DISABLE_HISTOGRAM', true); | |
1042 | // | |
594a6434 | 1043 | // Mobile app Behat testing requires this option, pointing to the url where the Ionic application is served: |
ff3ccab5 | 1044 | // $CFG->behat_ionic_wwwroot = 'http://localhost:8100'; |
1959e164 | 1045 | // |
1325d493 DM |
1046 | //========================================================================= |
1047 | // 12. DEVELOPER DATA GENERATOR | |
1048 | //========================================================================= | |
1049 | // | |
1050 | // The developer data generator tool is intended to be used only in development or testing sites and | |
1051 | // it's usage in production environments is not recommended; if it is used to create JMeter test plans | |
1052 | // is even less recommended as JMeter needs to log in as site course users. JMeter needs to know the | |
1053 | // users passwords but would be dangerous to have a default password as everybody would know it, which would | |
1054 | // be specially dangerouse if somebody uses this tool in a production site, so in order to prevent unintended | |
1055 | // uses of the tool and undesired accesses as well, is compulsory to set a password for the users | |
1056 | // generated by this tool, but only in case you want to generate a JMeter test. The value should be a string. | |
1057 | // Example: | |
1058 | // $CFG->tool_generator_users_password = 'examplepassword'; | |
1bce3a70 RT |
1059 | // |
1060 | //========================================================================= | |
1061 | // 13. SYSTEM PATHS (You need to set following, depending on your system) | |
1062 | //========================================================================= | |
1063 | // Ghostscript path. | |
1064 | // On most Linux installs, this can be left as '/usr/bin/gs'. | |
1065 | // On Windows it will be something like 'c:\gs\bin\gswin32c.exe' (make sure | |
1066 | // there are no spaces in the path - if necessary copy the files 'gswin32c.exe' | |
1067 | // and 'gsdll32.dll' to a new folder without a space in the path) | |
1068 | // $CFG->pathtogs = '/usr/bin/gs'; | |
1069 | // | |
c759ae5d TBM |
1070 | // Path to PHP CLI. |
1071 | // Probably something like /usr/bin/php. If you enter this, cron scripts can be | |
1072 | // executed from admin web interface. | |
1073 | // $CFG->pathtophp = ''; | |
1074 | // | |
1bce3a70 RT |
1075 | // Path to du. |
1076 | // Probably something like /usr/bin/du. If you enter this, pages that display | |
1077 | // directory contents will run much faster for directories with a lot of files. | |
1078 | // $CFG->pathtodu = ''; | |
1079 | // | |
1080 | // Path to aspell. | |
1081 | // To use spell-checking within the editor, you MUST have aspell 0.50 or later | |
1082 | // installed on your server, and you must specify the correct path to access the | |
1083 | // aspell binary. On Unix/Linux systems, this path is usually /usr/bin/aspell, | |
1084 | // but it might be something else. | |
1085 | // $CFG->aspellpath = ''; | |
1086 | // | |
1087 | // Path to dot. | |
1088 | // Probably something like /usr/bin/dot. To be able to generate graphics from | |
1089 | // DOT files, you must have installed the dot executable and point to it here. | |
1090 | // Note that, for now, this only used by the profiling features | |
1091 | // (Development->Profiling) built into Moodle. | |
1092 | // $CFG->pathtodot = ''; | |
2e76c14e | 1093 | // |
1356d851 DW |
1094 | // Path to unoconv. |
1095 | // Probably something like /usr/bin/unoconv. Used as a fallback to convert between document formats. | |
1096 | // Unoconv is used convert between file formats supported by LibreOffice. | |
1097 | // Use a recent version of unoconv ( >= 0.7 ), older versions have trouble running from a webserver. | |
1098 | // $CFG->pathtounoconv = ''; | |
e6a1843e SL |
1099 | // |
1100 | //========================================================================= | |
1101 | // 14. ALTERNATIVE FILE SYSTEM SETTINGS | |
1102 | //========================================================================= | |
1103 | // | |
1104 | // Alternative file system. | |
1105 | // Since 3.3 it is possible to override file_storage and file_system API and use alternative storage systems (e.g. S3, | |
1106 | // Rackspace Cloud Files, Google Cloud Storage, Azure Storage, etc.). | |
1107 | // To set the alternative file storage system in config.php you can use the following setting, providing the | |
1108 | // alternative system class name that will be auto-loaded by file_storage API. | |
1109 | // | |
1110 | // $CFG->alternative_file_system_class = '\\local_myfilestorage\\file_system'; | |
1111 | // | |
6077020a | 1112 | //========================================================================= |
ed7cd552 SL |
1113 | // 15. CAMPAIGN CONTENT |
1114 | //========================================================================= | |
1115 | // | |
1116 | // We have added a campaign content to the notifications page, in case you want to hide that from your site you just | |
1117 | // need to set showcampaigncontent setting to false. | |
1118 | // | |
1119 | // $CFG->showcampaigncontent = true; | |
1120 | // | |
1121 | //========================================================================= | |
ba9fc5ed PB |
1122 | // 16. ALTERNATIVE CACHE CONFIG SETTINGS |
1123 | //========================================================================= | |
1124 | // | |
1125 | // Alternative cache config. | |
1126 | // Since 3.10 it is possible to override the cache_factory class with an alternative caching factory. | |
1127 | // This overridden factory can provide alternative classes for caching such as cache_config, | |
1128 | // cache_config_writer and core_cache\local\administration_display_helper. | |
1129 | // The autoloaded factory class name can be specified to use. | |
1130 | // | |
1131 | // $CFG->alternative_cache_factory_class = 'tool_alternativecache_cache_factory'; | |
1132 | // | |
1133 | //========================================================================= | |
3a232840 JS |
1134 | // 17. SCHEDULED TASK OVERRIDES |
1135 | //========================================================================= | |
1136 | // | |
1137 | // It is now possible to define scheduled tasks directly within config. | |
1138 | // The overridden value will take precedence over the values that have been set VIA the UI from the | |
1139 | // next time the task is run. | |
1140 | // | |
1141 | // Tasks are configured as an array of tasks that can override a task's schedule, as well as setting | |
1142 | // the task as disabled. I.e: | |
1143 | // | |
1144 | // $CFG->scheduled_tasks = [ | |
1145 | // '\local_plugin\task\my_task' => [ | |
1146 | // 'schedule' => '*/15 0 0 0 0', | |
1147 | // 'disabled' => 0, | |
1148 | // ], | |
1149 | // ]; | |
1150 | // | |
a113af24 | 1151 | // The format for the schedule definition is: '{minute} {hour} {day} {month} {dayofweek}'. |
3a232840 JS |
1152 | // |
1153 | // The classname of the task also supports wildcards: | |
1154 | // | |
1155 | // $CFG->scheduled_tasks = [ | |
1156 | // '\local_plugin\*' => [ | |
1157 | // 'schedule' => '*/15 0 0 0 0', | |
1158 | // 'disabled' => 0, | |
1159 | // ], | |
1160 | // '*' => [ | |
1161 | // 'schedule' => '0 0 0 0 0', | |
1162 | // 'disabled' => 0, | |
1163 | // ], | |
1164 | // ]; | |
1165 | // | |
1166 | // In this example, any task classnames matching '\local_plugin\*' would match the first rule and | |
1167 | // use that schedule the next time the task runs. Note that even though the 'local_plugin' tasks match | |
1168 | // the second rule as well, the highest rule takes precedence. Therefore, the second rule would be | |
1169 | // applied to all tasks, except for tasks within '\local_plugin\'. | |
1170 | // | |
1171 | // When the full classname is used, this rule always takes priority over any wildcard rules. | |
1172 | // | |
1173 | //========================================================================= | |
42895003 SA |
1174 | // 18. SITE ADMIN PRESETS |
1175 | //========================================================================= | |
1176 | // | |
1177 | // The site admin presets plugin has been integrated in Moodle LMS. You can use a setting in case you | |
1178 | // want to apply a preset during the installation: | |
1179 | // | |
1180 | // $CFG->setsitepresetduringinstall = 'starter'; | |
1181 | // | |
1182 | // This setting accepts the following values: | |
1183 | // - One of the core preset names (i.e "starter" or "full"). | |
1184 | // - The path of a valid XML preset file, that will be imported and applied. Absolute paths are recommended, to | |
fc082d34 | 1185 | // guarantee the file is found: i.e."MOODLEPATH/admin/presets/tests/fixtures/import_settings_plugins.xml". |
42895003 SA |
1186 | // |
1187 | // This setting is only used during the installation process. So once the Moodle site is installed, it is ignored. | |
1188 | // | |
1189 | //========================================================================= | |
9dc03a9e SL |
1190 | // 19. SERVICES AND SUPPORT CONTENT |
1191 | //========================================================================= | |
1192 | // | |
1193 | // We have added services and support content to the notifications page, in case you want to hide that from your site | |
1194 | // you just need to set showservicesandsupportcontent setting to false. | |
1195 | // | |
1196 | // $CFG->showservicesandsupportcontent = false; | |
1197 | // | |
1198 | //========================================================================= | |
6077020a | 1199 | // ALL DONE! To continue installation, visit your main page with a browser |
1200 | //========================================================================= | |
c781942f | 1201 | |
1fcf0ca8 | 1202 | require_once(__DIR__ . '/lib/setup.php'); // Do not edit |
3b5ff37f | 1203 | |
fa4556c5 | 1204 | // There is no php closing tag in this file, |
1205 | // it is intentional because it prevents trailing whitespace problems! |