mirror of
https://github.com/ChristianLight/tutor.git
synced 2025-02-10 13:18:26 +00:00
d0f02b7268
We re-introduce the dependency of the nginx container on the lms/cms images. This dependency was removed to address a debugging scenario which is actually not practical. Without this dependency, we are forced to use an external docker-specific resolver which makes the local nginx configuration incompatible with the kubernetes configuration.
Tutor 🎓 Open edX 1-click install for everyone
==============================================
.. image:: https://img.shields.io/travis/regisb/tutor.svg
:alt: Build status
:target: https://travis-ci.org/regisb/tutor
.. image:: https://img.shields.io/github/issues/regisb/tutor.svg
:alt: GitHub issues
:target: https://github.com/regisb/tutor/issues
.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
:alt: GitHub closed issues
:target: https://github.com/regisb/tutor/issues?q=is%3Aclosed
**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
.. image:: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE.png
:alt: asciicast
:target: https://asciinema.org/a/octNfEnvIA6jNohCBmODBKizE
Quickstart
----------
::
git clone https://github.com/regisb/tutor
cd tutor/deploy/local
make all
Documentation
-------------
Extensive documentation is available online: http://docs.tutor.overhang.io/
How to contribute
-----------------
We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_ so that we can discuss it. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too! However, we should be careful to keep the project lean and simple: both to use and to modify. Optional features should not make the user experience more complex. Instead, documentation on how to add the feature is preferred.