From 5f94e29fa6b6b31fd02e83f9ae7c85d8bc853076 Mon Sep 17 00:00:00 2001 From: moodler Date: Tue, 31 Aug 2004 15:22:39 +0000 Subject: [PATCH] Improved installation documentation --- lang/en/docs/install.html | 439 +++++++++++++++++++------------------- 1 file changed, 225 insertions(+), 214 deletions(-) diff --git a/lang/en/docs/install.html b/lang/en/docs/install.html index fcda4394a1..f06f1df015 100644 --- a/lang/en/docs/install.html +++ b/lang/en/docs/install.html @@ -1,33 +1,45 @@ -Moodle Docs: Installation +Moodle Docs: Basic Installation +

Installing Moodle

Dont panic!

-
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!
-
Take your time and work through this document carefully - it will save you time later on.
+
This guide explains how to install Moodle for the first time. For some of these steps it goes into a lot of detail to try and cover the majority of possible + web server setups, so this document may look long and complicated. Don't panic, once you know how to do it you can install Moodle in minutes!
+
If you have problems please read this document carefully - most common issues are answered in here. + If you still have trouble, you can seek help from + Moodle Help
+
Another option is to contact a web hosting company + who can completely maintain Moodle for you, so that you can ignore all this and get straight into educating! +
+

Sections in this document:

Requirements
-
Download
+
Download and copy files into place

Site structure
-
Create a data directory
-
Create a database
-
Check web server settings
-
Edit config.php
-
Go to the admin page
+
Run the installer script to create config.php
+
Check web server settings
+
Creating a database
+
Creating a data directory
+
+
+
Go to the admin page to continue configuration

Set up cron

Create a new course
-
+

1. Requirements

@@ -41,21 +53,10 @@ but Moodle should work fine under any web server that supports PHP, such as IIS on Windows platforms.

PHP scripting language (version 4.1.0 - or later), with the following settings: -

GD library - turned ON, with support for JPG and PNG formats
zlib library turned ON (if you want to use backup/restore on Windows)
Sessions support turned ON
File uploading turned ON
Safe Mode must be turned OFF (see the forums on moodle.org for problems - caused by Safe Mode)

+ or later). PHP 5 is supported as of Moodle 1.4.

a working database server: MySQL or PostgreSQL are - completely supported and recommended for use with Moodle 1.1. Other - databases will be supported fully in a future release.

+ completely supported and recommended for use with Moodle.

Most web hosts support all of this by default. If you are signed up with one of the few webhosts that does not support these features ask them why, @@ -66,31 +67,36 @@ all this on most popular platforms.

2. Download

2. Download and copy files into place

There are two ways to get Moodle, as a compressed package and via CVS. These are explained in detail on the download page: http://moodle.org/download/

After downloading and unpacking the archive, or checking out the files via CVS, you will be left with a directory called "moodle", containing - a number of files and folders.
+ a number of files and folders.

You can either place the whole folder in your web server documents directory, in which case the site will be located at http://yourwebserver.com/moodle, or you can copy all the contents straight into the main web server documents directory, in which case the site will be simply http://yourwebserver.com.
+
If you are downloading Moodle to your local computer and then uploading it to your web site, it is usually better to upload the whole archive as one file, and then do the unpacking on the server. Even web hosting interfaces like Cpanel allow you to uncompress archives in the "File Manager".

3. Site structure

-
Here is a quick summary of the contents of the Moodle folder, to help get +
You can safely skip this section, but here is a quick summary of the contents of the Moodle folder, to help get you oriented:
- + + contains basic settings. This file does not come with Moodle - you will create it. + + + + + +
config-dist.php config.php - - you will later make a copy of this and save it as config.php. - This will be the ONLY file you need to edit to get started. -
install.php - the script you will run to create config.php
version.php

-
@@ -104,14 +110,16 @@
admin/ - code to administrate the whole server
-
auth/ - plugin modules to authenticate users
+
auth/ - plugin modules to authenticate users
+
blocks/ - plugin modules for the little side blocks on many pages
+
calendar/ - all the code for managing and displaying calendars

