Skip to content

Remove deprecated notification cron job instructions #1453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sarina wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −15
Open

Remove deprecated notification cron job instructions #1453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 5 additions & 15 deletions source/site_ops/how-tos/enable_notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,10 @@ Key characteristics

New Settings
************

As of Verawood, new settings have been added in
`openedx/envs/common.py <https://github.com/openedx/openedx-platform/blob/09878a18f071318aa446fd78b37a95ba81a62581/openedx/envs/common.py#L2694>`_
that govern how digests are delivered.

.. code-block:: python

Expand All @@ -186,25 +189,12 @@ New Settings
Override these in your deployment settings to change when digests are delivered.

.. warning::
``send_email_digest`` management command is DEPRECATED. You should remove any cron jobs that call it.
``send_email_digest`` management command, introduced in Ulmo, is DEPRECATED. You should remove any cron jobs that call it.

The management command still exists but is now a no-op with a deprecation warning:
``WARNING: This command is deprecated. Digest emails are now scheduled automatically. Please remove cron jobs using this command.``


DEPRECATED - Daily and weekly email digests
===========================================

To enable these digests, site operators must configure `cron jobs <https://www.redhat.com/en/blog/linux-cron-command>`_ on the host machine where tutor is being used to deploy the Open edX platform.

On the Linux host machine site operators need to run `crontab -e` for adding the cron jobs. This command opens up
an editor where the below mentioned command needs to be written. Site operators can modify these command to customize the
time to send the notification email. They need to change the command to `tutor local ...` or `tutor k8s ...` depending on
if they are running the instance locally or using kubernetes.

Daily digest - ``0 22 * * * tutor local run lms ./manage.py lms send_email_digest Daily``

Weekly digest - ``0 22 * * SUN tutor local run lms ./manage.py lms send_email_digest Weekly``
If you are on an Ulmo system, please view this doc in the ``ulmo`` version for instructions on cron job configuration.

Copy link
Copy Markdown

@musaabhasan musaabhasan May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This preserves the fallback guidance, but it would be more useful as a direct versioned link to the Ulmo page rather than only saying to view the ulmo version. Operators often arrive from search or copied links and may not notice the version picker, so something like If you are on an Ulmo system, see the Ulmo notification setup page <https://docs.openedx.org/en/ulmo/site_ops/how-tos/enable_notifications.html>_ would keep the deprecated instructions discoverable without keeping them in the latest docs.


Creating a new notification
Expand Down