A simple, but flexible, way for anyone to stand up an instance of the Open edX platform that is fully configured and ready-to-go
Python Shell Ruby Groovy Makefile Vim script C
Switch branches/tags
release-kifli release-johnnycake release-injera release-himbasha release-gugelhupf release-focaccia release-empanada release-dosa release-croissant release-brioche release-arepa rc/2014-11-03-lavash-0 open-release/ginkgo.1 open-release/ginkgo.1rc1 open-release/ficus.4 open-release/ficus.3 open-release/ficus.2 open-release/ficus.1 open-release/ficus.1rc4 open-release/ficus.1rc3 open-release/ficus.1rc1 open-release/eucalyptus.3 open-release/eucalyptus.2 open-release/eucalyptus.1 open-release/eucalyptus.1rc2 open-release/eucalyptus/1rc1 nedbat/test/ficus.4.4 nedbat/test/ficus.4.3 nedbat/test/ficus.4.2 nedbat/test/ficus.3.3 nedbat/test/ficus.3.2 nedbat/test/ficus.3.1 nedbat/test/ficus.2.3 nedbat/test/ficus.2.1 nedbat/test/ficus.2rc1.2 nedbat/test/ficus.2rc1.1 nedbat/test/ficus.1rc4.3 nedbat/test/ficus.1rc4.2 nedbat/test/ficus.1rc4.1 nedbat/test-ficus.1rc4 ned/test-ficus.2 ned/test-ficus.1 named-release/dogwood.3 named-release/dogwood.2 named-release/dogwood.1 named-release/dogwood named-release/dogwood.rc3 named-release/dogwood.rc2 named-release/dogwood.rc1 named-release/cypress named-release/cypress.rc4 named-release/cypress.rc3 named-release/cypress.rc2 named-release/cypress.rc1 named-release/birch.2 named-release/birch.1 named-release/birch named-release/birch.rc3 named-release/birch.rc2 named-release/birch.rc1 named-release/aspen edx-west/release_pre_injera edx-west/release-20131106 edx-west-release-pre-gugelhupf edx-west-release-20131218 edx-west-release-20131120 django-1.8-release config-release aspen.1 ansible-1.9.3-edx-snapshot
Nothing to show
Latest commit c96fe09 Sep 25, 2017 @jzoldak jzoldak committed on GitHub Merge pull request #4109 from edx/zoldak/jenkins-promotion
Remove playbook for test-jenkins


Configuration Management


The goal of the edx/configuration project is to provide a simple, but flexible, way for anyone to stand up an instance of Open edX that is fully configured and ready-to-go.

Before getting started, please look at the Open EdX Installation options, to see which method for deploying OpenEdX is right for you.

Building the platform takes place in two phases:

  • Infrastructure provisioning
  • Service configuration

As much as possible, we have tried to keep a clean distinction between provisioning and configuration. You are not obliged to use our tools and are free to use one, but not the other. The provisioning phase stands-up the required resources and tags them with role identifiers so that the configuration tool can come in and complete the job.

Note: The Cloudformation templates used for infrastructure provisioning are no longer maintained. We are working to move to a more modern and flexible tool.

The reference platform is provisioned using an Amazon CloudFormation template. When the stack has been fully created you will have a new AWS Virtual Private Cloud with hosts for the core Open edX services. This template will build quite a number of AWS resources that cost money, so please consider this before you start.

The configuration phase is managed by Ansible. We have provided a number of playbooks that will configure each of the Open edX services.

Important: The Open edX configuration scripts need to be run as root on your servers and will make changes to service configurations including, but not limited to, sshd, dhclient, sudo, apparmor and syslogd. Our scripts are made available as we use them and they implement our best practices. We strongly recommend that you review everything that these scripts will do before running them against your servers. We also recommend against running them against servers that are hosting other applications. No warranty is expressed or implied.

For more information including installation instruction please see the OpenEdX Wiki.

For info on any large recent changes please see the change log.