edx-platform technical reference#
This is the technical documentation reference for edx-platform.
- Settings
- LMS settings
- ACCOUNT_MICROFRONTEND_URL
- BADGING_BACKEND
- BADGR_BASE_URL
- BADGR_ISSUER_SLUG
- BADGR_PASSWORD
- BADGR_TIMEOUT
- BADGR_TOKENS_CACHE_KEY
- BADGR_USERNAME
- 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’]
- BUNDLE_ASSET_STORAGE_SETTINGS
- BUNDLE_ASSET_URL_STORAGE_KEY
- BUNDLE_ASSET_URL_STORAGE_SECRET
- CCX_MAX_STUDENTS_ALLOWED
- CELERY_EXTRA_IMPORTS
- CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT
- CODE_JAIL_REST_SERVICE_HOST
- CODE_JAIL_REST_SERVICE_READ_TIMEOUT
- CODE_JAIL_REST_SERVICE_REMOTE_EXEC
- COMPREHENSIVE_THEME_DIRS
- COMPREHENSIVE_THEME_LOCALE_PATHS
- COURSE_MEMBER_API_ENROLLMENT_LIMIT
- CUSTOM_RESOURCE_TEMPLATES_DIRECTORY
- DEFAULT_SITE_THEME
- DISCUSSIONS_MFE_FEEDBACK_URL
- DISCUSSIONS_MICROFRONTEND_URL
- EDXNOTES_CLIENT_NAME
- EDXNOTES_CONNECT_TIMEOUT
- EDXNOTES_INTERNAL_API
- EDXNOTES_PUBLIC_API
- EDXNOTES_READ_TIMEOUT
- LEARNING_MICROFRONTEND_URL
- LOGIN_REDIRECT_WHITELIST
- MAINTENANCE_BANNER_TEXT
- MAX_FAILED_LOGIN_ATTEMPTS_ALLOWED
- MAX_FAILED_LOGIN_ATTEMPTS_LOCKOUT_PERIOD_SECS
- MFE_CONFIG
- MFE_CONFIG_API_CACHE_TIMEOUT
- MFE_CONFIG_OVERRIDES
- ORA_GRADING_MICROFRONTEND_URL
- PLATFORM_NAME
- PREPEND_LOCALE_PATHS
- PROFILE_MICROFRONTEND_URL
- RATELIMIT_RATE
- REGISTRATION_EXTRA_FIELDS
- REGISTRATION_RATELIMIT
- REGISTRATION_VALIDATION_RATELIMIT
- RETIRED_EMAIL_DOMAIN
- RETIRED_EMAIL_FMT
- RETIRED_EMAIL_PREFIX
- RETIRED_USERNAME_FMT
- RETIRED_USERNAME_PREFIX
- RETIRED_USER_SALTS
- RETIREMENT_SERVICE_WORKER_USERNAME
- RETIREMENT_STATES
- SECURITY_PAGE_URL
- XBLOCK_FIELD_DATA_WRAPPERS
- XBLOCK_RUNTIME_V2_EPHEMERAL_DATA_CACHE
- XBLOCK_SETTINGS
- CMS settings
- BLOCKSTORE_BUNDLE_CACHE_TIMEOUT
- CODE_JAIL_REST_SERVICE_CONNECT_TIMEOUT
- CODE_JAIL_REST_SERVICE_HOST
- CODE_JAIL_REST_SERVICE_READ_TIMEOUT
- CODE_JAIL_REST_SERVICE_REMOTE_EXEC
- COMPREHENSIVE_THEME_DIRS
- COMPREHENSIVE_THEME_LOCALE_PATHS
- COURSEGRAPH_CONNECTION
- COURSEGRAPH_JOB_QUEUE
- CUSTOM_RESOURCE_TEMPLATES_DIRECTORY
- DEFAULT_SITE_THEME
- GIT_EXPORT_DEFAULT_IDENT
- GIT_REPO_EXPORT_DIR
- PREPEND_LOCALE_PATHS
- STUDIO_NAME
- LMS settings
- Feature Toggles
- ALLOW_HIDING_DISCUSSION_TAB
- BADGR_ENABLE_NOTIFICATIONS
- BLOCK_STRUCTURES_SETTINGS[‘PRUNING_ACTIVE’]
- BULK_EMAIL_SEND_USING_EDX_ACE
- COOKIE_NAME_CHANGE_ACTIVATE
- COURSEGRAPH_DUMP_COURSE_ON_PUBLISH
- 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
- DISABLE_JWT_FOR_MOBILE
- ENABLE_AUTHN_LOGIN_BLOCK_HIBP_POLICY
- ENABLE_AUTHN_LOGIN_NUDGE_HIBP_POLICY
- ENABLE_AUTHN_REGISTER_HIBP_POLICY
- ENABLE_AUTHN_RESET_PASSWORD_HIBP_POLICY
- ENABLE_CODEJAIL_REST_SERVICE
- ENABLE_COMPREHENSIVE_THEMING
- ENABLE_COPPA_COMPLIANCE
- ENABLE_DYNAMIC_REGISTRATION_FIELDS
- ENABLE_MFE_CONFIG_API
- ENABLE_REQUIRE_THIRD_PARTY_AUTH
- ENFORCE_SAFE_SESSIONS
- 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_HTML_VIEW’]
- FEATURES[‘CERTIFICATES_INSTRUCTOR_GENERATION’] # lint-amnesty, pylint: disable=annotation-missing-token
- FEATURES[‘COURSES_ARE_BROWSABLE’]
- FEATURES[‘CUSTOM_CERTIFICATE_TEMPLATES_ENABLED’]
- FEATURES[‘DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO’]
- FEATURES[‘DISABLE_ADVANCED_SETTINGS’]
- FEATURES[‘DISABLE_ALLOWED_ENROLLMENT_IF_ENROLLMENT_CLOSED’]
- FEATURES[‘DISABLE_COURSE_CREATION’]
- FEATURES[‘DISABLE_HONOR_CERTIFICATES’]
- FEATURES[‘DISABLE_LOGIN_BUTTON’]
- FEATURES[‘DISABLE_MOBILE_COURSE_AVAILABLE’]
- FEATURES[‘DISABLE_START_DATES’]
- FEATURES[‘DISABLE_UNENROLLMENT’]
- 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_AUTOMATED_SIGNUPS_EXTRA_FIELDS’]
- FEATURES[‘ENABLE_BULK_ENROLLMENT_VIEW’]
- FEATURES[‘ENABLE_BULK_USER_RETIREMENT’]
- FEATURES[‘ENABLE_CCX_ANALYTICS_DASHBOARD_URL’]
- FEATURES[‘ENABLE_CERTIFICATES_IDV_REQUIREMENT’]
- FEATURES[‘ENABLE_CHANGE_USER_PASSWORD_ADMIN’]
- FEATURES[‘ENABLE_COMBINED_LOGIN_REGISTRATION_FOOTER’]
- FEATURES[‘ENABLE_CONTENT_LIBRARIES_LTI_TOOL’]
- 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_FILENAME_CCX_SUFFIX’]
- 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_EXAM_SETTINGS_HTML_VIEW’]
- 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_INTEGRITY_SIGNATURE’]
- 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_MKTG_SITE’]
- FEATURES[‘ENABLE_NEW_BULK_EMAIL_EXPERIENCE’]
- 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_PASSWORD_RESET_FAILURE_EMAIL’]
- FEATURES[‘ENABLE_SEND_XBLOCK_EVENTS_OVER_BUS’]
- FEATURES[‘ENABLE_SPECIAL_EXAMS’]
- FEATURES[‘ENABLE_STUDENT_HISTORY_VIEW’]
- FEATURES[‘ENABLE_TEXTBOOK’]
- FEATURES[‘ENABLE_THIRD_PARTY_AUTH’]
- FEATURES[‘ENABLE_UNICODE_USERNAME’]
- FEATURES[‘ENABLE_V2_CERT_DISPLAY_SETTINGS’]
- FEATURES[‘ENABLE_XBLOCK_VIEW_ENDPOINT’]
- FEATURES[‘ENTRANCE_EXAMS’]
- FEATURES[‘HIDE_DASHBOARD_COURSES_UNTIL_ACTIVATED’]
- FEATURES[‘LICENSING’]
- FEATURES[‘MILESTONES_APP’]
- FEATURES[‘RESTRICT_AUTOMATIC_AUTH’]
- FEATURES[‘SHOW_FOOTER_LANGUAGE_SELECTOR’]
- FEATURES[‘SHOW_HEADER_LANGUAGE_SELECTOR’]
- FEATURES[‘SHOW_PROGRESS_BAR’]
- FEATURES[‘SKIP_EMAIL_VALIDATION’]
- GLOBAL_NOTICE_ENABLED
- HLSPlaybackEnabledFlag.enabled_for_all_courses
- JWT_AUTH_FORCE_CREATE_ASYMMETRIC
- LOG_REQUEST_USER_CHANGES
- LOG_REQUEST_USER_CHANGE_HEADERS
- MARK_LIBRARY_CONTENT_BLOCK_COMPLETE_ON_VIEW
- ORGANIZATIONS_AUTOCREATE
- RATELIMIT_ENABLE
- SEARCH_SKIP_INVITATION_ONLY_FILTERING
- SEARCH_SKIP_SHOW_IN_CATALOG_FILTERING
- SEND_CATALOG_INFO_SIGNAL
- SEND_CERTIFICATE_CREATED_SIGNAL
- SOME_FEATURE_NAME
- 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.storage_backing_for_cache
- blockstore.use_blockstore_app_api
- bulk_email.EMAIL_USE_COURSE_ID_FROM_FOR_BULK
- certificates.auto_certificate_generation
- contentstore.bypass_olx_failure
- contentstore.enable_copy_paste_feature
- contentstore.individualize_anonymous_user_id
- contentstore.library_authoring_mfe
- contentstore.split_library_on_studio_dashboard
- course_apps.exams_ida
- course_apps.proctoring_settings_modal_view
- course_blocks_api.hide_access_denials
- course_experience.calendar_sync
- course_experience.enable_about_sidebar_html
- course_experience.enable_course_goals
- course_experience.relative_dates
- course_experience.relative_dates_disable_reset
- course_list_api_rate_limit.rate_limit_10
- course_list_api_rate_limit.rate_limit_2
- course_live.enable_big_blue_button
- course_live.enable_course_live
- course_modes.use_new_track_selection
- courseware.enable_new_financial_assistance_flow
- courseware.mfe_progress_milestones
- courseware.mfe_progress_milestones_streak_celebration
- courseware.mfe_progress_milestones_streak_discount_enabled
- courseware.microfrontend_course_exit_page
- courseware.optimized_render_xblock
- discounts.enable_discounting
- discussions.enable_discussions_mfe
- discussions.enable_learners_stats
- discussions.enable_learners_tab_in_discussions_mfe
- discussions.enable_moderation_reason_codes
- discussions.enable_new_structure_discussions
- discussions.enable_reported_content_email_notifications
- discussions.override_discussion_legacy_settings
- discussions.pages_and_resources_mfe
- effort_estimation.disabled
- experiments.add_dashboard_info
- experiments.add_programs
- experiments.add_upsell_tracking
- experiments.mobile_upsell_rev934
- export_course_metadata
- grades.bulk_management
- grades.disable_regrade_on_policy_change
- grades.rejected_exam_overrides_grade
- grades.writable_gradebook
- instructor.enable_data_download_v2
- instructor_task.use_on_disk_grade_reporting
- ip.legacy
- learner_dashboard.enable_b2c_subscriptions
- learner_dashboard.enable_masters_program_tab_view
- learner_dashboard.enable_program_tab_view
- learner_home_mfe.enabled
- learner_profile.redirect_to_microfrontend
- learner_recommendations.enable_course_about_page_recommendations
- learner_recommendations.enable_dashboard_recommendations
- new_core_editors.use_new_problem_editor
- new_core_editors.use_new_text_editor
- new_core_editors.use_new_video_editor
- new_core_editors.use_video_gallery_flow
- new_studio_mfe.use_new_advanced_settings_page
- new_studio_mfe.use_new_course_outline_page
- new_studio_mfe.use_new_course_team_page
- new_studio_mfe.use_new_custom_pages
- new_studio_mfe.use_new_export_page
- new_studio_mfe.use_new_files_uploads_page
- new_studio_mfe.use_new_grading_page
- new_studio_mfe.use_new_home_page
- new_studio_mfe.use_new_import_page
- new_studio_mfe.use_new_schedule_details_page
- new_studio_mfe.use_new_unit_page
- new_studio_mfe.use_new_updates_page
- new_studio_mfe.use_new_video_uploads_page
- notifications.enable_notifications
- open_edx_util.display_maintenance_warning
- order_history.redirect_to_microfrontend
- registration.enable_failure_logging
- require_course_email_auth
- schedules.enable_debugging
- student.courseenrollment_admin
- student.enable_2u_recommendations
- student.enable_amplitude_recommendations
- student.enable_enrollment_confirmation_email
- student.enable_fallback_recommendations
- studio.custom_relative_dates
- teams.enable_teams_app
- third_party_auth.apple_user_migration
- user_authn.enable_login_using_thirdparty_auth_only
- user_authn.enable_pwned_password_api
- verify_student.optimised_is_small_course
- verify_student.use_new_email_templates
- video_config.public_video_share
- videos.deprecate_youtube
- videos.enable_devstack_video_uploads