proxmox-mirrors/pve-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-docs synced 2025-06-14 11:07:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

notifications: add section about how to use custom templates

Browse Source 
This section is meant to give a basic overview on how to use
custom templates for notifications. It will be expanded in the
future, providing a more detailed view on how templates are resolved,
existing fallback mechanisms, available templates, template
variables and helpers.

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Reviewed-by: Alexander Zeidler <a.zeidler@proxmox.com>
Link: https://lore.proxmox.com/20250409074713.55474-1-l.wagner@proxmox.com
This commit is contained in:
Lukas Wagner 2025-04-09 09:47:13 +02:00 committed by Thomas Lamprecht
parent a3479f7fb6
commit 56f3d84b75
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
notifications.adoc
View File

@ -462,3 +462,28 @@ to `auto`.
The `legacy-sendmail` mode might be removed in a later release of
{pve}.
Overriding Notification Templates
---------------------------------
{pve} uses Handlebars templates to render notifications. The
original templates provided by {pve} are stored in
`/usr/share/pve-manager/templates/default/`.
Notification templates can be overridden by providing a custom template
file in the override directory at `/etc/pve/notification-templates/default/`.
When rendering a notification of a given type, {pve} will first attempt
to load a template from the override directory. If this one does not
exist or fails to render, the original template will be used.
The template files follow the naming convention of
`<type>-<body|subject>.<html|txt>.hbs`. For instance, the file
`vzdump-body.html.hbs` contains the template for rendering the HTML version
for backup notifications, while `package-updates-subject.txt.hbs` is used to
render the subject line of notifications for available package updates.
Email-based notification targets, such as `sendmail` and `smtp`, always send
multi-part messages with an HTML and a plain text part. As a result, both
the `<type>-body.html.hbs` as well as the `<type>-body.txt.hbs` template
will be used when rendering the email message. All other notification
target types only use the `<type>-body.txt.hbs` template.