tutor/README.rst

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/badge/docs-current-brightgreen.svg
    :alt: Documentation
    :target: https://docs.tutor.overhang.io

.. 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

.. image:: https://img.shields.io/github/license/regisb/tutor.svg
    :alt: AGPL License
    :target: https://www.gnu.org/licenses/agpl-3.0.en.html

**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:: ./docs/img/quickstart.gif
    :alt: Tutor local quickstart
    :target: https://terminalizer.com/view/91b0bfdd557

Quickstart
----------

1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor (`Instructions for the command line <https://docs.tutor.overhang.io/install.html#direct-binary-downloads>`_)
2. Run ``tutor local quickstart``
3. You're done!

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

Extensive documentation is available online: https://docs.tutor.overhang.io/

Support
-------

To get community support, go to the official discussion forums: https://discuss.overhang.io.

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

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 first discuss it on the `Tutor forum <https://discuss.overhang.io>`_. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!
Improve documentation 2018-12-26 15:00:47 +00:00			`Tutor 🎓 Open edX 1-click install for everyone`
			`==============================================`

Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`.. image:: https://img.shields.io/travis/regisb/tutor.svg`
Improve documentation 2018-12-26 15:00:47 +00:00			`:alt: Build status`
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`:target: https://travis-ci.org/regisb/tutor`
Improve documentation 2018-12-26 15:00:47 +00:00
Docs are now hosted with https 2019-02-20 12:52:25 +00:00			`.. image:: https://img.shields.io/badge/docs-current-brightgreen.svg`
			`:alt: Documentation`
			`:target: https://docs.tutor.overhang.io`
Add documentation status badge 2019-02-19 21:37:59 +00:00
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`.. image:: https://img.shields.io/github/issues/regisb/tutor.svg`
Improve documentation 2018-12-26 15:00:47 +00:00			`:alt: GitHub issues`
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`:target: https://github.com/regisb/tutor/issues`
Improve documentation 2018-12-26 15:00:47 +00:00
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen`
Improve documentation 2018-12-26 15:00:47 +00:00			`:alt: GitHub closed issues`
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`:target: https://github.com/regisb/tutor/issues?q=is%3Aclosed`
Improve documentation 2018-12-26 15:00:47 +00:00
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			`.. image:: https://img.shields.io/github/license/regisb/tutor.svg`
			`:alt: AGPL License`
			`:target: https://www.gnu.org/licenses/agpl-3.0.en.html`

Improve documentation 2018-12-26 15:00:47 +00:00			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.

Gif animation for quickstart Animation created with Terminalizer: https://terminalizer.com/ Try it! It's awesome :) 2019-02-10 18:13:35 +00:00			`.. image:: ./docs/img/quickstart.gif`
			`:alt: Tutor local quickstart`
			`:target: https://terminalizer.com/view/91b0bfdd557`
Improve documentation 2018-12-26 15:00:47 +00:00
			`Quickstart`
			`----------`

Get rid of the "latest" release tag The "latest" tag is a pain to maintain: it's a tag that we delete and re-create at every release. Whenever we delete it, the binaries become unavailable on Github until they are re-generated. Thus, from now on, we conform to good practices (as examplified by the github.com/docker/compose) project and distribute only pinned release. The "nightly" tag remains, for now, as it allows us to distribute beta features. It may disappear in the future. 2019-04-22 11:29:53 +00:00			1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor (`Instructions for the command line <https://docs.tutor.overhang.io/install.html#direct-binary-downloads>`_)
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			2. Run ``tutor local quickstart``
			`3. You're done!`
Improve documentation 2018-12-26 15:00:47 +00:00
			`Documentation`
			`-------------`

Docs are now hosted with https 2019-02-20 12:52:25 +00:00			`Extensive documentation is available online: https://docs.tutor.overhang.io/`
Improve documentation 2018-12-26 15:00:47 +00:00
Add links to tutor forums 2019-02-19 21:26:43 +00:00			`Support`
			`-------`

			`To get community support, go to the official discussion forums: https://discuss.overhang.io.`

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
Add links to tutor forums 2019-02-19 21:26:43 +00:00			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 first discuss it on the `Tutor forum <https://discuss.overhang.io>`_. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!