mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-11-16 10:05:18 +00:00
ceddc11c29
One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
51 lines
1.5 KiB
ReStructuredText
51 lines
1.5 KiB
ReStructuredText
.. _plugins:
|
|
|
|
Plugins
|
|
=======
|
|
|
|
Tutor comes with a plugin system that allows anyone to customise the deployment of an Open edX platform very easily. The vision behind this plugin system is that users should not have to fork the Tutor repository to customise their deployments. For instance, if you have created a new application that integrates with Open edX, you should not have to describe how to manually patch the platform settings, ``urls.py`` or ``*.env.json`` files. Instead, you can create a "tutor-myapp" plugin for Tutor. Then, users will start using your application in three simple steps::
|
|
|
|
# 1) Install the plugin
|
|
pip install tutor-myapp
|
|
# 2) Enable the plugin
|
|
tutor plugins enable myapp
|
|
# 3) Reconfigure and restart the platform
|
|
tutor local quickstart
|
|
|
|
For simple changes, it may be extremely easy to create a Tutor plugin: even non-technical users may get started with :ref:`simple yaml plugins <plugins_yaml>`.
|
|
|
|
In the following we learn how to use and create Tutor plugins.
|
|
|
|
Commands
|
|
--------
|
|
|
|
List installed plugins::
|
|
|
|
tutor plugins list
|
|
|
|
Enable/disable a plugin::
|
|
|
|
tutor plugins enable myplugin
|
|
tutor plugins disable myplugin
|
|
|
|
After enabling or disabling a plugin, the environment should be re-generated with::
|
|
|
|
tutor config save
|
|
|
|
.. _existing_plugins:
|
|
|
|
Existing plugins
|
|
----------------
|
|
|
|
Officially-supported plugins are listed on the `Overhang.IO <https://overhang.io/tutor/plugins>`__ website.
|
|
|
|
Plugin development
|
|
------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
plugins/api
|
|
plugins/gettingstarted
|
|
plugins/examples
|