- How to install a theme
- What Open edX version we support
- What environment can the theme be installed to
- How to rollback to the previous state
- I want to make some changes in the theme. Is it allowed?
- I have installed the theme but the changes were not applied
We have created a separate page for this topic so that you can find it easier. Please follow this link to read how to install a theme to your instance.
Please see the list of supported versions:
Eucalyptus 2.0 named release - an official Open edX platform release package
Eucalyptus Raccoon Gang release - an improved version of official Open edX platform release.
- Dogwood 3 named release - an official Open edX platform release package
- Dogwood Raccoon Gang release - an improved version of official Open edX platform release.
Please see what environment the theme can be installed to:
Hosting. The product is tested on Amazon and on Azure. If you use any other hosting please let us know
Server. Ubuntu 12.04 64-bit server.
We do not support the Open edX powered by Bitnami yet.
Before you run the update procedure we have created server-vars.yml with the /edx/app/edx_ansible/server-vars.yml_TIMESTAMP name. Thus, in case something went wrong during the installation process you can always rollback by following the instructions below.
Go to the Open edX server via SSH and perform the following commands:
sudo cp /edx/app/edx_ansible/server-vars.yml_TIMESTAMP /edx/app/edx_ansible/server-vars.yml
sudo /edx/bin update edx-platform your_branch_name
TIMESTAMP - unix timestamp value when the installation script was launched
your_branch_name - name of the edx-platform branch
Script ignores devstack vagrant and works only with a live installation (not applicable for devstack).
If your installation does not use server-vars.yml (you just edit lms/cms.env.json file to change your settings), for rollback run:
sudo -Hu edxapp bash
cp lms.env.json_TIMESTAMP lms.env.json
cp cms.env.json_TIMESTAMP cms.env.json
sudo /edx/bin/supervisorctl restart edxapp:
- TIMESTAMP - unix timestamp value when the installation script was launched
To check the status, run:
sudo /edx/bin/supervisorctl status
Please feel free to make all the necessary modifications to our products to fit your purposes. Also, you may use the themes on Open edX platform including commercial use. But please remember that you must not:
sell or resell any part of themex.io products and service
claim intellectual property right or exclusive ownership to any of our products, modified or unmodified
There are some hints that can help you to find the problem:
Note: your edx-platform repository should not have any uncommitted changes for updating a theme. Try to check whether there are any.
Make sure server-vars file is present and located in accordance with official documentation Open edX - /edx/app/edx_ansible/server-vars.yml
Make sure you use Open edX fullstack vs devstack. The script does not work with devstack and if you try to install on a devstack you will receive a message: "Playbook not applicable for devstack"
If you did not find the problem you have in the list above, please contact us at email@example.com