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