From: "Alexander Zeidler" <a.zeidler@proxmox.com>
To: "Proxmox VE development discussion" <pve-devel@lists.proxmox.com>
Subject: Re: [pve-devel] [PATCH pve-docs] notifications: add section about how to use custom templates
Date: Wed, 09 Apr 2025 09:56:05 +0200 [thread overview]
Message-ID: <D91Y3Z7OQ9J8.13X9K2ESP0USN@proxmox.com> (raw)
In-Reply-To: <20250409074713.55474-1-l.wagner@proxmox.com>
On Wed Apr 9, 2025 at 9:47 AM CEST, Lukas Wagner wrote:
> 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>
> ---
> notifications.adoc | 25 +++++++++++++++++++++++++
> 1 file changed, 25 insertions(+)
>
> diff --git a/notifications.adoc b/notifications.adoc
> index 331ac1d..0b0311b 100644
> --- a/notifications.adoc
> +++ b/notifications.adoc
> @@ -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.
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next prev parent reply other threads:[~2025-04-09 7:56 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-09 7:47 Lukas Wagner
2025-04-09 7:56 ` Alexander Zeidler [this message]
2025-04-09 8:10 ` [pve-devel] applied: " Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=D91Y3Z7OQ9J8.13X9K2ESP0USN@proxmox.com \
--to=a.zeidler@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal