edx-platform Technical Reference
Settings
LMS settings
CMS settings
Feature Toggles
ALLOW_HIDING_DISCUSSION_TAB
BLOCK_STRUCTURES_SETTINGS[‘PRUNING_ACTIVE’]
COURSES_INVITE_ONLY
CUSTOM_COURSES_EDX
CourseDurationLimitConfig.enabled
CourseHLSPlaybackEnabledFlag.course_id
CourseVideoUploadsEnabledByDefault.course_id
DEFAULT_MOBILE_AVAILABLE
DISABLE_DEPRECATED_SIGNIN_URL
DISABLE_DEPRECATED_SIGNUP_URL
ENABLE_COMPREHENSIVE_THEMING
ENABLE_REQUIRE_THIRD_PARTY_AUTH
EXPECTED_ERRORS[N][‘IS_IGNORED’]
EXPECTED_ERRORS[N][‘LOG_ERROR’]
EXPECTED_ERRORS[N][‘LOG_STACK_TRACE’]
FEATURES[‘ALLOW_ADMIN_ENTERPRISE_COURSE_ENROLLMENT_DELETION’]
FEATURES[‘ALLOW_AUTOMATED_SIGNUPS’]
FEATURES[‘ALLOW_COURSE_RERUNS’]
FEATURES[‘ALLOW_COURSE_STAFF_GRADE_DOWNLOADS’]
FEATURES[‘ALLOW_EMAIL_ADDRESS_CHANGE’]
FEATURES[‘ALLOW_PUBLIC_ACCOUNT_CREATION’]
FEATURES[‘ALWAYS_REDIRECT_HOMEPAGE_TO_DASHBOARD_FOR_AUTHENTICATED_USER’]
FEATURES[‘AUTOMATIC_AUTH_FOR_TESTING’]
FEATURES[‘AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING’]
FEATURES[‘BATCH_ENROLLMENT_NOTIFY_USERS_DEFAULT’]
FEATURES[‘CERTIFICATES_INSTRUCTOR_GENERATION’]
FEATURES[‘COURSES_ARE_BROWSABLE’]
FEATURES[‘CUSTOM_CERTIFICATE_TEMPLATES_ENABLED’]
FEATURES[‘DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO’]
FEATURES[‘DISABLE_COURSE_CREATION’]
FEATURES[‘DISABLE_HONOR_CERTIFICATES’]
FEATURES[‘DISABLE_LOGIN_BUTTON’]
FEATURES[‘DISABLE_MOBILE_COURSE_AVAILABLE’]
FEATURES[‘DISABLE_START_DATES’]
FEATURES[‘DISPLAY_ANALYTICS_ENROLLMENTS’]
FEATURES[‘DISPLAY_DEBUG_INFO_TO_STAFF’]
FEATURES[‘DISPLAY_HISTOGRAMS_TO_STAFF’]
FEATURES[‘EDITABLE_SHORT_DESCRIPTION’]
FEATURES[‘EMBARGO’]
FEATURES[‘ENABLE_ACCOUNT_DELETION’]
FEATURES[‘ENABLE_ANNOUNCEMENTS’]
FEATURES[‘ENABLE_AUTHN_MICROFRONTEND’]
FEATURES[‘ENABLE_BULK_ENROLLMENT_VIEW’]
FEATURES[‘ENABLE_BULK_USER_RETIREMENT’]
FEATURES[‘ENABLE_CCX_ANALYTICS_DASHBOARD_URL’]
FEATURES[‘ENABLE_CHANGE_USER_PASSWORD_ADMIN’]
FEATURES[‘ENABLE_COMBINED_LOGIN_REGISTRATION_FOOTER’]
FEATURES[‘ENABLE_COOKIE_CONSENT’]
FEATURES[‘ENABLE_COSMETIC_DISPLAY_PRICE’]
FEATURES[‘ENABLE_COURSEWARE_SEARCH’]
FEATURES[‘ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF’]
FEATURES[‘ENABLE_COURSE_ASSESSMENT_GRADE_CHANGE_SIGNAL’]
FEATURES[‘ENABLE_COURSE_DISCOVERY’]
FEATURES[‘ENABLE_COURSE_HOME_REDIRECT’]
FEATURES[‘ENABLE_COURSE_SORTING_BY_START_DATE’]
FEATURES[‘ENABLE_CREDIT_ELIGIBILITY’]
FEATURES[‘ENABLE_CSMH_EXTENDED’]
FEATURES[‘ENABLE_DASHBOARD_SEARCH’]
FEATURES[‘ENABLE_DISCUSSION_EMAIL_DIGEST’]
FEATURES[‘ENABLE_DISCUSSION_HOME_PANEL’]
FEATURES[‘ENABLE_DISCUSSION_SERVICE’]
FEATURES[‘ENABLE_DJANGO_ADMIN_SITE’]
FEATURES[‘ENABLE_EDXNOTES’]
FEATURES[‘ENABLE_EXPORT_GIT’]
FEATURES[‘ENABLE_FOOTER_MOBILE_APP_LINKS’]
FEATURES[‘ENABLE_FORUM_DAILY_DIGEST’]
FEATURES[‘ENABLE_GRADE_DOWNLOADS’]
FEATURES[‘ENABLE_HELP_LINK’]
FEATURES[‘ENABLE_HTML_XBLOCK_STUDENT_VIEW_DATA’]
FEATURES[‘ENABLE_LEARNER_RECORDS’]
FEATURES[‘ENABLE_LIBRARY_AUTHORING_MICROFRONTEND’]
FEATURES[‘ENABLE_LOGIN_MICROFRONTEND’]
FEATURES[‘ENABLE_LTI_PROVIDER’]
FEATURES[‘ENABLE_MASQUERADE’]
FEATURES[‘ENABLE_MAX_FAILED_LOGIN_ATTEMPTS’]
FEATURES[‘ENABLE_MILESTONES_APP’]
FEATURES[‘ENABLE_MKTG_SITE’]
FEATURES[‘ENABLE_OAUTH2_PROVIDER’]
FEATURES[‘ENABLE_OPENBADGES’]
FEATURES[‘ENABLE_ORA_ALL_FILE_URLS’]
FEATURES[‘ENABLE_ORA_TEAM_SUBMISSIONS’]
FEATURES[‘ENABLE_ORA_USERNAMES_ON_DATA_EXPORT’]
FEATURES[‘ENABLE_ORA_USER_STATE_UPLOAD_DATA’]
FEATURES[‘ENABLE_SPECIAL_EXAMS’]
FEATURES[‘ENABLE_STUDENT_HISTORY_VIEW’]
FEATURES[‘ENABLE_TEXTBOOK’]
FEATURES[‘ENABLE_THIRD_PARTY_AUTH’]
FEATURES[‘ENABLE_UNICODE_USERNAME’]
FEATURES[‘ENABLE_XBLOCK_VIEW_ENDPOINT’]
FEATURES[‘ENTRANCE_EXAMS’]
FEATURES[‘HIDE_DASHBOARD_COURSES_UNTIL_ACTIVATED’]
FEATURES[‘LICENSING’]
FEATURES[‘RESTRICT_AUTOMATIC_AUTH’]
FEATURES[‘SHOW_FOOTER_LANGUAGE_SELECTOR’]
FEATURES[‘SHOW_HEADER_LANGUAGE_SELECTOR’]
FEATURES[‘SKIP_EMAIL_VALIDATION’]
HLSPlaybackEnabledFlag.enabled_for_all_courses
LOG_REQUEST_USER_CHANGES
ORGANIZATIONS_AUTOCREATE
PersistentGradesEnabledFlag.enabled
VEMPipelineIntegration.enabled
VideoUploadsEnabledByDefault.enabled_for_all_courses
WIKI_ACCOUNT_HANDLING
WIKI_ANONYMOUS
WIKI_ENABLED
WIKI_LINK_LIVE_LOOKUPS
WIKI_USE_BOOTSTRAP_SELECT_WIDGET
account.redirect_to_microfrontend
block_structure.invalidate_cache_on_publish
block_structure.raise_error_when_not_found
block_structure.storage_backing_for_cache
bulk_email.EMAIL_USE_DEFAULT_FROM_FOR_BULK
bypass_olx_failure
certificates_revamp.use_allowlist
certificates_revamp.use_updated
contentstore.library_authoring_mfe
course_blocks_api.hide_access_denials
course_experience.calendar_sync
course_experience.enable_about_sidebar_html
course_experience.enable_course_goals
course_experience.latest_update
course_experience.relative_dates
course_home.course_home_mfe
course_list_api_rate_limit.rate_limit_10
course_list_api_rate_limit.rate_limit_2
courseware.courseware_mfe
courseware.mfe_progress_milestones
courseware.mfe_progress_milestones_streak_celebration
courseware.microfrontend_course_exit_page
courseware.microfrontend_course_team_preview
courseware.optimized_render_xblock
courseware.proctoring_improvements
discounts.enable_discounting
experiments.add_dashboard_info
experiments.add_programs
experiments.add_upsell_tracking
experiments.mobile_upsell_rev934
export_course_metadata
grades.assume_zero_grade_if_absent
grades.bulk_management
grades.disable_regrade_on_policy_change
grades.rejected_exam_overrides_grade
grades.writable_gradebook
instructor.enable_data_download_v2
learner_profile.redirect_to_microfrontend
open_edx_util.display_maintenance_warning
order_history.redirect_to_microfrontend
registration.enable_failure_logging
request_utils.capture_cookie_sizes
require_course_email_auth
schedules.enable_debugging
split_library_on_studio_dashboard
student.courseenrollment_admin
third_party_auth.enable_multiple_sso_accounts_association_to_saml_user
user_api.enable_multiple_user_enterprises_feature
user_authn.enable_login_using_thirdparty_auth_only
user_authn.redirect_to_microfrontend
verify_student.optimised_is_small_course
verify_student.use_new_email_templates
videos.deprecate_youtube
videos.enable_devstack_video_uploads
edx-platform Technical Reference
Table of Contents
»
edx-platform
technical reference
Give Doc Feedback
Edit on GitHub
edx-platform
technical reference
¶
This is the technical documentation reference for edx-platform.
Settings
LMS settings
ACCOUNT_MICROFRONTEND_URL
BADGING_BACKEND
BADGR_API_TOKEN
BADGR_BASE_URL
BADGR_ISSUER_SLUG
BADGR_TIMEOUT
BLOCKSTORE_BUNDLE_CACHE_TIMEOUT
BLOCK_STRUCTURES_SETTINGS
BLOCK_STRUCTURES_SETTINGS[‘COURSE_PUBLISH_TASK_DELAY’]
BLOCK_STRUCTURES_SETTINGS[‘TASK_DEFAULT_RETRY_DELAY’]
BLOCK_STRUCTURES_SETTINGS[‘TASK_MAX_RETRIES’]
CCX_MAX_STUDENTS_ALLOWED
COMPREHENSIVE_THEME_DIRS
COMPREHENSIVE_THEME_LOCALE_PATHS
DEFAULT_SITE_THEME
EDXNOTES_CLIENT_NAME
EDXNOTES_CONNECT_TIMEOUT
EDXNOTES_INTERNAL_API
EDXNOTES_PUBLIC_API
EDXNOTES_READ_TIMEOUT
LEARNING_MICROFRONTEND_URL
MAINTENANCE_BANNER_TEXT
MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED
MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS
PLATFORM_NAME
PROFILE_MICROFRONTEND_URL
REGISTRATION_EXTRA_FIELDS
RETIRED_EMAIL_DOMAIN
RETIRED_EMAIL_FMT
RETIRED_EMAIL_PREFIX
RETIRED_USERNAME_FMT
RETIRED_USERNAME_PREFIX
RETIRED_USER_SALTS
RETIREMENT_SERVICE_WORKER_USERNAME
RETIREMENT_STATES
XBLOCK_FIELD_DATA_WRAPPERS
XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE
XBLOCK_SELECT_FUNCTION
XBLOCK_SETTINGS
CMS settings
BLOCKSTORE_BUNDLE_CACHE_TIMEOUT
COMPREHENSIVE_THEME_DIRS
COMPREHENSIVE_THEME_LOCALE_PATHS
DEFAULT_SITE_THEME
GIT_EXPORT_DEFAULT_IDENT
GIT_REPO_EXPORT_DIR
STUDIO_NAME
Feature Toggles
ALLOW_HIDING_DISCUSSION_TAB
BLOCK_STRUCTURES_SETTINGS[‘PRUNING_ACTIVE’]
COURSES_INVITE_ONLY
CUSTOM_COURSES_EDX
CourseDurationLimitConfig.enabled
CourseHLSPlaybackEnabledFlag.course_id
CourseVideoUploadsEnabledByDefault.course_id
DEFAULT_MOBILE_AVAILABLE
DISABLE_DEPRECATED_SIGNIN_URL
DISABLE_DEPRECATED_SIGNUP_URL
ENABLE_COMPREHENSIVE_THEMING
ENABLE_REQUIRE_THIRD_PARTY_AUTH
EXPECTED_ERRORS[N][‘IS_IGNORED’]
EXPECTED_ERRORS[N][‘LOG_ERROR’]
EXPECTED_ERRORS[N][‘LOG_STACK_TRACE’]
FEATURES[‘ALLOW_ADMIN_ENTERPRISE_COURSE_ENROLLMENT_DELETION’]
FEATURES[‘ALLOW_AUTOMATED_SIGNUPS’]
FEATURES[‘ALLOW_COURSE_RERUNS’]
FEATURES[‘ALLOW_COURSE_STAFF_GRADE_DOWNLOADS’]
FEATURES[‘ALLOW_EMAIL_ADDRESS_CHANGE’]
FEATURES[‘ALLOW_PUBLIC_ACCOUNT_CREATION’]
FEATURES[‘ALWAYS_REDIRECT_HOMEPAGE_TO_DASHBOARD_FOR_AUTHENTICATED_USER’]
FEATURES[‘AUTOMATIC_AUTH_FOR_TESTING’]
FEATURES[‘AUTOMATIC_VERIFY_STUDENT_IDENTITY_FOR_TESTING’]
FEATURES[‘BATCH_ENROLLMENT_NOTIFY_USERS_DEFAULT’]
FEATURES[‘CERTIFICATES_INSTRUCTOR_GENERATION’]
FEATURES[‘COURSES_ARE_BROWSABLE’]
FEATURES[‘CUSTOM_CERTIFICATE_TEMPLATES_ENABLED’]
FEATURES[‘DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO’]
FEATURES[‘DISABLE_COURSE_CREATION’]
FEATURES[‘DISABLE_HONOR_CERTIFICATES’]
FEATURES[‘DISABLE_LOGIN_BUTTON’]
FEATURES[‘DISABLE_MOBILE_COURSE_AVAILABLE’]
FEATURES[‘DISABLE_START_DATES’]
FEATURES[‘DISPLAY_ANALYTICS_ENROLLMENTS’]
FEATURES[‘DISPLAY_DEBUG_INFO_TO_STAFF’]
FEATURES[‘DISPLAY_HISTOGRAMS_TO_STAFF’]
FEATURES[‘EDITABLE_SHORT_DESCRIPTION’]
FEATURES[‘EMBARGO’]
FEATURES[‘ENABLE_ACCOUNT_DELETION’]
FEATURES[‘ENABLE_ANNOUNCEMENTS’]
FEATURES[‘ENABLE_AUTHN_MICROFRONTEND’]
FEATURES[‘ENABLE_BULK_ENROLLMENT_VIEW’]
FEATURES[‘ENABLE_BULK_USER_RETIREMENT’]
FEATURES[‘ENABLE_CCX_ANALYTICS_DASHBOARD_URL’]
FEATURES[‘ENABLE_CHANGE_USER_PASSWORD_ADMIN’]
FEATURES[‘ENABLE_COMBINED_LOGIN_REGISTRATION_FOOTER’]
FEATURES[‘ENABLE_COOKIE_CONSENT’]
FEATURES[‘ENABLE_COSMETIC_DISPLAY_PRICE’]
FEATURES[‘ENABLE_COURSEWARE_SEARCH’]
FEATURES[‘ENABLE_COURSEWARE_SEARCH_FOR_COURSE_STAFF’]
FEATURES[‘ENABLE_COURSE_ASSESSMENT_GRADE_CHANGE_SIGNAL’]
FEATURES[‘ENABLE_COURSE_DISCOVERY’]
FEATURES[‘ENABLE_COURSE_HOME_REDIRECT’]
FEATURES[‘ENABLE_COURSE_SORTING_BY_START_DATE’]
FEATURES[‘ENABLE_CREDIT_ELIGIBILITY’]
FEATURES[‘ENABLE_CSMH_EXTENDED’]
FEATURES[‘ENABLE_DASHBOARD_SEARCH’]
FEATURES[‘ENABLE_DISCUSSION_EMAIL_DIGEST’]
FEATURES[‘ENABLE_DISCUSSION_HOME_PANEL’]
FEATURES[‘ENABLE_DISCUSSION_SERVICE’]
FEATURES[‘ENABLE_DJANGO_ADMIN_SITE’]
FEATURES[‘ENABLE_EDXNOTES’]
FEATURES[‘ENABLE_EXPORT_GIT’]
FEATURES[‘ENABLE_FOOTER_MOBILE_APP_LINKS’]
FEATURES[‘ENABLE_FORUM_DAILY_DIGEST’]
FEATURES[‘ENABLE_GRADE_DOWNLOADS’]
FEATURES[‘ENABLE_HELP_LINK’]
FEATURES[‘ENABLE_HTML_XBLOCK_STUDENT_VIEW_DATA’]
FEATURES[‘ENABLE_LEARNER_RECORDS’]
FEATURES[‘ENABLE_LIBRARY_AUTHORING_MICROFRONTEND’]
FEATURES[‘ENABLE_LOGIN_MICROFRONTEND’]
FEATURES[‘ENABLE_LTI_PROVIDER’]
FEATURES[‘ENABLE_MASQUERADE’]
FEATURES[‘ENABLE_MAX_FAILED_LOGIN_ATTEMPTS’]
FEATURES[‘ENABLE_MILESTONES_APP’]
FEATURES[‘ENABLE_MKTG_SITE’]
FEATURES[‘ENABLE_OAUTH2_PROVIDER’]
FEATURES[‘ENABLE_OPENBADGES’]
FEATURES[‘ENABLE_ORA_ALL_FILE_URLS’]
FEATURES[‘ENABLE_ORA_TEAM_SUBMISSIONS’]
FEATURES[‘ENABLE_ORA_USERNAMES_ON_DATA_EXPORT’]
FEATURES[‘ENABLE_ORA_USER_STATE_UPLOAD_DATA’]
FEATURES[‘ENABLE_SPECIAL_EXAMS’]
FEATURES[‘ENABLE_STUDENT_HISTORY_VIEW’]
FEATURES[‘ENABLE_TEXTBOOK’]
FEATURES[‘ENABLE_THIRD_PARTY_AUTH’]
FEATURES[‘ENABLE_UNICODE_USERNAME’]
FEATURES[‘ENABLE_XBLOCK_VIEW_ENDPOINT’]
FEATURES[‘ENTRANCE_EXAMS’]
FEATURES[‘HIDE_DASHBOARD_COURSES_UNTIL_ACTIVATED’]
FEATURES[‘LICENSING’]
FEATURES[‘RESTRICT_AUTOMATIC_AUTH’]
FEATURES[‘SHOW_FOOTER_LANGUAGE_SELECTOR’]
FEATURES[‘SHOW_HEADER_LANGUAGE_SELECTOR’]
FEATURES[‘SKIP_EMAIL_VALIDATION’]
HLSPlaybackEnabledFlag.enabled_for_all_courses
LOG_REQUEST_USER_CHANGES
ORGANIZATIONS_AUTOCREATE
PersistentGradesEnabledFlag.enabled
VEMPipelineIntegration.enabled
VideoUploadsEnabledByDefault.enabled_for_all_courses
WIKI_ACCOUNT_HANDLING
WIKI_ANONYMOUS
WIKI_ENABLED
WIKI_LINK_LIVE_LOOKUPS
WIKI_USE_BOOTSTRAP_SELECT_WIDGET
account.redirect_to_microfrontend
block_structure.invalidate_cache_on_publish
block_structure.raise_error_when_not_found
block_structure.storage_backing_for_cache
bulk_email.EMAIL_USE_DEFAULT_FROM_FOR_BULK
bypass_olx_failure
certificates_revamp.use_allowlist
certificates_revamp.use_updated
contentstore.library_authoring_mfe
course_blocks_api.hide_access_denials
course_experience.calendar_sync
course_experience.enable_about_sidebar_html
course_experience.enable_course_goals
course_experience.latest_update
course_experience.relative_dates
course_home.course_home_mfe
course_list_api_rate_limit.rate_limit_10
course_list_api_rate_limit.rate_limit_2
courseware.courseware_mfe
courseware.mfe_progress_milestones
courseware.mfe_progress_milestones_streak_celebration
courseware.microfrontend_course_exit_page
courseware.microfrontend_course_team_preview
courseware.optimized_render_xblock
courseware.proctoring_improvements
discounts.enable_discounting
experiments.add_dashboard_info
experiments.add_programs
experiments.add_upsell_tracking
experiments.mobile_upsell_rev934
export_course_metadata
grades.assume_zero_grade_if_absent
grades.bulk_management
grades.disable_regrade_on_policy_change
grades.rejected_exam_overrides_grade
grades.writable_gradebook
instructor.enable_data_download_v2
learner_profile.redirect_to_microfrontend
open_edx_util.display_maintenance_warning
order_history.redirect_to_microfrontend
registration.enable_failure_logging
request_utils.capture_cookie_sizes
require_course_email_auth
schedules.enable_debugging
split_library_on_studio_dashboard
student.courseenrollment_admin
third_party_auth.enable_multiple_sso_accounts_association_to_saml_user
user_api.enable_multiple_user_enterprises_feature
user_authn.enable_login_using_thirdparty_auth_only
user_authn.redirect_to_microfrontend
verify_student.optimised_is_small_course
verify_student.use_new_email_templates
videos.deprecate_youtube
videos.enable_devstack_video_uploads