Installing, Configuring, and Running the Open edX Platform#
This guide provides instructions for using your own instance of the Open edX platform and associated applications.
This document applies to the most recent version of the Open edX platform, that is, it applies to the master branch of the edX platform. This document also contains instructions for installing Open edX releases. The most recent release of the Open edX platform is Lilac.
You can install any release of the Open edX platform. For most situations, edX recommends that you install the most recent release. However, if your organization or project is currently running an earlier release, or your software requires a specific release, you may want to install an earlier release.
- 1. General Information
- 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
- 4. Configuring the Open edX Platform
- 4.1. Guidelines for Updating the Open edX Platform
- 4.2. Configuring Open edX Sites
- 4.3. Changing the Appearance of Open edX Sites
- 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.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.21. Enabling Social Sharing of Courses and Certificates
- 4.22. Configuring a Password Policy
- 4.23. Enabling Third Party Authentication
- 4.24. Enabling Timed Exams
- 4.25. Enabling the User Retirement Feature
- 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
- 6. Adding E-Commerce to the Open edX Platform
- 7. Setting Up the Open edX Mobile Applications
- 8. Index of Open edX Feature Flags
- 9. Glossary