course/ - code to display and manage courses

doc/ - help documentation for Moodle (eg this page)

files/ - code to display and manage uploaded files

lang/ - texts in different languages, one directory per language

lib/ - libraries of core Moodle code

login/ - code to handle login and account creation
-
mod/ - all Moodle course modules
+
mod/ - all the main Moodle course modules are in here

pix/ - generic site graphics

theme/ - theme packs/skins to change the look of the site.

user/ - code to display and manage users
@@ -119,102 +127,57 @@

-
4. Create a data directory
+
4. Run the Installer script to create config.php
-
Moodle will also need some space on your hard disk to store uploaded files, - such as course documents and user pictures.
-
Create a directory for this purpose somewhere. For security, it's best that - this directory is NOT accessible directly 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: -
- -
deny from all
-
-
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 "nobody" or "apache".
-
On many shared hosting servers, you will probably need to restrict all file access - to your "group" (to prevent other webhost customers from looking at or changing your files), - but provide full read/write access to everyone else (which will allow the web server - to access your files). Speak to your server administrator if you are having - trouble setting this up securely.
+
To run the installer script (install.php), just try to access your Moodle main URL using a web browser, or access http://yourserver/install.php directly.
+
(The Installer will try to set a session cookie. If you get a popup warning in your browser make sure you accept that cookie!)
+
Moodle will detect that configuration is necessary and will lead you through some screens to help you create a new configuration file called config.php. At the end of the process Moodle will try and write the file into the right location, otherwise you can press a button to download it from the installer and then upload config.php into the main Moodle directory on the server.
+
Along the way the installer will test your server environment and give you suggestions about how to fix any problems. For most common issues these suggestions should be sufficient, but if you get stuck, look below for more information about some of common things that might be holding you up.
+
-

-
5. Create a database
-
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. -
-
Example command lines for MySQL:
-
-   # mysql -u root -p
-   > CREATE DATABASE moodle; 
-   > GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX,ALTER ON moodle.* 
-           TO moodleuser@localhost IDENTIFIED BY 'yourpassword'; 
-   > quit 
-   # mysqladmin -p reload
-
-
Example command lines for PostgreSQL:
-
-   # su - postgres
-   > psql -c "create user moodleuser createdb;" template1
-   > psql -c "create database moodle;" -U moodleuser template1
-   > psql -c "alter user moodleuser nocreatedb;" template1
-
-
(For MySQL I highly recommend the use of phpMyAdmin - to manage your databases - you can do all this via a web interface).
-
As of version 1.0.8, Moodle now supports table prefixes, and so can safely share - a database with tables from other applications.
-
-

-
6. Check your web server settings
-
-
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).
-
In Apache, this is done using a DirectoryIndex parameter in your httpd.conf - file. Mine usually looks like this:
-
-
DirectoryIndex index.php index.html index.htm 
-
-
Just make sure index.php is in the list (and preferably towards the start - of the list, for efficiency).
-
Secondly, if you are using Apache 2, then you should turn on the AcceptPathInfo - variable, which allows scripts to be passed arguments like http://server/file.php/arg1/arg2. - This is essential to allow relative links between your resources, and also - provides a performance boost for people using your Moodle web site. You can - turn this on by adding these lines to your httpd.conf file.
-
-
AcceptPathInfo on 
-
-
Thirdly, Moodle requires a number of PHP settings to be active for it to - work. On most servers these will already be the default settings. - 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):
-
-
magic_quotes_gpc = 1    (preferred but not necessary)
+4.1 General web server settings 
+  
+    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).
+    In Apache, this is done using a DirectoryIndex parameter in your httpd.conf 
+      file. Mine usually looks like this:
+    
+      DirectoryIndex index.php index.html index.htm 
+    
+    Just make sure index.php is in the list (and preferably towards the start 
+      of the list, for efficiency).
+    Secondly, if you are using Apache 2, then you should turn on the AcceptPathInfo
+       variable, which allows scripts to be passed arguments like http://server/file.php/arg1/arg2.
+       This is essential to allow relative links between your resources, and also 
+       provides a performance boost for people using your Moodle web site.  You can 
+       turn this on by adding these lines to your httpd.conf file.
+    
+      AcceptPathInfo on 
+    
+    Thirdly, Moodle requires a number of PHP settings to be active for it to 
+       work.  On most servers these will already be the default settings.
+       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):
+    
+      magic_quotes_gpc = 1    (preferred but not necessary)
 magic_quotes_runtime = 0    (necessary)
 file_uploads = 1
 session.auto_start = 0
 session.bug_compat_warn = 0
