[moodle.git] / doc / install.html
1 <HEAD>\r
2     <TITLE>Moodle Docs: Installation</TITLE>\r
3         <LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">\r
4 </HEAD>\r
5 \r
7 <H2>Installing Moodle</H2>\r
8 <P>This guide explains how to install Moodle for the first time.</P>\r
9 <P>Sections in this document:</P>\r
10 <OL>\r
11   <LI><A HREF="#requirements">Requirements</A></LI>\r
12   <LI><A HREF="#downloading">Download</A></LI>\r
13   <LI><A HREF="#site">Site structure</A></LI>\r
14   <LI><A HREF="#data">Create a data directory</A></LI>\r
15   <LI><A HREF="#database">Create a database</A></LI>\r
16   <LI><A HREF="#webserver">Check web server settings</A></LI>\r
17   <LI><A HREF="#config">Edit config.php</A></LI>\r
18   <LI><A HREF="#admin">Go to the admin page</A></LI>\r
19   <LI><A HREF="#cron">Set up cron</A></LI>\r
20   <LI><A HREF="#course">Create a new course</A></LI>\r
21 </OL>\r
22 <H3><A NAME="requirements"></A>1. Requirements</H3>\r
23 <blockquote>\r
24   <p>Moodle is primarily developed in Linux using PHP, Apache and MySQL, and regularly \r
25     tested under Windows XP and Mac OS X environments.</p>\r
26   <p>All you should need are:</p>\r
27   <ul>\r
28     <li>a working installation of <A HREF="http://www.php.net/">PHP</A> (version \r
29       4.1.0 or later), with the following features enabled (most PHP installations \r
30       these days will have all of these):\r
31       <ul>\r
32       <LI>JPEG and/or PNG image editing support via the <A HREF="http://www.boutell.com/gd/">GD library</A></li>\r
33       <LI>Sessions support\r
34       <LI>File uploading\r
35       </UL>\r
36     <li>a working database server (<A HREF="http://www.mysql.com/">MySQL</A> for \r
37       now, but soon it will support PostgreSQL, MSSQL, Oracle, Interbase, Foxpro, \r
38       Access, ADO, Sybase, DB2 or ODBC).</li>\r
39   </ul>\r
40   <p>On a Windows platform, the quickest way to satisfy these requirements is \r
41     to download <A HREF="http://www.phpgeek.com/">PHPTriad</A>, <A HREF="http://www.foxserv.net/">FoxServ</A>, \r
42     or <A HREF="http://www.easyphp.org/">EasyPHP</A> which will install Apache, \r
43     PHP, and MySQL for you. Make sure you enable the GD module so Moodle can process \r
44     images - you may have to edit php.ini and remove the comment (;) from this \r
45     line: 'extension=php_gd.dll'.</p>\r
46   <p>On Mac OS X I highly recommend the <a href="http://fink.sourceforge.net/">fink</a> \r
47     project.</p>\r
48 </blockquote>\r
49 <P>&nbsp;</P>\r
50 <H3><A NAME="downloading"></A>2. Download</H3>\r
51 <blockquote>\r
52   <p>There are two ways to get Moodle, as a compressed package and via CVS. These \r
53     are explained in detail on the download page on <A HREF="http://moodle.com/">http://moodle.com/</A></p>\r
54   <p>After downloading and unpacking the archive, or checking out the files via \r
55     CVS, you will be left with a directory called &quot;moodle&quot;, containing \r
56     a number of files and folders. </p>\r
57   <p>You can either place the whole folder in your web server documents directory, \r
58     in which case the site will be located at <B>http://yourwebserver.com/moodle</B>, \r
59     or you can copy all the contents straight into the main web server documents \r
60     directory, in which case the site will be simply <B>http://yourwebserver.com</B>.</p>\r
61 </blockquote>\r
62 <P>&nbsp;</P>\r
63 <H3><A NAME="site"></A>3. Site structure</H3>\r
65   <p>Here is a quick summary of the contents of the Moodle folder, to help get \r
66     you oriented:</p>\r
67   <blockquote>\r
68     <p>config.php - the only file you need to edit to get started<br>\r
69       version.php - defines the current version of Moodle code<BR>\r
70       index.php - the front page of the site</p>\r
71     <ul>\r
72       <li>admin/ - code to administrate the whole server </li>\r
73       <li>auth/ - plugin modules to authenticate users  </li>\r
74       <li>course/ - code to display and manage courses </li>\r
75       <li>doc/ - help documentation for Moodle (eg this page)</li>\r
76       <li>files/ - code to display and manage uploaded files</li>\r
77       <li>lang/ - texts in different languages, one directory per language </li>\r
78       <li>lib/ - libraries of core Moodle code </li>\r
79       <li>login/ - code to handle login and account creation </li>\r
80       <li>mod/ - all Moodle course modules</li>\r
81       <li>pix/ - generic site graphics</li>\r
82       <li>theme/ - theme packs/skins to change the look of the site.</li>\r
83       <li>user/ - code to display and manage users</li>\r
84     </ul>\r
85     <p>&nbsp;</p>\r
86   </blockquote>\r
88 <H3><A NAME="data"></A>4. Create a data directory</H3>\r
89 <blockquote>\r
90   <p>Moodle will also need some space on your hard disk to store uploaded files, \r
91     such as course documents and user pictures.</p>\r
92   <p>Create a directory for this purpose somewhere <B>away</B> from the web server \r
93     documents directory (we don't want these files to be directly accessible from \r
94     the web), and ensure that the web server software has permission to write \r
95     to this directory. On Unix machines, this means setting the owner of the directory \r
96     to be something like &quot;nobody&quot; or &quot;apache&quot;.</p>\r
97 </blockquote>\r
98 <P>&nbsp;</P>\r
99 <H3><A NAME="database"></A>5. Create a database</H3>\r
100 <blockquote>\r
101   <p>You need to create an empty database (eg "moodle") in your database system \r
102     along with a special user (eg "moodleuser") that has access to that database \r
103     (and that database only. For example, don't use the "root" user for the moodle \r
104     database in a production system - it's a security hazard). </p>\r
105   <p>eg for MySQL: </p>\r
106   <PRE>\r
107    # mysql -u root -p\r
108    > CREATE DATABASE moodle; \r
110            TO moodleuser@localhost IDENTIFIED BY 'yourpassword'; \r
111    > quit \r
112    # mysqladmin -p reload\r
113 </PRE>\r
114   <p>(For MySQL I highly recommend the use of <a href="http://phpmyadmin.sourceforge.net/">phpMyAdmin</a> \r
115     to manage your databases).</p>\r
116 </blockquote>\r
117 <P>&nbsp;</P>\r
118 <H3><A NAME="webserver" id="webserver"></A>6. Check your web server settings</H3>\r
119 <blockquote>\r
120   <p>Firstly, make sure that your web server is set up to use index.php as a default \r
121     page (perhaps in addition to index.html, default.htm and so on).</p>\r
122   <p>In Apache, this is done using a DirectoryIndex parameter in your httpd.conf \r
123     file. Mine usually looks like this:</p>\r
124   <blockquote>\r
125     <pre><strong>DirectoryIndex</strong> index.php index.html index.htm </pre>\r
126   </blockquote>\r
127   <p>Just make sure index.php is in the list (and preferably towards the start \r
128     of the list, for efficiency).</p>\r
129   <p>Secondly, check your PHP configuration file (usually called php.ini) and \r
130     make sure uploading has been turned on:</p>\r
131   <blockquote>\r
132     <pre>file_uploads = On</pre>\r
133   </blockquote>\r
134   <p>Most distributions of PHP have this turned on by default, but you may want \r
135     to check it anyway. </p>\r
136   <p>If you don't have access to httpd.conf or php.ini on your server, another \r
137     way you can set both of the above settings (and more) is to put definitions in a \r
138     .htaccess file in Moodle's main directory.  This only works on Apache servers \r
139     and only when Overrides have been allowed.  A sample .htaccess file \r
140     is included with Moodle (called lib/htaccess) that includes further information.\r
141 \r
142 </blockquote>\r
143 <p>&nbsp;</p>\r
144 <H3><A NAME="config"></A>7. Edit config.php</H3>\r
145 <blockquote>\r
146   <p>Now you can edit the configuration file, <strong>config.php</strong>, using a \r
147      text editor. This file is used by all other files in Moodle.</p>\r
148   <p>To start with, make a copy of config-dist.php and call it config.php. We \r
149     do this so that your config.php won't be overwritten in case you upgrade Moodle \r
150     later on. </p>\r
151   <p>Edit config.php to specify the database details that you just defined, as \r
152     well as the site address, file system directory and data directory. \r
153     The config file has detailed directions.</p>\r
154   <p>For the rest of this installation document we will assume your site is at: \r
155     <u>http://example.com/moodle</u></p>\r
156 </blockquote>\r
157 <P>&nbsp;</P>\r
158 <H3><A NAME="admin"></A>8. Go to the admin page</H3>\r
159 <blockquote> \r
160   <p>The admin page should now be working at: http://example.com/moodle/admin. \r
161     If you try and access the front page of your site you'll be taken there automatically \r
162     anyway. The first time you access this admin page, you will be presented with \r
163     a GPL agreement with which you need to agree before you can continue with the setup.</p>\r
164   <P>(Moodle will also try to set some cookies in your browser.  If you have \r
165      your browser set up to let you choose to accept cookies, then you <B>must</B>\r
166      accept the Moodle cookies, or Moodle won't work properly.)\r
167   <p>Now Moodle will start setting set up your database. Firstly, the main database \r
168     tables are created. You should see a number of SQL statements followed by \r
169     status messages (in green or red) that look like this:</p>\r
170   <blockquote> \r
171     <p>CREATE TABLE course ( id int(10) unsigned NOT NULL auto_increment, category \r
172       int(10) unsigned NOT NULL default '0', password varchar(50) NOT NULL default \r
173       '', fullname varchar(254) NOT NULL default '', shortname varchar(15) NOT \r
174       NULL default '', summary text NOT NULL, format tinyint(4) NOT NULL default \r
175       '1', teacher varchar(100) NOT NULL default 'Teacher', startdate int(10) \r
176       unsigned NOT NULL default '0', enddate int(10) unsigned NOT NULL default \r
177       '0', timemodified int(10) unsigned NOT NULL default '0', PRIMARY KEY (id)) \r
178       TYPE=MyISAM</p>\r
179     <p><FONT COLOR="#006600">SUCCESS</FONT></p>\r
180     <p>...and so on, followed by: <FONT COLOR="#FF0000">Main databases set up \r
181       successfully</FONT>. </p>\r
182   </blockquote>\r
183   <p>If you don't see these, then there must have been some problem with the database \r
184     or the configuration settings you defined in config.php. Check that PHP isn't \r
185     in a restricted "safe mode" (commercial web hosts often have safe mode turned \r
186     on). You can check PHP variables by creating a little file containing &lt? \r
187     phpinfo() ?&gt and looking at it through a browser. Check all these and try \r
188     this page again.</p>\r
189   <p>Scroll down the very bottom of the page and press the &quot;Continue&quot; \r
190     link.</p>\r
191   <p>Next you will see a similar page that sets up all the tables required by \r
192     each Moodle module. As before, they should all be green, otherwise you may \r
193     be a problem in the module code.</p>\r
194 \r
195   <p>Scroll down the very bottom of the page and press the &quot;Continue&quot; \r
196     link.</p>\r
197 \r
198   <p>You should now see a form where you can define more configuration variables\r
199      for your installation, such as the default language, SMTP hosts and so on.\r
200      Don't worry too much about getting everything right just now - you can always \r
201      come back and edit these later on using the admin interface.  Scroll down \r
202      to the bottom and click &quot;Save changes&quot;.</p>\r
203 \r
204   <p>Next is a form where you can define parameters for your Moodle site and the \r
205      front page, such as the name, format, description and so on. \r
206 \r
207     Fill this out (you can always go back and change these later) and then press \r
208     &quot;Save changes&quot;.</p>\r
209 \r
210   <p>Finally, you will then be asked to create a top-level administration user \r
211     for future access to the admin pages. Fill out the details with your own name, \r
212     email etc and then click &quot;Save changes&quot;. Not all the fields are \r
213     required, but if you miss any important fields you'll be re-prompted for them. \r
214   </p>\r
215   <blockquote> \r
216     <blockquote> \r
217       <blockquote> \r
218         <blockquote> \r
219           <blockquote>\r
220             <p><strong>Make sure you remember the username and password you chose \r
221               for the administration user account, as they will be necessary to \r
222               access the administration page in future.</strong></p>\r
223           </blockquote>\r
224         </blockquote>\r
225       </blockquote>\r
226     </blockquote>\r
227   </blockquote>\r
228   <p>Once successful, you will be returned to the main admin page, which contain \r
229     a number of links arranged in a menu (these items also appear on the home \r
230     page when you are logged in as the admin user). All your further administration \r
231     of Moodle can now be done using this menu, such as:</p>\r
232   <ul>\r
233     <li>creating and deleting courses</li>\r
234     <li>creating and editing user accounts</li>\r
235     <li>administering teacher accounts</li>\r
236     <li>changing site-wide settings like themes etc</li>\r
237   </ul>\r
238 </blockquote>\r
239 <P>&nbsp;</P>\r
240 <H3><A NAME="cron"></A>9. Set up cron</H3>\r
241 <blockquote> \r
242   <p>Some of Moodle's modules require continual checks to perform tasks. For example, \r
243     Moodle needs to check the discussion forums so it can mail out copies of posts \r
244     to people who have subscribed.</p>\r
245   <p>The script that does all this is located in the admin directory, and is called \r
246     cron.php. However, it can not run itself, so you need to set up a mechanism \r
247     where this script is run regularly (eg every five minutes). This provides \r
248     a &quot;heartbeat&quot; so that the script can perform functions at periods \r
249     defined by each module.</p>\r
250   <p>Test that the script works by running it directly from your browser:</p>\r
251   <blockquote> \r
252     <PRE>http://example.com/moodle/admin/cron.php</PRE>\r
253   </blockquote>\r
254   <p>Now, you need to set up some of way of running the script automatically and \r
255     regularly. </p>\r
256   <H4> Running the script from a command line</H4>\r
257   <p>You can call the page from the command line just as you did in the example \r
258     above. For example, you can use a Unix utility like 'wget':</p>\r
259   <blockquote>\r
260     <PRE>wget -q -O /dev/null http://example.com/moodle/admin/cron.php</PRE>\r
261   </blockquote>\r
262   <p>Note in this example that the output is thrown away (to /dev/null).</p>\r
263   <p>The same thing using lynx:</p>\r
264   <blockquote>\r
265     <pre>lynx -dump http://example.com/moodle/admin/cron.php &gt; /dev/null</pre>\r
266   </blockquote>\r
267   <p>Alternatively you could use a standalone version of PHP, compiled to be run \r
268     on the command line. The advantage with doing this is that your web server \r
269     logs aren't filled with constant requests to cron.php. The disadvantage is \r
270     that you need to have access to a command-line version of php.</p>\r
271   <blockquote>\r
272     <PRE>/opt/bin/php /web/moodle/admin/cron.php\r
273 \r
274 \r
275 (Windows) C:\apache\php\php.exe C:\apache\htdocs\moodle\admin\cron.php\r
276 \r
277 </PRE>\r
278   </blockquote>\r
279   <h4>Automatically running the script every 5 minutes</h4>\r
280   <p>On Unix systems: Use <B>cron</B>. Edit your cron settings from the commandline \r
281     using &quot;crontab -e&quot; and add a line like:</p>\r
282   <blockquote>\r
283     <PRE>*/5 * * * * wget -q -O /dev/null http://example.com/moodle/admin/cron.php</PRE>\r
284   </blockquote>\r
285   <p>On Windows systems: The simplest way is to use my package <A TITLE="Click to download this package (150k)" HREF="http://moodle.com/download/moodle-cron-for-windows.zip">moodle-cron-for-windows.zip</A> \r
286     which makes this whole thing very easy.</p>\r
287   <p>Other platforms: you will need to find another way to do this (please let \r
288     me know so I can update this documentation).<br>\r
289   </p>\r
290 </blockquote>\r
291 <H3><A NAME="course"></A>10. Create a new course</H3>\r
292 <blockquote>\r
293   <p>Now that Moodle is running properly, you can create a course. </p>\r
294   <p>Select &quot;Create a new course&quot; from the Admin page (or the admin \r
295     links on the home page).</p>\r
296   <p>Fill out the form, paying special attention to the course format. You don't \r
297     have to worry about the details too much at this stage, as everything can \r
298     be changed later by the teacher.</p>\r
299   <p>Press &quot;Save changes&quot;, and you will be taken to a new form where \r
300     you can assign teachers to the course. You can only add existing user accounts \r
301     from this form - if you want to create a new teacher account then either ask \r
302     the teacher to create one for themselves (see the login page), or create one \r
303     for them using the &quot;Add a new user&quot; on the Admin page.</p>\r
304   <p>Once done, the course is ready to customise, and is accessible via the &quot;Courses&quot; \r
305     link on the home page.</p>\r
306   <p>See the &quot;<A HREF="teacher.html">Teacher Manual</A>&quot; for more details \r
307     on course-building.</p>\r
308 </blockquote>\r
309 <P>&nbsp;</P>\r
310 <P ALIGN="CENTER"><FONT SIZE="1"><A HREF="index.html" TARGET="_top">Moodle Documentation</A></FONT></P>\r
311 <P ALIGN="CENTER"><FONT SIZE="1">Version: $Id$</FONT></P>\r
312 \r
313 </BODY>\r