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.
Download the latest stable release of Tutor, uncompress the file and place the
tutorexecutable 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
tutor local quickstart
Yes :) This is what happens when you run
tutor local quickstart:
- You answer a few questions about the Configuration of your Open edX platform.
- Configuration files are generated from templates.
- Docker images are downloaded.
- Docker containers are provisioned.
- 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.
- Local deployment
- Open edX platform customisation
- Using Tutor for Open edX development
- Kubernetes deployment
- Web UI
- Mobile Android application
- “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
The complete source code for Tutor is available on Github: https://github.com/regisb/tutor
To get community support, go to the official discussion forums: https://discuss.overhang.io.
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!
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.