Quickstart (1-click install)

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

sudo curl -L "https://github.com/overhangio/tutor/releases/download/v12.0.2/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor
sudo chmod 0755 /usr/local/bin/tutor

Or:

pip install tutor

  1. Run tutor local quickstart

  2. 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 Open edX platform (Lilac release) 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.

There’s a lot more to Tutor than that! To learn more about what you can do with Tutor and Open edX, check out the What next? section. If the quickstart installation method above somehow didn’t work for you, check out the Troubleshooting guide.