Skip to content

openedx/tutor-contrib-platform-notifications

Notifications plugin for Tutor

A Tutor plugin to manage plugin slot and configuration for tray and email notifications feature. Learn more about it in Notifications & Preferences

Installation

pip install git+https://github.com/openedx/tutor-contrib-notifications

Usage

tutor plugins enable notifications

Configuration

The plugin exposes the following Tutor configuration keys:
  • NOTIFICATIONS_DEFAULT_FROM_EMAIL
  • Default: inherits from the platform CONTACT_EMAIL.
  • Purpose: sets the default "from" address used when sending notification emails.
NOTIFICATIONS_DEFAULT_FROM_EMAIL: "[email protected]"

After changing configuration,restart environment so the new environment variable and settings are picked up by the LMS and MFE images. If you rely on a specific "from" email for outgoing notifications, explicitly set NOTIFICATIONS_DEFAULT_FROM_EMAIL rather than relying on the platform-wide CONTACT_EMAIL.

Visibility of email notification preferences in the Notifications section on the Account Settings page is governed by the NOTIFICATIONS_ENABLE_SHOW_EMAIL_CHANNEL setting. It is TRUE by default.

Visibility of mobile push notification preferences in the Notifications section on the Account Settings page is governed by the NOTIFICATIONS_ENABLE_SHOW_PUSH_CHANNEL. It is FALSE by default because we do NOT have support for mobile push notifications at the moment.

License

This software is licensed under the terms of the AGPLv3.

About

A Tutor plugin to manage configuration and plugin slots for the Notifications tray feature.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6