Enable XBlocks for a course

Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and MacOS) or by clicking the shortcut in the Start Menu under “Start -> Bitnami APPNAME Stack -> Application console” (Windows). On OS X VMs, the installation directory is /opt/bitnami and OS X VM users can click the “Open Terminal” button to run commands. Learn more about the Bitnami stack environment and about OS X VMs.

To install a new XBlock, follow the steps below:

  • Log in to your server console.

  • Download the module.

  • Load the Bitnami stack environment:

    $ sudo installdir/use_edx
  • Load the Open edX virtual environment:

    $ source installdir/apps/edx/venvs/edxapp/bin/activate
  • Install the XBlock using pip:

    $ pip install /path/to/downloaded/xblock/

    NOTE: The installation steps could differ depending on the XBlock. Check the provider documentation to get more information.

  • Restart the Apache server to load the changes.

Next, enable the XBlock for the course, as follows:

  • Navigate to the course in Studio.

  • Click the “Settings -> Advanced settings” menu.

  • Specify the XBlock to use in the “Advanced Module List” area using a comma-separated list. Note that you can find the name of the module in the provider documentation.

    XBlock configuration

You should now be able to use the extension. To check this, create a new unit and select the “Advanced” button:

XBlock usage

You should see the modules previously specified:

XBlock usage

Last modification April 8, 2020