Open edX Feature Toggles

This is the list of all Open edX feature toggles used in edx-platform. These feature toggles can be used to enable or disable features manually on every platform.

DEPRECATE_OLD_COURSE_KEYS_IN_STUDIO

Default: True

Source: cms/envs/common.py (line 395)

Warn about removing support for deprecated course keys. To enable, set to True. To disable, set to False. To enable with a custom support deadline, set to an ISO-8601 date string: eg: ‘2020-09-01’

Warning

This can be removed once support is removed for deprecated course keys.

DISABLE_DEPRECATED_SIGNIN_URL

Default: False

Source: cms/envs/common.py (line 2269)

Toggle for removing the deprecated /signin url.

Warning

This url can be removed once it no longer has any real traffic.

DISABLE_DEPRECATED_SIGNUP_URL

Default: False

Source: cms/envs/common.py (line 2282)

Toggle for removing the deprecated /signup url.

Warning

This url can be removed once it no longer has any real traffic.

DISABLE_HONOR_CERTIFICATES

Default: False

Source: lms/envs/common.py (line 180)

Set to True to disable honor certificates. Typically used when your installation only allows verified certificates, like courses.edx.org.

Warning

???

ENABLE_CHANGE_USER_PASSWORD_ADMIN

Default: False

Source: lms/envs/common.py (line 407)

Set to True to enable changing a user password through django admin. This is disabled by default because enabling allows a method to bypass password policy.

ENABLE_COURSEWARE_MICROFRONTEND

Default: False

Source: lms/envs/common.py (line 420)

Set to True to enable the Courseware MFE at the platform level for global staff (see REDIRECT_TO_COURSEWARE_MICROFRONTEND for course rollout)

Warning

Also set settings.LEARNING_MICROFRONTEND_URL and see REDIRECT_TO_COURSEWARE_MICROFRONTEND for rollout.

ENABLE_LIBRARY_AUTHORING_MICROFRONTEND

Default: False

Source: cms/envs/common.py (line 412)

Set to True to enable the Library Authoring MFE

Warning

Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and see REDIRECT_TO_LIBRARY_AUTHORING_MICROFRONTEND for rollout.

ENABLE_LOGISTRATION_MICROFRONTEND

Default: False

Source: lms/envs/common.py (line 433)

Supports staged rollout of a new micro-frontend-based implementation of the logistration.

Warning

Also set settings.ACCOUNT_MICROFRONTEND_URL and set REDIRECT_TO_ACCOUNT_MICROFRONTEND for rollout.

ENABLE_ORA_ALL_FILE_URLS

Default: False

Source: lms/envs/common.py (line 461)

A “work-around” feature toggle meant to help in cases where some file uploads are not discoverable. If enabled, will iterate through all possible file key suffixes up to the max for displaying file metadata in staff assessments.

ENABLE_ORA_TEAM_SUBMISSIONS

Default: False

Source: lms/envs/common.py (line 448)

Set to True to enable team-based ORA submissions.

ENABLE_ORA_USERNAMES_ON_DATA_EXPORT

Default: False

Source: lms/envs/common.py (line 490)

Set to True to add deanonymized usernames to ORA data report.

ENABLE_ORA_USER_STATE_UPLOAD_DATA

Default: False

Source: lms/envs/common.py (line 476)

A “work-around” feature toggle meant to help in cases where some file uploads are not discoverable. If enabled, will pull file metadata from StudentModule.state for display in staff assessments.

ENABLE_SYSADMIN_DASHBOARD

Default: False

Source: lms/envs/common.py (line 115)

enables dashboard at /syadmin/ for django staff, for seeing overview of system status, for deleting and loading courses, for seeing log of git imports of courseware.

Warning

some views are not performant when there are more than 100 courses

FEATURES[‘ENABLE_FORUM_DAILY_DIGEST’]

Default: True

Source: lms/djangoapps/discussion/config/settings.py (line 6)

Settings for forums/discussions to on/off daily digest feature. Set this to True if you want to enable users to subscribe and unsubscribe for daily digest. This setting enables deprecation of daily digest.

WAFFLE_FLAG_CUSTOM_METRICS

Default: False

Source: openedx/core/djangoapps/waffle_utils/__init__.py (line 379)

A list of waffle flag to track with custom metrics having values of (True, False, or Both).

Warning

Intent is for temporary research (1 day - several weeks) of a flag’s usage.

account.redirect_to_microfrontend

Default: False

