This section describes how to install the Open edX Developer Stack.
The Open edX Developer Stack, known as Devstack, is a Vagrant instance designed for local development.
Devstack uses the same system requirements as Open edX Fullstack. This allows you to discover and fix system configuration issues early in development.
See the Vagrant documentation for more information.
Devstack includes the following edX components.
Devstack also includes a demonstration edX course.
To use Devstack, you should meet the following knowledge requirements.
To install and run Devstack, you must first install the following required software.
To install Devstack directly from the command line, follow the instructions below. You can also install DevStack using a Torrent file, as explained in the next section.
Before beginning the installation, ensure that you have the administrator password for your local computer. The administrator password is needed so that NFS can be set up to allow users to access code directories directly from your computer.
nfsd client is running.
devstack directory and navigate to it in the command prompt.
mkdir devstack cd devstack
Download the Devstack Vagrant file.
curl -L https://raw.github.com/edx/configuration/master/vagrant/release/devstack/Vagrantfile > Vagrantfile
Install the Vagrant
vagrant plugin install vagrant-vbguest
Create the Devstack virtual machine.
The first time you create the Devstack virtual machine, Vagrant downloads the base box, which has a file size of about 4GB. If you destroy and recreate the virtual machine, Vagrant re-uses the box it downloaded. See Vagrant’s documentation on boxes for more information.
When prompted, enter the administrator password for your local computer.
When you have completed these steps, see Running the Open edX Developer Stack to begin using Devstack.
For help with the Devstack installation, see Troubleshooting the Devstack Installation.
You can use BitTorrent to download the box file. Follow all of the instructions in Install DevStack, but instead of downloading the Vagrant file with curl, do this:
Download the Torrent file for the latest Open edX release. See the Open edX Releases Wiki page to find out what the latest Open edX release is, and where to download the Torrent file.
When you have the file on your computer, add the virtual machine using the following command.
vagrant box add box-name path-to-box-file
In some cases, you see an error when you attempt to create the Devstack virtual
vagrant up). For example:
mount.nfs: mount to NFS server '192.168.33.1:/path/to/edx-platform' failed: timed out, giving up
This error situation arises because Vagrant uses a host-only network in
Virtualbox to communicate with your computer. If a network does not exist, one
is created on
vagrant up. If this network is created with the VPN up, it
will not work. You must recreate the network with the VPN down.
To resolve the error, follow these steps.