Settings

Contents

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.

Platform-Wide Settings#

ACCOUNT_MICROFRONTEND_URL#

Default: None

Source: common.py (line 1869)

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

ADMIN_CONSOLE_MICROFRONTEND_URL#

Default: None

Source: common.py (line 1913)

Base URL of the micro-frontend-based admin console page.

BLOCK_STRUCTURES_SETTINGS#

Default: "dict of settings"

Source: common.py (line 1506)

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.

BLOCK_STRUCTURES_SETTINGS[‘COURSE_PUBLISH_TASK_DELAY’]#

Default: 30

Source: common.py (line 1512)

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.

BLOCK_STRUCTURES_SETTINGS[‘TASK_DEFAULT_RETRY_DELAY’]#

Default: 30

Source: common.py (line 1521)

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.

BLOCK_STRUCTURES_SETTINGS[‘TASK_MAX_RETRIES’]#

Default: 5

Source: common.py (line 1528)

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.

CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT#

Default: 0.5

Source: common.py (line 2242)

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 2237)

Set the codejail remote service host

CODE_JAIL_REST_SERVICE_READ_TIMEOUT#

Default: 3.5

Source: common.py (line 2248)

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

CODE_JAIL_REST_SERVICE_REMOTE_EXEC#

Default: "'xmodule.capa.safe_exec.remote_exec.send_safe_exec_request_v0'"

Source: common.py (line 2231)

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 2429)

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.

COMPREHENSIVE_THEME_LOCALE_PATHS#

Default: "[]"

Source: common.py (line 2873)

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

COURSE_ACCESS_DURATION_MAX_WEEKS#

Default: 18

Source: common.py (line 750)

Maximum course duration in weeks. Course access duration is bounded by this upper limit

COURSE_ACCESS_DURATION_MIN_WEEKS#

Default: 4

Source: common.py (line 743)

Minimum course duration in weeks when Discovery service data is unavailable or course has no

COURSE_AUTHORING_MICROFRONTEND_URL#

Default: None

Source: common.py (line 1908)

Base URL of the micro-frontend-based course authoring (Studio) page.

CUSTOM_RESOURCE_TEMPLATES_DIRECTORY#

Default: None

Source: common.py (line 2934)

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

DEFAULT_SITE_THEME#

Default: None

Source: common.py (line 2437)

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_MFE_FEEDBACK_URL#

Default: None

Source: common.py (line 1887)

Base URL of the discussions micro-frontend google form based feedback.

DISCUSSIONS_MICROFRONTEND_URL#

Default: None

Source: common.py (line 1881)

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

Warning

Also set site’s courseware.discussions_mfe waffle flag.

EVENT_BUS_PRODUCER_CONFIG#

Default: "all events disabled"

Source: common.py (line 2716)

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://docs.openedx.org/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.

LEARNER_HOME_MICROFRONTEND_URL#

Default: None

Source: common.py (line 1903)

Base URL of the micro-frontend-based learner home page.

LEARNING_MICROFRONTEND_URL#

Default: None

Source: common.py (line 1876)

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

LOGIN_REDIRECT_WHITELIST#

Default: "empty list ([])"

Source: common.py (line 1463)

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: None

Source: common.py (line 3008)

Specifies the text that is rendered on the maintenance banner. (Note: set to ‘Sample banner message’ by default in the CMS).

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 2348)

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 2357)

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 978)

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

PREPEND_LOCALE_PATHS#

Default: "[]"

Source: common.py (line 2879)

A list of the paths to locale directories to load first e.g. “PREPEND_LOCALE_PATHS” : [“/edx/my-locales/”].

PROCTORING_BACKENDS#

Default: "{         'DEFAULT': 'null',         'null': {}     }"

Source: common.py (line 2952)

A dictionary describing all available proctoring provider configurations. Structure: { “<provider_name>”: { “show_review_rules”: <bool>, “requires_escalation_email”: <bool>, … additional provider-specific options … }, “<another_provider_name>”: { … } … “DEFAULT”: “<provider_name>”, } Keys: **show_review_rules** (bool): Whether studio would show a “Review Rules” field as part of proctoring configuration. Default is True. **requires_escalation_email** (bool): Providers with this flag set to True require that an escalation email address be specified in the advanced course settings. Default is False.

REGISTRATION_EMAIL_PATTERNS_ALLOWED#

Default: None

Source: common.py (line 1648)

Optional setting to restrict registration / account creation to only emails that match a regex in this list. Set to ``None`` to allow any email (default).

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 1668)

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 850)

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 841)

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.

RETIRED_EMAIL_DOMAIN#

Default: "retired.invalid"

