Open edX Forum

0.4.3 verified Fri May 01 auth: no python

Open edX Forum is the forum application for Open edX platforms, providing threading, commenting, search, and moderation. Version 0.4.3 requires Python >=3.12 and supports MySQL and Typesense backends while dropping MongoDB and Python 3.11 support. Active development with frequent releases.

pip install openedx-forum

Common errors

error ModuleNotFoundError: No module named 'openedx_forum' ↓

cause Package not installed or wrong import path.

fix

Run 'pip install openedx-forum' then import 'from openedx_forum import start_forum'.

error django.core.exceptions.ImproperlyConfigured: Error loading MySQLdb module. Did you install mysqlclient? ↓

cause MySQL backend requires mysqlclient package.

fix

Install mysqlclient: 'pip install mysqlclient' or use apt/yum for system dependencies.

error pymongo.errors.ServerSelectionTimeoutError: No servers found ↓

cause MongoDB backend was removed; trying to connect to MongoDB.

fix

Upgrade to forum v0.4.3+ and migrate to MySQL. Ensure DATABASES setting points to MySQL.

error RuntimeError: Threads count mismatch after pin/unpin ↓

cause Bug in sorting threads after pin/unpin in older versions.

fix

Upgrade to v0.3.7 or later.

Warnings

breaking MongoDB backend removed in v0.4.3. Must migrate to MySQL before upgrading. ↓

fix Use the mongo2mysql management command before upgrading to 0.4.3.

breaking Python 3.11 support dropped in v0.4.2. Requires Python >=3.12. ↓

fix Upgrade Python environment to 3.12+ before installing v0.4.2+.

deprecated MongoDB backend deprecated since v0.4.0; removed in v0.4.3. Both MySQL and MongoDB backends existed temporarily but now only MySQL is supported. ↓

fix Migrate to MySQL backend using the official migration tools.

breaking Typesense search backend introduced in v0.4.1. Existing Elasticsearch/other backends are not supported. ↓

fix Set up Typesense and configure settings accordingly.

Imports

start_forum

wrong

from openedx_forum.forum import start_forum

correct

from openedx_forum import start_forum

The main entry point is at the package level.

Quickstart

Starts the forum application with default dev settings.

import os
from openedx_forum import start_forum
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'openedx_forum.settings.dev')
start_forum()