Open edX Site Operators

Tags: site operator

Note

This area is still under active development.

For information about the latest release of the Open edX Platform, you can check out the Open edX Platform Release Notes

Quick Links

• Installing, Configuring, and Running the Open edX Platform
• Site Operators: Quickstarts
• Site Operators: How-tos
• Site Operators: Concepts
• Site Operators: References

All Site Operators’ Guides

• Installing, Configuring, and Running the Open edX Platform
  • General Information
    • Read Me
    • Get Help with Open edX
      • Information to Provide When Asking for Help
    • Open edX Browser Support
  • Open edX Platform Releases
    • Open edX Latest Platform Release
    • Open edX Olive Release
      • What’s Included in Olive
      • What Is the Olive Git Tag?
      • Installing the Olive Release
      • Upgrading from the Nutmeg Release
      • Upgrading to a Subsequent Olive Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Nutmeg Release
      • What’s Included in Nutmeg
      • What Is the Nutmeg Git Tag?
      • Installing the Nutmeg Release
      • Upgrading from the Maple Release
      • Upgrading to a Subsequent Nutmeg Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Maple Release
      • What’s Included in Maple
      • What Is the Maple Git Tag?
      • Installing the Maple Release
      • Upgrading from the Lilac Release
      • Upgrading to a Subsequent Maple Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Lilac Release
      • What’s Included in Lilac
      • What Is the Lilac Git Tag?
      • Installing the Lilac Release
      • Upgrading from the Koa Release
      • Upgrading to a Subsequent Lilac Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Koa Release
      • What’s Included in Koa
      • What Is the Koa Git Tag?
      • Installing the Koa Release
      • Upgrading from the Juniper Release
      • Upgrading to a Subsequent Koa Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Juniper Release
      • What’s Included in Juniper
      • What Is the Juniper Git Tag?
      • Installing the Juniper Release
      • Upgrading from the Ironwood Release
      • Upgrading to a Subsequent Juniper Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Ironwood Release
      • What’s Included in Ironwood
      • What Is the Ironwood Git Tag?
      • Installing the Ironwood Release
      • Upgrading from the Hawthorn Release
      • Upgrading to a Subsequent Ironwood Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Hawthorn Release
      • What’s Included in Hawthorn
        • User Retirement Feature
      • What Is the Hawthorn Git Tag?
      • Installing the Hawthorn Release
      • Upgrading from the Ginkgo Release
      • Upgrading to a Subsequent Hawthorn Release
        • Upgrading a Docker Installation
        • Upgrading a Native Installation
    • Open edX Ginkgo Release
      • What’s Included in Ginkgo
      • What Is the Ginkgo Git Tag?
      • Upgrading from the Ficus Release
        • Upgrading Django Oscar
      • Upgrading to a Subsequent Ginkgo Release
        • Upgrading a Vagrant Installation
        • Upgrading a Native Installation
    • Open edX Ficus Release
      • What’s Included in Ficus
      • What Is the Ficus Git Tag?
      • Upgrading to a Subsequent Ficus Release
        • Upgrading a Vagrant Installation
        • Upgrading a Native Installation
    • Open edX Eucalyptus Release
      • What’s Included in Eucalyptus
      • What Is the Eucalyptus Git Tag?
      • Upgrading from Dogwood to Eucalyptus
      • Upgrading to a Subsequent Eucalyptus Release
        • Upgrading a Vagrant Installation
        • Upgrading a Native Installation
    • Open edX Dogwood Release
      • What’s Included in Dogwood
      • What Is the Dogwood Git Tag?
      • Upgrading from Cypress to Dogwood
        • Automatic Upgrading
        • Upgrade Process Overview
      • Upgrading to a Dogwood Point Release
        • Upgrading a Vagrant Installation
        • Upgrading a Native Installation
    • Open edX Cypress Release
      • What’s Included in Cypress
      • What is the Cypress Git Tag?
      • Upgrading from Birch to Cypress
    • Open edX Birch Release
      • What’s Included in Birch
      • What is the Birch Git Tag?
      • Upgrading from Aspen to Birch
  • Installing and Starting the Open edX Platform
    • Choose a version
    • Choose an installation method
      • Open edX Tutor Installation
  • Configuring the Open edX Platform
    • Guidelines for Updating the Open edX Platform
    • Configuring Open edX Sites
      • Create an Open edX Site
      • Configuring Sites Independently
        • Configuring a Site
        • Site Configuration Reference
    • Changing the Appearance of Open edX Sites
      • Changing Themes for an Open edX Site
        • Themes Overview
        • Root Directories for Theme Files
        • Creating a Theme
          • Understanding Which UI Files to Customize
          • Example File Path for a Theme File
          • Naming a Theme Directory
        • Enabling and Applying Themes
          • Enable Themes
          • Example Settings for Comprehensive Theme
          • Apply a Theme to a Site
        • Compiling a Theme
          • Update a Theme for the LMS or Studio
          • Update a Theme for the E-commerce Service
      • Styling Drag and Drop Problems (deprecated)
    • Adding Custom Fields to the Registration Page
      • Overview
      • Add Custom Fields to the Registration Page
    • Specifying Allowed Registration Email Patterns
      • Overview
      • Configure Allowed Email Patterns
    • Adding the CourseTalk Widget
      • Overview
      • Add the CourseTalk Widget
    • Enabling Open edX Search
      • Overview
      • Search Engines and edX Search
        • MockSearchEngine
        • ElasticSearchEngine
      • EdX Search Requirements
      • Install edX Search
      • Enable Indexing
        • Which Data Gets Indexed
      • Supported Flags
        • CMS
        • LMS
    • Enabling Course Certificates
      • Course Certificates Overview
      • Enable Course Certificates in Studio and the LMS
      • Configuring Course Certificates in Studio
      • Configure Course Certificates for Your Open edX Instance
        • Discontinue Audit Track Certificates
      • Customize Certificate Templates For Your Organization
      • Enable Certificates in Additional Languages
        • Configure Course Certificates in Additional Languages
      • Display Hours of Effort on Course Certificates
      • Enable Automatic Certificate Generation
      • Manually Generate Certificates For a Course
    • Enabling Self-Paced Courses
      • Overview
      • Enable Self-Paced Courses in the Learning Management System
    • Enabling Public Course Content
      • Public Course Content and Search Engines
      • Enable Public Course Content in the Admin
      • Set Visibility for a Course in Studio
        • Set Course Content Visibility
        • Set Course About Page Visibility
      • Feature Limitations
    • Enabling Custom Courses
    • Enabling Custom Course Settings
    • Enabling Discussion Notifications
      • Requirements for Discussion Notifications
      • Enable Discussion Notifications
    • Enabling Entrance Exams
      • Overview
      • Configure the Milestones Application
      • Enable Entrance Exams in Studio and the Learning Management System
    • Configuring Open Response Assessments
      • Configuring ORA2 to Upload Files to Alternative Storage Systems
      • Prohibiting Submission of Specified File Types
    • Enabling Course Prerequisites
      • Overview
      • Configure the Milestones Application
      • Enable Prerequisite Courses in Studio and the Learning Management System
    • Enabling Course and Video Licensing
      • Overview
      • Enable Licensing in Studio
    • Configuring Transcript Behavior
      • Configuring the Transcript Feature Flag
    • Configuring an edX Instance as an LTI Tool Provider
      • Enable LTI Provider Functionality
      • Configuring Credentials for a Tool Consumer
        • Configure the Tool Consumer
      • Define an Interval for Grade Aggregation (Optional)
      • Options for LTI Authentication and User Provisioning
        • Anonymous User Authentication
        • Open edX User Authentication
      • Configuring Open edX User Authentication for LTI
        • Configure Open edX User Authentication for LTI
        • Test LTI Authentication
    • Enabling Social Sharing of Courses and Certificates
      • Overview
      • Configure Social Sharing
      • Enable Custom Course URLs
        • Set a Custom URL for a Course
    • Configuring a Password Policy
      • Overview
      • Creating a Password Validator
      • Configuring a Password Validator
    • Enabling Third Party Authentication
      • Supported Identity Providers
        • Supported Identity Providers
        • Provisionally Supported Identity Providers
        • Integrating Identity Providers
      • SSO Behavior
        • New Learner Registration
        • Linking Accounts
      • Integrating Third Party Authentication in Open edX
        • Enable the Third Party Authentication Feature
        • Set Up a Third Party Authentication Provider
          • Integrating with an OAuth2 Identity Provider
            • Common OAuth2 Providers
              • Register the Open edX Instance
                • Register the Open edX Instance with Google
                • Register the Open edX Instance with Facebook
                • Register the Open edX Instance with LinkedIn
                • Register the Open edX Instance with Azure Active Directory
              • Configure Open edX
              • Add the Provider Configuration
            • Additional OAuth2 Providers (Advanced)
          • Integrating with a SAML Identity Provider
            • Exchange Metadata
            • Add and Enable a SAML Identity Provider
            • Configure the SAML Identity Provider
            • Test an Enabled SAML Provider
      • Configuring your Open edX Site as a SAML Service Provider
        • Generate Public and Private Keys
        • Add Keys to the LMS Configuration File
        • Configure your Open edX Site as a Service Provider
        • Ensure that the SAML Authentication Backend is Loaded
      • Advanced Third Party Authentication Features
        • Skip Registration Form
        • Skip Email Verification
        • Hinted Sign In
        • Auto-enrollment
        • Secondary Providers
        • SAML Attribute Requirements
      • Eliminating PII From Third-Party Authentication
        • Creating Open edX Learner Accounts Without Transmitting PII
        • Minimizing PII in Account Profiles
        • PII Considerations with SAML
      • Third Party Auth ID Mapping API
        • Using the Third Party Auth ID Mapping API
    • Enabling Timed Exams
      • Overview
      • Enable Timed Exams in Studio and the Learning Management System
    • Setting Up the YouTube API Key
      • Overview
      • Get a YouTube API Key
      • Install the YouTube API Key in Open edX
        • Option 1: Ansible (recommended)
        • Option 2: JSON files
    • Installing an XBlock
    • Enabling a CDN for Course Assets
      • Overview
      • Guidelines for CDN Configuration
      • Enable the CDN
    • Enabling the Weekly Learning Goals Feature
      • Overview
      • Enable the feature
    • Retrieving Extended Profile Metadata
      • Overview
        • Updating the Site Configuration
  • Open edX Analytics Options
    • Aspects
    • Cairn
    • Unsupported Analytics solutions
      • edX Insights
      • Figures
  • Adding ECommerce to Open edX
    • Open edX Commerce (WordPress Plugin)
    • Open edX Webhook Receiver
  • Setting Up the Open edX Mobile Applications
    • Currently Supported Mobile Applications
    • Mobile Documentation
  • Index of Open edX Feature Flags
  • Glossary
