Installation

Starting from the Open edX Sumac release, the forum app is distributed via the Tutor forum plugin.

The only prerequisite for installation is a working Open edX platform with Tutor, on the Sumac release (v19+) or the main branch. Enable the forum by running:

tutor plugins enable forum
tutor local launch

The forum feature will then be automatically enabled in the Open edX platform, and all API calls will be transparently handled by the new application.

Development

Run tests with:

make test-all       # run all tests
make test           # run unit tests only
make test-quality   # run quality tests only
make test-e2e       # run end-to-end tests only

When developing this application, it is recommended to clone this repository locally and mount it within the application containers:

git clone git@github.com:openedx/forum.git
tutor mounts add ./forum/

Check that the forum repository is properly bind-mounted both at build- and run-time by running tutor mounts list. It should output the following:

- name: /home/path/to/forum
  build_mounts:
  - image: openedx
    context: mnt-forum
  - image: openedx-dev
    context: mnt-forum
  compose_mounts:
  - service: openedx
    container_path: /mnt/forum
  - service: openedx-dev
    container_path: /mnt/forum

Re-build the openedx-dev image and launch the platform:

tutor images build openedx-dev
tutor dev launch

Administration

This application provides a few commands to facilitate the transition from the legacy forum app.

./manage.py lms waffle_flag --create --everyone discussions.enable_forum_v2

./manage.py lms forum_migrate_course_from_mongodb_to_mysql <course_id_1> <course_id_2>

./manage.py lms forum_migrate_course_from_mongodb_to_mysql all

./manage.py lms forum_delete_course_from_mongodb <course_id_1> <course_id_2>

./manage.py lms forum_delete_course_from_mongodb all

./manage.py lms forum_delete_course_from_mongodb all --dry-run

./manage.py lms initialize_forum_indices

./manage.py lms rebuild_forum_indices

Getting Help

If you are having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted. See LICENSE.txt for details.

Contributing

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to discuss your new feature idea with the maintainers before beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

The Open edX Code of Conduct

All community members are expected to follow the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.org.