tutor/README.rst

Tutor: the Docker-based Open edX distribution designed for peace of mind
========================================================================

.. image:: https://overhang.io/static/img/tutor-logo.svg
  :alt: Tutor logo
  :width: 500px
  :align: center

|

.. _readme_intro_start:

.. image:: https://img.shields.io/static/v1?logo=github&label=Git&style=flat-square&color=brightgreen&message=Source%20code
  :alt: Source code
  :target: https://github.com/overhangio/tutor

.. image:: https://img.shields.io/static/v1?logo=discourse&label=Forums&style=flat-square&color=ff0080&message=discuss.openedx.org
  :alt: Forums
  :target: https://discuss.openedx.org/tag/tutor

.. image:: https://img.shields.io/static/v1?logo=readthedocs&label=Documentation&style=flat-square&color=blue&message=docs.tutor.edly.io
  :alt: Documentation
  :target: https://docs.tutor.edly.io

.. image:: https://img.shields.io/pypi/v/tutor?logo=python&logoColor=white
  :alt: PyPI releases
  :target: https://pypi.org/project/tutor

.. image:: https://img.shields.io/github/license/overhangio/tutor.svg?style=flat-square
  :alt: AGPL License
  :target: https://www.gnu.org/licenses/agpl-3.0.en.html

.. image:: https://img.shields.io/static/v1?logo=twitter&label=Twitter&style=flat-square&color=1d9bf0&message=@overhangio
  :alt: Follow us on Twitter
  :target: https://twitter.com/overhangio/

.. image:: https://img.shields.io/static/v1?logo=youtube&label=YouTube&style=flat-square&color=ff0000&message=@overhangio
    :alt: Follow us on Youtube
    :target: https://www.youtube.com/c/OverhangIO

**Tutor** is the official Docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customise, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used to deploy hundreds of Open edX platforms around the world.

Do you need professional assistance setting up or managing your Open edX platform? `Edly <https://edly.io>`__ provides online support as part of its `Open edX installation service <https://edly.io/services/open-edx-installation/>`__.

Features
--------

* 100% `open source <https://github.com/overhangio/tutor>`__
* Runs entirely on Docker
* World-famous 1-click `installation and upgrades <https://docs.tutor.edly.io/install.html>`__
* Comes with batteries included: `theming <https://github.com/overhangio/indigo>`__, `SCORM <https://github.com/overhangio/openedx-scorm-xblock>`__, `HTTPS <https://docs.tutor.edly.io/configuration.html#ssl-tls-certificates-for-https-access>`__, `web-based administration interface <https://github.com/overhangio/tutor-webui>`__, `mobile app <https://github.com/overhangio/tutor-android>`__, `custom translations <https://docs.tutor.edly.io/configuration.html#adding-custom-translations>`__...
* Extensible architecture with `plugins <https://docs.tutor.edly.io/plugins/index.html>`__
* Works with `Kubernetes <https://docs.tutor.edly.io/k8s.html>`__
* No technical skill required with the `zero-click Tutor AWS image <https://docs.tutor.edly.io/install.html#zero-click-aws-installation>`__

.. _readme_intro_end:

.. image:: ./docs/img/launch.webp
    :alt: Tutor local launch
    :target: https://www.terminalizer.com/view/3a8d55835686

Quickstart
----------

1. Install the `latest stable release <https://github.com/overhangio/tutor/releases>`_ of Tutor
2. Run ``tutor local launch``
3. You're done!

Documentation
-------------

Extensive documentation is available: https://docs.tutor.edly.io/

Is there a problem?
-------------------

Please follow the instructions from the `troubleshooting section <https://docs.tutor.edly.io/troubleshooting.html>`__ in the docs.

.. _readme_support_start:

Support
-------

To get community support, go to the official Open edX discussion forum: https://discuss.openedx.org. For official support, `Edly <https://edly.io>`__ provides professional assistance as part of its `Open edX installation service <https://edly.io/services/open-edx-installation/>`__.

.. _readme_support_end:

.. _readme_contributing_start:

Contributing
------------

We welcome contributions to Tutor! To learn how you can contribute, please check the relevant section of the Tutor docs: `https://docs.tutor.edly.io/tutor.html#contributing <https://docs.tutor.edly.io/tutor.html#contributing>`__.

.. _readme_contributing_end:

License
-------

This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor/blob/master/LICENSE.txt>`_.
docs: minor formatting/link improvements 2022-01-18 08:25:35 +00:00			`Tutor: the Docker-based Open edX distribution designed for peace of mind`
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things... 2019-10-17 15:20:22 +00:00			`========================================================================`
Improve documentation 2018-12-26 15:00:47 +00:00
Fix tutor logo link in docs 2020-01-10 14:23:05 +00:00			`.. image:: https://overhang.io/static/img/tutor-logo.svg`
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things... 2019-10-17 15:20:22 +00:00			`:alt: Tutor logo`
			`:width: 500px`
			`:align: center`

