Settings

This is the list of (non-toggle) Django settings defined in the common.py modules of edx-platform.

Note

Toggle settings, which enable or disable a specific feature, are documented in the feature toggles section.

LMS settings

ACCOUNT_MICROFRONTEND_URL

Default: None

Source: common.py (line 4720)

Base URL of the micro-frontend-based account settings page.

Warning

Also set site’s ENABLE_ACCOUNT_MICROFRONTEND and account.redirect_to_microfrontend waffle flag

BADGING_BACKEND

Default: "'lms.djangoapps.badges.backends.badgr.BadgrBackend'"

Source: common.py (line 3513)

The backend service class (or callable) for creating OpenBadges. It must implement the interface provided by lms.djangoapps.badges.backends.base.BadgeBackend

Warning

Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BADGR_BASE_URL

Default: "'http://localhost:8005'"

Source: common.py (line 3520)

The base URL for the Badgr server.

Warning

DO NOT include a trailing slash. Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BADGR_ISSUER_SLUG

Default: "'example-issuer'"

Source: common.py (line 3526)

A string that is the slug for the Badgr issuer. The slug can be obtained from the URL of the Badgr Server page that displays the issuer. For example, in the URL http://exampleserver.com/issuer/test-issuer, the issuer slug is “test-issuer”.

Warning

Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BADGR_PASSWORD

Default: None

Source: common.py (line 3542)