Source: openedx/core/djangoapps/user_api/accounts/toggles.py (line 31)

Supports staged rollout of a new micro-frontend-based implementation of the account page.

Warning

Also set settings.ACCOUNT_MICROFRONTEND_URL and site’s ENABLE_ACCOUNT_MICROFRONTEND.

contentstore.library_authoring_mfe

Default: False

Source: cms/djangoapps/contentstore/config/waffle.py (line 46)

Toggles the new micro-frontend-based implementation of the library authoring experience.

Warning

Also set settings.LIBRARY_AUTHORING_MICROFRONTEND_URL and ENABLE_LIBRARY_AUTHORING_MICROFRONTEND.

course_blocks_api.hide_access_denials

Default: False

Source: lms/djangoapps/course_api/blocks/toggles.py (line 11)

??

Warning

??

course_experience.enable_about_sidebar_html

Default: False

Source: openedx/features/course_experience/waffle.py (line 11)

Used to determine whether to show custom HTML in the sidebar on the internal course about page.

course_experience.enable_course_goals

Default: False

Source: openedx/features/course_experience/__init__.py (line 102)

Used to determine whether or not to use course goals for the particular course.

course_experience.latest_update

Default: False

Source: openedx/features/course_experience/__init__.py (line 122)

Used to switch between ‘welcome message’ and ‘latest update’ on the course home page.

Warning

This is meant to be configured using waffle_utils course override only. Either do not create the actual waffle flag, or be sure to unset the flag even for Superusers.

course_experience.show_reviews_tool

Default: False

Source: openedx/features/course_experience/__init__.py (line 88)

Used with our integration with CourseTalk to display reviews for a course.

Warning

We are no longer integrating with CourseTalk, so this probably should be deprecated and the code for reviews should be removed.

courseware.courseware_mfe

Default: False

Source: lms/djangoapps/courseware/toggles.py (line 12)

Supports staged rollout to students for a new micro-frontend-based implementation of the courseware page.

Warning

Also set settings.LEARNING_MICROFRONTEND_URL and ENABLE_COURSEWARE_MICROFRONTEND.

courseware.microfrontend_course_team_preview

Default: False

Source: lms/djangoapps/courseware/toggles.py (line 28)

Supports staged rollout to course teams of a new micro-frontend-based implementation of the courseware page.

Warning

Also set settings.LEARNING_MICROFRONTEND_URL and ENABLE_COURSEWARE_MICROFRONTEND.

experiments.add_dashboard_info

Default: False

Source: lms/djangoapps/experiments/utils.py (line 53)

Toggle for adding info about each course to the dashboard metadata

experiments.add_programs

Default: False

Source: lms/djangoapps/experiments/utils.py (line 37)

Toggle for adding the current course’s program information to user metadata

experiments.add_upsell_tracking

Default: False

Source: lms/djangoapps/experiments/utils.py (line 67)

Make sure upsell tracking JS works as expected.

learner_profile.redirect_to_microfrontend

Default: False

Source: openedx/features/learner_profile/toggles.py (line 13)

Supports staged rollout of a new micro-frontend-based implementation of the profile page.

Warning

Also set settings.PROFILE_MICROFRONTEND_URL and site’s ENABLE_PROFILE_MICROFRONTEND.

order_history.redirect_to_microfrontend

Default: False

Source: openedx/core/djangoapps/user_api/accounts/toggles.py (line 10)

Supports staged rollout of a new micro-frontend-based implementation of the order history page.

Warning

Also set settings.ORDER_HISTORY_MICROFRONTEND_URL and site’s ENABLE_ORDER_HISTORY_MICROFRONTEND.

require_course_email_auth

Default: "True (enabled)"

Source: lms/djangoapps/bulk_email/models.py (line 471)

If the flag is enabled, course-specific authorization is required, and the course_id is either

user_authn.enable_login_using_thirdparty_auth_only

Default: False

Source: openedx/core/djangoapps/user_authn/config/waffle.py (line 11)

When enabled, users must be sign in using their allowed domain SSO account.

Warning

Requires THIRD_PARTY_AUTH_ONLY_DOMAIN to also be set.

verify_student.redirect_to_idv_microfrontend

Default: False

Source: lms/djangoapps/verify_student/toggles.py (line 32)

Supports staged rollout to students for the new IDV flow.

verify_student.use_new_email_templates

Default: False

Source: lms/djangoapps/verify_student/toggles.py (line 10)

Supports staged rollout to students for a new email templates implementation for ID verification.