docs: minor formatting/link improvements 2022-01-18 08:25:35 +00:00			`\|`

docs: update logos 2023-12-14 14:29:30 +00:00			`.. _readme_intro_start:`

docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`.. image:: https://img.shields.io/static/v1?logo=github&label=Git&style=flat-square&color=brightgreen&message=Source%20code`
			`:alt: Source code`
			`:target: https://github.com/overhangio/tutor`
Improve documentation 2018-12-26 15:00:47 +00:00
docs: move forum to discuss.openedx.org Now that Tutor is the official community installation for Open edX, it no longer makes sense to host a forum that is separate from the general Open edX forum. Moving conversations there will encourage cross-communication between projects and maintainers. This change is part of a larger overhaul described in this Tutor enhancement proposal (TEP): https://discuss.overhang.io/t/tep-rethinking-the-tutor-maintainers-program/2724 In the future, plugin maintainers should point their users to the Open edX forum as well. They are encouraged to create dedicated "tutor-pluginnname" tags on the forum and to set their notification level to "watching". 2022-05-19 08:25:28 +00:00			`.. image:: https://img.shields.io/static/v1?logo=discourse&label=Forums&style=flat-square&color=ff0080&message=discuss.openedx.org`
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`:alt: Forums`
docs: move forum to discuss.openedx.org Now that Tutor is the official community installation for Open edX, it no longer makes sense to host a forum that is separate from the general Open edX forum. Moving conversations there will encourage cross-communication between projects and maintainers. This change is part of a larger overhaul described in this Tutor enhancement proposal (TEP): https://discuss.overhang.io/t/tep-rethinking-the-tutor-maintainers-program/2724 In the future, plugin maintainers should point their users to the Open edX forum as well. They are encouraged to create dedicated "tutor-pluginnname" tags on the forum and to set their notification level to "watching". 2022-05-19 08:25:28 +00:00			`:target: https://discuss.openedx.org/tag/tutor`
Add documentation status badge 2019-02-19 21:37:59 +00:00
docs: docs.tutor.overhang.io -> docs.tutor.edly.io See: https://github.com/overhangio/tutor/issues/945 2023-12-05 10:46:38 +00:00			`.. image:: https://img.shields.io/static/v1?logo=readthedocs&label=Documentation&style=flat-square&color=blue&message=docs.tutor.edly.io`
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`:alt: Documentation`
docs: docs.tutor.overhang.io -> docs.tutor.edly.io See: https://github.com/overhangio/tutor/issues/945 2023-12-05 10:46:38 +00:00			`:target: https://docs.tutor.edly.io`
Improve documentation 2018-12-26 15:00:47 +00:00
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`.. image:: https://img.shields.io/pypi/v/tutor?logo=python&logoColor=white`
			`:alt: PyPI releases`
			`:target: https://pypi.org/project/tutor`
Improve documentation 2018-12-26 15:00:47 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things... 2019-10-17 15:20:22 +00:00			`.. image:: https://img.shields.io/github/license/overhangio/tutor.svg?style=flat-square`
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`:alt: AGPL License`
			`:target: https://www.gnu.org/licenses/agpl-3.0.en.html`
Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`.. image:: https://img.shields.io/static/v1?logo=twitter&label=Twitter&style=flat-square&color=1d9bf0&message=@overhangio`
			`:alt: Follow us on Twitter`
			`:target: https://twitter.com/overhangio/`
docs: advertise Cairn and the maintainers group Here we add to the docs a few shameless plugs about Cairn -- because it's really awesome! We also add a few improvements to the wording, here and there. 2021-06-25 14:52:05 +00:00
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance. 2021-09-16 11:03:34 +00:00			`.. image:: https://img.shields.io/static/v1?logo=youtube&label=YouTube&style=flat-square&color=ff0000&message=@overhangio`
docs: advertise Cairn and the maintainers group Here we add to the docs a few shameless plugs about Cairn -- because it's really awesome! We also add a few improvements to the wording, here and there. 2021-06-25 14:52:05 +00:00			`:alt: Follow us on Youtube`
			`:target: https://www.youtube.com/c/OverhangIO`

minor typos fixed 2022-03-27 10:36:55 +00:00			Tutor is the official Docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customise, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used to deploy hundreds of Open edX platforms around the world.
Hey America! Please do not fuck this up. 2020-10-01 09:15:47 +00:00
wip 2023-10-16 13:20:56 +00:00			Do you need professional assistance setting up or managing your Open edX platform? `Edly <https://edly.io>`__ provides online support as part of its `Open edX installation service <https://edly.io/services/open-edx-installation/>`__.
Hey America! Please do not fuck this up. 2020-10-01 09:15:47 +00:00
Coolify readme 2019-10-07 12:26:17 +00:00			`Features`
			`--------`

			* 100% `open source <https://github.com/overhangio/tutor>`__
			`* Runs entirely on Docker`