-
-  
-  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 don't worry, you can still OVERRIDE all of the default settings. 
-  
To do this, you need to create a file called .htaccess in Moodle's
-     main directory that contains definitions for these settings.
-     This only works on Apache servers and only when Overrides have been allowed.
-     
-  

-    +  
+    
+    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 don't worry, you can often still OVERRIDE the default settings. 
+    
+    To do this, you need to create a file called .htaccess in Moodle's
+       main directory that contains lines like the following.
+       This only works on Apache servers and only when Overrides have been allowed in the main configuration. 
+    
+       DirectoryIndex index.php index.html index.htm
 
 <IfDefine APACHE2>
@@ -226,50 +189,86 @@ php_flag magic_quotes_runtime 0
 php_flag file_uploads 1
 php_flag session.auto_start 0
 php_flag session.bug_compat_warn 0
-  
-  You can also do things like define the maximum size for uploaded files:
-     
-  

-    +    
+    You can also do things like define the maximum size for uploaded files:
+         
+
+    
+       LimitRequestBody 0
 php_value upload_max_filesize 2M
 php_value post_max_size 2M
      
+    
+    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:
+   
+    
+      cp lib/htaccess .htaccess
+    
   
-  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:
+
 
+4.2 Creating a database
+
   
-    cp lib/htaccess .htaccess
+    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 for a test server, 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. 
+    If you are using a webhost, they will probably have a control panel web interface for you to create your database. 
+    The Cpanel system is  one of the most popular of these. To create a database in Cpanel, 
+    
+      Click on the "MySQL Databases" icon.
+      Type "moodle" in the database field and click "Add Database".
+       Type a username and password (not one you use elsewhere) in the respective fields and click "Add User".
+       Now use the "Add User to Database" button to give this new user account "ALL" rights to the new database.
+      Note that the username and database names may be prefixed by your Cpanel account name. When entering this information into the Moodle installer - use the full names.
+    
+    If you have access to Unix command lines then you can do the same sort of thing by typing commands. 
+    Here are some example Unix command lines for MySQL: 
+    +   # mysql -u root -p
+   > CREATE DATABASE moodle; 
+   > GRANT SELECT,INSERT,UPDATE,DELETE,CREATE,DROP,INDEX,ALTER ON moodle.* 
+           TO moodleuser@localhost IDENTIFIED BY 'yourpassword'; 
+   > quit 
+   # mysqladmin -p reload
+    
+    And some example command lines for PostgreSQL: 
+    +   # su - postgres
+   > psql -c "create user moodleuser createdb;" template1
+   > psql -c "create database moodle;" -U moodleuser template1
+   > psql -c "alter user moodleuser nocreatedb;" template1
+  
+   
+  
+4.3 Creating a data directory 
+
+  
+    Moodle will also need some space on your server's hard disk to store uploaded files, such as course documents and user pictures. 
+    The Moodle installer tries hard to create this directory for you but if it fails then you will have to create a directory for this purpose manually. 
+    For security, it's best that this directory is NOT accessible directly via the web. The easiest way to do this is to simply locate it OUTSIDE the web directory, but if you must have it in the web directory then  protect it by creating a file in the data directory called .htaccess, containing this line: 
+    
+      deny from all
+    
+    To make sure that Moodle can save uploaded files in this directory, check that the web server software (eg Apache) has permission to read, write and execute in  this directory. 
+    On Unix machines, this means setting the owner of the directory to be something like "nobody" or "apache", and then giving that user read, write and execute permissions.
+    On Cpanel systems you can use the "File Manager" to find the folder, click on it, then choose "Change Permissions". On many shared hosting servers, you will probably need to restrict all file access to your "group" (to prevent other webhost customers from looking at or changing your files), but provide full read/write access to everyone else (which will allow the web server to access your files). 
+    Speak to your server administrator if you are having trouble setting this up securely. In particular some sites that use a PHP feature known as "Safe Mode" may require the administrator to create this directory properly for you. 
   
