This section describes how to install the Open edX Dogwood release.
Note
Now that the Open edX Eucalyptus release is available, edX no longer supports the Dogwood release.
The Open edX Dogwood release contains several new features for learners, course teams, and developers. See the release notes for the Open edX Dogwood Release for more details.
A Git tag identifies the version of Open edX code that is the Dogwood release. You can find the most up-to-date Git tag for the current Open edX release on the Open edX Releases Wiki page.
The following Open edX Git repositories have the Dogwood Git tag.
You can install the Open edX Dogwood release using Devstack or Fullstack.
Review the prerequisites and instructions for each option, and then choose the option that best meets your needs. Ensure that you install the required software to run the edX platform.
If you are upgrading from the Cypress release, see Upgrading from Cypress to Dogwood.
For new installations, follow these steps.
Download the Vagrant Box or Download the BitTorrent File.
Caution
The Vagrant boxes have a large file size (between 4 and 5 GB). If you have a slow or unreliable Internet connection, use BitTorrent to download the Vagrant box you need.
If you have a fast and reliable Internet connection, you can download the
Vagrant box directly or by running vagrant up
when you install
Devstack or
Fullstack.
To access the latest Vagrant boxes, see the Open edX Releases Wiki page.
For more information about working with vagrant boxes, see Vagrant’s documentation on boxes.
You can also download the BitTorrent file for the option you selected. BitTorrent is recommended if you have a slow or unreliable data connection. You then use the BitTorrent file to download the Vagrant box. If the Internet connection is temporarily lost while you are downloading the Vagrant box through BitTorrent, you can later continue the download without data loss or corruption.
To access the latest Vagrant box torrents, see the Open edX Releases Wiki page.
For more information about downloading BitTorrent files, see BitTorrent.
If you download the Vagrant box through BitTorrent, you must add the box to Vagrant before continuing with the installation process.
Be sure to verify that you have the most up-to-date Git tag for the Open edX releases on the Open edX Releases Wiki page.
For devstack installations, run the following command.
$ vagrant box add /{path-to-downloaded-box}/{vagrant-box-name} --name {Git-tag}
For fullstack installations, run the following command.
$ vagrant box add /{path-to-downloaded-box}/{vagrant-box-name} --name {Git-tag}
Before installing the Vagrant box, you must set the value of the
OPENEDX_RELEASE
environment variable to the Git tag for the Dogwood
release. To do so, use the Linux export
command.
export OPENEDX_RELEASE="{Git tag}"
You can upgrade an Open edX instance that is running the Cypress release to the
Dogwood release. EdX provides the migrate.sh
script if you have a simple
Cypress installation and want to upgrade it automatically. If you have a more
complex or customized installation, you may need to upgrade manually.
The migrate.sh script is in the edX configuration repository on GitHub.
Note
The upgrade scripts provided are verified only for upgrading instances running the Cypress release. If you are running any other version of the Open edX Platform, the upgrade scripts might not work.
Caution
Before upgrading your Open edX instance, back up all data and configuration files. Then verify that you can restore your Open edX instance from the backup files.
On the computer or virtual machine that is running the Cypress release of Open edX, run the upgrade script for your type of installation.
./migrate.sh -c devstack -t named-release/dogwood
../migrate.sh -c fullstack -t named-release/dogwood
.You can find the most up-to-date Git tag for the current Open edX release on the Open edX Releases Wiki page.
You can also run ./migrate.sh -h
to see which other options the script
accepts.
The script creates a temporary directory in which it upgrades Open edX, then cleans up extra files and directories when it finishes running.
After upgrading Open edX to the Dogwood release, start the LMS and Studio and verify that course content and data was migrated correctly.
This is an overview of what happens during an upgrade from Cypress to Dogwood.
The migrate.sh
script implements this process. You may need to understand
this process if your installation is customized in some way, or if you need to
diagnose problems during the upgrade.
Upgrading Cypress to Dogwood is more involved than most Open edX release upgrades.
The upgrade from Cypress to Dogwood includes these steps.
release-2015-11-09
tag. This is the last
released version that used Django 1.4.dogwood-first-18
tag. This is the first
version of the code that used Django 1.8.generate_course_overview
and post_cohort_membership_fix
.Similar steps are followed to upgrade other repositories such as xqueue.
Occasionally, we release updates to Dogwood. The first of these is named
Dogwood.1, then Dogwood.2, and so on. The steps differ based on your original
installation method. You will need to know the name of the Dogwood tag you
want to install, for example named-release/dogwood.2
.
Devstack and Fullstack are installed using Vagrant. To upgrade to a Dogwood point release, follow these steps in the host operating system.
$ export OPENEDX_RELEASE={desired-dogwood-tag}
$ vagrant provision
If you installed Open edX using the Open edX Native 12.04 Installation, re-run
those steps using your desired Dogwood tag as the new value for
OPENEDX_RELEASE
.