Tutor 🎓 Open edX 1-click install for everyone

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.

---

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!

That’s it?

Yes :) This is what happens when you run tutor local quickstart:

1. You answer a few questions about the Configuration of your Open edX platform.
2. Configuration files are generated from templates.
3. Docker images are downloaded.
4. Docker containers are provisioned.
5. A full, production-ready platform is run with docker-compose.

The whole procedure should require less than 10 minutes, on a server with a good bandwidth. Note that your host environment will not be affected in any way, since everything runs inside docker containers. Root access is not even necessary.

But there’s a lot more to Tutor than that! For more advanced usage, please refer to the following sections.

User guide

• Installation
  • Requirements
  • Direct binary downloads
  • Cloud deployment
  • Installing from source
• Quickstart
• Configuration
  • Docker
  • Custom images
  • Custom registry
  • Vendor services
  • Optional features
• Local deployment
  • Main commands
  • Extra commands
  • Recipes
• Open edX platform customisation
  • Adding custom themes
  • Installing extra xblocks and requirements
  • Running a fork of edx-platform
  • Running a different openedx Docker image
• Using Tutor for Open edX development
  • Run a local development webserver
  • Running arbitrary commands
  • Point to a local edx-platform
  • Customised themes
  • Custom edx-platform settings
• Kubernetes deployment
  • Requirements
  • Quickstart
  • Upgrading
  • Accessing the Kubernetes dashboard
  • Missing features
• Web UI
  • Launching the web UI
  • Authentication
• Mobile Android application
  • Releasing an Android app
  • Customising the Android app
• Troubleshooting
  • Logging
  • “Cannot start service nginx: driver failed programming external connectivity”
  • Help! The Docker containers are eating all my RAM/CPU/CHEESE
  • “Running migrations… Killed!”
  • “Build failed running pavelib.servers.lms: Subprocess return code: 1”
  • “ValueError: Unable to configure handler ‘local’”
  • “TypeError: get_logger_config() got an unexpected keyword argument ‘debug’”
  • The chosen default language does not display properly
• Tutor development
  • Install requirements
  • Run tests
  • Bundle tutor executable
  • Generate the documentation
  • Releasing a new version
• FAQ
  • What is Tutor?
  • What’s the difference with the official “native” install?
  • What’s the difference with the official devstack?
  • Is Tutor officially supported by edX?
  • What features are missing from Tutor?
  • Why should I trust software written by some random guy on the Internet?

Source code

The complete source code for Tutor is available on Github: https://github.com/regisb/tutor

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!

License

This work is licensed under the terms of the GNU Affero General Public License (AGPL).

The AGPL license covers the Tutor code, including the Dockerfiles, but not the content of the Docker images which can be downloaded from https://hub.docker.com. Software other than Tutor provided with the docker images retain their original license.

The Tutor Web UI depends on the Gotty binary, which is provided under the terms of the MIT license.