+
 
-

-
7. Edit config.php
-
-
Now you can create and edit the configuration file, config.php, using a - text editor. This file is used by all other files in Moodle.
-
To start with, make a copy of config-dist.php and name it - config.php. We do this so that your config.php won't be overwritten in case - you upgrade Moodle later on.
-
Edit config.php to specify the database details that you - just defined (including a table prefix - notice that this is REQUIRED for - PostgreSQL), as well as the site address, file system directory and data directory. - The config file itself has detailed directions and examples.
-
Once you have done this the rest of the installation is via a web interface. - For the rest of this installation document we will assume your site is at: - http://example.com/moodle
+
-

-
8. Go to the admin page
+
5. Go to the admin page to continue configuration

-
The admin page should now be working at: http://example.com/moodle/admin. - 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 "shrinkwrap" agreement with which you must agree before you - can continue with the setup.
-
(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 must accept - the Moodle cookies, or Moodle won't work properly.) +
Once the basic config.php has been correctly created in the previous step, trying to access the front page of your site will take you the "admin" page for the rest of the configuration.
+
The first time you access this admin page, you will be presented with + a GPL "shrinkwrap" agreement with which you must agree before you + can continue with the setup.

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 @@ -284,30 +283,31 @@ php_value post_max_size 2M '0', timemodified int(10) unsigned NOT NULL default '0', PRIMARY KEY (id)) TYPE=MyISAM

SUCCESS
-
...and so on, followed by: Main databases set up +
+
...and so on, followed by: Main databases set up successfully.
+
+
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 sometimes have safe mode + turned on). You can check PHP variables by creating a little file containing <?php phpinfo() ?> and looking at it through a browser. Check all these and + try this page again.

-
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 sometimes have safe mode - turned on). You can check PHP variables by creating a little file containing - <? phpinfo() ?> and looking at it through a browser. Check all these and - try this page again.
-
Scroll down the very bottom of the page and press the "Continue" - link.
-
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.

Scroll down the very bottom of the page and press the "Continue" link.

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 + come back and edit these later on using the admin interface. The defaults are designed to be useful and secure for most sites. Scroll down to the bottom and click "Save changes".
-
If (and only if) you find yourself getting stuck on this page, unable to - continue, then your server probably has what I call the "buggy referrer" problem. - This is easy to fix: just turn off the "secureforms" setting, then - try to continue again.
+
+
If (and only if) you find yourself getting stuck on this page, unable to + continue, then your server probably has what I call the "buggy referrer" problem. + This is easy to fix: just turn off the "secureforms" setting, then + try to continue again.
+
+
Next you will see more pages that print lots of status messages as they set up all the tables required by the various Moodle module. As before, they should all be green.
+
Scroll down the very bottom of the page and press the "Continue" link.

The next page 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 come back and change these later) and then press @@ -329,12 +329,12 @@ php_value post_max_size 2M
+
(If for any reason your install is interrupted, or there is a system error + of some kind that prevents you from logging in using the admin account, you + can usually log in using the default username of "admin", + with password "admin".)
-
(If for any reason your install is interrupted, or there is a system error - of some kind that prevents you from logging in using the admin account, you - can usually log in using the default username of "admin", - with password "admin".)
-
Once successful, you will be returned to home page of your site. Note the +
Once successful, you will be returned to the home page of your new site! Note the administration links that appear down the left hand side of the page (these items also appear on a separate Admin page) - these items are only visible to you because you are logged in as the admin user. All your further administration @@ -345,9 +345,10 @@ php_value post_max_size 2M
administering teacher accounts

changing site-wide settings like themes etc
+
But you are not done installing yet! There is one very important thing still to do (see the next section on cron).

