Install XBlocks

XBlocks are plugins or extensions that the community develops to give additional functionality to Open edX. Atlassian.net maintains a directory of XBlocks. Many XBlocks are listed there, but not all.

XBlock List

Here are some of the XBlocks that we use:

PDF Alternative:

  • xblock-pdf
  • Requires dependency package: git+https://github.com/IONISx/xblock-pdf.git@v1.0.0#egg=xblock-pdf

XBlocks and Tutor

XBlocks are installed using a URL to a GIT repository. The URL to an xblock goes in the requirements file using the format listed below. The Open edX docker image must be rebuilt to include the new XBlock.

git+https://url-to-xblock/xblock.git

# For example, here is how you would install the Poll XBlock:
git+https://github.com/open-craft/xblock-poll.git

Enable XBlocks in Tutor

  1. Edit file private.txt that will contain URLs to the XBlocks

    nano $(tutor config printroot)/env/build/openedx/requirements/private.txt
  2. Place the URLs to the XBlocks that you want to use. Here is the complete list that we use.

    git+https://github.com/open-craft/xblock-poll.git
    git+https://github.com/open-craft/xblock-drag-and-drop-v2.git
    git+https://github.com/appsembler/oppia-xblock.git
    git+https://github.com/ubc/ubcpi.git
    git+https://github.com/mitodl/edx-sga.git
    git+https://github.com/polimediaupv/pdfXBlock.git
    git+https://github.com/overhangio/openedx-scorm-xblock.git
    git+https://github.com/open-craft/xblock-activetable.git
    git+https://github.com/edx/xblock-lti-consumer.git
  3. Rebuild the docker Open edX image to include the XBlocks

    tutor images build openedx
  4. Restart Tutor

    tutor local stop
    tutor local start -d

Add XBlocks to a Course

The course developer should add the XBlocks that they want to use in their course.

XBlocks are enabled on a per-course basis. See our Course Developers section or view the Enabling XBlocks in Open edX from appsembler.

Here is a list of XBlocks that match the above list. Studio page: Settings > Advanced Settings > Advanced Module List

[
    "activetable",
    "edx_sga",
    "google-calendar",
    "google-document",
    "pdf",
    "poll",
    "scorm",
    "survey",
    "lti_consumer"
]

These XBlocks will show in the Add New Component -> Advanced list.