Open edX: Configuration
10 Nov 2014

After installation, there are a lot of settings that you’ll need to tweak to suit your situation. There’s a fast way to do this and a ‘correct’ way to do this.

Underneath, there’s one master config file (server-vars.yml) which generates config files for each of the components.

There’s a list of potential config variables here:

The quick way

Modify the config files in /edx/app/edxapp/ directly. lms.env.json and cms.env.json contain the most useful variables.

The issue with this method is that your changes could be overwritten during an upgrade, so you’ll need to reapply them manually. The upside is that you can try things out relatively quickly, which is nice when you’re experimenting.

After you modify a config file, you’ll need to restart the relevant service using supervisorctl. Usually, this means:

/edx/bin/supervisorctl restart edxapp:  # Run as root. Note the trailing colon.

The right way

This method is more tolerant of server upgrades. Everything is stored in source control so it can be quickly deployed later.

Suggested settings

You should almost certainly change the following settings:

CODE_JAIL/python_bin: I make this something that isn’t real. I don’t run programming MOOCs and do use LXC (which doesn’t have AppArmor support) and so want to hobble the sandbox as much as possible for security purposes.

Various email addresses

The Facebook address

Twitter address

SITE_NAME (most stuff works without it, but occasionally you’ll get broken links/IP addresses showing through)


comments powered by Disqus