6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 06:07:56 +00:00
Go to file
Régis Behmo 24035ac1fe v10.0.1 (2020-06-15)
- [Bugfix] Fix KeyError when running ``local quickstart`` for the first
time
2020-06-15 17:59:27 +02:00
.github/ISSUE_TEMPLATE Add github template for questions 2019-05-23 12:59:18 +02:00
bin v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
docs v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
requirements v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
tests v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
tutor v10.0.1 (2020-06-15) 2020-06-15 17:59:27 +02:00
.gitignore Add all plugins (with data) to binary bundle 2019-08-20 17:03:46 +02:00
.gitlab-ci.yml Fix "distribution was not found and is required by kubernetes" in CI 2020-04-26 00:36:17 +02:00
.travis.yml Make sure twine & pip are up-to-date in CI 2019-10-09 13:22:00 +02:00
CHANGELOG.md v10.0.1 (2020-06-15) 2020-06-15 17:59:27 +02:00
CONTRIBUTING.rst Migrate github repo to overhangio organization 2019-06-23 23:11:07 +02:00
Dockerfile Base image python:3.7-slim-stretch 2020-05-08 15:38:35 +02:00
github-release.py Upgrade script for pushing github releases 2020-04-20 06:23:57 +02:00
LICENSE.txt gpl -> agpl 2019-01-18 15:19:18 +01:00
Makefile v10.0.0 Upgrade to Juniper (2020-06-15) 2020-06-15 10:19:07 +02:00
MANIFEST.in Fix missing requirements file in pypi package 2019-10-19 18:30:11 +02:00
README.rst Add scorm xblock to the openedx docker image 2020-04-25 14:20:13 +02:00
setup.py Fix jinja2 dependency 2019-10-14 06:26:25 +02:00
tutor.spec Improve job running in local and k8s 2020-04-25 23:12:42 +02:00

.. _readme_intro_start:

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

|

.. image:: https://img.shields.io/travis/overhangio/tutor.svg?label=Release%20build&style=flat-square
    :alt: Release build status
    :target: https://travis-ci.org/overhangio/tutor

.. image:: https://img.shields.io/badge/docs-current-blue.svg?style=flat-square
    :alt: Documentation
    :target: https://docs.tutor.overhang.io

.. image:: https://img.shields.io/github/issues/overhangio/tutor.svg?style=flat-square
    :alt: GitHub issues
    :target: https://github.com/overhangio/tutor/issues

.. image:: https://img.shields.io/github/issues-closed/overhangio/tutor.svg?colorB=brightgreen&style=flat-square
    :alt: GitHub closed issues
    :target: https://github.com/overhangio/tutor/issues?q=is%3Aclosed

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


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

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

Features
--------

* 100% `open source <https://github.com/overhangio/tutor>`__
* Runs entirely on Docker
* 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>`__
* Professional support and premium plugins available with `Tutor Long Term Support (LTS) <https://overhang.io/tutor/lts>`__

.. _readme_intro_end:

.. 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/overhangio/tutor/releases>`_ of Tutor
2. Run ``tutor local quickstart``
3. You're done!

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

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

.. _readme_support_start:

Support
-------

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.

.. _readme_support_end:

.. _readme_contributing_start:

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

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!

.. _readme_contributing_end: