This section provides information about how to install and update the Open edX developer stack (Devstack).
Before you install Devstack, make sure that you have met the installation prerequisites.
To install Devstack, follow these steps.
Decide which branch you will be working with. “master” is the latest code in the repositories, changed daily. Open edX releases are more stable, for example, Hawthorn.
Check out a local copy of the
edx/devstack repository from
git clone https://github.com/edx/devstack
Navigate to the
If you are not using the master branch, check out the branch you want.
git checkout open-release/hawthorn.master
If you are not using the master branch, define an environment variable for
the Open edX version you are using, such as
zebrawood.rc1. Note that unlike a server install, the value of the
OPENEDX_RELEASE variable should not use the
make dev.checkout to check out the correct branch in the local
checkout of each service repository.
Clone the Open edX service repositories. The Docker Compose file
mounts a host volume for each service’s executing code. The host directory
defaults to be a sibling of the
/devstack directory. For example, if
you clone the
edx/devstack repository to
volumes will be expected in
~/workspace/ecommerce, etc. You can clone these repositories with the
To customize where the local repositories are found, set the
DEVSTACK_WORKSPACE environment variable.
(macOS only) Share the cloned service directories in Docker, using Docker -> Preferences -> File Sharing in the Docker menu.
Run the provision command to configure the various services with superusers (for development without the auth service) and tenants (for multi-tenancy).
When you run the provision command, databases for
edxapp will be dropped and recreated.
Use the following default provision command.
The default username and password for the superusers are both
edx. You can
access the services directly using Django admin at the
/admin/ path, or
log in using single sign-on at
When you have completed these steps, see Starting the Open edX Developer Stack.
For help with running Devstack, see Troubleshooting Devstack.
EdX publishes new images for Open edX services frequently. After you have installed and started Devstack, you can update your Devstack installation to use the most up-to-date versions of the Devstack images by running the following sequence of commands.
make down make pull make dev.up
This stops any running Devstack containers, pulls the latest images, and then starts all of the Devstack containers.