XBlock for edx-platform implementing interconnection between Open edX and HTML Academy.
XBlock is compatible with the 9-th openEdx named release Ironwood, and most likely in not compatible with any other.
Add the following line in requirements.txt
:
-e git+https://github.com/openeduITMO/[email protected]#egg=ifmo-xblock-htmlacademy==9.0
Add following parameters in lms.env.json
:
"XBLOCK_SETTINGS": {
"IFMO_XBLOCK_HTMLACADEMY": {
"SELECTED_CONFIGURATION": "selected_configuration",
"LAB_URL": "lab_url_goes_here",
"API_URL": "api_url_goes_here",
"SECRET": "secret_goes_here"
}
}
Add following apps in INSTALLED_APPS
:
INSTALLED_APPS += (
"xblock_htmlacademy",
)
Or modify lms.env.json
and cms.env.json
:
"ADDL_INSTALLED_APPS": [
"xblock_htmlacademy"
]
SELECTED_CONFIGURATION
can now be ifmo
, npoed
or default
.
LAB_URL
is optional, may be omitted when SELECTED_CONFIGURATION
is either
ifmo
or npoed
otherwise unpredicted behaviour may occur.
API_URL
is optional, may be omitted when SELECTED_CONFIGURATION
is either
ifmo
or npoed
otherwise unpredicted behaviour may occur.
SECRET
is required, provided by HTML Academy service.
Sample for server_vars.yml
:
XBLOCK_SETTINGS:
IFMO_XBLOCK_HTMLACADEMY:
SELECTED_CONFIGURATION: "selected_configuration_goes_here"
LAB_URL: "lab_url_goes_here"
API_URL: "api_url_goes_here"
SECRET: "secret_goes_here"
XBlock provides entry point xblock_htmlacademy
which must be used in course Advanced settings.