Supported OS: Tutor runs on any 64-bit, UNIX-based system. It was also reported to work on Windows.
Do not attempt to simply run
apt-get install docker docker-compose on older Ubuntu platforms, such as 16.04 (Xenial), as you will get older versions of these utilities.
Ports 80 and 443 should be open. If other web services run on these ports, check the section on how to setup a web proxy.
Minimum configuration: 4 GB RAM, 2 CPU, 8 GB disk space
Recommended configuration: 8 GB RAM, 4 CPU, 25 GB disk space
On Mac OS, by default, containers are allocated 2 GB of RAM, which is not enough. You should follow these instructions from the official Docker documentation to allocate at least 4-5 GB to the Docker daemon. If the deployment fails because of insufficient memory during database migrations, check the relevant section in the troubleshooting guide.
Direct binary download¶
The latest binaries can be downloaded from https://github.com/overhangio/tutor/releases. From the command line:
sudo curl -L "https://github.com/overhangio/tutor/releases/download/v11.2.9/tutor-$(uname -s)_$(uname -m)" -o /usr/local/bin/tutor sudo chmod 0755 /usr/local/bin/tutor
This is the simplest and recommended installation method for most people. Note however that you will not be able to use custom plugins with this pre-compiled binary. The only plugins you can use with this approach are those that are already bundled with the binary: see the existing plugins.
Alternative installation methods¶
If you would like to inspect the Tutor source code, you are most welcome to install Tutor from Pypi or directly from the Github repository. You will need python >= 3.6 with pip and the libyaml development headers. On Ubuntu, these requirements can be installed by running:
sudo apt install python3 python3-pip libyaml-dev
Installing from pypi¶
pip install tutor-openedx
Installing from source¶
git clone https://github.com/overhangio/tutor cd tutor pip install -e .
When running a server in production, it is necessary to define DNS records which will make it possible to access your Open edX platform by name in your browser. The precise procedure to create DNS records vary from one provider to the next and is beyond the scope of these docs. You should create a record of type A with a name equal to your LMS hostname (given by
tutor config printvalue LMS_HOST) and a value that indicates the IP address of your server. Applications other than the LMS, such as the studio, ecommerce, etc. typically reside in subdomains of the LMS. Thus, you should also create a CNAME record to point all subdomains of the LMS to the LMS_HOST.
For instance, the demo Open edX server that runs at http://demo.openedx.overhang.io has the following DNS records:
demo.openedx 1800 IN A 188.8.131.52 *.demo.openedx 1800 IN CNAME demo.openedx.overhang.io.
With Tutor, it is very easy to upgrade to a more recent Open edX or Tutor release. Just install the latest
tutor version (using either methods above) and run the
quickstart command again. If you have customised your docker images, you will have to re-build them prior to running
quickstart should take care of automatically running the upgrade process. If for some reason you need to manually upgrade from an Open edX release to the next, you should run
tutor local upgrade. For instance, to upgrade from Juniper to Koa, run:
tutor local upgrade --from=juniper
Tutor is built on top of Click, which is a great library for building command line interface (CLI) tools. As such, Tutor benefits from all Click features, including auto-completion. After installing Tutor, auto-completion can be enabled by running:
_TUTOR_COMPLETE=source tutor >> ~/.bashrc
If you are running zsh, run instead:
_TUTOR_COMPLETE=source_zsh tutor >> ~/.zshrc
After opening a new shell, you can test auto-completion by typing:
Running Tutor with Podman¶
You have the option of running Tutor with Podman, instead of the native Docker tools. This has some practical advantages: it does not require a running Docker daemon, and it enables you to run and build Docker images without depending on any system component running
root. As such, it is particularly useful for building Tutor images from CI pipelines.
podman CLI aims to be fully compatible with the
docker CLI, and
podman-compose is meant to be a fully-compatible alias of
docker-compose. This means that you should be able to use together with Tutor, without making any changes to Tutor itself.
Since this was written, it was discovered that there are major compatibility issues between
docker-compose. Thus, podman cannot be considered a drop-in replacement of Docker in the context of Tutor – at least for running Open edX locally.
You should not attempt to run Tutor with Podman on a system that already has native
docker installed. If you want to switch to
podman using the aliases described here, you should uninstall (or at least stop) the native Docker daemon first.
Podman is supported on a variety of development platforms, see the installation instructions for details.
Once you have installed Podman and its dependencies on the platform of your choice, you’ll need to make sure that its
podman binary, usually installed as
/usr/bin/podman, is aliased to
docker, and is included as such in your system
$PATH. On some CentOS and Fedora releases you can install a package named
podman-docker to do this for you, but on other platforms you’ll need to take of this yourself.
$HOME/binis in your
$PATH, you can create a symbolic link there:
ln -s $(which podman) $HOME/bin/docker
If you want to instead make
dockera system-wide alias for
podman, you can create your symlink in
/usr/local/bin, an action that normally requires
sudo ln -s $(which podman) /usr/local/bin/docker
podman-compose is available as a package from PyPI, and can thus be installed with
pip. See its README for installation instructions. Note that if you have installed Tutor in its own virtualenv, you’ll need to run
pip install podman-compose in that same virtualenv.
Once installed, you’ll again need to create a symbolic link that aliases
If you run Tutor and
podman-composein a virtualenv, create the symlink in that virtualenv’s
bindirectory: activate the virtualenv, then run:
ln -s $(which podman-compose) $(dirname $(which podman-compose))/docker-compose
If you do not, create the symlink in
sudo ln -s $(which podman-compose) /usr/local/bin/docker-compose
Verifying your environment¶
Once you have configured your symbolic links as described, you should be able to run
docker version and
docker-compose --help and their output should agree, respectively, with
podman version and
After that, you should be able to use
tutor build, and other commands as if you had installed the native Docker tools.
It is fairly easy to completely uninstall Tutor and to delete the Open edX platforms that is running locally.
First of all, stop any locally-running platform:
tutor local stop tutor dev stop
Then, delete all data associated to your Open edX platform:
# WARNING: this step is irreversible sudo rm -rf "$(tutor config printroot)"
Finally, uninstall Tutor itself:
# If you installed tutor from source pip uninstall tutor-openedx # If you downloaded the tutor binary sudo rm /usr/local/bin/tutor