Skip to content

Instantly share code, notes, and snippets.

@sarina

sarina/sumac_references_settings.xml

Created April 23, 2025 22:58
Show Gist options
  • Save sarina/2a20bc4d449384ede34156ba0ae8fd2c to your computer and use it in GitHub Desktop.
Save sarina/2a20bc4d449384ede34156ba0ae8fd2c to your computer and use it in GitHub Desktop.
Download ZIP
sumac settings report
Raw
sumac_references_settings.xml
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd">
<!-- Generated by Docutils 0.21.2 -->
<document source="/Users/sarinacanelake/static-clones/edx-platform/docs/references/settings.rst" translation_progress="{'total': 0, 'translated': 0}" xmlns:c="https://www.sphinx-doc.org/" xmlns:changeset="https://www.sphinx-doc.org/" xmlns:citation="https://www.sphinx-doc.org/" xmlns:cpp="https://www.sphinx-doc.org/" xmlns:http="https://www.sphinx-doc.org/" xmlns:index="https://www.sphinx-doc.org/" xmlns:js="https://www.sphinx-doc.org/" xmlns:math="https://www.sphinx-doc.org/" xmlns:py="https://www.sphinx-doc.org/" xmlns:rst="https://www.sphinx-doc.org/" xmlns:std="https://www.sphinx-doc.org/">
<section ids="settings" names="settings">
<title>Settings</title>
<paragraph>This is the list of (non-toggle) Django settings defined in the <literal>common.py</literal> modules of edx-platform.</paragraph>
<note>
<paragraph>Toggle settings, which enable or disable a specific feature, are documented in the <reference internal="True" refuri="featuretoggles#featuretoggles"><inline classes="std std-ref">feature toggles</inline></reference> section.</paragraph>
</note>
<section ids="lms-settings" names="lms\ settings">
<title>LMS settings</title>
<section ids="setting-ACCOUNT_MICROFRONTEND_URL">
<title ids="title-ACCOUNT_MICROFRONTEND_URL">ACCOUNT_MICROFRONTEND_URL</title>
<paragraph ids="default-ACCOUNT_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-ACCOUNT_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5007">common.py (line 5007)</reference></paragraph>
<paragraph ids="description-ACCOUNT_MICROFRONTEND_URL">Base URL of the micro-frontend-based account settings page.</paragraph>
<warning ids="warning-ACCOUNT_MICROFRONTEND_URL">
<paragraph>Also set site’s ENABLE_ACCOUNT_MICROFRONTEND and
account.redirect_to_microfrontend waffle flag</paragraph>
</warning>
</section>
<section ids="setting-BLOCK_STRUCTURES_SETTINGS">
<title ids="title-BLOCK_STRUCTURES_SETTINGS">BLOCK_STRUCTURES_SETTINGS</title>
<paragraph ids="default-BLOCK_STRUCTURES_SETTINGS">Default: <literal>"dict of settings"</literal></paragraph>
<paragraph ids="source-BLOCK_STRUCTURES_SETTINGS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2948">common.py (line 2948)</reference></paragraph>
<paragraph ids="description-BLOCK_STRUCTURES_SETTINGS">Stores all the settings used by block structures and block structure
related tasks. See BLOCK_STRUCTURES_SETTINGS[XXX] documentation for details of each setting.
For more information, check https://github.com/openedx/edx-platform/pull/13388.</paragraph>
</section>
<section ids="setting-BLOCK_STRUCTURES_SETTINGS['COURSE_PUBLISH_TASK_DELAY']">
<title ids="title-BLOCK_STRUCTURES_SETTINGS['COURSE_PUBLISH_TASK_DELAY']">BLOCK_STRUCTURES_SETTINGS[‘COURSE_PUBLISH_TASK_DELAY’]</title>
<paragraph ids="default-BLOCK_STRUCTURES_SETTINGS['COURSE_PUBLISH_TASK_DELAY']">Default: <literal>30</literal></paragraph>
<paragraph ids="source-BLOCK_STRUCTURES_SETTINGS['COURSE_PUBLISH_TASK_DELAY']">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2954">common.py (line 2954)</reference></paragraph>
<paragraph ids="description-BLOCK_STRUCTURES_SETTINGS['COURSE_PUBLISH_TASK_DELAY']">Delay, in seconds, after a new edit of a course is published before
updating the block structures cache. This is needed for a better chance at getting
the latest changes when there are secondary reads in sharded mongoDB clusters.
For more information, check https://github.com/openedx/edx-platform/pull/13388 and
https://github.com/openedx/edx-platform/pull/14571.</paragraph>
</section>
<section ids="setting-BLOCK_STRUCTURES_SETTINGS['TASK_DEFAULT_RETRY_DELAY']">
<title ids="title-BLOCK_STRUCTURES_SETTINGS['TASK_DEFAULT_RETRY_DELAY']">BLOCK_STRUCTURES_SETTINGS[‘TASK_DEFAULT_RETRY_DELAY’]</title>
<paragraph ids="default-BLOCK_STRUCTURES_SETTINGS['TASK_DEFAULT_RETRY_DELAY']">Default: <literal>30</literal></paragraph>
<paragraph ids="source-BLOCK_STRUCTURES_SETTINGS['TASK_DEFAULT_RETRY_DELAY']">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2963">common.py (line 2963)</reference></paragraph>
<paragraph ids="description-BLOCK_STRUCTURES_SETTINGS['TASK_DEFAULT_RETRY_DELAY']">Delay, in seconds, between retry attempts if a block structure task
fails. For more information, check https://github.com/openedx/edx-platform/pull/13388 and
https://github.com/openedx/edx-platform/pull/14571.</paragraph>
</section>
<section ids="setting-BLOCK_STRUCTURES_SETTINGS['TASK_MAX_RETRIES']">
<title ids="title-BLOCK_STRUCTURES_SETTINGS['TASK_MAX_RETRIES']">BLOCK_STRUCTURES_SETTINGS[‘TASK_MAX_RETRIES’]</title>
<paragraph ids="default-BLOCK_STRUCTURES_SETTINGS['TASK_MAX_RETRIES']">Default: <literal>5</literal></paragraph>
<paragraph ids="source-BLOCK_STRUCTURES_SETTINGS['TASK_MAX_RETRIES']">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2970">common.py (line 2970)</reference></paragraph>
<paragraph ids="description-BLOCK_STRUCTURES_SETTINGS['TASK_MAX_RETRIES']">Maximum number of retries per block structure task.
If the maximum number of retries is exceeded, then you can attempt to either manually run
the celery task, or wait for it to be triggered again.
For more information, check https://github.com/openedx/edx-platform/pull/13388 and
https://github.com/openedx/edx-platform/pull/14571.</paragraph>
</section>
<section ids="setting-CCX_MAX_STUDENTS_ALLOWED">
<title ids="title-CCX_MAX_STUDENTS_ALLOWED">CCX_MAX_STUDENTS_ALLOWED</title>
<paragraph ids="default-CCX_MAX_STUDENTS_ALLOWED">Default: <literal>200</literal></paragraph>
<paragraph ids="source-CCX_MAX_STUDENTS_ALLOWED">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4503">common.py (line 4503)</reference></paragraph>
<paragraph ids="description-CCX_MAX_STUDENTS_ALLOWED">Maximum number of students allowed in a CCX (Custom Courses for edX), This is an arbitrary
hard limit, chosen so that a CCX does not compete with public MOOCs.</paragraph>
</section>
<section ids="setting-CELERY_EXTRA_IMPORTS">
<title ids="title-CELERY_EXTRA_IMPORTS">CELERY_EXTRA_IMPORTS</title>
<paragraph ids="default-CELERY_EXTRA_IMPORTS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-CELERY_EXTRA_IMPORTS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2851">common.py (line 2851)</reference></paragraph>
<paragraph ids="description-CELERY_EXTRA_IMPORTS">Adds extra packages that don’t get auto-imported (Example: XBlocks).
These packages are added in addition to those added by CELERY_IMPORTS.</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">
<title ids="title-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">Default: <literal>0.5</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1856">common.py (line 1856)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">Set the number of seconds LMS will wait to establish an internal
connection to the codejail remote service.</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_HOST">
<title ids="title-CODE_JAIL_REST_SERVICE_HOST">CODE_JAIL_REST_SERVICE_HOST</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_HOST">Default: <literal>"'http://127.0.0.1:8550'"</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_HOST">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1852">common.py (line 1852)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_HOST">Set the codejail remote service host</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">
<title ids="title-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">CODE_JAIL_REST_SERVICE_READ_TIMEOUT</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">Default: <literal>3.5</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1860">common.py (line 1860)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">Set the number of seconds LMS will wait for a response from the
codejail remote service endpoint.</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">
<title ids="title-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">CODE_JAIL_REST_SERVICE_REMOTE_EXEC</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">Default: <literal>"'xmodule.capa.safe_exec.remote_exec.send_safe_exec_request_v0'"</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1847">common.py (line 1847)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">Set the python package.module.function that is reponsible of
calling the remote service in charge of jailed code execution</paragraph>
</section>
<section ids="setting-COMPREHENSIVE_THEME_DIRS">
<title ids="title-COMPREHENSIVE_THEME_DIRS">COMPREHENSIVE_THEME_DIRS</title>
<paragraph ids="default-COMPREHENSIVE_THEME_DIRS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-COMPREHENSIVE_THEME_DIRS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4560">common.py (line 4560)</reference></paragraph>
<paragraph ids="description-COMPREHENSIVE_THEME_DIRS">A list of paths to directories, each of which will
be searched for comprehensive themes. Do not override this Django setting directly.
Instead, set the COMPREHENSIVE_THEME_DIRS environment variable, using colons (:) to
separate paths.</paragraph>
</section>
<section ids="setting-COMPREHENSIVE_THEME_LOCALE_PATHS">
<title ids="title-COMPREHENSIVE_THEME_LOCALE_PATHS">COMPREHENSIVE_THEME_LOCALE_PATHS</title>
<paragraph ids="default-COMPREHENSIVE_THEME_LOCALE_PATHS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-COMPREHENSIVE_THEME_LOCALE_PATHS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4568">common.py (line 4568)</reference></paragraph>
<paragraph ids="description-COMPREHENSIVE_THEME_LOCALE_PATHS">A list of the paths to themes locale directories e.g.
“COMPREHENSIVE_THEME_LOCALE_PATHS” : [“/edx/src/edx-themes/conf/locale”].</paragraph>
</section>
<section ids="setting-COURSE_MEMBER_API_ENROLLMENT_LIMIT">
<title ids="title-COURSE_MEMBER_API_ENROLLMENT_LIMIT">COURSE_MEMBER_API_ENROLLMENT_LIMIT</title>
<paragraph ids="default-COURSE_MEMBER_API_ENROLLMENT_LIMIT">Default: <literal>1000</literal></paragraph>
<paragraph ids="source-COURSE_MEMBER_API_ENROLLMENT_LIMIT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4377">common.py (line 4377)</reference></paragraph>
<paragraph ids="description-COURSE_MEMBER_API_ENROLLMENT_LIMIT">This limits the response size of the `get_course_members` API, throwing an exception
if the number of Enrolled users is greater than this number. This is needed to limit the dataset size
since the API does most of the calculation in Python to avoid expensive database queries.</paragraph>
</section>
<section ids="setting-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">
<title ids="title-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">CUSTOM_RESOURCE_TEMPLATES_DIRECTORY</title>
<paragraph ids="default-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">Default: <literal>None</literal></paragraph>
<paragraph ids="source-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4599">common.py (line 4599)</reference></paragraph>
<paragraph ids="description-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">Path to an existing directory of YAML files containing
html content to be used with the subclasses of xmodule.x_module.ResourceTemplates.
Default example templates can be found in xmodule/templates/html.
Note that the extension used is “.yaml” and not “.yml”.
See xmodule.x_module.ResourceTemplates for usage.
“CUSTOM_RESOURCE_TEMPLATES_DIRECTORY” : null</paragraph>
</section>
<section ids="setting-DEFAULT_SITE_THEME">
<title ids="title-DEFAULT_SITE_THEME">DEFAULT_SITE_THEME</title>
<paragraph ids="default-DEFAULT_SITE_THEME">Default: <literal>None</literal></paragraph>
<paragraph ids="source-DEFAULT_SITE_THEME">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4581">common.py (line 4581)</reference></paragraph>
<paragraph ids="description-DEFAULT_SITE_THEME">Theme to use when no site or site theme is defined, for example
“dark-theme”. Set to None if you want to use openedx default theme.</paragraph>
<warning ids="warning-DEFAULT_SITE_THEME">
<paragraph>The theme folder needs to be in ‘edx-platform/themes’ or define the path
to the theme folder in COMPREHENSIVE_THEME_DIRS. To be effective, ENABLE_COMPREHENSIVE_THEMING
has to be enabled.</paragraph>
</warning>
</section>
<section ids="setting-DISABLED_COUNTRIES">
<title ids="title-DISABLED_COUNTRIES">DISABLED_COUNTRIES</title>
<paragraph ids="default-DISABLED_COUNTRIES">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-DISABLED_COUNTRIES">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5535">common.py (line 5535)</reference></paragraph>
<paragraph ids="description-DISABLED_COUNTRIES">List of country codes that should be disabled</paragraph>
</section>
<section ids="setting-DISCUSSIONS_MFE_FEEDBACK_URL">
<title ids="title-DISCUSSIONS_MFE_FEEDBACK_URL">DISCUSSIONS_MFE_FEEDBACK_URL</title>
<paragraph ids="default-DISCUSSIONS_MFE_FEEDBACK_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-DISCUSSIONS_MFE_FEEDBACK_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5039">common.py (line 5039)</reference></paragraph>
<paragraph ids="description-DISCUSSIONS_MFE_FEEDBACK_URL">Base URL of the discussions micro-frontend google form based feedback.</paragraph>
</section>
<section ids="setting-DISCUSSIONS_MICROFRONTEND_URL">
<title ids="title-DISCUSSIONS_MICROFRONTEND_URL">DISCUSSIONS_MICROFRONTEND_URL</title>
<paragraph ids="default-DISCUSSIONS_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-DISCUSSIONS_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5034">common.py (line 5034)</reference></paragraph>
<paragraph ids="description-DISCUSSIONS_MICROFRONTEND_URL">Base URL of the micro-frontend-based discussions page.</paragraph>
<warning ids="warning-DISCUSSIONS_MICROFRONTEND_URL">
<paragraph>Also set site’s courseware.discussions_mfe waffle flag.</paragraph>
</warning>
</section>
<section ids="setting-EDXNOTES_CLIENT_NAME">
<title ids="title-EDXNOTES_CLIENT_NAME">EDXNOTES_CLIENT_NAME</title>
<paragraph ids="default-EDXNOTES_CLIENT_NAME">Default: <literal>"edx-notes"</literal></paragraph>
<paragraph ids="source-EDXNOTES_CLIENT_NAME">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2179">common.py (line 2179)</reference></paragraph>
<paragraph ids="description-EDXNOTES_CLIENT_NAME">Set the name of the Oauth client used by LMS to authenticate with
the edx_notes_api service.</paragraph>
<warning ids="warning-EDXNOTES_CLIENT_NAME">
<paragraph>The Oauth client must be created in the platform Django admin in the
path /admin/oauth2_provider/application/, setting the name field of the client as the
value of this setting.</paragraph>
</warning>
</section>
<section ids="setting-EDXNOTES_CONNECT_TIMEOUT">
<title ids="title-EDXNOTES_CONNECT_TIMEOUT">EDXNOTES_CONNECT_TIMEOUT</title>
<paragraph ids="default-EDXNOTES_CONNECT_TIMEOUT">Default: <literal>0.5</literal></paragraph>
<paragraph ids="source-EDXNOTES_CONNECT_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2187">common.py (line 2187)</reference></paragraph>
<paragraph ids="description-EDXNOTES_CONNECT_TIMEOUT">Set the number of seconds LMS will wait to establish an internal
connection to the edx_notes_api service.</paragraph>
</section>
<section ids="setting-EDXNOTES_INTERNAL_API">
<title ids="title-EDXNOTES_INTERNAL_API">EDXNOTES_INTERNAL_API</title>
<paragraph ids="default-EDXNOTES_INTERNAL_API">Default: <literal>"http://localhost:18120/api/v1"</literal></paragraph>
<paragraph ids="source-EDXNOTES_INTERNAL_API">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2170">common.py (line 2170)</reference></paragraph>
<paragraph ids="description-EDXNOTES_INTERNAL_API">Set the internal API endpoint LMS will use in the backend to
interact with the edx_notes_api service.</paragraph>
<warning ids="warning-EDXNOTES_INTERNAL_API">
<paragraph>Normally set to the same value of EDXNOTES_PUBLIC_API. It is not
mandatory for this setting to be a publicly accessible endpoint, but to be accessible
by the LMS service. It is only used when the setting FEATURES[‘ENABLE_EDXNOTES’] is
activated.</paragraph>
</warning>
</section>
<section ids="setting-EDXNOTES_PUBLIC_API">
<title ids="title-EDXNOTES_PUBLIC_API">EDXNOTES_PUBLIC_API</title>
<paragraph ids="default-EDXNOTES_PUBLIC_API">Default: <literal>"http://localhost:18120/api/v1"</literal></paragraph>
<paragraph ids="source-EDXNOTES_PUBLIC_API">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2162">common.py (line 2162)</reference></paragraph>
<paragraph ids="description-EDXNOTES_PUBLIC_API">Set the public API endpoint LMS will use in the frontend to
interact with the edx_notes_api service.</paragraph>
<warning ids="warning-EDXNOTES_PUBLIC_API">
<paragraph>This setting must be a publicly accessible endpoint. It is only used
when the setting FEATURES[‘ENABLE_EDXNOTES’] is activated.</paragraph>
</warning>
</section>
<section ids="setting-EDXNOTES_READ_TIMEOUT">
<title ids="title-EDXNOTES_READ_TIMEOUT">EDXNOTES_READ_TIMEOUT</title>
<paragraph ids="default-EDXNOTES_READ_TIMEOUT">Default: <literal>1.5</literal></paragraph>
<paragraph ids="source-EDXNOTES_READ_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2191">common.py (line 2191)</reference></paragraph>
<paragraph ids="description-EDXNOTES_READ_TIMEOUT">Set the number of seconds LMS will wait for a response from the
edx_notes_api service internal endpoint.</paragraph>
</section>
<section ids="setting-ELASTIC_SEARCH_INDEX_PREFIX">
<title ids="title-ELASTIC_SEARCH_INDEX_PREFIX">ELASTIC_SEARCH_INDEX_PREFIX</title>
<paragraph ids="default-ELASTIC_SEARCH_INDEX_PREFIX">Default: <literal>"''"</literal></paragraph>
<paragraph ids="source-ELASTIC_SEARCH_INDEX_PREFIX">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1456">common.py (line 1456)</reference></paragraph>
<paragraph ids="description-ELASTIC_SEARCH_INDEX_PREFIX">Specifies the prefix used when naming elasticsearch indexes related to edx-search.</paragraph>
</section>
<section ids="setting-EVENT_BUS_PRODUCER_CONFIG">
<title ids="title-EVENT_BUS_PRODUCER_CONFIG">EVENT_BUS_PRODUCER_CONFIG</title>
<paragraph ids="default-EVENT_BUS_PRODUCER_CONFIG">Default: <literal>"all events disabled"</literal></paragraph>
<paragraph ids="source-EVENT_BUS_PRODUCER_CONFIG">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5397">common.py (line 5397)</reference></paragraph>
<paragraph ids="description-EVENT_BUS_PRODUCER_CONFIG">Dictionary of event_types mapped to dictionaries of topic to topic-related configuration.
Each topic configuration dictionary contains
* `enabled`: a toggle denoting whether the event will be published to the topic. These should be annotated
according to
https://edx.readthedocs.io/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html
* `event_key_field` which is a period-delimited string path to event data field to use as event key.
Note: The topic names should not include environment prefix as it will be dynamically added based on
EVENT_BUS_TOPIC_PREFIX setting.</paragraph>
</section>
<section ids="setting-EXAMS_DASHBOARD_MICROFRONTEND_URL">
<title ids="title-EXAMS_DASHBOARD_MICROFRONTEND_URL">EXAMS_DASHBOARD_MICROFRONTEND_URL</title>
<paragraph ids="default-EXAMS_DASHBOARD_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-EXAMS_DASHBOARD_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5043">common.py (line 5043)</reference></paragraph>
<paragraph ids="description-EXAMS_DASHBOARD_MICROFRONTEND_URL">Base URL of the exams dashboard micro-frontend for instructors.</paragraph>
</section>
<section ids="setting-GRADEBOOK_FREEZE_DAYS">
<title ids="title-GRADEBOOK_FREEZE_DAYS">GRADEBOOK_FREEZE_DAYS</title>
<paragraph ids="default-GRADEBOOK_FREEZE_DAYS">Default: <literal>30</literal></paragraph>
<paragraph ids="source-GRADEBOOK_FREEZE_DAYS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1096">common.py (line 1096)</reference></paragraph>
<paragraph ids="description-GRADEBOOK_FREEZE_DAYS">Sets the number of days after which the gradebook will freeze following the course’s end.</paragraph>
</section>
<section ids="setting-LEARNING_MICROFRONTEND_URL">
<title ids="title-LEARNING_MICROFRONTEND_URL">LEARNING_MICROFRONTEND_URL</title>
<paragraph ids="default-LEARNING_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-LEARNING_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5016">common.py (line 5016)</reference></paragraph>
<paragraph ids="description-LEARNING_MICROFRONTEND_URL">Base URL of the micro-frontend-based courseware page.</paragraph>
</section>
<section ids="setting-LOGIN_REDIRECT_WHITELIST">
<title ids="title-LOGIN_REDIRECT_WHITELIST">LOGIN_REDIRECT_WHITELIST</title>
<paragraph ids="default-LOGIN_REDIRECT_WHITELIST">Default: <literal>"empty list ([])"</literal></paragraph>
<paragraph ids="source-LOGIN_REDIRECT_WHITELIST">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3693">common.py (line 3693)</reference></paragraph>
<paragraph ids="description-LOGIN_REDIRECT_WHITELIST">While logout, if logout request has a redirect-url as query strings,
then the redirect-url is validated through LOGIN_REDIRECT_WHITELIST.</paragraph>
</section>
<section ids="setting-MAINTENANCE_BANNER_TEXT">
<title ids="title-MAINTENANCE_BANNER_TEXT">MAINTENANCE_BANNER_TEXT</title>
<paragraph ids="default-MAINTENANCE_BANNER_TEXT">Default: <literal>"'Sample banner message'"</literal></paragraph>
<paragraph ids="source-MAINTENANCE_BANNER_TEXT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1487">common.py (line 1487)</reference></paragraph>
<paragraph ids="description-MAINTENANCE_BANNER_TEXT">Specifies the text that is rendered on the maintenance banner.</paragraph>
<warning ids="warning-MAINTENANCE_BANNER_TEXT">
<paragraph>Depends on the `open_edx_util.display_maintenance_warning` waffle switch.
The banner is only rendered when the switch is activated.</paragraph>
</warning>
</section>
<section ids="setting-MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED">
<title ids="title-MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED">MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED</title>
<paragraph ids="default-MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED">Default: <literal>6</literal></paragraph>
<paragraph ids="source-MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3826">common.py (line 3826)</reference></paragraph>
<paragraph ids="description-MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED">Specifies the maximum failed login attempts allowed to users. Once the user reaches this
failure threshold then the account will be locked for a configurable amount of seconds (30 minutes) which will
prevent additional login attempts until this time period has passed. This setting is related with
MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS and only used when ENABLE_MAX_FAILED_LOGIN_ATTEMPTS is enabled.</paragraph>
</section>
<section ids="setting-MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS">
<title ids="title-MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS">MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS</title>
<paragraph ids="default-MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS">Default: <literal>"30 * 60"</literal></paragraph>
<paragraph ids="source-MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3835">common.py (line 3835)</reference></paragraph>
<paragraph ids="description-MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS">Specifies the lockout period in seconds for consecutive failed login attempts. Once the user
reaches the threshold of the login failure, then the account will be locked for the given amount of seconds
(30 minutes) which will prevent additional login attempts until this time period has passed. This setting is
related with MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED and only used when ENABLE_MAX_FAILED_LOGIN_ATTEMPTS is enabled.</paragraph>
</section>
<section ids="setting-MFE_CONFIG">
<title ids="title-MFE_CONFIG">MFE_CONFIG</title>
<paragraph ids="default-MFE_CONFIG">Default: <literal>"{}"</literal></paragraph>
<paragraph ids="source-MFE_CONFIG">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5303">common.py (line 5303)</reference></paragraph>
<paragraph ids="description-MFE_CONFIG">Is a configuration that will be exposed by the MFE Config API to be consumed by the MFEs.
Contains configuration common to all MFEs. When a specific MFE’s configuration is requested, these values
will be treated as a base and then overriden/supplemented by those in `MFE_CONFIG_OVERRIDES`.
Example: {
“BASE_URL”: “https://name_of_mfe.example.com”,
“LANGUAGE_PREFERENCE_COOKIE_NAME”: “example-language-preference”,
“CREDENTIALS_BASE_URL”: “https://credentials.example.com”,
“DISCOVERY_API_BASE_URL”: “https://discovery.example.com”,
“LMS_BASE_URL”: “https://courses.example.com”,
“LOGIN_URL”: “https://courses.example.com/login”,
“LOGOUT_URL”: “https://courses.example.com/logout”,
“STUDIO_BASE_URL”: “https://studio.example.com”,
“LOGO_URL”: “https://courses.example.com/logo.png”
}</paragraph>
</section>
<section ids="setting-MFE_CONFIG_API_CACHE_TIMEOUT">
<title ids="title-MFE_CONFIG_API_CACHE_TIMEOUT">MFE_CONFIG_API_CACHE_TIMEOUT</title>
<paragraph ids="default-MFE_CONFIG_API_CACHE_TIMEOUT">Default: <literal>"60*5"</literal></paragraph>
<paragraph ids="source-MFE_CONFIG_API_CACHE_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5343">common.py (line 5343)</reference></paragraph>
<paragraph ids="description-MFE_CONFIG_API_CACHE_TIMEOUT">The MFE Config API response will be cached during the
specified time</paragraph>
</section>
<section ids="setting-MFE_CONFIG_OVERRIDES">
<title ids="title-MFE_CONFIG_OVERRIDES">MFE_CONFIG_OVERRIDES</title>
<paragraph ids="default-MFE_CONFIG_OVERRIDES">Default: <literal>"{}"</literal></paragraph>
<paragraph ids="source-MFE_CONFIG_OVERRIDES">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5324">common.py (line 5324)</reference></paragraph>
<paragraph ids="description-MFE_CONFIG_OVERRIDES">Overrides or additions to `MFE_CONFIG` for when a specific MFE is requested
by the MFE Config API. Top-level keys are APP_IDs, a.k.a. the name of the MFE (for example,
for an MFE named “frontend-app-xyz”, the top-level key would be “xyz”).
Example: {
“gradebook”: {
“BASE_URL”: “https://gradebook.example.com”,
},
“profile”: {
“BASE_URL”: “https://profile.example.com”,
“ENABLE_LEARNER_RECORD_MFE”: “true”,
},
}</paragraph>
</section>
<section ids="setting-ORA_GRADING_MICROFRONTEND_URL">
<title ids="title-ORA_GRADING_MICROFRONTEND_URL">ORA_GRADING_MICROFRONTEND_URL</title>
<paragraph ids="default-ORA_GRADING_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-ORA_GRADING_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5020">common.py (line 5020)</reference></paragraph>
<paragraph ids="description-ORA_GRADING_MICROFRONTEND_URL">Base URL of the micro-frontend-based openassessment grading page.
This is will be show in the open response tab list data.</paragraph>
<warning ids="warning-ORA_GRADING_MICROFRONTEND_URL">
<paragraph>Also set site’s openresponseassessment.enhanced_staff_grader
waffle flag.</paragraph>
</warning>
</section>
<section ids="setting-ORA_MICROFRONTEND_URL">
<title ids="title-ORA_MICROFRONTEND_URL">ORA_MICROFRONTEND_URL</title>
<paragraph ids="default-ORA_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-ORA_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5027">common.py (line 5027)</reference></paragraph>
<paragraph ids="description-ORA_MICROFRONTEND_URL">Base URL for modern openassessment app.
This is will be show in the open response tab list data.</paragraph>
<warning ids="warning-ORA_MICROFRONTEND_URL">
<paragraph>Also set site’s openresponseassessment.mfe_views
waffle flag.</paragraph>
</warning>
</section>
<section ids="setting-PLATFORM_NAME">
<title ids="title-PLATFORM_NAME">PLATFORM_NAME</title>
<paragraph ids="default-PLATFORM_NAME">Default: <literal>"Your Platform Name Here"</literal></paragraph>
<paragraph ids="source-PLATFORM_NAME">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L74">common.py (line 74)</reference></paragraph>
<paragraph ids="description-PLATFORM_NAME">The display name of the platform to be used in
templates/emails/etc.</paragraph>
</section>
<section ids="setting-PREPEND_LOCALE_PATHS">
<title ids="title-PREPEND_LOCALE_PATHS">PREPEND_LOCALE_PATHS</title>
<paragraph ids="default-PREPEND_LOCALE_PATHS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-PREPEND_LOCALE_PATHS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4575">common.py (line 4575)</reference></paragraph>
<paragraph ids="description-PREPEND_LOCALE_PATHS">A list of the paths to locale directories to load first e.g.
“PREPEND_LOCALE_PATHS” : [“/edx/my-locales/”].</paragraph>
</section>
<section ids="setting-PROFILE_MICROFRONTEND_URL">
<title ids="title-PROFILE_MICROFRONTEND_URL">PROFILE_MICROFRONTEND_URL</title>
<paragraph ids="default-PROFILE_MICROFRONTEND_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-PROFILE_MICROFRONTEND_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5000">common.py (line 5000)</reference></paragraph>
<paragraph ids="description-PROFILE_MICROFRONTEND_URL">Base URL of the micro-frontend-based profile page.</paragraph>
<warning ids="warning-PROFILE_MICROFRONTEND_URL">
<paragraph>Also set site’s ENABLE_PROFILE_MICROFRONTEND and
learner_profile.redirect_to_microfrontend waffle flag</paragraph>
</warning>
</section>
<section ids="setting-RATELIMIT_RATE">
<title ids="title-RATELIMIT_RATE">RATELIMIT_RATE</title>
<paragraph ids="default-RATELIMIT_RATE">Default: <literal>"120/m"</literal></paragraph>
<paragraph ids="source-RATELIMIT_RATE">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4862">common.py (line 4862)</reference></paragraph>
<paragraph ids="description-RATELIMIT_RATE">Due to some reports about attack on /oauth2/access_token/ which took LMS down,
this setting was introduced to rate-limit all endpoints of AccessTokenView up to
120 requests per IP Address in a minute by default.</paragraph>
<warning ids="warning-RATELIMIT_RATE">
<paragraph>RATELIMIT_ENABLE flag must also be enabled/set to True to use this RATELIMIT_RATE setting.</paragraph>
</warning>
</section>
<section ids="setting-REGISTRATION_EXTRA_FIELDS">
<title ids="title-REGISTRATION_EXTRA_FIELDS">REGISTRATION_EXTRA_FIELDS</title>
<paragraph ids="default-REGISTRATION_EXTRA_FIELDS">Default: <literal>"{'confirm_email': 'hidden', 'level_of_education': 'optional', 'gender': 'optional',
'year_of_birth': 'optional', 'mailing_address': 'optional', 'goals': 'optional', 'honor_code': 'required',
'terms_of_service': 'hidden', 'city': 'hidden', 'country': 'hidden'}"</literal></paragraph>
<paragraph ids="source-REGISTRATION_EXTRA_FIELDS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3701">common.py (line 3701)</reference></paragraph>
<paragraph ids="description-REGISTRATION_EXTRA_FIELDS">The signup form may contain extra fields that are presented to every user. For every field, we
can specifiy whether it should be “required”: to display the field, and make it mandatory; “optional”: to display
the optional field as part of a toggled input field list; “optional-exposed”: to display the optional fields among
the required fields, and make it non-mandatory; “hidden”: to not display the field.
When the terms of service are not visible and agreement to the honor code is required (the default), the signup page
includes a paragraph that links to the honor code page (defined my MKTG_URLS[“HONOR”]). This page might not be
available for all Open edX platforms. In such cases, the “honor_code” registration field should be “hidden”.</paragraph>
</section>
<section ids="setting-REGISTRATION_RATELIMIT">
<title ids="title-REGISTRATION_RATELIMIT">REGISTRATION_RATELIMIT</title>
<paragraph ids="default-REGISTRATION_RATELIMIT">Default: <literal>"60/7d"</literal></paragraph>
<paragraph ids="source-REGISTRATION_RATELIMIT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3447">common.py (line 3447)</reference></paragraph>
<paragraph ids="description-REGISTRATION_RATELIMIT">New users are registered on edx via RegistrationView.
It’s POST end-point is rate-limited up to 60 requests per IP Address in a week by default.
Purpose of this setting is to restrict an attacker from registering numerous fake accounts.</paragraph>
</section>
<section ids="setting-REGISTRATION_VALIDATION_RATELIMIT">
<title ids="title-REGISTRATION_VALIDATION_RATELIMIT">REGISTRATION_VALIDATION_RATELIMIT</title>
<paragraph ids="default-REGISTRATION_VALIDATION_RATELIMIT">Default: <literal>"30/7d"</literal></paragraph>
<paragraph ids="source-REGISTRATION_VALIDATION_RATELIMIT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3438">common.py (line 3438)</reference></paragraph>
<paragraph ids="description-REGISTRATION_VALIDATION_RATELIMIT">Whenever a user tries to register on edx, the data entered during registration
is validated via RegistrationValidationView.
It’s POST endpoint is rate-limited up to 30 requests per IP Address in a week by default.
It was introduced because an attacker can guess or brute force a series of names to enumerate valid users.</paragraph>
</section>
<section ids="setting-RETIRED_EMAIL_DOMAIN">
<title ids="title-RETIRED_EMAIL_DOMAIN">RETIRED_EMAIL_DOMAIN</title>
<paragraph ids="default-RETIRED_EMAIL_DOMAIN">Default: <literal>"retired.invalid"</literal></paragraph>
<paragraph ids="source-RETIRED_EMAIL_DOMAIN">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4907">common.py (line 4907)</reference></paragraph>
<paragraph ids="description-RETIRED_EMAIL_DOMAIN">Set the domain part of hashed emails for retired users. Used by the derived
setting RETIRED_EMAIL_FMT.</paragraph>
</section>
<section ids="setting-RETIRED_EMAIL_FMT">
<title ids="title-RETIRED_EMAIL_FMT">RETIRED_EMAIL_FMT</title>
<paragraph ids="default-RETIRED_EMAIL_FMT">Default: <literal>"retired__user_{}@retired.invalid"</literal></paragraph>
<paragraph ids="source-RETIRED_EMAIL_FMT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4918">common.py (line 4918)</reference></paragraph>
<paragraph ids="description-RETIRED_EMAIL_FMT">Set the format a retired user email field gets transformed into, where {} is
replaced with the hash of the original email. This is a derived setting that depends on
RETIRED_EMAIL_PREFIX and RETIRED_EMAIL_DOMAIN values.</paragraph>
</section>
<section ids="setting-RETIRED_EMAIL_PREFIX">
<title ids="title-RETIRED_EMAIL_PREFIX">RETIRED_EMAIL_PREFIX</title>
<paragraph ids="default-RETIRED_EMAIL_PREFIX">Default: <literal>"retired__user_"</literal></paragraph>
<paragraph ids="source-RETIRED_EMAIL_PREFIX">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4902">common.py (line 4902)</reference></paragraph>
<paragraph ids="description-RETIRED_EMAIL_PREFIX">Set the prefix part of hashed emails for retired users. Used by the derived
setting RETIRED_EMAIL_FMT.</paragraph>
</section>
<section ids="setting-RETIRED_USERNAME_FMT">
<title ids="title-RETIRED_USERNAME_FMT">RETIRED_USERNAME_FMT</title>
<paragraph ids="default-RETIRED_USERNAME_FMT">Default: <literal>"retired__user_{}"</literal></paragraph>
<paragraph ids="source-RETIRED_USERNAME_FMT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4912">common.py (line 4912)</reference></paragraph>
<paragraph ids="description-RETIRED_USERNAME_FMT">Set the format a retired user username field gets transformed into, where {}
is replaced with the hash of the original username. This is a derived setting that depends on
RETIRED_USERNAME_PREFIX value.</paragraph>
</section>
<section ids="setting-RETIRED_USERNAME_PREFIX">
<title ids="title-RETIRED_USERNAME_PREFIX">RETIRED_USERNAME_PREFIX</title>
<paragraph ids="default-RETIRED_USERNAME_PREFIX">Default: <literal>"retired__user_"</literal></paragraph>
<paragraph ids="source-RETIRED_USERNAME_PREFIX">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4896">common.py (line 4896)</reference></paragraph>
<paragraph ids="description-RETIRED_USERNAME_PREFIX">Set the prefix part of hashed usernames for retired users. Used by the derived
setting RETIRED_USERNAME_FMT.</paragraph>
</section>
<section ids="setting-RETIRED_USER_SALTS">
<title ids="title-RETIRED_USER_SALTS">RETIRED_USER_SALTS</title>
<paragraph ids="default-RETIRED_USER_SALTS">Default: <literal>"['abc', '123']"</literal></paragraph>
<paragraph ids="source-RETIRED_USER_SALTS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4925">common.py (line 4925)</reference></paragraph>
<paragraph ids="description-RETIRED_USER_SALTS">Set a list of salts used for hashing usernames and emails on users retirement.</paragraph>
<warning ids="warning-RETIRED_USER_SALTS">
<paragraph>Only the last item in this list is used as a salt for all new retirements, but
historical salts are preserved in order to guarantee that all hashed usernames and emails can still
be checked.</paragraph>
</warning>
</section>
<section ids="setting-RETIREMENT_SERVICE_WORKER_USERNAME">
<title ids="title-RETIREMENT_SERVICE_WORKER_USERNAME">RETIREMENT_SERVICE_WORKER_USERNAME</title>
<paragraph ids="default-RETIREMENT_SERVICE_WORKER_USERNAME">Default: <literal>"RETIREMENT_SERVICE_USER"</literal></paragraph>
<paragraph ids="source-RETIREMENT_SERVICE_WORKER_USERNAME">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4932">common.py (line 4932)</reference></paragraph>
<paragraph ids="description-RETIREMENT_SERVICE_WORKER_USERNAME">Set the username of the retirement service worker user. Retirement scripts
authenticate with LMS as this user with oauth client credentials.</paragraph>
</section>
<section ids="setting-RETIREMENT_STATES">
<title ids="title-RETIREMENT_STATES">RETIREMENT_STATES</title>
<paragraph ids="default-RETIREMENT_STATES">Default: <literal>"[
'PENDING',
'LOCKING_ACCOUNT',
'LOCKING_COMPLETE',
'RETIRING_FORUMS',
'FORUMS_COMPLETE',
'RETIRING_EMAIL_LISTS',
'EMAIL_LISTS_COMPLETE',
'RETIRING_ENROLLMENTS',
'ENROLLMENTS_COMPLETE',
'RETIRING_NOTES',
'NOTES_COMPLETE',
'RETIRING_LMS',
'LMS_COMPLETE',
'ERRORED',
'ABORTED',
'COMPLETE',
]"</literal></paragraph>
<paragraph ids="source-RETIREMENT_STATES">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L4938">common.py (line 4938)</reference></paragraph>
<paragraph ids="description-RETIREMENT_STATES">Set a list that defines the name and order of states for the retirement
workflow.</paragraph>
<warning ids="warning-RETIREMENT_STATES">
<paragraph>These states are stored in the database and it is the responsibility of the
administrator to populate the state list since the states can vary across different installations.
There must be, at minimum, a PENDING state at the beginning, and COMPLETED, ERRORED, and ABORTED
states at the end of the list.</paragraph>
</warning>
</section>
<section ids="setting-SECURITY_PAGE_URL">
<title ids="title-SECURITY_PAGE_URL">SECURITY_PAGE_URL</title>
<paragraph ids="default-SECURITY_PAGE_URL">Default: <literal>None</literal></paragraph>
<paragraph ids="source-SECURITY_PAGE_URL">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L3497">common.py (line 3497)</reference></paragraph>
<paragraph ids="description-SECURITY_PAGE_URL">A link to the site’s security disclosure/reporting policy,
to display in the site footer. This will only appear for sites using themes that
use the links produced by ``lms.djangoapps.branding.api.get_footer``.</paragraph>
</section>
<section ids="setting-SURVEY_REPORT_CHECK_THRESHOLD">
<title ids="title-SURVEY_REPORT_CHECK_THRESHOLD">SURVEY_REPORT_CHECK_THRESHOLD</title>
<paragraph ids="default-SURVEY_REPORT_CHECK_THRESHOLD">Default: <literal>"every 6 months"</literal></paragraph>
<paragraph ids="source-SURVEY_REPORT_CHECK_THRESHOLD">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5525">common.py (line 5525)</reference></paragraph>
<paragraph ids="description-SURVEY_REPORT_CHECK_THRESHOLD">Survey report banner will appear if a survey report is not sent in the months defined.</paragraph>
</section>
<section ids="setting-SURVEY_REPORT_ENDPOINT">
<title ids="title-SURVEY_REPORT_ENDPOINT">SURVEY_REPORT_ENDPOINT</title>
<paragraph ids="default-SURVEY_REPORT_ENDPOINT">Default: <literal>"Open edX organization endpoint"</literal></paragraph>
<paragraph ids="source-SURVEY_REPORT_ENDPOINT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5514">common.py (line 5514)</reference></paragraph>
<paragraph ids="description-SURVEY_REPORT_ENDPOINT">Endpoint where the report will be sent.</paragraph>
</section>
<section ids="setting-SURVEY_REPORT_EXTRA_DATA">
<title ids="title-SURVEY_REPORT_EXTRA_DATA">SURVEY_REPORT_EXTRA_DATA</title>
<paragraph ids="default-SURVEY_REPORT_EXTRA_DATA">Default: <literal>"empty dictionary"</literal></paragraph>
<paragraph ids="source-SURVEY_REPORT_EXTRA_DATA">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L5529">common.py (line 5529)</reference></paragraph>
<paragraph ids="description-SURVEY_REPORT_EXTRA_DATA">Dictionary with additional information that you want to share in the report.</paragraph>
</section>
<section ids="setting-WEBPACK_CONFIG_PATH">
<title ids="title-WEBPACK_CONFIG_PATH">WEBPACK_CONFIG_PATH</title>
<paragraph ids="default-WEBPACK_CONFIG_PATH">Default: <literal>""webpack.prod.config.js""</literal></paragraph>
<paragraph ids="source-WEBPACK_CONFIG_PATH">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L2827">common.py (line 2827)</reference></paragraph>
<paragraph ids="description-WEBPACK_CONFIG_PATH">Path to the Webpack configuration file. Used by Paver scripts.</paragraph>
<warning ids="warning-WEBPACK_CONFIG_PATH">
<paragraph>This Django setting is DEPRECATED! Starting in Sumac, Webpack will no longer
use Django settings. Please set the WEBPACK_CONFIG_PATH environment variable instead. For details,
see: https://github.com/openedx/edx-platform/issues/31895</paragraph>
</warning>
</section>
<section ids="setting-XBLOCK_EXTRA_MIXINS">
<title ids="title-XBLOCK_EXTRA_MIXINS">XBLOCK_EXTRA_MIXINS</title>
<paragraph ids="default-XBLOCK_EXTRA_MIXINS">Default: <literal>"()"</literal></paragraph>
<paragraph ids="source-XBLOCK_EXTRA_MIXINS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1667">common.py (line 1667)</reference></paragraph>
<paragraph ids="description-XBLOCK_EXTRA_MIXINS">Custom mixins that will be dynamically added to every XBlock and XBlockAside instance.
These can be classes or dotted-path references to classes.
For example: `XBLOCK_EXTRA_MIXINS = (‘my_custom_package.my_module.MyCustomMixin’,)`</paragraph>
</section>
<section ids="setting-XBLOCK_FIELD_DATA_WRAPPERS">
<title ids="title-XBLOCK_FIELD_DATA_WRAPPERS">XBLOCK_FIELD_DATA_WRAPPERS</title>
<paragraph ids="default-XBLOCK_FIELD_DATA_WRAPPERS">Default: <literal>"()"</literal></paragraph>
<paragraph ids="source-XBLOCK_FIELD_DATA_WRAPPERS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1674">common.py (line 1674)</reference></paragraph>
<paragraph ids="description-XBLOCK_FIELD_DATA_WRAPPERS">Paths to wrapper methods which should be applied to every XBlock’s FieldData.</paragraph>
</section>
<section ids="setting-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">
<title ids="title-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE</title>
<paragraph ids="default-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">Default: <literal>"default"</literal></paragraph>
<paragraph ids="source-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1690">common.py (line 1690)</reference></paragraph>
<paragraph ids="description-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">The django cache key of the cache to use for storing anonymous user state for XBlocks.</paragraph>
</section>
<section ids="setting-XBLOCK_SETTINGS">
<title ids="title-XBLOCK_SETTINGS">XBLOCK_SETTINGS</title>
<paragraph ids="default-XBLOCK_SETTINGS">Default: <literal>"{}"</literal></paragraph>
<paragraph ids="source-XBLOCK_SETTINGS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/lms/envs/common.py#L1682">common.py (line 1682)</reference></paragraph>
<paragraph ids="description-XBLOCK_SETTINGS">Dictionary containing server-wide configuration of XBlocks on a per-type basis.
By default, keys should match the XBlock `block_settings_key` attribute/property. If the attribute/property
is not defined, use the XBlock class name. Check `xmodule.services.SettingsService`
for more reference.</paragraph>
</section>
</section>
<section ids="cms-settings" names="cms\ settings">
<title>CMS settings</title>
<section ids="setting-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">
<title ids="title-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">Default: <literal>0.5</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1194">common.py (line 1194)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT">Set the number of seconds CMS will wait to establish an internal
connection to the codejail remote service.</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_HOST">
<title ids="title-CODE_JAIL_REST_SERVICE_HOST">CODE_JAIL_REST_SERVICE_HOST</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_HOST">Default: <literal>"'http://127.0.0.1:8550'"</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_HOST">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1190">common.py (line 1190)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_HOST">Set the codejail remote service host</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">
<title ids="title-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">CODE_JAIL_REST_SERVICE_READ_TIMEOUT</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">Default: <literal>3.5</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1198">common.py (line 1198)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_READ_TIMEOUT">Set the number of seconds CMS will wait for a response from the
codejail remote service endpoint.</paragraph>
</section>
<section ids="setting-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">
<title ids="title-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">CODE_JAIL_REST_SERVICE_REMOTE_EXEC</title>
<paragraph ids="default-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">Default: <literal>"'xmodule.capa.safe_exec.remote_exec.send_safe_exec_request_v0'"</literal></paragraph>
<paragraph ids="source-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1185">common.py (line 1185)</reference></paragraph>
<paragraph ids="description-CODE_JAIL_REST_SERVICE_REMOTE_EXEC">Set the python package.module.function that is reponsible of
calling the remote service in charge of jailed code execution</paragraph>
</section>
<section ids="setting-COMPREHENSIVE_THEME_DIRS">
<title ids="title-COMPREHENSIVE_THEME_DIRS">COMPREHENSIVE_THEME_DIRS</title>
<paragraph ids="default-COMPREHENSIVE_THEME_DIRS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-COMPREHENSIVE_THEME_DIRS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2188">common.py (line 2188)</reference></paragraph>
<paragraph ids="description-COMPREHENSIVE_THEME_DIRS">A list of paths to directories, each of which will
be searched for comprehensive themes. Do not override this Django setting directly.
Instead, set the COMPREHENSIVE_THEME_DIRS environment variable, using colons (:) to
separate paths.</paragraph>
</section>
<section ids="setting-COMPREHENSIVE_THEME_LOCALE_PATHS">
<title ids="title-COMPREHENSIVE_THEME_LOCALE_PATHS">COMPREHENSIVE_THEME_LOCALE_PATHS</title>
<paragraph ids="default-COMPREHENSIVE_THEME_LOCALE_PATHS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-COMPREHENSIVE_THEME_LOCALE_PATHS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2196">common.py (line 2196)</reference></paragraph>
<paragraph ids="description-COMPREHENSIVE_THEME_LOCALE_PATHS">See LMS annotation.
“COMPREHENSIVE_THEME_LOCALE_PATHS” : [“/edx/src/edx-themes/conf/locale”].</paragraph>
</section>
<section ids="setting-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">
<title ids="title-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">CUSTOM_RESOURCE_TEMPLATES_DIRECTORY</title>
<paragraph ids="default-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">Default: <literal>None</literal></paragraph>
<paragraph ids="source-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2221">common.py (line 2221)</reference></paragraph>
<paragraph ids="description-CUSTOM_RESOURCE_TEMPLATES_DIRECTORY">Path to an existing directory of YAML files containing
html content to be used with the subclasses of xmodule.x_module.ResourceTemplates.
Default example templates can be found in xmodule/templates/html.
Note that the extension used is “.yaml” and not “.yml”.
See xmodule.x_module.ResourceTemplates for usage.
“CUSTOM_RESOURCE_TEMPLATES_DIRECTORY” : null</paragraph>
</section>
<section ids="setting-DEFAULT_GRADE_DESIGNATIONS">
<title ids="title-DEFAULT_GRADE_DESIGNATIONS">DEFAULT_GRADE_DESIGNATIONS</title>
<paragraph ids="default-DEFAULT_GRADE_DESIGNATIONS">Default: <literal>"['A', 'B', 'C', 'D']"</literal></paragraph>
<paragraph ids="source-DEFAULT_GRADE_DESIGNATIONS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2430">common.py (line 2430)</reference></paragraph>
<paragraph ids="description-DEFAULT_GRADE_DESIGNATIONS">The default ‘pass’ grade cutoff designations to be used. The failure grade
is always ‘F’ and should not be included in this list.</paragraph>
<warning ids="warning-DEFAULT_GRADE_DESIGNATIONS">
<paragraph>The DEFAULT_GRADE_DESIGNATIONS list must have more than one designation,
or else [‘A’, ‘B’, ‘C’, ‘D’] will be used as the default grade designations. Also, only the first
11 grade designations are used by the UI, so it’s advisable to restrict the list to 11 items.</paragraph>
</warning>
</section>
<section ids="setting-DEFAULT_SITE_THEME">
<title ids="title-DEFAULT_SITE_THEME">DEFAULT_SITE_THEME</title>
<paragraph ids="default-DEFAULT_SITE_THEME">Default: <literal>None</literal></paragraph>
<paragraph ids="source-DEFAULT_SITE_THEME">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2208">common.py (line 2208)</reference></paragraph>
<paragraph ids="description-DEFAULT_SITE_THEME">See LMS annotation.</paragraph>
</section>
<section ids="setting-DISABLED_COUNTRIES">
<title ids="title-DISABLED_COUNTRIES">DISABLED_COUNTRIES</title>
<paragraph ids="default-DISABLED_COUNTRIES">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-DISABLED_COUNTRIES">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2940">common.py (line 2940)</reference></paragraph>
<paragraph ids="description-DISABLED_COUNTRIES">List of country codes that should be disabled</paragraph>
</section>
<section ids="setting-EVENT_BUS_PRODUCER_CONFIG">
<title ids="title-EVENT_BUS_PRODUCER_CONFIG">EVENT_BUS_PRODUCER_CONFIG</title>
<paragraph ids="default-EVENT_BUS_PRODUCER_CONFIG">Default: <literal>"all events disabled"</literal></paragraph>
<paragraph ids="source-EVENT_BUS_PRODUCER_CONFIG">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2834">common.py (line 2834)</reference></paragraph>
<paragraph ids="description-EVENT_BUS_PRODUCER_CONFIG">Dictionary of event_types mapped to dictionaries of topic to topic-related configuration.
Each topic configuration dictionary contains
* `enabled`: a toggle denoting whether the event will be published to the topic. These should be annotated
according to
https://edx.readthedocs.io/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html
* `event_key_field` which is a period-delimited string path to event data field to use as event key.
Note: The topic names should not include environment prefix as it will be dynamically added based on
EVENT_BUS_TOPIC_PREFIX setting.</paragraph>
</section>
<section ids="setting-GIT_EXPORT_DEFAULT_IDENT">
<title ids="title-GIT_EXPORT_DEFAULT_IDENT">GIT_EXPORT_DEFAULT_IDENT</title>
<paragraph ids="default-GIT_EXPORT_DEFAULT_IDENT">Default: <literal>"{'name': 'STUDIO_EXPORT_TO_GIT', 'email': '[email protected]'}"</literal></paragraph>
<paragraph ids="source-GIT_EXPORT_DEFAULT_IDENT">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1237">common.py (line 1237)</reference></paragraph>
<paragraph ids="description-GIT_EXPORT_DEFAULT_IDENT">When courses are exported to git, commits are signed with this name/email git identity.</paragraph>
</section>
<section ids="setting-GIT_REPO_EXPORT_DIR">
<title ids="title-GIT_REPO_EXPORT_DIR">GIT_REPO_EXPORT_DIR</title>
<paragraph ids="default-GIT_REPO_EXPORT_DIR">Default: <literal>"'/edx/var/edxapp/export_course_repos'"</literal></paragraph>
<paragraph ids="source-GIT_REPO_EXPORT_DIR">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1231">common.py (line 1231)</reference></paragraph>
<paragraph ids="description-GIT_REPO_EXPORT_DIR">When courses are exported to git, either with the export_git management command or the git
export view from the studio (when FEATURES[‘ENABLE_EXPORT_GIT’] is True), they are stored in this directory, which
must exist at the time of the export.</paragraph>
</section>
<section ids="setting-JS_ENV_EXTRA_CONFIG">
<title ids="title-JS_ENV_EXTRA_CONFIG">JS_ENV_EXTRA_CONFIG</title>
<paragraph ids="default-JS_ENV_EXTRA_CONFIG">Default: <literal>"{}"</literal></paragraph>
<paragraph ids="source-JS_ENV_EXTRA_CONFIG">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1318">common.py (line 1318)</reference></paragraph>
<paragraph ids="description-JS_ENV_EXTRA_CONFIG">JavaScript code can access this dictionary using `process.env.JS_ENV_EXTRA_CONFIG`
One of the current use cases for this is enabling custom TinyMCE plugins
(TINYMCE_ADDITIONAL_PLUGINS) and overriding the TinyMCE configuration (TINYMCE_CONFIG_OVERRIDES).</paragraph>
<warning ids="warning-JS_ENV_EXTRA_CONFIG">
<paragraph>This Django setting is DEPRECATED! Starting in Sumac, Webpack will no longer
use Django settings. Please set the JS_ENV_EXTRA_CONFIG environment variable to an equivalent JSON
string instead. For details, see: https://github.com/openedx/edx-platform/issues/31895</paragraph>
</warning>
</section>
<section ids="setting-PREPEND_LOCALE_PATHS">
<title ids="title-PREPEND_LOCALE_PATHS">PREPEND_LOCALE_PATHS</title>
<paragraph ids="default-PREPEND_LOCALE_PATHS">Default: <literal>"[]"</literal></paragraph>
<paragraph ids="source-PREPEND_LOCALE_PATHS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L2202">common.py (line 2202)</reference></paragraph>
<paragraph ids="description-PREPEND_LOCALE_PATHS">A list of the paths to locale directories to load first e.g.
“PREPEND_LOCALE_PATHS” : [“/edx/my-locales/”].</paragraph>
</section>
<section ids="setting-STUDIO_NAME">
<title ids="title-STUDIO_NAME">STUDIO_NAME</title>
<paragraph ids="default-STUDIO_NAME">Default: <literal>"Your Platform Studio"</literal></paragraph>
<paragraph ids="source-STUDIO_NAME">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L177">common.py (line 177)</reference></paragraph>
<paragraph ids="description-STUDIO_NAME">The name that will appear on the landing page of Studio, as well as in various emails and
templates.</paragraph>
</section>
<section ids="setting-WEBPACK_CONFIG_PATH">
<title ids="title-WEBPACK_CONFIG_PATH">WEBPACK_CONFIG_PATH</title>
<paragraph ids="default-WEBPACK_CONFIG_PATH">Default: <literal>""webpack.prod.config.js""</literal></paragraph>
<paragraph ids="source-WEBPACK_CONFIG_PATH">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1509">common.py (line 1509)</reference></paragraph>
<paragraph ids="description-WEBPACK_CONFIG_PATH">Path to the Webpack configuration file. Used by Paver scripts.</paragraph>
<warning ids="warning-WEBPACK_CONFIG_PATH">
<paragraph>This Django setting is DEPRECATED! Starting in Sumac, Webpack will no longer
use Django settings. Please set the WEBPACK_CONFIG_PATH environment variable instead. For details,
see: https://github.com/openedx/edx-platform/issues/31895</paragraph>
</warning>
</section>
<section ids="setting-XBLOCK_EXTRA_MIXINS">
<title ids="title-XBLOCK_EXTRA_MIXINS">XBLOCK_EXTRA_MIXINS</title>
<paragraph ids="default-XBLOCK_EXTRA_MIXINS">Default: <literal>"()"</literal></paragraph>
<paragraph ids="source-XBLOCK_EXTRA_MIXINS">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1003">common.py (line 1003)</reference></paragraph>
<paragraph ids="description-XBLOCK_EXTRA_MIXINS">Custom mixins that will be dynamically added to every XBlock and XBlockAside instance.
These can be classes or dotted-path references to classes.
For example: `XBLOCK_EXTRA_MIXINS = (‘my_custom_package.my_module.MyCustomMixin’,)`</paragraph>
</section>
<section ids="setting-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">
<title ids="title-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE</title>
<paragraph ids="default-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">Default: <literal>"default"</literal></paragraph>
<paragraph ids="source-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">Source: <reference refuri="https://github.com/openedx/edx-platform/blob/a63a6a6fbaec6bf1c234b9b26b66c7b50c00e336/cms/envs/common.py#L1013">common.py (line 1013)</reference></paragraph>
<paragraph ids="description-XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE">The django cache key of the cache to use for storing anonymous user state for XBlocks.</paragraph>
</section>
</section>
</section>
</document>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment