christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 06:07:56 +00:00
Code Issues Releases Activity

Coolify readme

Browse Source
This commit is contained in:
Régis Behmo 2019-10-07 14:26:17 +02:00
parent 7dd96d7842
commit 5e6ad893a6
3 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.rst
View File

@ -27,7 +27,18 @@ Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
**Tutor** is a 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, customize, upgrade and scale Open edX. Tutor is fast, full of cool features, extensible, and it is already used by dozens of Open edX platforms in the world.
**Tutor** is a 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, customize, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used by dozens of Open edX platforms in the world.
Features
--------
* 100% `open source <https://github.com/overhangio/tutor>`__
* Runs entirely on Docker
* World-famous 1-click :ref:`installation <install>` and :ref:`upgrades <upgrade>`
* Extensible architecture with :ref:`plugins <plugins>`
* Works with :ref:`Kubernetes <k8s>`
* No technical skill required with the :ref:`1-click Tutor AWS image <install_cloud>`
* Try it out!
.. _readme_intro_end:

2
docs/Makefile
View File

@ -8,4 +8,4 @@ browse:
sensible-browser _build/html/index.html
watch: html browse
while true; do inotifywait -e modify *.rst; $(MAKE) html; done
while true; do inotifywait -e modify *.rst ../*.rst; $(MAKE) html; done

9
docs/install.rst
View File

@ -49,11 +49,20 @@ Installing from a local clone of the repository::
cd tutor
pip install -e .
.. _install_cloud:
Cloud deployment
----------------
Tutor can be launched on Amazon Web Services very quickly with the `official Tutor AMI <https://aws.amazon.com/marketplace/pp/B07PV3TB8X>`_. Shell access is not even required, as all configuration will happen through the Tutor web user interface. This is a commercial offer priced at $50/month ($500/year) that was created to support the development of Tutor.
.. _upgrade:
Upgrading
=========
To upgrade a running Open edX platform, just install the latest ``tutor`` version (using either methods above) and run the ``quickstart`` command again. If you have :ref:`customised <configuration_customisation>` your docker images, you will have to re-build them prior to running ``quickstart``.
Autocomplete
------------