-
9. Set up cron
+
6. Set up cron -- IMPORTANT!

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 @@ -356,10 +357,10 @@ php_value post_max_size 2M 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 or ten minutes). This provides a "heartbeat" so that the script can perform functions at periods - defined by each module.
+ defined by each module. This kind of regular mechanism is known as a cron service.

Note that the machine performing the cron does not need to be the same machine that is running Moodle. For example, if you have a limited web - hosting service that does not have cron, then you can might choose to run + hosting service that does not have a cron service, 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 regularly.

The load of this script is not very high, so 5 minutes is usually reasonable, @@ -371,55 +372,62 @@ php_value post_max_size 2M
http://example.com/moodle/admin/cron.php

Now, you need to set up some of way of running the script automatically and - regularly.
-
Running the script from a command line
-
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':
+ regularly.
+
On Windows systems

-
wget -q -O /dev/null http://example.com/moodle/admin/cron.php
+
The simplest way is to use this little package moodle-cron-for-windows.zip which makes this whole thing very easy by installing a small Windows service. Run it and forget about it!

-
Note in this example that the output is thrown away (to /dev/null).
-
The same thing using lynx:
+
On web hosting services

-
lynx -dump http://example.com/moodle/admin/cron.php > /dev/null
+
Your web-based control panel may have a web page that allows you to set up this cron process. For example, on Cpanel system, look for a button called "Cron jobs". In there you can put the same sort of Unix commands as listed below.

-
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.
+
Using the command line on Unix

-
/opt/bin/php /web/moodle/admin/cron.php - - -(Windows) C:\apache\php\php.exe C:\apache\htdocs\moodle\admin\cron.php +
There are different command line programs you can use to call the page from the command line. Not all of them may be available on a given server.
+
For example, you can use a Unix utility like 'wget':
+
+
wget -q -O /dev/null http://example.com/moodle/admin/cron.php
+
+
Note in this example that the output is thrown away (to /dev/null).
+
The same thing using lynx:
+
+
lynx -dump http://example.com/moodle/admin/cron.php > /dev/null
+
+
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.
+
+
/opt/bin/php /web/moodle/admin/cron.php -
+
+
-
Automatically running the script every 5 minutes
-
On Unix systems: Use cron. Edit your cron settings from the commandline - using "crontab -e" and add a line like:
+
Using the crontab program on Unix

-
*/5 * * * * wget -q -O /dev/null http://example.com/moodle/admin/cron.php
-
-
Usually, the "crontab" command will put you into the 'vi' editor. You enter +
All that Cpanel does is provide a web interface to a Unix utility known as crontab. If you have a command line, you can set up crontab yourself using the command:
+
+
crontab -e
+
+
and then adding one of the above commands like:
+
+
*/5 * * * * wget -q -O /dev/null http://example.com/moodle/admin/cron.php
+
+
Usually, the "crontab" command will put you into the 'vi' editor. You enter "insert mode" by pressing "i", then type in the line as above, then exit insert mode by - pressing ESC. You save and exit by typing ":wq", or quit without saving using ":q!" (without the quotes).
-
On Windows systems: The simplest way is to use this little package moodle-cron-for-windows.zip - which makes this whole thing very easy. You can also explore using the built-in - Windows feature for "Scheduled Tasks".
-
On web hosts: Your web-based control panel may have a web page that allows - you to set up this cron process. Ask your administrator for details on how - it works.
+ pressing ESC. You save and exit by typing ":wq", or quit without saving using ":q!" (without the quotes).
+ +

-
10. Create a new course
+
7. Create a new course

-
Now that Moodle is running properly, you can create a course.
+
Now that Moodle is running properly, you can try creating a new course to play with.

Select "Create a new course" from the Admin page (or the admin links on the home page).

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.
+ be changed later by the teacher. Note that the yellow help icons are everywhere to provide contextual help on any aspect.

Press "Save changes", 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 @@ -429,6 +437,9 @@ php_value post_max_size 2M link on the home page.

See the "Teacher Manual" for more details on course-building.
+

+
Happy exploring and happy Moodling!
+
If you like Moodle, please consider donating to help us cover our costs!

Moodle Documentation
-- 2.39.5