03 ‐ Notifications
VoucherVault makes use of Apprise push notifications.
You can find a list of supported notification channels here.
Browse the VoucherVault web application and login.
Now use the top right user profile section to access the Notification Settings.
Here you can configure one or multiple (comma or newline separated) Apprise URLs.
You can use the Test button to test your defined Apprise URLs. If everything works as expected, hit the Update button.
Warning
The Apprise URLs are not displayed again afterwards to protect secrets.
You can click the Test button again to ensure notification are still working though.
A working Apprise URL for sending out e-mail notifications may look like this:
mailtos://myuser:[email protected]?smtp=smtp.gmail.com&[email protected]&[email protected]
For everything else, please see the official documentation by Apprise.
You can always test your Apprise URLs via the following way:
# exec into the vouchervault container
docker exec -it vouchervault bash
# test your apprise url
apprise --debug -t 'Test Message Title' -b 'Test Message Body' '<YOUR-APPRISE-URL>'
Browse the VoucherVault web application and login.
Now use the top right user profile section to access the Notification Settings.
Remove all previously configured Apprise URLs by clearing the input form.
Then hit the button Update. Notifications are disabled now.
The expiry check runs daily at 9 AM.
You are allowed to adjust the time an expiry check is run. However, please leave the crontab schedule on a daily run.
If you want to adjust the time the cronjob runs, please head over to the admin area at Periodic Tasks > Periodic Expiry Check > Crontab Schedule > Edit and adjust it. You must authenticate as superuser (default admin user).
The interval, how often items are checked against a potential expiry, is pre-defined (every Monday at 9AM) in the Django admin area.
Here, we are utilizing Django-Celery-Beat + a Redis instance for periodic task execution.
If you want to adjust the crontab interval, please head over to the admin area at Periodic Tasks > Periodic Expiry Check > Crontab Schedule > Edit and adjust to your liking. You must authenticate as superuser (default admin user).
An item will trigger an expiry notification if the expiry date is within the number of days defined by the environment variable EXPIRY_THRESHOLD_DAYS.
By default, this threshold is set to 30 days. It is displayed within the Notification Settings too.
You can adjust the threshold by modifying the Docker container's environment variable EXPIRY_THRESHOLD_DAYS. Typically, by adjusting the docker-compose.yml file and restarting the container.
Expiry notifications are sent out only once. The trigger is based on the EXPIRY_THRESHOLD_DAYS environment variable. So if an item falls within this time frame, a notification is sent out using Apprise once.
Additionally, there will be a final reminder notification shortly before an item expires (default 7 days before expiry). You can configure this behavior via the environment variable EXPIRY_LAST_NOTIFICATION_DAYS. This notification is also sent out once and acts as a last chance reminder to redeem your item(s).