Source: common.py (line 2550)

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 2563)

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 2544)

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 2556)

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 2538)

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 2570)

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 2578)

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 2584)

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.

STATIC_URL_BASE#

Default: ""None""

Source: common.py (line 2867)

The LMS and CMS use this to construct ``STATIC_URL`` by appending a slash (if needed), and for the CMS, ``studio/`` afterwards.

STUDIO_NAME#

Default: "Your Platform Studio"

Source: common.py (line 3016)

The name that will appear on the landing page of Studio, as well as in various emails and templates. (Note: set to ‘Studio’ by default in the LMS).

XBLOCK_EXTRA_MIXINS#

Default: "()"

Source: common.py (line 2011)

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’,)`

XBLOCK_FIELD_DATA_WRAPPERS#

Default: "()"

Source: common.py (line 2018)

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 2034)

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

XBLOCK_SETTINGS#

Default: "{}"

Source: common.py (line 2026)

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.

LMS Settings#

CATALOG_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2863)

Base URL of the micro-frontend-based course catalog page.

CCX_MAX_STUDENTS_ALLOWED#

Default: 200

Source: common.py (line 2610)

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.

CELERY_EXTRA_IMPORTS#

Default: "[]"

Source: common.py (line 1693)

Adds extra packages that don’t get auto-imported (Example: XBlocks). These packages are added in addition to those added by CELERY_IMPORTS.

COMMUNICATIONS_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2871)

Base URL of the micro-frontend-based communications app.

CONTENT_FOR_SPAM_POSTS#

Default: """"

Source: common.py (line 2880)

Content to replace spam posts with

COURSE_MEMBER_API_ENROLLMENT_LIMIT#

Default: 1000

Source: common.py (line 2550)

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.

DISABLED_ORGS_FOR_PROGRAM_NUDGE#

Default: "[]"

Source: common.py (line 3150)

List of organization codes that should be disabled

DISCUSSION_SPAM_URLS#

Default: "[]"

Source: common.py (line 2875)

Urls to filter from discussion content to avoid spam

EDXNOTES_CLIENT_NAME#

Default: "edx-notes"

Source: common.py (line 1115)

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 1123)

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 1106)

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 settings.ENABLE_EDXNOTES is activated.

EDXNOTES_PUBLIC_API#

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

Source: common.py (line 1098)

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 settings.ENABLE_EDXNOTES is activated.

EDXNOTES_READ_TIMEOUT#

Default: 1.5

Source: common.py (line 1127)

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

ELASTIC_SEARCH_INDEX_PREFIX#

Default: "''"

Source: common.py (line 884)

Specifies the prefix used when naming elasticsearch indexes related to edx-search.

EXAMS_DASHBOARD_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2859)

Base URL of the exams dashboard micro-frontend for instructors.

FRONTEND_SITE_CONFIG#

Default: "{}"

Source: common.py (line 3100)

Frontend site configuration in frontend-base’s native camelCase format. Unlike MFE_CONFIG, values here require no translation and are passed through to the /api/frontend_site_config/v1/ endpoint as-is, at the highest precedence (overriding any values translated from MFE_CONFIG). See https://github.com/openedx/frontend-base/blob/main/types.ts for the expected SiteConfig schema. Example: { “externalRoutes”: [ {“role”: “learnerDashboard”, “url”: “https://courses.example.com/dashboard”} ], “logoutUrl”: “https://courses.example.com/logout” }

GRADEBOOK_FREEZE_DAYS#

Default: 30

Source: common.py (line 769)

Sets the number of days after which the gradebook will freeze following the course’s end.

HIBP_LOGIN_BLOCK_PASSWORD_FREQUENCY_THRESHOLD#

Default: 5.0

Source: common.py (line 2943)

Log10 threshold in effect for ENABLE_AUTHN_LOGIN_BLOCK_HIBP_POLICY. See ENABLE_AUTHN_LOGIN_BLOCK_HIBP_POLICY for more details.

HIBP_LOGIN_NUDGE_PASSWORD_FREQUENCY_THRESHOLD#

Default: 3.0

Source: common.py (line 2919)

Log10 threshold in effect for ENABLE_AUTHN_LOGIN_NUDGE_HIBP_POLICY. See ENABLE_AUTHN_LOGIN_BLOCK_HIBP_POLICY for more details.

HIBP_REGISTRATION_PASSWORD_FREQUENCY_THRESHOLD#

Default: 3.0

Source: common.py (line 2904)

Log10 threshold in effect for ENABLE_AUTHN_REGISTER_HIBP_POLICY. See ENABLE_AUTHN_LOGIN_BLOCK_HIBP_POLICY for more details.

INSTRUCTOR_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2867)

Base URL of the micro-frontend-based instructor app.

LTI_CUSTOM_PARAMS#

Default: "[]"

Source: common.py (line 2585)

This expands the list of optional LTI parameters that the platform accepts. These parameters are not used by the platform, but can then be used by other plugins.

MFE_CONFIG#

Default: "{}"

Source: common.py (line 3060)

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

MFE_CONFIG_API_CACHE_TIMEOUT#

Default: "60*5"

Source: common.py (line 3119)

The MFE Config API response will be cached during the specified time

MFE_CONFIG_OVERRIDES#

Default: "{}"

Source: common.py (line 3081)

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”, }, }

ORA_GRADING_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2845)

Base URL of the micro-frontend-based openassessment grading page. This is will be show in the open response tab list data.

Warning

Also set site’s openresponseassessment.enhanced_staff_grader waffle flag.

ORA_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2852)

Base URL for modern openassessment app. This is will be show in the open response tab list data.

Warning

Also set site’s openresponseassessment.mfe_views waffle flag.

ORA_PEER_LEASE_EXPIRATION_HOURS#

Default: 8

Source: common.py (line 2341)

Amount of time before a lease on a peer submission expires

ORA_STAFF_LEASE_EXPIRATION_HOURS#

Default: 8

Source: common.py (line 2346)

Amount of time before a lease on a staff submission expires

PROFILE_INFORMATION_REPORT_PRIVATE_FIELDS#

Default: "["year_of_birth"]"

Source: common.py (line 2428)

List of private fields that will be hidden from the profile information report.

PROFILE_MICROFRONTEND_URL#

Default: None

Source: common.py (line 2834)

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

PYTHON_LIB_FILENAME#

Default: "python_lib.zip"

Source: common.py (line 983)

Name of the course file to make available to code in custom Python-graded problems. By default, this file will not be downloadable by learners.

RATELIMIT_RATE#

Default: "120/m"

Source: common.py (line 2816)

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.

RECAPTCHA_PRIVATE_KEY#

Default: "empty string"

Source: common.py (line 3253)

Add recaptcha private key to use captcha feature in discussion app.

RECAPTCHA_PROJECT_ID#

Default: None

Source: common.py (line 3275)

Add recaptcha project id to use captcha feature in discussion app.

Warning

This setting is used to configure the reCAPTCHA project ID for the discussion app. The project ID is used to identify the reCAPTCHA project in the Google Cloud Console and is required for the reCAPTCHA service to function correctly. The project ID should be obtained from the Google Cloud Console when creating a reCAPTCHA

RECAPTCHA_SITE_KEYS#

Default: "empty dictionary"

Source: common.py (line 3258)

Add recaptcha site keys to use captcha feature in discussion app.

Warning

This setting is used to configure the reCAPTCHA keys for web, iOS, and Android platforms. The keys are expected to be in the format: { ‘web’: ‘your-web-site-key’, ‘ios’: ‘your-ios-site-key’, ‘android’: ‘your-android-site-key’, }

SECURITY_PAGE_URL#

Default: None

Source: common.py (line 2153)

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

SURVEY_REPORT_CHECK_THRESHOLD#

Default: "every 6 months"

Source: common.py (line 3242)

Survey report banner will appear if a survey report is not sent in the months defined.

SURVEY_REPORT_ENDPOINT#

Default: "Open edX organization endpoint"

Source: common.py (line 3231)

Endpoint where the report will be sent.

SURVEY_REPORT_EXTRA_DATA#

Default: "empty dictionary"

Source: common.py (line 3246)

Dictionary with additional information that you want to share in the report.

CMS Settings#

DEFAULT_GRADE_DESIGNATIONS#

Default: "['A', 'B', 'C', 'D']"

Source: common.py (line 1021)

The default ‘pass’ grade cutoff designations to be used. The failure grade is always ‘F’ and should not be included in this list.

Warning

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.

DEFAULT_ORG_LOGO_URL#

Default: "Derived(lambda settings: settings.STATIC_URL + 'images/logo.png')"

Source: common.py (line 1314)

The default logo url for organizations that do not have a logo set.

Warning

This url is used as a placeholder for organizations that do not have a logo set.

GIT_EXPORT_DEFAULT_IDENT#

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

Source: common.py (line 464)

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 458)

When courses are exported to git, either with the export_git management command or the git export view from the studio (when settings.ENABLE_EXPORT_GIT is True), they are stored in this directory, which must exist at the time of the export.

LIBRARY_ENABLED_BLOCKS#

Default: "['problem', 'video', 'html', 'drag-and-drop-v2']"

Source: common.py (line 1287)

List of block types that are ready/enabled to be created/used

Contents