config-dist.php

   1 <?PHP // $Id$
   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 2 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 $CFG = new stdClass();
  32
  33 //=========================================================================
  34 // 1. DATABASE SETUP
  35 //=========================================================================
  36 // First, you need to configure the database where all Moodle data       //
  37 // will be stored.  This database must already have been created         //
  38 // and a username/password created to access it.                         //
  39 //                                                                       //
  40 //   mysql      - the prefix is optional, but useful when installing     //
  41 //                into databases that already contain tables.            //
  42 //
  43 //   postgres7  - the prefix is REQUIRED, regardless of whether the      //
  44 //                database already contains tables.                      //
  45 //                                                                       //
  46 // A special case exists when using PostgreSQL databases via sockets.    //
  47 // Define dbhost as follows, leaving dbname, dbuser, dbpass BLANK!:      //
  48 //    $CFG->dbhost = " user='muser' password='mpass' dbname='mdata'";    //
  49 //
  50
  51 $CFG->dbtype    = 'mysql';       // mysql or postgres7 (for now)
  52 $CFG->dbhost    = 'localhost';   // eg localhost or db.isp.com
  53 $CFG->dbname    = 'moodle';      // database name, eg moodle
  54 $CFG->dbuser    = 'username';    // your database username
  55 $CFG->dbpass    = 'password';    // your database password
  56 $CFG->prefix    = 'mdl_';        // Prefix to use for all table names
  57
  58 $CFG->dbpersist = false;         // Should database connections be reused?
  59                  // "false" is the most stable setting
  60                  // "true" can improve performance sometimes
  61
  62
  63 //=========================================================================
  64 // 1.5. SECRET PASSWORD SALT
  65 //=========================================================================
  66 // User password salt is very important security feature, it is created
  67 // automatically in installer, you have to uncomment and modify value
  68 // on the next line if you are creating config.php manually.
  69 //
  70 // $CFG->passwordsaltmain = 'a_very_long_random_string_of_characters#@6&*1';
  71 //
  72 // After changing the main salt you have to copy old value into one
  73 // of the following settings - this allows migration to the new salt
  74 // during the next login of each user.
  75 //
  76 // $CFG->passwordsaltalt1 = '';
  77 // $CFG->passwordsaltalt2 = '';
  78 // $CFG->passwordsaltalt3 = '';
  79 // ....
  80 // $CFG->passwordsaltalt19 = '';
  81 // $CFG->passwordsaltalt20 = '';
  82
  83
  84 //=========================================================================
  85 // 2. WEB SITE LOCATION
  86 //=========================================================================
  87 // Now you need to tell Moodle where it is located. Specify the full
  88 // web address to where moodle has been installed.  If your web site
  89 // is accessible via multiple URLs then choose the most natural one
  90 // that your students would use.  Do not include a trailing slash
  91
  92 $CFG->wwwroot   = 'http://example.com/moodle';
  93
  94
  95 //=========================================================================
  96 // 3. SERVER FILES LOCATION
  97 //=========================================================================
  98 // Next, specify the full OS directory path to this same location
  99 // Make sure the upper/lower case is correct.  Some examples:
 100 //
 101 //    $CFG->dirroot = 'C:\program files\easyphp\www\moodle';    // Windows
 102 //    $CFG->dirroot = '/var/www/html/moodle';     // Redhat Linux
 103 //    $CFG->dirroot = '/home/example/public_html/moodle'; // Cpanel host
 104
 105 $CFG->dirroot   = '/home/example/public_html/moodle';
 106
 107
 108 //=========================================================================
 109 // 4. DATA FILES LOCATION
 110 //=========================================================================
 111 // Now you need a place where Moodle can save uploaded files.  This
 112 // directory should be readable AND WRITEABLE by the web server user
 113 // (usually 'nobody' or 'apache'), but it should not be accessible
 114 // directly via the web.
 115 //
 116 // - On hosting systems you might need to make sure that your "group" has
 117 //   no permissions at all, but that "others" have full permissions.
 118 //
 119 // - On Windows systems you might specify something like 'c:\moodledata'
 120
 121 $CFG->dataroot  = '/home/example/moodledata';
 122
 123
 124 //=========================================================================
 125 // 5. DATA FILES PERMISSIONS
 126 //=========================================================================
 127 // The following parameter sets the permissions of new directories
 128 // created by Moodle within the data directory.  The format is in
 129 // octal format (as used by the Unix utility chmod, for example).
 130 // The default is usually OK, but you may want to change it to 0750
 131 // if you are concerned about world-access to the files (you will need
 132 // to make sure the web server process (eg Apache) can access the files.
 133 // NOTE: the prefixed 0 is important, and don't use quotes.
 134
 135 $CFG->directorypermissions = 02777;
 136
 137
 138 //=========================================================================
 139 // 6. DIRECTORY LOCATION  (most people can just ignore this setting)
 140 //=========================================================================
 141 // A very few webhosts use /admin as a special URL for you to access a
 142 // control panel or something.  Unfortunately this conflicts with the
 143 // standard location for the Moodle admin pages.  You can fix this by
 144 // renaming the admin directory in your installation, and putting that
 145 // new name here.  eg "moodleadmin".  This will fix admin links in Moodle.
 146
 147 $CFG->admin = 'admin';
 148
 149
 150 //=========================================================================
 151 // 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
 152 //=========================================================================
 153 //
 154 // These are additional tweaks for which no GUI exists in Moodle yet.
 155 //
 156 // Starting in PHP 5.3 administrators should specify default timezone
 157 // in PHP.ini, you can also specify it here if needed.
 158 // See details at: http://php.net/manual/en/function.date-default-timezone-set.php
 159 // List of time zones at: http://php.net/manual/en/timezones.php
 160 //     date_default_timezone_set('Australia/Perth');
 161 //
 162 // Change the key pair lifetime for Moodle Networking
 163 // The default is 28 days. You would only want to change this if the key
 164 // was not getting regenerated for any reason. You would probably want
 165 // make it much longer. Note that you'll need to delete and manually update
 166 // any existing key.
 167 //      $CFG->mnetkeylifetime = 28;
 168 //
 169 // Prevent scheduled backups from operating (and hide the GUI for them)
 170 // Useful for webhost operators who have alternate methods of backups
 171 //      $CFG->disablescheduledbackups = true;
 172 //
 173 // Allow user passwords to be included in backup files. Very dangerous
 174 // setting as far as it publishes password hashes that can be unencrypted
 175 // if the backup file is publicy available. Use it only if you can guarantee
 176 // that all your backup files remain only privacy available and are never
 177 // shared out from your site/institution!
 178 //      $CFG->includeuserpasswordsinbackup = true;
 179 //
 180 // Completely disable user creation when restoring a course, bypassing any
 181 // permissions granted via roles and capabilities. Enabling this setting
 182 // results in the restore process stopping when a user attempts to restore a
 183 // course requiring users to be created.
 184 //     $CFG->disableusercreationonrestore = true;
 185 //
 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;
 195 //
 196 // Prevent stats processing and hide the GUI
 197 //      $CFG->disablestatsprocessing = true;
 198 //
 199 // Setting this to true will enable admins to edit any post at any time
 200 //      $CFG->admineditalways = true;
 201 //
 202 // These variables define DEFAULT block variables for new courses
 203 // If this one is set it overrides all others and is the only one used.
 204 //      $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 205 //
 206 // These variables define the specific settings for defined course formats.
 207 // They override any settings defined in the formats own config file.
 208 //      $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
 209 //      $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
 210 //      $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 211 //      $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 212 //
 213 // These blocks are used when no other default setting is found.
 214 //      $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 215 //
 216 //
 217 // Allow unicode characters in uploaded files, generated reports, etc.
 218 // This setting is new and not much tested, there are known problems
 219 // with backup/restore that will not be solved, because native infozip
 220 // binaries are doing some weird conversions - use internal PHP zipping instead.
 221 // NOT RECOMMENDED FOR PRODUCTION SITES
 222 //     $CFG->unicodecleanfilename = true;
 223 //
 224 // Seconds for files to remain in caches. Decrease this if you are worried
 225 // about students being served outdated versions of uploaded files.
 226 //     $CFG->filelifetime = 86400;
 227 //
 228 // This setting will prevent the 'My Courses' page being displayed when a student
 229 // logs in. The site front page will always show the same (logged-out) view.
 230 //     $CFG->disablemycourses = true;
 231 //
 232 // Enable this option if you need fully working default frontpage role,
 233 // please note it might cause serious memory and performance issues,
 234 // also there should not be any negative capabilities in default
 235 // frontpage role (MDL-19039).
 236 //     $CFG->fullusersbycapabilityonfrontpage = true;
 237 //
 238 // If this setting is set to true, then Moodle will track the IP of the
 239 // current user to make sure it hasn't changed during a session.  This
 240 // will prevent the possibility of sessions being hijacked via XSS, but it
 241 // may break things for users coming using proxies that change all the time,
 242 // like AOL.
 243 //      $CFG->tracksessionip = true;
 244 //
 245 //
 246 // The following lines are for handling email bounces.
 247 //      $CFG->handlebounces = true;
 248 //      $CFG->minbounces = 10;
 249 //      $CFG->bounceratio = .20;
 250 // The next lines are needed both for bounce handling and any other email to module processing.
 251 // mailprefix must be EXACTLY four characters.
 252 // Uncomment and customise this block for Postfix
 253 //      $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
 254 //      $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
 255 //      $CFG->maildomain = 'youremaildomain.com';
 256 //
 257 // The following setting will tell Moodle to respect your PHP session
 258 // settings. Use this if you want to control session configuration
 259 // from php.ini, httpd.conf or .htaccess files.
 260 //      $CFG->respectsessionsettings = true;
 261 //
 262 // This setting will cause the userdate() function not to fix %d in
 263 // date strings, and just let them show with a zero prefix.
 264 //      $CFG->nofixday = true;
 265 //
 266 // This setting will make some graphs (eg user logs) use lines instead of bars
 267 //      $CFG->preferlinegraphs = true;
 268 //
 269 // Enabling this will allow custom scripts to replace existing moodle scripts.
 270 // For example: if $CFG->customscripts/course/view.php exists then
 271 // it will be used instead of $CFG->wwwroot/course/view.php
 272 // At present this will only work for files that include config.php and are called
 273 // as part of the url (index.php is implied).
 274 // Some examples are:
 275 //      http://my.moodle.site/course/view.php
 276 //      http://my.moodle.site/index.php
 277 //      http://my.moodle.site/admin            (index.php implied)
 278 // Custom scripts should not include config.php
 279 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
 280 // be compatible with upgrades. Use this option only if you are aware of the risks
 281 // involved.
 282 // Specify the full directory path to the custom scripts
 283 //      $CFG->customscripts = '/home/example/customscripts';
 284 //
 285 // Performance profiling
 286 //
 287 //   If you set Debug to "Yes" in the Configuration->Variables page some
 288 //   performance profiling data will show up on your footer (in default theme).
 289 //   With these settings you get more granular control over the capture
 290 //   and printout of the data
 291 //
 292 //   Capture performance profiling data
 293 //   define('MDL_PERF'  , true);
 294 //
 295 //   Capture additional data from DB
 296 //   define('MDL_PERFDB'  , true);
 297 //
 298 //   Print to log (for passive profiling of production servers)
 299 //   define('MDL_PERFTOLOG'  , true);
 300 //
 301 //   Print to footer (works with the default theme)
 302 //   define('MDL_PERFTOFOOT', true);
 303 //
 304 // Force displayed usernames
 305 //   A little hack to anonymise user names for all students.  If you set these
 306 //   then all non-teachers will always see these for every person.
 307 //       $CFG->forcefirstname = 'Bruce';
 308 //       $CFG->forcelastname  = 'Simpson';
 309 //
 310 // The following setting will turn SQL Error logging on. This will output an
 311 // entry in apache error log indicating the position of the error and the statement
 312 // called. This option will action disregarding error_reporting setting.
 313 //     $CFG->dblogerror = true;
 314 //
 315 // The following setting will log every database query to a table called adodb_logsql.
 316 // Use this setting on a development server only, the table grows quickly!
 317 //     $CFG->logsql = true;
 318 // By default, only queries that take longer than 0.05 seconds are logged. To change that,
 319 // set the following variable. For example, to lot all queries:
 320 //     $CFG->logsqlmintime = 0.0;
 321 //
 322 // The following setting will turn on username logging into Apache log. For full details regarding setting
 323 // up of this function please refer to the install section of the document.
 324 //     $CFG->apacheloguser = 0; // Turn this feature off. Default value.
 325 //     $CFG->apacheloguser = 1; // Log user id.
 326 //     $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
 327 //     $CFG->apacheloguser = 3; // Log username.
 328 // To get the values logged in Apache's log, add to your httpd.conf
 329 // the following statements. In the General part put:
 330 //     LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
 331 // And in the part specific to your Moodle install / virtualhost:
 332 //     CustomLog "/your/path/to/log" moodleformat
 333 // CAUTION: Use of this option will expose usernames in the Apache log,
 334 // If you are going to publish your log, or the output of your web stats analyzer
 335 // this will weaken the security of your website.
 336 //
 337 // Email database connection errors to someone.  If Moodle cannot connect to the
 338 // database, then email this address with a notice.
 339 //
 340 //     $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
 341 //
 342 // NOTE: if you are using custompix in your theme, see /fixpix.php.
 343 //
 344 // special magic evil developer only wanting to edit the xmldb files manually
 345 // AND don't use the XMLDBEditor nor the prev/next stuff at all (Mahara and others)
 346 // Uncomment these if you're lazy like Penny
 347 // $CFG->xmldbdisablecommentchecking = true;
 348 // $CFG->xmldbdisablenextprevchecking = true;
 349 //
 350 // special magig evil developer only wanting to edit xmldb files manually
 351 // AND allowing the XMLDBEditor to recostruct the prev/next elements every
 352 // time one file is loaded and saved (Moodle).
 353 // Uncomment this if you're lazy like Petr
 354 // $CFG->xmldbreconstructprevnext = true;
 355 //
 356 // Set the priority of themes from highest to lowest. This is useful (for
 357 // example) in sites where the user theme should override all other theme
 358 // settings for accessibility reasons. You can also disable types of themes
 359 // by removing them from the array. The default setting is:
 360 //      $CFG->themeorder = array('page', 'course', 'category', 'session', 'user', 'site');
 361 // NOTE: course, category, session, user themes still require the
 362 // respective settings to be enabled
 363 //
 364 // When working with production data on test servers, no emails should ever be send to real users
 365 // $CFG->noemailever = true;
 366 //
 367 // Divert all outgoing emails to this address to test and debug emailing features
 368 // $CFG->divertallemailsto = 'root@localhost.local';
 369 //
 370 //=========================================================================
 371 // ALL DONE!  To continue installation, visit your main page with a browser
 372 //=========================================================================
 373 if ($CFG->wwwroot == 'http://example.com/moodle') {
 374     echo "<p>Error detected in configuration file</p>";
 375     echo "<p>Your server address can not be: \$CFG->wwwroot = 'http://example.com/moodle';</p>";
 376     die;
 377 }
 378
 379 if (file_exists("$CFG->dirroot/lib/setup.php"))  {       // Do not edit
 380     include_once("$CFG->dirroot/lib/setup.php");
 381 } else {
 382     if ($CFG->dirroot == dirname(__FILE__)) {
 383         echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
 384         echo "<p>Are you sure all your files have been uploaded?</p>";
 385     } else {
 386         echo "<p>Error detected in config.php</p>";
 387         echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
 388         echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
 389     }
 390     die;
 391 }
 392 // MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
 393 // RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
 394 ?>