Skip to content
🎓 The easiest way to install Open edX, both for production and local development (all in Docker)
Branch: master
Clone or download
regisb Simplify docs requirement management
It is assumed that users who compile the documentation also need base
requirements.
Latest commit 5f625f7 Apr 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tutor v3 complete rewrite Feb 9, 2019
bin Tutor v3 complete rewrite Feb 9, 2019
cloud
docs Document the stop/start restart procedure on new image Apr 19, 2019
requirements Simplify docs requirement management Apr 19, 2019
tests Move all yaml-related code to dedicated module Mar 24, 2019
tutor Crash on env overwrite in non-interactive mode Apr 19, 2019
.gitignore Add __pycache__ to .gitignore Apr 19, 2019
.travis.yml
CHANGELOG.md Crash on env overwrite in non-interactive mode Apr 19, 2019
LICENSE.txt
MANIFEST.in
Makefile Rename `--silent` option to `-y/--yes` Apr 9, 2019
README.rst
setup.py Fix install from source docs Mar 27, 2019

README.rst

Tutor 🎓 Open edX 1-click install for everyone

Build status Documentation GitHub issues GitHub closed issues AGPL License

Tutor is a one-click install of Open edX, 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.

Tutor local quickstart

Quickstart

  1. Download the latest stable release of Tutor, uncompress the file and place the tutor executable in your path. From the command line:

    sudo curl -L "https://github.com/regisb/tutor/releases/download/latest/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
    sudo chmod +x /usr/local/bin/tutor
    
  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. 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. Pull requests will be happily examined, too!

You can’t perform that action at this time.