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-2004  Martin Dougiamas  http://dougiamas.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 // 2. WEB SITE LOCATION
  64 //=========================================================================
  65 // Now you need to tell Moodle where it is located. Specify the full
  66 // web address to where moodle has been installed.  If your web site
  67 // is accessible via multiple URLs then choose the most natural one
  68 // that your students would use.  Do not include a trailing slash
  69
  70 $CFG->wwwroot   = 'http://example.com/moodle';
  71
  72
  73 //=========================================================================
  74 // 3. SERVER FILES LOCATION
  75 //=========================================================================
  76 // Next, specify the full OS directory path to this same location
  77 // Make sure the upper/lower case is correct.  Some examples:
  78 //
  79 //    $CFG->dirroot = 'c:\program files\easyphp\www\moodle';    // Windows
  80 //    $CFG->dirroot = '/var/www/html/moodle';     // Redhat Linux
  81 //    $CFG->dirroot = '/home/example/public_html/moodle'; // Cpanel host
  82
  83 $CFG->dirroot   = '/home/example/public_html/moodle';
  84
  85
  86 //=========================================================================
  87 // 4. DATA FILES LOCATION
  88 //=========================================================================
  89 // Now you need a place where Moodle can save uploaded files.  This
  90 // directory should be readable AND WRITEABLE by the web server user
  91 // (usually 'nobody' or 'apache'), but it should not be accessible
  92 // directly via the web.
  93 //
  94 // - On hosting systems you might need to make sure that your "group" has
  95 //   no permissions at all, but that "others" have full permissions.
  96 //
  97 // - On Windows systems you might specify something like 'c:\moodledata'
  98
  99 $CFG->dataroot  = '/home/example/moodledata';
 100
 101
 102 //=========================================================================
 103 // 5. DATA FILES PERMISSIONS
 104 //=========================================================================
 105 // The following parameter sets the permissions of new directories
 106 // created by Moodle within the data directory.  The format is in
 107 // octal format (as used by the Unix utility chmod, for example).
 108 // The default is usually OK, but you may want to change it to 0750
 109 // if you are concerned about world-access to the files (you will need
 110 // to make sure the web server process (eg Apache) can access the files.
 111 // NOTE: the prefixed 0 is important, and don't use quotes.
 112
 113 $CFG->directorypermissions = 02777;
 114
 115
 116 //=========================================================================
 117 // 6. DIRECTORY LOCATION  (most people can just ignore this setting)
 118 //=========================================================================
 119 // A very few webhosts use /admin as a special URL for you to access a
 120 // control panel or something.  Unfortunately this conflicts with the
 121 // standard location for the Moodle admin pages.  You can fix this by
 122 // renaming the admin directory in your installation, and putting that
 123 // new name here.  eg "moodleadmin".  This will fix admin links in Moodle.
 124
 125 $CFG->admin = 'admin';
 126
 127
 128 //=========================================================================
 129 // 7. OTHER MISCELLANEOUS SETTINGS (ignore these for new installations)
 130 //=========================================================================
 131 //
 132 // These are additional tweaks for which no GUI exists in Moodle yet.
 133 //
 134 //
 135 // Prevent users from updating their profile images
 136 //      $CFG->disableuserimages = true;
 137 //
 138 // Prevent scheduled backups from operating (and hide the GUI for them)
 139 // Useful for webhost operators who have alternate methods of backups
 140 //      $CFG->disablescheduledbackups = true;
 141 //
 142 // Allow user passwords to be included in backup files. Very dangerous
 143 // setting as far as it publishes password hashes that can be unencrypted
 144 // if the backup file is publicy available. Use it only if you can guarantee
 145 // that all your backup files remain only privacy available and are never
 146 // shared out from your site/institution!
 147 //      $CFG->includeuserpasswordsinbackup = true;
 148 //
 149 // Prevent stats processing and hide the GUI
 150 //      $CFG->disablestatsprocessing = true;
 151 //
 152 // Set global password for "Login as", teacher is prompted only once in each session.
 153 // Set your own password and tell it only to teachers that should have access to this feature.
 154 //      $CFG->loginaspassword = 'yoursharedpassword';
 155 //
 156 // Setting this to true will enable admins to edit any post at any time
 157 //      $CFG->admineditalways = true;
 158 //
 159 // These variables define DEFAULT block variables for new courses
 160 // If this one is set it overrides all others and is the only one used.
 161 //      $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 162 //
 163 // These variables define the specific settings for defined course formats.
 164 // They override any settings defined in the formats own config file.
 165 //      $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
 166 //      $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
 167 //      $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 168 //      $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 169 //
 170 // These blocks are used when no other default setting is found.
 171 //      $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
 172 //
 173 //
 174 // Allow unicode characters in uploaded files, generated reports, etc.
 175 // This setting is new and not much tested, there are known problems
 176 // with backup/restore that will not be solved, because native infozip
 177 // binaries are doing some weird conversions - use internal PHP zipping instead.
 178 // NOT RECOMMENDED FOR PRODUCTION SITES
 179 //     $CFG->unicodecleanfilename = true;
 180 //
 181 // Seconds for files to remain in caches. Decrease this if you are worried
 182 // about students being served outdated versions of uploaded files.
 183 //     $CFG->filelifetime = 86400;
 184 //
 185 // This setting will prevent the 'My Courses' page being displayed when a student
 186 // logs in. The site front page will always show the same (logged-out) view.
 187 //     $CFG->disablemycourses = true;
 188 //
 189 // If this setting is set to true, then Moodle will track the IP of the
 190 // current user to make sure it hasn't changed during a session.  This
 191 // will prevent the possibility of sessions being hijacked via XSS, but it
 192 // may break things for users coming using proxies that change all the time,
 193 // like AOL.
 194 //      $CFG->tracksessionip = true;
 195 //
 196 //
 197 // The following lines are for handling email bounces.
 198 //      $CFG->handlebounces = true;
 199 //      $CFG->minbounces = 10;
 200 //      $CFG->bounceratio = .20;
 201 // The next lines are needed both for bounce handling and any other email to module processing.
 202 // mailprefix must be EXACTLY four characters.
 203 // Uncomment and customise this block for Postfix
 204 //      $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
 205 //      $CFG->mailprefix = 'mdl-'; // - is the separator for qmail
 206 //      $CFG->maildomain = 'youremaildomain.com';
 207 //
 208 // The following setting will tell Moodle to respect your PHP session
 209 // settings. Use this if you want to control session configuration
 210 // from php.ini, httpd.conf or .htaccess files.
 211 //      $CFG->respectsessionsettings = true;
 212 //
 213 // This setting will cause the userdate() function not to fix %d in
 214 // date strings, and just let them show with a zero prefix.
 215 //      $CFG->nofixday = true;
 216 //
 217 // This setting will make some graphs (eg user logs) use lines instead of bars
 218 //      $CFG->preferlinegraphs = true;
 219 //
 220 // Enabling this will allow custom scripts to replace existing moodle scripts.
 221 // For example: if $CFG->customscripts/course/view.php exists then
 222 // it will be used instead of $CFG->wwwroot/course/view.php
 223 // At present this will only work for files that include config.php and are called
 224 // as part of the url (index.php is implied).
 225 // Some examples are:
 226 //      http://my.moodle.site/course/view.php
 227 //      http://my.moodle.site/index.php
 228 //      http://my.moodle.site/admin            (index.php implied)
 229 // Custom scripts should not include config.php
 230 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
 231 // be compatible with upgrades. Use this option only if you are aware of the risks
 232 // involved.
 233 // Specify the full directory path to the custom scripts
 234 //      $CFG->customscripts = '/home/example/customscripts';
 235 //
 236 // Performance profiling
 237 //
 238 //   If you set Debug to "Yes" in the Configuration->Variables page some
 239 //   performance profiling data will show up on your footer (in default theme).
 240 //   With these settings you get more granular control over the capture
 241 //   and printout of the data
 242 //
 243 //   Capture performance profiling data
 244 //   define('MDL_PERF'  , true);
 245 //
 246 //   Capture additional data from DB
 247 //   define('MDL_PERFDB'  , true);
 248 //
 249 //   Print to log (for passive profiling of production servers)
 250 //   define('MDL_PERFTOLOG'  , true);
 251 //
 252 //   Print to footer (works with the default theme)
 253 //   define('MDL_PERFTOFOOT', true);
 254 //
 255 // Force displayed usernames
 256 //   A little hack to anonymise user names for all students.  If you set these
 257 //   then all non-teachers will always see these for every person.
 258 //       $CFG->forcefirstname = 'Bruce';
 259 //       $CFG->forcelastname  = 'Simpson';
 260 //
 261 // The following setting will turn SQL Error logging on. This will output an
 262 // entry in apache error log indicating the position of the error and the statement
 263 // called. This option will action disregarding error_reporting setting.
 264 //     $CFG->dblogerror = true;
 265 //
 266 // The following setting will turn on username logging into Apache log. For full details regarding setting
 267 // up of this function please refer to the install section of the document.
 268 //     $CFG->apacheloguser = 0; // Turn this feature off. Default value.
 269 //     $CFG->apacheloguser = 1; // Log user id.
 270 //     $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
 271 //     $CFG->apacheloguser = 3; // Log username.
 272 // To get the values logged in Apache's log, add to your httpd.conf
 273 // the following statements. In the General part put:
 274 //     LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
 275 // And in the part specific to your Moodle install / virtualhost:
 276 //     CustomLog "/your/path/to/log" moodleformat
 277 // CAUTION: Use of this option will expose usernames in the Apache log,
 278 // If you are going to publish your log, or the output of your web stats analyzer
 279 // this will weaken the security of your website.
 280 //
 281 // Email database connection errors to someone.  If Moodle cannot connect to the
 282 // database, then email this address with a notice.
 283 //
 284 //     $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
 285 //
 286 // Restore pre-1.6 behaviour where courses could still be available
 287 // even if the category they were in was hidden
 288 //     $CFG->allowvisiblecoursesinhiddencategories = true;
 289 //
 290 // NOTE: if you are using custompix in your theme, see /fixpix.php.
 291
 292 //=========================================================================
 293 // ALL DONE!  To continue installation, visit your main page with a browser
 294 //=========================================================================
 295 if ($CFG->wwwroot == 'http://example.com/moodle') {
 296     echo "<p>Error detected in configuration file</p>";
 297     echo "<p>Your server address can not be: \$CFG->wwwroot = 'http://example.com/moodle';</p>";
 298     die;
 299 }
 300
 301 if (file_exists("$CFG->dirroot/lib/setup.php"))  {       // Do not edit
 302     include_once("$CFG->dirroot/lib/setup.php");
 303 } else {
 304     if ($CFG->dirroot == dirname(__FILE__)) {
 305         echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
 306         echo "<p>Are you sure all your files have been uploaded?</p>";
 307     } else {
 308         echo "<p>Error detected in config.php</p>";
 309         echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
 310         echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
 311     }
 312     die;
 313 }
 314 // MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
 315 // RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
 316 ?>