• Site Operators: Quickstarts
  • Site Operators: Quick Start
  • Tutor Quickstart (Operator)
• Site Operators: How-tos
  • How to Enable a Waffle Flag for a User
  • Configuring Site-Wide Analytics Tools
  • Configuring Badges
    • Feature switch
    • Default settings
  • Enable Badges
    • Prerequisites - service account
    • Enable feature
    • Configure integration
  • Enabling Public Course Content
    • Public Course Content and Search Engines
    • Enable Public Course Content in the Admin
    • Set Visibility for a Course in Studio
      • Set Course Content Visibility
      • Set Course About Page Visibility
    • Feature Limitations
  • Configuring Google Analytics
    • Adding Google Analytics 4
    • Confirming the Configuration
      • edx-platform templates
      • MFE pages
  • Use A Frontend Plugin Framework Slot
    • More on Frontend Plugin Slots
• Site Operators: Concepts
  • What is Tutor?
• Site Operators: References
  • Badges Configuration examples
  • Available Frontend Plugin Slots
    • Header slots, available in MFEs that use frontend-component-header:
    • Footer slots, available in MFEs that use frontend-component-footer:
    • A slot only available in the Account MFE:
    • Slots only available in the Authoring MFE:
    • Slots only available in the Learner Dashboard MFE:
    • Slots only available in the Learning MFE:

Maintenance chart

Review Date	Working Group Reviewer	Release	Test situation

---

Feedback