Email notifications and messages¶
Notifications and messages within Canopy can be sent via email. There are user-driven messages and also system-driven messages. A system-driven message might be one relating to an operation having completed (e.g. report ready for download or report due with client today). The content of many of these can be modified via the Message templates system.
In order to set this up, the following settings need to be configured
EXTERNAL_BASE_URL is used as the prefix for any links sent
out via email. This is typically set to the production URL of your
It’s recommended to change the author email (
default: firstname.lastname@example.org) and name (
default: CheckSec Canopy Notifications). These settings should be in
the Admin → Settings interface.
EMAIL_AUTHOR_NAME are not set
or misconfigured a warning message will be logged whenever an email
If these are not present, you can add them as follows (from the command line):
sudo canopy-manage shell_plus
Create and save the following settings:
email_author_address = Setting(setting="EMAIL_AUTHOR_ADDRESS", value="email@example.com")
email_author_name = Setting(setting="EMAIL_AUTHOR_NAME", value="Pentest Team Notifications")
Validation of the email configuration can be done via the
send_test_email command. If the email settings have been setup-up
properly then an email should be received at the provided address from
canopy-manage send_test_email firstname.lastname@example.org canopy-manage send_test_email email@example.com 'alternate message'
It is possible to extend the base functionality of the email system using plugins. The following plugins ship with Canopy: