Skip to main content

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

Project description

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: "no-reply@example.org"

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tutor_contrib_platform_notifications-21.0.1.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file tutor_contrib_platform_notifications-21.0.1.tar.gz.

File metadata

File hashes

Hashes for tutor_contrib_platform_notifications-21.0.1.tar.gz
Algorithm Hash digest
SHA256 0ca640a7c7ab426ebb79e15ad29687b5fb63381236e4bb49ea4cb6db6d66c907
MD5 f9ddc1708b938c7195bbe64152bc6a68
BLAKE2b-256 5425114b3c17f71955b48a56f973e73744d6bcd76fcc6a6a0fa23573687b8496

See more details on using hashes here.

File details

Details for the file tutor_contrib_platform_notifications-21.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for tutor_contrib_platform_notifications-21.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ffd8549dfa23451d1d68900f3d1c2f6afdef15f6ea8e011e7796061f5c27bd8
MD5 e5700074e9e85abafd49b05ff5a11e32
BLAKE2b-256 927b5c77945c2729e984131a3ad0f8fde976b10ba05af3d700850a5c9dfcd6ad

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page