Skip to main content

Command Palette

Search for a command to run...

Installing extra xblock and requirements in Tutor(OpenedX)

Published
1 min read
Installing extra xblock and requirements in Tutor(OpenedX)
Y

https://discuss.openedx.org/u/yagnesh/summary The online learning market is getting saturated as the entire education industry is moving towards digitalization. Open edX software has been powering several e-learning platforms, by offering useful features that make online learning much more accessible and convenient. Since it is open-source. √ Open edX installation and configuration √ Course Catalogue Page creation. √ White labeling √ install various plugins (XBlocks) √ Certificate Integration √ on Experience with SQL/MONGO √ work on the production side with the Tutor and much more

Would you like to include custom xblocks, or extra requirements to your Open edX platform?

Additional requirements can be added to the OPENEDX_EXTRA_PIP_REQUIREMENTS parameter in the config file or to the env/build/openedx/requirements/private.txt file. The difference between them, is that private.txt file, even though it could be used for both

tutor config save –append OPENEDX_EXTRA_PIP_REQUIREMENTS=git+https://github.com/Yagnesh1998/DoneXBlock.git

Alternatively, add the dependency to private.txt:

echo "git+https://github.com/Yagnesh1998/DoneXBlock.git" >> "$(tutor config printroot)/env/build/openedx/requirements/private.txt"

Then, the openedx docker image must be rebuilt:

tutor images build openedx

Installing extra requirements from private repositories

When installing extra xblock or requirements from private repositories, private.txt file should be used because it allows installing dependencies without adding git credentials to the Docker image. By adding your git credentials to the Docker image, you’re risking leaking your git credentials, if you were to publish (intentionally or unintentionally) the Docker image in a public place.

To install xblocks from a private repository that requires authentication, you must first clone the repository inside the openedx/requirements folder on the host:

git clone git@github.com:me/myprivaterepo.git "$(tutor config printroot)/env/build/openedx/requirements/myprivaterepo"

Then, declare your extra requirements with the -e flag in openedx/requirements/private.txt:

echo "-e ./myprivaterepo" >> "$(tutor config printroot)/env/build/openedx/requirements/private.txt"

More from this blog

yagnesh nayi

6 posts

The online learning market is getting saturated as the entire education industry is moving towards digitalization. Open edX software has been powering several e-learning platforms, by offering useful features that make online learning much more accessible and convenient. Since it is open-source.

√ Open edX installation and configuration √ Course Catalogue Page creation. √ White labeling √ install various plugins (XBlocks) √ Certificate Integration √ on Experience with SQL/MONGO √ work on the production side with Tutor and much more