Skip to content

Latest commit

 

History

History
115 lines (101 loc) · 23.4 KB

how_to_customize_distro.rst

File metadata and controls

115 lines (101 loc) · 23.4 KB

How to customize tutor-distro plugin

Tutor distro plugin manages a set of settings:

General Settings

Setting Example Values

DOCKER_IMAGE_OPENEDX

Base docker image, that contain all distro basic configuration for production and replace tutor default openedx image

docker.io/ednxops/distro-edunext-edxapp:<distro_version>

DOCKER_IMAGE_OPENEDX_DEV

Base docker image, that contain all distro basic configuration for development and replace tutor default openedx image

docker.io/ednxops/distro-edunext-edxapp-dev:<distro-version>

EDX_PLATFORM_REPOSITORY

Repository for your edx-platform base code

https://github.com/eduNEXT/edunext-platform.git

EDX_PLATFORM_VERSION

Branch to use as main code

ednx-release/<distro-version>.master

DISTRO_THEMES

Establish repository(ies) of your openedx theme(s)

You can add other repositories using the same estructure.

- name: ednx-saas-themes
  repo: ednx-saas-theme
  domain: github.com
  protocol: ssh
  path: eduNEXT

DISTRO_THEMES_ROOT

Directory where the themes are cloned

/openedx/themes

DISTRO_THEME_DIRS

Path to theme directories

- /openedx/themes/ednx-saas-themes/edx-platform/
- openedx/themes/ednx-saas-themes/edx-platform/bragi-generator

DISTRO_THEMES_NAME

Name(s) for enable theme(s)

- bragi

DISTRO_DEFAULT_SITE_THEME

Optional value to set the default theme. Useful when you want to install more than 1 theme.

bragi

DISTRO_EXTRA_COMMANDS

Add any tutor command which need to be executed

- tutor plugins install mfe && tutor plugins enable mfe

DISTRO_EXTRA_MIDDLEWARES

Add any middleware to openedx setting MIDDLEWARE

- middleware.test.1

INSTALL_EXTRA_FILE_REQUIREMENTS

Add any extra files to aditional requirements

path: ./requirements/extra_file/
files: [
  /edunext/base.txt,
  /test/test.txt
]

OPENEDX_EXTRA_SETTINGS

Enable openedx extra settings to configure cms_env, lms_env or pre_init_lms_tasks variables

cms_env: [
  USE_EOX_TENANT: true
]
lms_env: [
  USE_EOX_TENANT: true,
  ENABLE_EOX_THEMING_DERIVE_WORKAROUND: true
]
pre_init_lms_tasks: [
  ./manage.py lms migrate contenttypes,
  ./manage.py lms migrate eox_core,
  ./manage.py lms migrate eox_tenant
]

To set these settings, define it on config.yml file ($(tutor config printroot)/config.yaml) or use the command tutor config save --set GENERAL_SETTING=Value.

Note: INSTALL_EXTRA_FILE_REQUIREMENTS and OPENEDX_EXTRA_SETTINGS are included from version 15, you can use it from this release.

Plugins or packages

We use the Edunext Open Extensionss (aka EOX), all of them are public you can use if them if you find it useful for your instance:

Name Description More information
DISTRO_EOX_TENANT_DPKG Multi-tenancy django app for edx-platform https://github.com/eduNEXT/eox-tenant
DISTRO_EOX_CORE_DPKG Adds multiple API endpoints in order to extend the functionality of the edx-platform https://github.com/eduNEXT/eox-core
DISTRO_EOX_AUDIT_MODEL_DPKG Register status of any execution of a method or function https://github.com/eduNEXT/eox-audit-model
DISTRO_EOX_THEMING_DPKG Tool to make it easy to create a openedx theme (Django) https://github.com/eduNEXT/eox-theming
DISTRO_EOX_HOOKS_DPKG Extend edx-platform through Django configurations and Open edX Events https://github.com/eduNEXT/eox-hooks/
DISTRO_EOX_TAGGING_DPKG Tags objects in edx-platform which can be used to categorize, include extra information, etc. https://github.com/eduNEXT/eox-tagging/

You can visit the corresponding section for the inclusion of new packages: How to add a new package.