Open edX Platform ################# | |License: AGPL v3| |Status| |Python CI|

.. |License: AGPL v3| image:: https://img.shields.io/badge/License-AGPL_v3-blue.svg :target: https://www.gnu.org/licenses/agpl-3.0

.. |Python CI| image:: https://github.com/openedx/openedx-platform/actions/workflows/unit-tests.yml/badge.svg :target: https://github.com/openedx/openedx-platform/actions/workflows/unit-tests.yml

.. |Status| image:: https://img.shields.io/badge/status-maintained-31c653

Formerly known as "edx-platform"

Purpose

---

The Open edX Platform <https://openedx.org>_ enables the authoring and delivery of online learning at any scale. The platform is written in Python and JavaScript and makes extensive use of the Django framework. At the highest level, the platform is composed of a modular monolith, some independently deployable applications (IDAs), and micro-frontends (MFEs) based on the ReactJS.

This repository hosts the monolith at the center of the Open edX platform. Functionally, the openedx-platform repository provides two services:

• CMS (Content Management Service), which powers Open edX Studio, the platform's learning content authoring environment; and
• LMS (Learning Management Service), which delivers learning content.

Documentation

---

Documentation can be found at https://docs.openedx.org/projects/edx-platform.

Getting Started

---

For Production

Installing and running an Open edX instance is not simple. We strongly recommend that you use a service provider to run the software for you. They have free trials that make it easy to get started: https://openedx.org/get-started/

However, if you have the time and expertise, then it is is possible to self-manage a production Open edX instance. To help you build, customize, upgrade, and scale your instance, we recommend using Tutor_, the community-supported, Docker-based Open edX distribution.

You can read more about getting up and running with a Tutor deployment at the Site Ops home on docs.openedx.org_.

For Development

Tutor also features a development mode_ which will also help you modify, test, and extend openedx-platform. We recommend this method for all Open edX developers.

.. note::

Experimental: We are trialing a new bare-metal development workflow based on a dedicated development.py settings module that builds directly on common.py and uses local.openedx.io domains. It is not yet the recommended default, but you can try it by following Using the development.py settings_.

Bare Metal (Advanced)

It is also possible to spin up an Open edX platform directly on a Linux host. This method is less common and mostly undocumented. The Open edX community will only be able to provided limited support for it.

Running "bare metal" is only advisable for (a) developers seeking an adventure and (b) experienced system administrators who are willing to take the complexity of Open edX configuration and deployment into their own hands.

System Dependencies

OS:

• Ubuntu 24.04

Interpreters/Tools:

• Python 3.12

• Node: See the .nvmrc file in this repository.

Services:

• MySQL 8.0

• Mongo 7.x

• Memcached

Language Packages:

• Frontend:

  • npm clean-install (production)
  • npm clean-install --dev (development)

• Backend build:

  • uv sync --no-default-groups --only-group assets

• Backend application:

  • uv sync --no-default-groups --group bundled (production)
  • uv sync --group development --group ci (development, i.e. make dev-requirements)

  Some Python packages have system dependencies. For example, installing these packages on Debian or Ubuntu will require first running sudo apt install python3-dev default-libmysqlclient-dev build-essential pkg-config to satisfy the requirements of the mysqlclient Python package.

Codejail Setup

As a part of the baremetal setup, you will need to configure your system to work properly with codejail. See the codejail installation steps_ for more details.

.. _codejail installation steps: https://github.com/openedx/codejail?tab=readme-ov-file#installation

Build Steps

Create two MySQL databases and a MySQL user with write permissions to both, and configure Django to use them by updating the DATABASES setting.

Then, run migrations::

./manage.py lms migrate ./manage.py lms migrate --database=student_module_history ./manage.py cms migrate

Build static assets (for more details, see building static assets_)::

npm run build # or, 'build-dev'

Download locales and collect static assets (can be skipped for development sites)::

make pull_translations ./manage.py lms collectstatic ./manage.py cms collectstatic

Set up CMS SSO (for Development)::

./manage.py lms manage_user studio_worker [email protected] --unusable-password

DO NOT DO THIS IN PRODUCTION. It will make your auth insecure.

./manage.py lms create_dot_application studio-sso-id studio_worker
--grant-type authorization-code
--skip-authorization
--redirect-uris 'http://localhost:18010/complete/edx-oauth2/'
--scopes user_id
--client-id 'studio-sso-key'
--client-secret 'studio-sso-secret'

Set up CMS SSO (for Production):

• Create the CMS user and the OAuth application::

  ./manage.py lms manage_user studio_worker [email protected] --unusable-password ./manage.py lms create_dot_application studio-sso-key studio_worker
  --grant-type authorization-code
  --skip-authorization
  --redirect-uris 'http://localhost:18010/complete/edx-oauth2/'
  --scopes user_id

• Log into Django admin (eg. http://localhost:18000/admin/oauth2_provider/application/), click into the application you created above (studio-sso-key), and copy its "Client secret".

• In your private LMS_CFG yaml file or your private Django settings module:

This is the beginning of the README. Read the rest at the original. Read the full README ↗