Forum plugin for Tutor

This plugin adds discussion forums to your Open edX platform, such that students can have conversations about the courses they are following right in your LMS.

Forum screenshot

Installation

pip install tutor-forum

Usage

tutor plugins enable forum
tutor local launch

Configuration

  • FORUM_DOCKER_IMAGE (default: ""{{ DOCKER_REGISTRY }}overhangio/openedx-forum:{{ FORUM_VERSION }}")
  • FORUM_MONGODB_DATABASE (default: "cs_comments_service")
  • FORUM_PORT (default: "4567"")
  • FORUM_API_KEY (default: "forumapikey")
  • FORUM_MONGODB_USE_SSL: (default: False)
  • FORUM_MONGODB_AUTH_SOURCE: (default: "")
  • FORUM_MONGODB_AUTH_MECH: (default: "")
  • FORUM_REPOSITORY (default: "https://github.com/openedx/cs_comments_service.git")
  • FORUM_REPOSITORY_VERSION (default: "{{ OPENEDX_COMMON_VERSION }}")

Caveats for the mongodb+srv:// syntax

While the newer [mongodb+srv://](https://www.mongodb.com/developer/products/mongodb/srv-connection-strings/) syntax for the MONGODB_HOST is supported, there are some tradeoffs:

  • Query paramaters in the URL are not supported. For example, the URL mongodb+srv://test:test@tutor.local/?ssl=true&authSource=admin is invalid. Please use the provided configuration options instead.
  • The username and password should form part of the URL in the format mongodb+srv://username:password@host/.

Debugging

To debug the comments service, you are encouraged to mount the cs_comments_service repo from the host in the development container:

tutor dev start --mount /path/to/cs_comments_service

Once a local repository is mounted in the image, you will have to install all gems (ruby dependencies):

bundle install

Troubleshooting

This Tutor plugin is maintained by Ghassan Maslamani from Zaat.dev. Community support is available from the official Open edX forum. Do you need help with this plugin? See the troubleshooting section from the Tutor documentation.

License

This software is licensed under the terms of the AGPLv3.