Version Compatibility

For “Lilac” or more recent release of edX platform

Use any version of edx-sysadmin plugin.

For releases prior to “Lilac”

You do not need edx-sysadmin plugin. Just enable ENABLE_SYSADMIN_DASHBOARD feature flag in environment files (e.g lms.yml or lms.env.json) to access sysadmin dashboard features.

For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.

Installing The Plugin

For detailed installation instructions, please refer to the plugin installation guide.

Installation required in:

• LMS

• CMS

Upon installation you need to create /openedx/course_repos directory within the LMS service:

tutor dev exec lms bash
mkdir /openedx/course_repos

After this, you can visit <EDX_BASE_URL>/sysadmin to access the plugin features.

Configurations

The plugin offers multiple settings for customization that can be set using the config file in Open edX. For any release after Juniper, that config file is /edx/etc/lms.yml. If you’re using private.py, add these values to lms/envs/private.py.

• GIT_REPO_DIR: This path defines where the imported repositories will be placed in storage. Default value is /openedx/course_repos. For Devstack, set this value to /edx/var/edxapp/course_repos.

• GIT_IMPORT_STATIC: This is a boolean that tells the plugin to either load the static content from the course repo or not. Default value is True

• SYSADMIN_GITHUB_WEBHOOK_KEY: This value is used to save either of sha256 or sha1 hashes. (This key is only used for Github Webhooks). Default value is None.

• SYSADMIN_DEFAULT_BRANCH: This value is used to specify environment specific branch name to be used for course reload/import through Github Webhooks. (This key is only used for Github Webhooks). Default value is None

Features

edx-sysadmin provides different features such as:

• Register Users:

  • You can register new user accounts with an easy to use form via Users tab.

• Delete Courses:

  • You can delete any course by using a course ID or directory via Courses tab.

• Git Import:

  • You can import any course maintained through a git repository via Git Import tab.

• Git Logs

  • You can check the logs for all imported courses through git via Git Logs tab.

• Git Reload (Not directly visible)

  • You can configure Github webhooks with this plugin to ensure reload/import of your courses on new commits