Installing plugins: Difference between revisions

Revision as of 07:42, 20 December 2011

This page requires updating. Please do so and remove this template when finished.

Warning: Please be aware that some contributed modules and plugins have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. The modules and plugins may have security problems, data-loss problems, interface problems or just plain not work. Please think carefully about maintenance before relying on contributed code in your production site, as some of this code may not work with future versions of Moodle.

Downloads

Contributed modules and plugins may be downloaded from...:

Modules Plugin Directory

Installation

To install a contributed plugin:

You must have access to the server containing Moodle. This can be direct access, through a network or to a remote server through Internet with an FTP client, you can't do it from "inside" Moodle itself. (There are many free FTP programs like FileZilla [1] that can be used. If you use FTP, you will need to know [from the server provider] the ID and password and maybe a couple more things. Once it is setup, it's as easy as other file management.)
Locate the plugin in Modules Plugin Directory, find the plugin version that matches your Moodle version and click on version release name (or 'Learn more' link). You will see installation instructions for this plugin type.
Download the zip file and unzip it to the corresponding directory.
In your browser, go to your Moodle site, login as administrator and choose Site Administration > Notifications > Continue
Perform other plugin-specific actions to enable this plugin (add a block to the page, enable filter, add module to some course, etc.)

Note: The plugin may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard Site Administration > Language editing interface.

Installation trouble-shooting

If you visit the admin page and don't get a message about a new block (or module) being successfully installed then check the following:

You unzipped the archive to the proper directory

Module and block removal

To remove a contributed module:

First make sure that you don't use this module in any course
Access Administration > Modules > Activities > Manage activities
Click on delete next to the module you wish to remove.
Use a file manager to remove/delete the actual module directory from mod/ directory, otherwise Moodle will reinstall it next time you access the site administration.

To remove a contributed block:

Access Administration > Modules > Blocks > Manage blocks
Click on delete next to the block you wish to remove.
Use a file manager to remove/delete the actual module directory from blocks/ directory, otherwise Moodle will reinstall it next time you access the site administration.

@@ Line 12: / Line 12: @@
 * [http://moodle.org/plugins/ Modules Plugin Directory]
-==Module installation==
+==Installation==
-To install a contributed module:
+To install a contributed plugin:
 # You must have access to the server containing Moodle. This can be direct access, through a network or to a remote server through Internet with an FTP client, you can't do it from "inside" Moodle itself. (There are many free FTP programs like FileZilla [http://filezilla-project.org/] that can be used. If you use FTP, you will need to know [from the server provider] the ID and password and maybe a couple more things. Once it is setup, it's as easy as other file management.)
-# Download the zip file and unzip it to your ''moodle/mod'' directory.
+# Locate the plugin in [http://moodle.org/plugins/ Modules Plugin Directory], find the plugin version that matches your Moodle version and click on version release name (or 'Learn more' link).  You will see installation instructions for this plugin type.
-# In your browser, go to your Moodle site:
+# Download the zip file and unzip it to the corresponding directory.
- Site Administration
+# In your browser, go to your Moodle site, login as administrator and choose ''Site Administration > Notifications > Continue''
-  Notifications
+# Perform other plugin-specific actions to enable this plugin (add a block to the page, enable filter, add module to some course, etc.)
-    Continue
-Note: The module may contain language files.  If so then just leave them in the folder and they'll be found automatically. These language strings can be customized using the standard ''Site Administration > Language'' editing interface.
+Note: The plugin may contain language files.  They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Site Administration > Language'' editing interface.
-To install a contributed module to a local Mac OS X web server:
+===Installation trouble-shooting===
-Download the zip file and unzip it to:
-    /Applications/MAMP/htdocs/moodle19/mod
-Visit your Local Moodle site <nowiki>http://localhost:8888/moodle19/</nowiki>
- Site Administration
-  Notifications
-    Scroll to the bottom of the page and click on "Continue"
-Check your new module has been installed:
-  Site Administration
-    Modules
-    Activities
-      Manage activities
-==Block installation==
-To install a contributed block:
-# Download the zip file and unzip it to your ''moodle/blocks'' directory.
-# Visit your admin page <nowiki>http://your_moodle_address/admin/index.php</nowiki> to complete the installation.
-==Other types of plugin==
-Plugins are installed in various places in Moodle, depending upon the plugin. For example, plugin question types need to be unzipped to your ''moodle/question/type'' directory.
-You can work out the correct place from the download link. If the download link is http://download.moodle.org/download.php/plugins19/mod/quiz/report/responses.zip, then after unzipping, the responses folder needs to be copied into the mod/quiz/report folder of your Moodle install.
-After installing any plugin, you should visit the admin notifications page of your web site (URL .../admin/index.php) to allow the plugin to install itself if necessary. (It is not always necessary, but you should always check.)
-==Installation trouble-shooting==
 If you visit the admin page and don't get a message about a new block (or module) being successfully installed then check the following:
-# The new block folder is named correctly. For example, the Learning Resources block folder should be named "learning_resources" (not "learning_resources_block").
+* You unzipped the archive to the proper directory
-# The new block folder is not contained within another folder. For example, unzipping ''block_learning_resources.zip'' results in a folder named "block_learning_resources" containing a folder named "blocks" containing a folder named "learning_resources". If it's easier, just copy and paste the folder named "learning_resources" into the blocks folder of your Moodle site.
-If you browse the blocks folder of your Moodle site, you'll notice that all the blocks follow a pattern - the activity_modules folder contains a file ''block_activity_modules.php'', the calendar_month folder contains a file ''block_calendar_month.php'', the learning_resources folder contains a file ''block_learning_resources.php'' etc. Modules follow a similar pattern.
 ==Module and block removal==
 To remove a contributed module:
-# Access ''Administration > Modules > Activities > Manage activities'' (or ''Administration > Modules > Activities'' in versions of Moodle prior to 1.9).
+# First make sure that you don't use this module in any course
+# Access ''Administration > Modules > Activities > Manage activities''
 # Click on delete next to the module you wish to remove.
-# Use a file manager to remove/delete the actual module directory from ''moodle/mod'', otherwise Moodle will reinstall it next time you access the site administration.
+# Use a file manager to remove/delete the actual module directory from ''mod/'' directory, otherwise Moodle will reinstall it next time you access the site administration.
 To remove a contributed block:
-# Access ''Administration > Modules > Blocks > Manage blocks'' (or ''Administration > Modules > Blocks'' in versions of Moodle prior to 1.9).
+# Access ''Administration > Modules > Blocks > Manage blocks''
 # Click on delete next to the block you wish to remove.
-# Use a file manager to remove/delete the actual module directory from ''moodle/blocks'', otherwise Moodle will reinstall it next time you access the site administration.
+# Use a file manager to remove/delete the actual module directory from ''blocks/'' directory, otherwise Moodle will reinstall it next time you access the site administration.
 ==See also==

Documentation