docs: docs.tutor.overhang.io -> docs.tutor.edly.io See: https://github.com/overhangio/tutor/issues/945 2023-12-05 10:46:38 +00:00			* World-famous 1-click `installation and upgrades <https://docs.tutor.edly.io/install.html>`__
			* Comes with batteries included: `theming <https://github.com/overhangio/indigo>`__, `SCORM <https://github.com/overhangio/openedx-scorm-xblock>`__, `HTTPS <https://docs.tutor.edly.io/configuration.html#ssl-tls-certificates-for-https-access>`__, `web-based administration interface <https://github.com/overhangio/tutor-webui>`__, `mobile app <https://github.com/overhangio/tutor-android>`__, `custom translations <https://docs.tutor.edly.io/configuration.html#adding-custom-translations>`__...
			* Extensible architecture with `plugins <https://docs.tutor.edly.io/plugins/index.html>`__
			* Works with `Kubernetes <https://docs.tutor.edly.io/k8s.html>`__
			* No technical skill required with the `zero-click Tutor AWS image <https://docs.tutor.edly.io/install.html#zero-click-aws-installation>`__
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00
			`.. _readme_intro_end:`
Improve documentation 2018-12-26 15:00:47 +00:00
feat: upgrade to olive 2022-11-22 12:53:29 +00:00			`.. image:: ./docs/img/launch.webp`
			`:alt: Tutor local launch`
			`:target: https://www.terminalizer.com/view/3a8d55835686`

			`Quickstart`
Improve documentation 2018-12-26 15:00:47 +00:00			`----------`

Migrate github repo to overhangio organization 2019-06-23 17:56:15 +00:00			1. Install the `latest stable release <https://github.com/overhangio/tutor/releases>`_ of Tutor
feat: deprecate "quickstart" and rename to "launch" `quickstart` is being renamed to `launch` and deprecated in favor of using `launch`. The `quickstart` function temporarily aliases to `launch`. Further mentions of `quickstart` have been changed to reference `launch` instead. We are indicating that this change is breaking 💥 to encourage people to migrate their scripts right away! 2022-09-30 10:00:24 +00:00			2. Run ``tutor local launch``
Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			`3. You're done!`
Improve documentation 2018-12-26 15:00:47 +00:00
			`Documentation`
			`-------------`

docs: docs.tutor.overhang.io -> docs.tutor.edly.io See: https://github.com/overhangio/tutor/issues/945 2023-12-05 10:46:38 +00:00			`Extensive documentation is available: https://docs.tutor.edly.io/`
Improve documentation 2018-12-26 15:00:47 +00:00
feat: upgrade to open-release/lilac.master 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 2021-04-13 20:14:43 +00:00			`Is there a problem?`
			`-------------------`

docs: docs.tutor.overhang.io -> docs.tutor.edly.io See: https://github.com/overhangio/tutor/issues/945 2023-12-05 10:46:38 +00:00			Please follow the instructions from the `troubleshooting section <https://docs.tutor.edly.io/troubleshooting.html>`__ in the docs.
feat: upgrade to open-release/lilac.master 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 2021-04-13 20:14:43 +00:00
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. _readme_support_start:`

Add links to tutor forums 2019-02-19 21:26:43 +00:00			`Support`
			`-------`

docs: overhang.io -> edly references 2023-10-17 06:37:52 +00:00			To get community support, go to the official Open edX discussion forum: https://discuss.openedx.org. For official support, `Edly <https://edly.io>`__ provides professional assistance as part of its `Open edX installation service <https://edly.io/services/open-edx-installation/>`__.
Add links to tutor forums 2019-02-19 21:26:43 +00:00
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. _readme_support_end:`

			`.. _readme_contributing_start:`

Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			`Contributing`
			`------------`
Improve documentation 2018-12-26 15:00:47 +00:00
docs: docs.tutor.overhang.io -> docs.tutor.edly.io See: https://github.com/overhangio/tutor/issues/945 2023-12-05 10:46:38 +00:00			We welcome contributions to Tutor! To learn how you can contribute, please check the relevant section of the Tutor docs: `https://docs.tutor.edly.io/tutor.html#contributing <https://docs.tutor.edly.io/tutor.html#contributing>`__.
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00
refactor: migrate from Travis.ci to GitHub Actions GitHub Actions now performs the following tasks: - run tests on every PR - sync with git.overhang.io on push - build binary releases on tags Travis.CI was completely removed from this repo. 2021-05-17 13:39:46 +00:00			`.. _readme_contributing_end:`
docs: add license to readme 2023-02-22 10:00:22 +00:00
			`License`
			`-------`

			This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor/blob/master/LICENSE.txt>`_.