Skip to main content
Ctrl+K
Installing, Configuring, and Running the Open edX Platform documentation - Home
  • Installing, Configuring, and Running the Open edX Platform
  • 1. General Information
    • 1.1. Read Me
    • 1.2. Getting Help
    • 1.3. Other edX Resources
    • 1.4. Open edX Browser Support
  • 2. Open edX Platform Releases
    • 2.1. Open edX Olive Release
    • 2.2. Open edX Nutmeg Release
    • 2.3. Open edX Maple Release
    • 2.4. Open edX Lilac Release
    • 2.5. Open edX Koa Release
    • 2.6. Open edX Juniper Release
    • 2.7. Open edX Ironwood Release
    • 2.8. Open edX Hawthorn Release
    • 2.9. Open edX Ginkgo Release
    • 2.10. Open edX Ficus Release
    • 2.11. Open edX Eucalyptus Release
    • 2.12. Open edX Dogwood Release
    • 2.13. Open edX Cypress Release
    • 2.14. Open edX Birch Release
  • 3. Installing and Starting the Open edX Platform
    • 3.2.1. Open edX Tutor Installation
    • 3.2.2. Lilac Open edX Native Installation
    • 3.2.3. Devstack
  • 4. Configuring the Open edX Platform
    • 4.1. Guidelines for Updating the Open edX Platform
    • 4.2. Configuring Open edX Sites
      • 4.2.1. Create an Open edX Site
      • 4.2.2. Configuring Sites Independently
    • 4.3. Changing the Appearance of Open edX Sites
      • 4.3.1. Changing Themes for an Open edX Site
        • 4.3.1.1. Themes Overview
        • 4.3.1.2. Root Directories for Theme Files
        • 4.3.1.3. Creating a Theme
        • 4.3.1.4. Enabling and Applying Themes
        • 4.3.1.5. Compiling a Theme
      • 4.3.2. Styling Drag and Drop Problems
    • 4.4. Adding Custom Fields to the Registration Page
    • 4.5. Specifying Allowed Registration Email Patterns
    • 4.6. Adding the CourseTalk Widget
    • 4.7. Enabling Open edX Search
    • 4.8. Enabling Badging
    • 4.9. Enabling Course Certificates
    • 4.10. Enabling Self-Paced Courses
    • 4.11. Enabling Public Course Content
    • 4.12. Enabling Custom Courses
    • 4.13. Enabling Custom Course Settings
    • 4.14. Enabling Discussion Notifications
    • 4.15. Enabling Entrance Exams
    • 4.16. Configuring Open Response Assessments
      • 4.16.1. Configuring ORA2 to Upload Files to Alternative Storage Systems
      • 4.16.2. Prohibiting Submission of Specified File Types
    • 4.17. Enabling Course Prerequisites
    • 4.18. Enabling Course and Video Licensing
    • 4.19. Configuring Transcript Behavior
    • 4.20. Configuring an edX Instance as an LTI Tool Provider
      • 4.20.1. Enable LTI Provider Functionality
      • 4.20.2. Configuring Credentials for a Tool Consumer
      • 4.20.3. Define an Interval for Grade Aggregation (Optional)
      • 4.20.4. Options for LTI Authentication and User Provisioning
      • 4.20.5. Configuring Open edX User Authentication for LTI
    • 4.21. Enabling Social Sharing of Courses and Certificates
    • 4.22. Configuring a Password Policy
    • 4.23. Enabling Third Party Authentication
      • 4.23.1. Supported Identity Providers
      • 4.23.2. SSO Behavior
      • 4.23.3. Integrating Third Party Authentication in Open edX
        • 4.23.3.2.1. Integrating with an OAuth2 Identity Provider
        • 4.23.3.2.2. Integrating with a SAML Identity Provider
      • 4.23.4. Configuring your Open edX Site as a SAML Service Provider
      • 4.23.5. Advanced Third Party Authentication Features
      • 4.23.6. Eliminating PII From Third-Party Authentication
      • 4.23.7. Third Party Auth ID Mapping API
    • 4.24. Enabling Timed Exams
    • 4.25. Enabling the User Retirement Feature
      • 4.25.1. Implementation Overview
      • 4.25.2. Setting Up User Retirement in the LMS
      • 4.25.3. Setting Up the User Retirement Driver Scripts
      • 4.25.4. Handling Special Cases
    • 4.26. Setting Up the YouTube API Key
    • 4.27. Installing an XBlock
    • 4.28. Enabling a CDN for Course Assets
    • 4.29. Enabling the Weekly Learning Goals Feature
    • 4.30. Retrieving Extended Profile Metadata
  • 5. Adding edX Insights for Course Teams
    • 5.1. Options for Installing edX Insights
    • 5.2. Using Elastic MapReduce on AWS
  • 6. Adding E-Commerce to the Open edX Platform
    • 6.1. Install and Start the E-Commerce Service
    • 6.2. Comprehensive Theming
    • 6.3. Manage Static Assets
    • 6.4. Create E-Commerce Products
      • 6.4.1. Creating Products Overview
      • 6.4.2. Create Course Seats
      • 6.4.3. Create and Manage Coupons
      • 6.4.4. Enable and Create Enrollment Codes
      • 6.4.5. About Programs
      • 6.4.6. Create Program Offers
    • 6.5. Enable the E-Commerce Service Receipt Page
    • 6.6. Manage Orders
    • 6.7. Test Your E-Commerce Application
    • 6.8. Additional E-Commerce Features
      • 6.8.1. Sending Notifications
      • 6.8.2. Changing Payment Processors
      • 6.8.3. Apple Pay
      • 6.8.4. Tracking Data
      • 6.8.5. Gating E-Commerce Service Features
      • 6.8.6. Maintaining the E-Commerce Service
    • 6.9. Internationalization
  • 7. Setting Up the Open edX Mobile Applications
  • 8. Index of Open edX Feature Flags
  • 9. Glossary
  • Repository
  • Suggest edit
  • Open issue
  • .rst

General Information

1. General Information#

  • 1.1. Read Me
  • 1.2. Getting Help
    • 1.2.1. Where to Find Help
    • 1.2.2. Information to Provide When Asking for Help
  • 1.3. Other edX Resources
    • 1.3.1. Resources for edx.org Learners
    • 1.3.2. The edX Partner Portal
    • 1.3.3. The Open edX Site
    • 1.3.4. System Status
    • 1.3.5. Resources for edx.org Course Teams
    • 1.3.6. Resources for Researchers
    • 1.3.7. Resources for Developers
    • 1.3.8. Resources for Open edX
  • 1.4. Open edX Browser Support

previous

Installing, Configuring, and Running the Open edX Platform

next

1.1. Read Me

© Copyright 2023, The Axim Collaborative.

Creative Commons License
These works by The Axim Collaborative are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.