The password for Badgr. You should set up an issuer application with Badgr (https://badgr.org/app-developers/). The username and password will then be used to create or renew OAuth2 tokens.

Warning

Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BADGR_TIMEOUT

Default: 10

Source: common.py (line 3557)

Number of seconds to wait on the badging server when contacting it before giving up.

Warning

Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BADGR_TOKENS_CACHE_KEY

Default: None

Source: common.py (line 3550)

The cache key for Badgr API tokens. Once created, the tokens will be stored in cache. Define the key here for setting and retrieveing the tokens.

Warning

Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BADGR_USERNAME

Default: None

Source: common.py (line 3534)

The username for Badgr. You should set up an issuer application with Badgr (https://badgr.org/app-developers/). The username and password will then be used to create or renew OAuth2 tokens.

Warning

Review FEATURES[‘ENABLE_OPENBADGES’] for further context.

BLOCKSTORE_BUNDLE_CACHE_TIMEOUT

Default: 3000

Source: common.py (line 4839)

Maximum time-to-live of cached Bundles fetched from Blockstore, in seconds. When the values returned from Blockstore have TTLs of their own (such as signed S3 URLs), the maximum TTL of this cache must be lower than the minimum TTL of those values. We use a default of 3000s (50mins) because temporary URLs are often configured to expire after one hour.

BLOCK_STRUCTURES_SETTINGS

Default: "dict of settings"

Source: common.py (line 2745)

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/edx/edx-platform/pull/13388.

BLOCK_STRUCTURES_SETTINGS[‘COURSE_PUBLISH_TASK_DELAY’]

Default: 30

Source: common.py (line 2751)

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/edx/edx-platform/pull/13388 and https://github.com/edx/edx-platform/pull/14571.

BLOCK_STRUCTURES_SETTINGS[‘TASK_DEFAULT_RETRY_DELAY’]

Default: 30

Source: common.py (line 2760)

Delay, in seconds, between retry attempts if a block structure task fails. For more information, check https://github.com/edx/edx-platform/pull/13388 and https://github.com/edx/edx-platform/pull/14571.

BLOCK_STRUCTURES_SETTINGS[‘TASK_MAX_RETRIES’]

Default: 5

Source: common.py (line 2767)

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/edx/edx-platform/pull/13388 and https://github.com/edx/edx-platform/pull/14571.

CCX_MAX_STUDENTS_ALLOWED

Default: 200

Source: common.py (line 4283)

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.

CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT

Default: 0.5

Source: common.py (line 1651)

Set the number of seconds LMS will wait to establish an internal connection to the codejail remote service.

CODE_JAIL_REST_SERVICE_HOST

Default: "'http://127.0.0.1:8550'"

Source: common.py (line 1647)

Set the codejail remote service host

CODE_JAIL_REST_SERVICE_READ_TIMEOUT

Default: 3.5

Source: common.py (line 1655)

Set the number of seconds LMS will wait for a response from the codejail remote service endpoint.

CODE_JAIL_REST_SERVICE_REMOTE_EXEC

Default: "'common.lib.capa.capa.safe_exec.remote_exec.send_safe_exec_request_v0'"

Source: common.py (line 1642)

Set the python package.module.function that is reponsible of calling the remote service in charge of jailed code execution

COMPREHENSIVE_THEME_DIRS

Default: "[]"

Source: common.py (line 4336)

A list of directories containing themes folders, each entry should be a full path to the directory containing the theme folder.

COMPREHENSIVE_THEME_LOCALE_PATHS

Default: "[]"

Source: common.py (line 4342)

A list of the paths to themes locale directories e.g. “COMPREHENSIVE_THEME_LOCALE_PATHS” : [“/edx/src/edx-themes/conf/locale”].

COURSE_MEMBER_API_ENROLLMENT_LIMIT

Default: 1000

Source: common.py (line 4159)

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.

DEFAULT_SITE_THEME

Default: None

Source: common.py (line 4348)

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.

Warning

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.

DISCUSSIONS_MICROFRONTEND_URL

Default: None

Source: common.py (line 4733)

Base URL of the micro-frontend-based discussions page.

Warning

Also set site’s courseware.discussions_mfe waffle flag.

EDXNOTES_CLIENT_NAME

Default: "edx-notes"

Source: common.py (line 1973)

Set the name of the Oauth client used by LMS to authenticate with the edx_notes_api service.

Warning

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.

EDXNOTES_CONNECT_TIMEOUT

Default: 0.5

Source: common.py (line 1981)

Set the number of seconds LMS will wait to establish an internal connection to the edx_notes_api service.

EDXNOTES_INTERNAL_API

Default: "http://localhost:18120/api/v1"

Source: common.py (line 1964)

Set the internal API endpoint LMS will use in the backend to interact with the edx_notes_api service.

Warning

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.

EDXNOTES_PUBLIC_API

Default: "http://localhost:18120/api/v1"

Source: common.py (line 1956)

Set the public API endpoint LMS will use in the frontend to interact with the edx_notes_api service.

Warning

This setting must be a publicly accessible endpoint. It is only used when the setting FEATURES[‘ENABLE_EDXNOTES’] is activated.

EDXNOTES_READ_TIMEOUT

Default: 1.5

Source: common.py (line 1985)

Set the number of seconds LMS will wait for a response from the edx_notes_api service internal endpoint.

LEARNING_MICROFRONTEND_URL

Default: None

Source: common.py (line 4729)

Base URL of the micro-frontend-based courseware page.

LOGIN_REDIRECT_WHITELIST

Default: "empty list ([])"

Source: common.py (line 3447)

While logout, if logout request has a redirect-url as query strings, then the redirect-url is validated through LOGIN_REDIRECT_WHITELIST.

MAINTENANCE_BANNER_TEXT

Default: "'Sample banner message'"

Source: common.py (line 1306)

Specifies the text that is rendered on the maintenance banner.

Warning

Depends on the `open_edx_util.display_maintenance_warning` waffle switch. The banner is only rendered when the switch is activated.

MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED

Default: 6

Source: common.py (line 3636)

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.

MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS

Default: "30 * 60"

Source: common.py (line 3645)

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.

PLATFORM_NAME

Default: "Your Platform Name Here"

Source: common.py (line 57)

The display name of the platform to be used in templates/emails/etc.

PROFILE_MICROFRONTEND_URL

Default: None

Source: common.py (line 4713)

Base URL of the micro-frontend-based profile page.

Warning

Also set site’s ENABLE_PROFILE_MICROFRONTEND and learner_profile.redirect_to_microfrontend waffle flag

RATELIMIT_RATE

Default: "120/m"

Source: common.py (line 4579)

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.

Warning

RATELIMIT_ENABLE flag must also be enabled/set to True to use this RATELIMIT_RATE setting.

REGISTRATION_EXTRA_FIELDS

Default: "{'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'}"

Source: common.py (line 3455)

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”.

REGISTRATION_RATELIMIT

Default: "60/7d"

Source: common.py (line 3240)

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.

REGISTRATION_VALIDATION_RATELIMIT

Default: "30/7d"

Source: common.py (line 3231)

Whenver 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.

RETIRED_EMAIL_DOMAIN

Default: "retired.invalid"

Source: common.py (line 4620)

Set the domain part of hashed emails for retired users. Used by the derived setting RETIRED_EMAIL_FMT.

RETIRED_EMAIL_FMT

Default: "retired__user_{}@retired.invalid"

Source: common.py (line 4631)

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.

RETIRED_EMAIL_PREFIX

Default: "retired__user_"

Source: common.py (line 4615)

Set the prefix part of hashed emails for retired users. Used by the derived setting RETIRED_EMAIL_FMT.

RETIRED_USERNAME_FMT

Default: "retired__user_{}"

Source: common.py (line 4625)

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.

RETIRED_USERNAME_PREFIX

Default: "retired__user_"

Source: common.py (line 4609)

Set the prefix part of hashed usernames for retired users. Used by the derived setting RETIRED_USERNAME_FMT.

RETIRED_USER_SALTS

Default: "['abc', '123']"

Source: common.py (line 4638)

Set a list of salts used for hashing usernames and emails on users retirement.

Warning

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.

RETIREMENT_SERVICE_WORKER_USERNAME

Default: "RETIREMENT_SERVICE_USER"

Source: common.py (line 4645)

Set the username of the retirement service worker user. Retirement scripts authenticate with LMS as this user with oauth client credentials.

RETIREMENT_STATES

Default: "[          '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',      ]"

Source: common.py (line 4651)

Set a list that defines the name and order of states for the retirement workflow.

Warning

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.

XBLOCK_FIELD_DATA_WRAPPERS

Default: "()"

Source: common.py (line 1475)

Paths to wrapper methods which should be applied to every XBlock’s FieldData.

XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE

Default: "default"

Source: common.py (line 4834)

The django cache key of the cache to use for storing anonymous user state for XBlocks.

XBLOCK_SELECT_FUNCTION

Default: "prefer_xmodules"

Source: common.py (line 1467)

Function used to select an XBlock from the python package EntryPoints. Some alternatives are `prefer_xmodules` and `default_select`. The `prefer_modules` function will choose the first “xmodule” if there is one, otherwise, it will act like `default_select`. The `default_select` function will simply choose the first match found.

XBLOCK_SETTINGS

Default: "{}"

Source: common.py (line 1483)

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.

CMS settings

BLOCKSTORE_BUNDLE_CACHE_TIMEOUT

Default: 3000

Source: common.py (line 2411)

Maximum time-to-live of cached Bundles fetched from Blockstore, in seconds. When the values returned from Blockstore have TTLs of their own (such as signed S3 URLs), the maximum TTL of this cache must be lower than the minimum TTL of those values. We use a default of 3000s (50mins) because temporary URLs are often configured to expire after one hour.

CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT

Default: 0.5

Source: common.py (line 1038)

Set the number of seconds CMS will wait to establish an internal connection to the codejail remote service.

CODE_JAIL_REST_SERVICE_HOST

Default: "'http://127.0.0.1:8550'"

Source: common.py (line 1034)

Set the codejail remote service host

CODE_JAIL_REST_SERVICE_READ_TIMEOUT

Default: 3.5

Source: common.py (line 1042)

Set the number of seconds CMS will wait for a response from the codejail remote service endpoint.

CODE_JAIL_REST_SERVICE_REMOTE_EXEC

Default: "'common.lib.capa.capa.safe_exec.remote_exec.send_safe_exec_request_v0'"

Source: common.py (line 1029)

Set the python package.module.function that is reponsible of calling the remote service in charge of jailed code execution

COMPREHENSIVE_THEME_DIRS

Default: "[]"

Source: common.py (line 2017)

See LMS annotation.

COMPREHENSIVE_THEME_LOCALE_PATHS

Default: "[]"

Source: common.py (line 2022)

See LMS annotation. “COMPREHENSIVE_THEME_LOCALE_PATHS” : [“/edx/src/edx-themes/conf/locale”].

COURSEGRAPH_JOB_QUEUE

Default: "value of LOW_PRIORITY_QUEUE"

Source: common.py (line 2198)

The name of the Celery queue to which CourseGraph refresh tasks will be sent

DEFAULT_SITE_THEME

Default: None

Source: common.py (line 2028)

See LMS annotation.

GIT_EXPORT_DEFAULT_IDENT

Default: "{'name': 'STUDIO_EXPORT_TO_GIT', 'email': 'STUDIO_EXPORT_TO_GIT@example.com'}"

Source: common.py (line 1081)

When courses are exported to git, commits are signed with this name/email git identity.

GIT_REPO_EXPORT_DIR

Default: "'/edx/var/edxapp/export_course_repos'"

Source: common.py (line 1075)

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.

STUDIO_NAME

Default: "Your Platform Studio"

Source: common.py (line 172)

The name that will appear on the landing page of Studio, as well as in various emails and templates.