removed $SESSION->encoding now replaced by current_charset() and $CFG->unicodedb...
[moodle.git] / 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
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 //
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
57 $CFG->dbpersist = false;         // Should database connections be reused?
58                  // "false" is the most stable setting
59                  // "true" can improve performance sometimes
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
70 $CFG->wwwroot   = 'http://example.com/moodle';
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
83 $CFG->dirroot   = '/home/example/public_html/moodle';
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'
99 $CFG->dataroot  = '/home/example/moodledata';
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.
113 $CFG->directorypermissions = 02777;
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.
125 $CFG->admin = 'admin';
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 // Restrict certain usernames from doing things that may mess up a site
143 // This is especially useful for demonstration teacher accounts
144 //      $CFG->restrictusers = 'teacher,fred,jim';
145 //
146 // Set global password for "Login as", teacher is prompted only once in each session.
147 // Set your own password and tell it only to teachers that should have access to this feature.
148 //      $CFG->loginaspassword = 'yoursharedpassword';
149 //
150 // Setting this to true will enable admins to edit any post at any time
151 //      $CFG->admineditalways = true;
152 //
153 // These variables define DEFAULT block variables for new courses
154 // If this one is set it overrides all others and is the only one used.
155 //      $CFG->defaultblocks_override = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
156 //
157 // These variables define the specific settings for defined course formats.
158 // They override any settings defined in the formats own config file.
159 //      $CFG->defaultblocks_site = 'site_main_menu,admin,course_list:course_summary,calendar_month';
160 //      $CFG->defaultblocks_social = 'participants,search_forums,calendar_month,calendar_upcoming,social_activities,recent_activity,admin,course_list';
161 //      $CFG->defaultblocks_topics = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
162 //      $CFG->defaultblocks_weeks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
163 //
164 // These blocks are used when no other default setting is found.
165 //      $CFG->defaultblocks = 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
166 //
167 //
168 // This setting will put Moodle in Unicode mode. Please note that database must support it.
169 // Do not enable this if your database in not converted to UTF-8!
170 //     $CFG->unicodedb = true;
171 //
172 // Allow unicode characters in uploaded files, generated reports, etc.
173 // This setting is new and not much tested, there are known problems
174 // with backup/restore that will not be solved, because native infozip
175 // binaries are doing some weird conversions - use internal PHP zipping instead.
176 // NOT RECOMMENDED FOR PRODUCTION SITES
177 //     $CFG->unicodecleanfilename = true;
178 //
179 // Seconds for files to remain in caches. Decrease this if you are worried
180 // about students being served outdated versions of uploaded files.
181 //     $CFG->filelifetime = 86400;
182 //
183 // This setting will prevent the 'My Courses' page being displayed when a student
184 // logs in. The site front page will always show the same (logged-out) view.
185 //     $CFG->disablemycourses = true;
186 // 
187 // If this setting is set to true, then Moodle will track the IP of the 
188 // current user to make sure it hasn't changed during a session.  This 
189 // will prevent the possibility of sessions being hijacked via XSS, but it 
190 // may break things for users coming using proxies that change all the time,
191 // like AOL.
192 //      $CFG->tracksessionip = true;
193 //
194 //
195 // The following lines are for handling email bounces.
196 //      $CFG->handlebounces = true;
197 //      $CFG->minbounces = 10;
198 //      $CFG->bounceratio = .20;
199 // The next lines are needed both for bounce handling and any other email to module processing.
200 // mailprefix must be EXACTLY four characters.
201 // Uncomment and customise this block for Postfix 
202 //      $CFG->mailprefix = 'mdl+'; // + is the separator for Exim and Postfix.
203 //      $CFG->mailprefix = 'mdl-'l // - is the separator for qmail 
204 //      $CFG->maildomain = 'youremaildomain.com';
205 //
206 // The following setting will tell Moodle to respect your PHP session 
207 // settings. Use this if you want to control session configuration
208 // from php.ini, httpd.conf or .htaccess files. 
209 //      $CFG->respectsessionsettings = true;
210 //
211 // This setting will cause the userdate() function not to fix %d in 
212 // date strings, and just let them show with a zero prefix.
213 //      $CFG->nofixday = true;
214 //
215 // This setting will make some graphs (eg user logs) use lines instead of bars
216 //      $CFG->preferlinegraphs = true;
217 //
218 // Enabling this will make most text-based filters only match the first time
219 // a phrase occurs in a given text.  Otherwise all are matched.
220 //      $CFG->filtermatchonepertext = true;
221 //
222 // Enabling this will make most text-based filters only match the first time
223 // a phrase occurs in a given page.  Otherwise all are matched.
224 //      $CFG->filtermatchoneperpage = true;
225 //
226 // Enabling this will allow custom scripts to replace existing moodle scripts.
227 // For example: if $CFG->customscripts/course/view.php exists then
228 // it will be used instead of $CFG->wwwroot/course/view.php
229 // At present this will only work for files that include config.php and are called
230 // as part of the url (index.php is implied).
231 // Some examples are:
232 //      http://my.moodle.site/course/view.php
233 //      http://my.moodle.site/index.php
234 //      http://my.moodle.site/admin            (index.php implied)
235 // Custom scripts should not include config.php
236 // Warning: Replacing standard moodle scripts may pose security risks and/or may not
237 // be compatible with upgrades. Use this option only if you are aware of the risks
238 // involved. 
239 // Specify the full directory path to the custom scripts
240 //      $CFG->customscripts = '/home/example/customscripts';
241 //
242 // Performance profiling 
243 // 
244 //   If you set Debug to "Yes" in the Configuration->Variables page some
245 //   performance profiling data will show up on your footer (in default theme).
246 //   With these settings you get more granular control over the capture
247 //   and printout of the data
248 //
249 //   Capture performance profiling data
250 //   define('MDL_PERF'  , true);
251 //
252 //   Capture additional data from DB
253 //   define('MDL_PERFDB'  , true);
254 //
255 //   Print to log (for passive profiling of production servers)
256 //   define('MDL_PERFTOLOG'  , true);
257 //
258 //   Print to footer (works with the default theme)
259 //   define('MDL_PERFTOFOOT', true);
260 //
261 // Force displayed usernames
262 //   A little hack to anonymise user names for all students.  If you set these 
263 //   then all non-teachers will always see these for every person.
264 //       $CFG->forcefirstname = 'Bruce';
265 //       $CFG->forcelastname  = 'Simpson';
266 //
267 // The following setting will turn SQL Error logging on. This will output an
268 // entry in apache error log indicating the position of the error and the statement
269 // called. This option will action disregarding error_reporting setting.
270 //     $CFG->dblogerror = true;
271 //
272 // The following setting will turn on username logging into Apache log. For full details regarding setting
273 // up of this function please refer to the install section of the document.
274 //     $CFG->apacheloguser = 0; // Turn this feature off. Default value.
275 //     $CFG->apacheloguser = 1; // Log user id.
276 //     $CFG->apacheloguser = 2; // Log full name in cleaned format. ie, Darth Vader will be displayed as darth_vader.
277 //     $CFG->apacheloguser = 3; // Log username. 
278 // To get the values logged in Apache's log, add to your httpd.conf
279 // the following statements. In the General part put:
280 //     LogFormat "%h %l %{MOODLEUSER}n %t \"%r\" %s %b \"%{Referer}i\" \"%{User-Agent}i\"" moodleformat
281 // And in the part specific to your Moodle install / virtualhost:
282 //     CustomLog "/your/path/to/log" moodleformat
283 // CAUTION: Use of this option will expose usernames in the Apache log,
284 // If you are going to publish your log, or the output of your web stats analyzer
285 // this will weaken the security of your website.
286 // 
287 // Email database connection errors to someone.  If Moodle cannot connect to the 
288 // database, then email this address with a notice.
289 //
290 //     $CFG->emailconnectionerrorsto = 'your@emailaddress.com';
291 // 
292 // 
293 // NOTE: if you are using custompix in your theme, see /fixpix.php.
295 //=========================================================================
296 // ALL DONE!  To continue installation, visit your main page with a browser
297 //=========================================================================
298 if ($CFG->wwwroot == 'http://example.com/moodle') {
299     echo "<p>Error detected in configuration file</p>";
300     echo "<p>Your server address can not be: \$CFG->wwwroot = 'http://example.com/moodle';</p>";
301     die;
304 if (file_exists("$CFG->dirroot/lib/setup.php"))  {       // Do not edit
305     include_once("$CFG->dirroot/lib/setup.php");
306 } else {
307     if ($CFG->dirroot == dirname(__FILE__)) {
308         echo "<p>Could not find this file: $CFG->dirroot/lib/setup.php</p>";
309         echo "<p>Are you sure all your files have been uploaded?</p>";
310     } else {
311         echo "<p>Error detected in config.php</p>";
312         echo "<p>Error in: \$CFG->dirroot = '$CFG->dirroot';</p>";
313         echo "<p>Try this: \$CFG->dirroot = '".dirname(__FILE__)."';</p>";
314     }
315     die;
317 // MAKE SURE WHEN YOU EDIT THIS FILE THAT THERE ARE NO SPACES, BLANK LINES,
318 // RETURNS, OR ANYTHING ELSE AFTER THE TWO CHARACTERS ON THE NEXT LINE.
319 ?>