Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

executable file 362 lines (346 sloc) 18.4 KB
<TITLE>Moodle Docs: Installation</TITLE>
<LINK REL="stylesheet" HREF="../theme/standard/styles.css" TYPE="TEXT/CSS">
<H2>Installing Moodle</H2>
<P>This guide explains how to install Moodle for the first time. It goes into some detail
about some of the steps, in order to cover the wide variety of small differences between
web server setups, so this document may look long and complicated. Don't be put off by this
- I usually set Moodle up in a few minutes!</P>
<P>Take your time and work through this document carefully - it will save you time later on.</P>
<P>Sections in this document:</P>
<LI><A HREF="#requirements">Requirements</A></LI>
<LI><A HREF="#downloading">Download</A></LI>
<LI><A HREF="#site">Site structure</A></LI>
<LI><A HREF="#data">Create a data directory</A></LI>
<LI><A HREF="#database">Create a database</A></LI>
<LI><A HREF="#webserver">Check web server settings</A></LI>
<LI><A HREF="#config">Edit config.php</A></LI>
<LI><A HREF="#admin">Go to the admin page</A></LI>
<LI><A HREF="#cron">Set up cron</A></LI>
<LI><A HREF="#course">Create a new course</A></LI>
<H3><A NAME="requirements"></A>1. Requirements</H3>
<p>Moodle is primarily developed in Linux using PHP, Apache and MySQL, and regularly
tested under Windows XP and Mac OS X environments.</p>
<p>All you should need are:</p>
<li>a working installation of <A HREF="">PHP</A> (version
4.1.0 or later), with the following features enabled (most PHP installations
these days will have all of these):
<LI>JPEG and/or PNG image editing support via the <A HREF="">GD library</A></li>
<LI>Sessions support
<LI>File uploading
<li>a working database server (<A HREF="">MySQL</A> for
now, but soon it will support PostgreSQL, MSSQL, Oracle, Interbase, Foxpro,
Access, ADO, Sybase, DB2 or ODBC).</li>
<p>On a Windows platform, the quickest way to satisfy these requirements is
to download <A HREF="">FoxServ</A>,
or <A HREF="">EasyPHP</A> which will install Apache,
PHP, and MySQL for you. Make sure you enable the GD module so Moodle can process
images - you may have to edit php.ini and remove the comment (;) from this
line: 'extension=php_gd.dll'.</p>
<p>On Mac OS X I highly recommend the <a href="">fink</a>
<H3><A NAME="downloading"></A>2. Download</H3>
<p>There are two ways to get Moodle, as a compressed package and via CVS. These
are explained in detail on the download page on <A HREF=""></A></p>
<p>After downloading and unpacking the archive, or checking out the files via
CVS, you will be left with a directory called &quot;moodle&quot;, containing
a number of files and folders. </p>
<p>You can either place the whole folder in your web server documents directory,
in which case the site will be located at <B></B>,
or you can copy all the contents straight into the main web server documents
directory, in which case the site will be simply <B></B>.</p>
<H3><A NAME="site"></A>3. Site structure</H3>
<p>Here is a quick summary of the contents of the Moodle folder, to help get
you oriented:</p>
<p>config.php - the only file you need to edit to get started<br>
version.php - defines the current version of Moodle code<BR>
index.php - the front page of the site</p>
<li>admin/ - code to administrate the whole server </li>
<li>auth/ - plugin modules to authenticate users </li>
<li>course/ - code to display and manage courses </li>
<li>doc/ - help documentation for Moodle (eg this page)</li>
<li>files/ - code to display and manage uploaded files</li>
<li>lang/ - texts in different languages, one directory per language </li>
<li>lib/ - libraries of core Moodle code </li>
<li>login/ - code to handle login and account creation </li>
<li>mod/ - all Moodle course modules</li>
<li>pix/ - generic site graphics</li>
<li>theme/ - theme packs/skins to change the look of the site.</li>
<li>user/ - code to display and manage users</li>
<H3><A NAME="data"></A>4. Create a data directory</H3>
<p>Moodle will also need some space on your hard disk to store uploaded files,
such as course documents and user pictures.</p>
<p>Create a directory for this purpose somewhere. For security, it's best that
this directory is NOT accessible via the web. The easiest way to do this
is to simply locate it OUTSIDE the web directory, otherwise protect it
by creating a file in the data directory called .htaccess, containing this line:
<PRE>deny from all</PRE>
<p>To make sure that Moodle can save uploaded files in this directory, check that
the web server software (eg Apache) has permission to write
to this directory. On Unix machines, this means setting the owner of the directory
to be something like &quot;nobody&quot; or &quot;apache&quot;.</p>
<H3><A NAME="database"></A>5. Create a database</H3>
<p>You need to create an empty database (eg "moodle") in your database system
along with a special user (eg "moodleuser") that has access to that database
(and that database only). You could use the "root" user if you wanted to, but
this is not recommended for a production system: if hackers manage to discover
the password then your whole database system would be at risk, rather than
just one database.
<p>eg for MySQL: </p>
# mysql -u root -p
TO moodleuser@localhost IDENTIFIED BY 'yourpassword';
> quit
# mysqladmin -p reload
<p>(For MySQL I highly recommend the use of <a href="">phpMyAdmin</a>
to manage your databases).</p>
<p>Note that Moodle currently does not yet support table name prefixes, and works best with a whole
database to itself. If you do want to install Moodle in a database that already contains
tables, and are SURE that Moodle tables will not conflict with any tables
that you already have installed, then you can call this script in your moodle
installation: admin/forcetables.php</p>
<H3><A NAME="webserver" id="webserver"></A>6. Check your web server settings</H3>
<p>Firstly, make sure that your web server is set up to use index.php as a default
page (perhaps in addition to index.html, default.htm and so on).</p>
<p>In Apache, this is done using a DirectoryIndex parameter in your httpd.conf
file. Mine usually looks like this:</p>
<pre><strong>DirectoryIndex</strong> index.php index.html index.htm </pre>
<p>Just make sure index.php is in the list (and preferably towards the start
of the list, for efficiency).</p>
<p>Secondly, Moodle requires a number of PHP settings to be active for it to
work. <B>On most servers these will already be the default settings.</B>
However, some PHP servers (and some of the more recent PHP versions) may
have things set differently. These are defined in PHP's configuration
file (usually called php.ini):</p>
<pre>file_uploads = 1
magic_quotes_gpc = 1
short_open_tag = 1
session.auto_start = 0
<p>If you don't have access to httpd.conf or php.ini on your server, or you
have Moodle on a server with other applications that require different
settings, then you can OVERRIDE all of the default settings.
<p>To do this, you need to create a file called <B>.htaccess</B> in Moodle's
main directory that contains definitions for these settings.
This only works on Apache servers and only when Overrides have been allowed.
DirectoryIndex index.php index.html index.htm
php_value magic_quotes_gpc 1
php_value file_uploads 1
php_value short_open_tag 1
php_value session.auto_start 0</BLOCKQUOTE></PRE>
<P>You can also do things like define the maximum size for uploaded files:
php_value upload_max_filesize 2M
php_value post_max_size 2M
<p>The easiest thing to do is just copy the sample file from lib/htaccess
and edit it to suit your needs. It contains further instructions. For
example, in a Unix shell:
<pre>cp lib/htaccess .htaccess</pre>
<H3><A NAME="config"></A>7. Edit config.php</H3>
<p>Now you can edit the configuration file, <strong>config.php</strong>, using a
text editor. This file is used by all other files in Moodle.</p>
<p>To start with, make a copy of config-dist.php and call it config.php. We
do this so that your config.php won't be overwritten in case you upgrade Moodle
later on. </p>
<p>Edit config.php to specify the database details that you just defined, as
well as the site address, file system directory and data directory.
The config file has detailed directions.</p>
<p>For the rest of this installation document we will assume your site is at:
<H3><A NAME="admin"></A>8. Go to the admin page</H3>
<p>The admin page should now be working at: <u></u>.
If you try and access the front page of your site you'll be taken there automatically
anyway. The first time you access this admin page, you will be presented with
a GPL agreement with which you need to agree before you can continue with the setup.</p>
<P>(Moodle will also try to set some cookies in your browser. If you have
your browser set up to let you choose to accept cookies, then you <B>must</B>
accept the Moodle cookies, or Moodle won't work properly.)
<p>Now Moodle will start setting up your database and creating tables to store data.
Firstly, the main database tables are created. You should see a number of SQL statements followed by
status messages (in green or red) that look like this:</p>
<p>CREATE TABLE course ( id int(10) unsigned NOT NULL auto_increment, category
int(10) unsigned NOT NULL default '0', password varchar(50) NOT NULL default
'', fullname varchar(254) NOT NULL default '', shortname varchar(15) NOT
NULL default '', summary text NOT NULL, format tinyint(4) NOT NULL default
'1', teacher varchar(100) NOT NULL default 'Teacher', startdate int(10)
unsigned NOT NULL default '0', enddate int(10) unsigned NOT NULL default
'0', timemodified int(10) unsigned NOT NULL default '0', PRIMARY KEY (id))
<p><FONT COLOR="#006600">SUCCESS</FONT></p>
<p>...and so on, followed by: <FONT COLOR="#FF0000">Main databases set up
successfully</FONT>. </p>
<p>If you don't see these, then there must have been some problem with the database
or the configuration settings you defined in config.php. Check that PHP isn't
in a restricted "safe mode" (commercial web hosts often have safe mode turned
on). You can check PHP variables by creating a little file containing &lt?
phpinfo() ?&gt and looking at it through a browser. Check all these and try
this page again.</p>
<p>Scroll down the very bottom of the page and press the &quot;Continue&quot;
<p>Next you will see a similar page that sets up all the tables required by
each Moodle module. As before, they should all be green.</p>
<p>Scroll down the very bottom of the page and press the &quot;Continue&quot;
<p>You should now see a form where you can define more configuration variables
for your installation, such as the default language, SMTP hosts and so on.
Don't worry too much about getting everything right just now - you can always
come back and edit these later on using the admin interface. Scroll down
to the bottom and click &quot;Save changes&quot;.</p>
<p>Next is a form where you can define parameters for your Moodle site and the
front page, such as the name, format, description and so on.
Fill this out (you can always go back and change these later) and then press
&quot;Save changes&quot;.</p>
<p>Finally, you will then be asked to create a top-level administration user
for future access to the admin pages. Fill out the details with your own name,
email etc and then click &quot;Save changes&quot;. Not all the fields are
required, but if you miss any important fields you'll be re-prompted for them.
<p><strong>Make sure you remember the username and password you chose
for the administration user account, as they will be necessary to
access the administration page in future.</strong></p>
<p>Once successful, you will be returned to the main admin page, which contain
a number of links arranged in a menu (these items also appear on the home
page when you are logged in as the admin user). All your further administration
of Moodle can now be done using this menu, such as:</p>
<li>creating and deleting courses</li>
<li>creating and editing user accounts</li>
<li>administering teacher accounts</li>
<li>changing site-wide settings like themes etc</li>
<H3><A NAME="cron"></A>9. Set up cron</H3>
<p>Some of Moodle's modules require continual checks to perform tasks. For example,
Moodle needs to check the discussion forums so it can mail out copies of posts
to people who have subscribed.</p>
<p>The script that does all this is located in the admin directory, and is called
cron.php. However, it can not run itself, so you need to set up a mechanism
where this script is run regularly (eg every five minutes). This provides
a &quot;heartbeat&quot; so that the script can perform functions at periods
defined by each module.</p>
<P>Note that the machine performing the cron <B>does not need to be the same
machine that is running Moodle</B>. For example, if you have a limited web hosting
service that does not have cron, then you can might choose to run cron on another
server or on your home computer. All that matters is that the cron.php file is
called every five minutes or so.</p>
<p>First, test that the script works by running it directly from your browser:</p>
<p>Now, you need to set up some of way of running the script automatically and
regularly. </p>
<H4> Running the script from a command line</H4>
<p>You can call the page from the command line just as you did in the example
above. For example, you can use a Unix utility like 'wget':</p>
<PRE>wget -q -O /dev/null</PRE>
<p>Note in this example that the output is thrown away (to /dev/null).</p>
<p>The same thing using lynx:</p>
<pre>lynx -dump &gt; /dev/null</pre>
<p>Alternatively you could use a standalone version of PHP, compiled to be run
on the command line. The advantage with doing this is that your web server
logs aren't filled with constant requests to cron.php. The disadvantage is
that you need to have access to a command-line version of php.</p>
<PRE>/opt/bin/php /web/moodle/admin/cron.php
(Windows) C:\apache\php\php.exe C:\apache\htdocs\moodle\admin\cron.php
<h4>Automatically running the script every 5 minutes</h4>
<p>On Unix systems: Use <B>cron</B>. Edit your cron settings from the commandline
using &quot;crontab -e&quot; and add a line like:</p>
<PRE>*/5 * * * * wget -q -O /dev/null</PRE>
<p>On Windows systems: The simplest way is to use my package <A TITLE="Click to download this package (150k)" HREF=""></A>
which makes this whole thing very easy. You can also explore using the built-in
Windows feature for "Scheduled Tasks".</p>
<H3><A NAME="course"></A>10. Create a new course</H3>
<p>Now that Moodle is running properly, you can create a course. </p>
<p>Select &quot;Create a new course&quot; from the Admin page (or the admin
links on the home page).</p>
<p>Fill out the form, paying special attention to the course format. You don't
have to worry about the details too much at this stage, as everything can
be changed later by the teacher.</p>
<p>Press &quot;Save changes&quot;, and you will be taken to a new form where
you can assign teachers to the course. You can only add existing user accounts
from this form - if you want to create a new teacher account then either ask
the teacher to create one for themselves (see the login page), or create one
for them using the &quot;Add a new user&quot; on the Admin page.</p>
<p>Once done, the course is ready to customise, and is accessible via the &quot;Courses&quot;
link on the home page.</p>
<p>See the &quot;<A HREF="teacher.html">Teacher Manual</A>&quot; for more details
on course-building.</p>
<P ALIGN="CENTER"><FONT SIZE="1"><A HREF="." TARGET="_top">Moodle Documentation</A></FONT></P>
<P ALIGN="CENTER"><FONT SIZE="1">Version: $Id$</FONT></P>
Jump to Line
Something went wrong with that request. Please try again.