Installing plugins: Skillnad mellan sidversioner
(rewording) |
(page rewrite (1st draft)) |
||
Rad 1: | Rad 1: | ||
{{Installing Moodle}} | {{Installing Moodle}} | ||
An add-on is an optional plugin for adding additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more. | |||
==What is meant by the words 'plugin' and 'add-on'?== | ==What is meant by the words 'plugin' and 'add-on'?== | ||
Rad 10: | Rad 10: | ||
== Before you do anything else... == | == Before you do anything else... == | ||
'''VERY IMPORTANT''' Warning: Please be aware that some add-ons have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful | '''VERY IMPORTANT''' Warning: Please be aware that some add-ons have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all. | ||
* Do you '''really''' need the add-on? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time. | * Do you '''really''' need the add-on? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time. | ||
Rad 17: | Rad 17: | ||
* Beware of ''patches''! If an add-on modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade. | * Beware of ''patches''! If an add-on modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade. | ||
== | ==Installing an add-on== | ||
{{New features}}In Moodle 2.5 onwards, add-ons may be from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file. | |||
To install an add-on directly from the Moodle plugins directory: | |||
# Login as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''. | |||
# Click the button 'Install add-ons from Moodle plugins directory'. | |||
# Choose a plugin with an Install button (i.e. suitable for 2.5), click the Install button then click Continue. | |||
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'. | |||
To install an add-on by uploading a ZIP file: | |||
# Go to the [https://moodle.org/plugins Moodle plugins directory], select Moodle 2.5 as version, then choose an add-on with a Download button and download the ZIP file. | |||
# Login to your Moodle site as an admin and go to ''Administration > Site administration > Plugins > Install add-ons''. | |||
# Upload the ZIP file, select the appropriate plugin type, tick the acknowledgement checkbox, then click the button 'Install add-on from the ZIP file'. | |||
# Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'. | |||
For both methods, after clicking the button 'Install add-on', you will then be automatically redirected to ''Settings > Site administration > Notifications'' where you will see a message saying that the add-on is installed. | |||
Note: The add-on may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. | Note: The add-on may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard ''Settings > Site administration > Language'' editing interface. | ||
== | ==Uninstalling an add-on== | ||
To uninstall an add-on | |||
# Go to ''Settings > Site Administration > Plugins > Plugins overview'' and click the Uninstall link opposite the add-on you wish to remove | |||
# Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration | |||
Note: Certain plugin types offer the removal from the disk as well, though not yet all. | |||
==Plugins overview== | ==Plugins overview== | ||
Rad 70: | Rad 51: | ||
[[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]The Plugins overview page in ''Settings > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number, availability (enabled or disabled) and settings link (if applicable). | [[File:plugins overview.png|thumb|left|Plugins overview highlighting available update with install button]]The Plugins overview page in ''Settings > Site Administration > Plugins > Plugins overview'' lists all installed plugins, together with the version number, availability (enabled or disabled) and settings link (if applicable). | ||
A 'Check for available updates' button enables admins to quickly check for any updates available to standard plugins or add-ons installed on the site (from the [http://moodle.org/plugins plugins directory]). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin. | |||
A 'Check for available updates' button enables admins to quickly check for any updates available to | |||
===Plugin updating from within Moodle=== | ===Plugin updating from within Moodle=== | ||
In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details. | In Moodle 2.4 onwards, an administrator can enable updates deployment in ''Administration > Site Administration > Server > Update notifications''. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See [[Automatic updates deployment]] for more details. | ||
==Preventing installing add-ons from within Moodle== | |||
If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php. | |||
// Use the following flag to completely disable the On-click add-on installation | |||
// feature and hide it from the server administration UI. | |||
// | |||
// $CFG->disableonclickaddoninstall = true; | |||
==See also== | ==See also== | ||
Rad 83: | Rad 71: | ||
*[[Add-on FAQ]] | *[[Add-on FAQ]] | ||
*Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum] | *Using Moodle [http://moodle.org/mod/forum/view.php?id=44 General add-ons forum] | ||
* [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]] | * [[Installing Moodle from Git repository#Installing a contributed extension from its Git repository|Installing a contributed extension from its Git repository]] | ||
Rad 90: | Rad 77: | ||
*[[:dev:Category:Plugins|Plugins developer documentation]] | *[[:dev:Category:Plugins|Plugins developer documentation]] | ||
*[[:dev:Plugin validation]] | *[[:dev:Plugin validation]] | ||
*[[:dev:On-click add-on installation]] | |||
[[Category:Contributed code]] | [[Category:Contributed code]] |
Versionen från 2 maj 2013 kl. 16.17
An add-on is an optional plugin for adding additional features and functionality to Moodle, such as new activities, new quiz question types, new reports, integrations with other systems and many more.
What is meant by the words 'plugin' and 'add-on'?
Moodle = core code + plugins
Plugins may be either standard plugins (included in the Moodle download package) or add-ons.
Before you do anything else...
VERY IMPORTANT Warning: Please be aware that some add-ons have not been reviewed, and the quality and/or suitability for your Moodle site has not been checked. Please be careful. It may not do what you expect, it may have serious security issues or it may even not work at all.
- Do you really need the add-on? More functionality means more things to support, more things to (potentially) go wrong and more things to worry about at upgrade time.
- Is the add-on supported and maintained? If something goes wrong can you get support? Will bugs be fixed?
- If the add-on does not work in a future version of Moodle, what will you do about it?
- Beware of patches! If an add-on modifies or replaces core files then be very careful. It can only be guaranteed to work with the exact build (version) of Moodle it was created for and is highly unlikely to survive a Moodle upgrade.
Installing an add-on
New feature
in Moodle 4.0!
In Moodle 2.5 onwards, add-ons may be from within Moodle, either directly from the Moodle plugins directory or by uploading a ZIP file.
To install an add-on directly from the Moodle plugins directory:
- Login as an admin and go to Administration > Site administration > Plugins > Install add-ons.
- Click the button 'Install add-ons from Moodle plugins directory'.
- Choose a plugin with an Install button (i.e. suitable for 2.5), click the Install button then click Continue.
- Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.
To install an add-on by uploading a ZIP file:
- Go to the Moodle plugins directory, select Moodle 2.5 as version, then choose an add-on with a Download button and download the ZIP file.
- Login to your Moodle site as an admin and go to Administration > Site administration > Plugins > Install add-ons.
- Upload the ZIP file, select the appropriate plugin type, tick the acknowledgement checkbox, then click the button 'Install add-on from the ZIP file'.
- Check that you obtain a 'Validation passed!' message, then click the button 'Install add-on'.
For both methods, after clicking the button 'Install add-on', you will then be automatically redirected to Settings > Site administration > Notifications where you will see a message saying that the add-on is installed.
Note: The add-on may contain language files. They'll be found by your Moodle automatically. These language strings can be customized using the standard Settings > Site administration > Language editing interface.
Uninstalling an add-on
To uninstall an add-on
- Go to Settings > Site Administration > Plugins > Plugins overview and click the Uninstall link opposite the add-on you wish to remove
- Use a file manager to remove/delete the actual plugin directory as instructed, otherwise Moodle will reinstall it next time you access the site administration
Note: Certain plugin types offer the removal from the disk as well, though not yet all.
Plugins overview
The Plugins overview page in Settings > Site Administration > Plugins > Plugins overview lists all installed plugins, together with the version number, availability (enabled or disabled) and settings link (if applicable).
A 'Check for available updates' button enables admins to quickly check for any updates available to standard plugins or add-ons installed on the site (from the plugins directory). Any updates available are highlighted, with further information and a download link in the notes column opposite the plugin.
Plugin updating from within Moodle
In Moodle 2.4 onwards, an administrator can enable updates deployment in Administration > Site Administration > Server > Update notifications. Then when updates are available, 'Install this update' buttons are shown on the Plugins overview page. See Automatic updates deployment for more details.
Preventing installing add-ons from within Moodle
If required, installing and updating from within Moodle can be prevented by copying the following lines of code from config-dist.php and pasting them in config.php.
// Use the following flag to completely disable the On-click add-on installation // feature and hide it from the server administration UI. // // $CFG->disableonclickaddoninstall = true;
See also
- Notifications for further details of update notifications
- Add-on FAQ
- Using Moodle General add-ons forum
- Installing a contributed extension from its Git repository
For developers: