2019-04-25 07:30:48 +00:00
.. _readme_intro_start:
2019-10-17 15:20:22 +00:00
Tutor: the docker-based Open edX distribution designed for peace of mind
========================================================================
2018-12-26 15:00:47 +00:00
2019-10-17 15:20:22 +00:00
|
2020-01-10 14:23:05 +00:00
.. image :: https://overhang.io/static/img/tutor-logo.svg
2019-10-17 15:20:22 +00:00
:alt: Tutor logo
:width: 500px
:align: center
|
.. image :: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build&style=flat-square
2019-06-24 11:06:40 +00:00
:alt: Release build status
2019-06-23 17:56:15 +00:00
:target: https://travis-ci.org/overhangio/tutor
2018-12-26 15:00:47 +00:00
2019-10-17 15:20:22 +00:00
.. image :: https://img.shields.io/badge/docs-current-blue.svg?style=flat-square
2019-02-20 12:52:25 +00:00
:alt: Documentation
:target: https://docs.tutor.overhang.io
2019-02-19 21:37:59 +00:00
2019-10-17 15:20:22 +00:00
.. image :: https://img.shields.io/github/issues/overhangio/tutor.svg?style=flat-square
2018-12-26 15:00:47 +00:00
:alt: GitHub issues
2019-06-23 17:56:15 +00:00
:target: https://github.com/overhangio/tutor/issues
2018-12-26 15:00:47 +00:00
2019-10-17 15:20:22 +00:00
.. image :: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen&style=flat-square
2018-12-26 15:00:47 +00:00
:alt: GitHub closed issues
2019-06-23 17:56:15 +00:00
:target: https://github.com/overhangio/tutor/issues?q=is%3Aclosed
2018-12-26 15:00:47 +00:00
2019-10-17 15:20:22 +00:00
.. image :: https://img.shields.io/github/license/overhangio/tutor.svg?style=flat-square
2019-01-22 20:25:04 +00:00
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
2019-10-17 15:20:22 +00:00
2019-10-24 11:32:45 +00:00
**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 around the world.
2019-10-07 12:26:17 +00:00
2020-04-25 12:20:13 +00:00
Do you need professional assistance setting up or managing your Open edX platform? Overhang.IO provides online support as part of its `Long Term Support (LTS) offering <https://overhang.io/tutor/lts> `__ .
2020-01-10 14:46:56 +00:00
2019-10-07 12:26:17 +00:00
Features
--------
* 100% `open source <https://github.com/overhangio/tutor> `__
* Runs entirely on Docker
2020-04-25 12:20:13 +00:00
* World-famous 1-click `installation and upgrades <https://docs.tutor.overhang.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.overhang.io/configuration.html#ssl-tls-certificates-for-https-access> `__ , `web-based administration interface <https://docs.tutor.overhang.io/extra.html#web-ui> `__ , `mobile app <https://docs.tutor.overhang.io/extra.html#mobile-android-application> `__ , `custom translations <https://docs.tutor.overhang.io/configuration.html#adding-custom-translations> `__ ...
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins.html> `__
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html> `__
* No technical skill required with the `1-click Tutor AWS image <https://docs.tutor.overhang.io/install.html#cloud-deployment> `__
2020-01-10 14:29:56 +00:00
* Professional support and premium plugins available with `Tutor Long Term Support (LTS) <https://overhang.io/tutor/lts> `__
2019-04-25 07:30:48 +00:00
.. _readme_intro_end:
2018-12-26 15:00:47 +00:00
2019-02-10 18:13:35 +00:00
.. image :: ./docs/img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
2018-12-26 15:00:47 +00:00
Quickstart
----------
2019-06-23 17:56:15 +00:00
1. Install the `latest stable release <https://github.com/overhangio/tutor/releases> `_ of Tutor
2019-01-22 20:25:04 +00:00
2. Run `` tutor local quickstart ``
3. You're done!
2018-12-26 15:00:47 +00:00
Documentation
-------------
2019-02-20 12:52:25 +00:00
Extensive documentation is available online: https://docs.tutor.overhang.io/
2018-12-26 15:00:47 +00:00
2019-04-25 07:30:48 +00:00
.. _readme_support_start:
2019-02-19 21:26:43 +00:00
Support
-------
2020-02-25 16:02:39 +00:00
To get community support, go to the official discussion forums: https://discuss.overhang.io. For official support, please subscribe to a Long Term Support (LTS) license at https://overhang.io/tutor/lts.
2019-02-19 21:26:43 +00:00
2019-04-25 07:30:48 +00:00
.. _readme_support_end:
.. _readme_contributing_start:
2019-01-22 20:25:04 +00:00
Contributing
------------
2018-12-26 15:00:47 +00:00
2019-06-23 17:56:15 +00:00
We are very much open to new ideas and features for Tutor. If you have an improvement idea, feel free to first discuss it on the `Tutor forums <https://discuss.overhang.io> `_ . If you are not quite familiar with Open edX or if you need technical advice, the forums are a great place to start, too. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an upstream issue with Open edX. Then, `open an issue on Github <https://github.com/overhangio/tutor/issues/new/choose> `_ . `Pull requests <https://github.com/overhangio/tutor/pulls> `_ will be happily examined, too!
2019-04-25 07:30:48 +00:00
.. _readme_contributing_end:
