public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
* [pbs-devel] [PATCH proxmox-backup v2 1/3] docs: notifications: add section about how to use custom templates
@ 2025-04-09  8:46 Lukas Wagner
  2025-04-09  8:46 ` [pbs-devel] [PATCH proxmox-backup v2 2/3] docs: notifications: reflow text to 80 characters Lukas Wagner
                   ` (3 more replies)
  0 siblings, 4 replies; 5+ messages in thread
From: Lukas Wagner @ 2025-04-09  8:46 UTC (permalink / raw)
  To: pbs-devel

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>
---
 docs/notifications.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/docs/notifications.rst b/docs/notifications.rst
index 34fc0128..2781dc1e 100644
--- a/docs/notifications.rst
+++ b/docs/notifications.rst
@@ -362,3 +362,23 @@ type via the ``notify`` option.
 
 The ``notify-user`` and ``notify`` options are ignored if ``notification-mode``
 is set to ``notification-system``.
+
+Overriding Notification Templates
+---------------------------------
+
+Proxmox Backup Server uses Handlebars templates to render notifications. The
+original templates provided by Proxmox Backup Server are stored in
+``/usr/share/proxmox-backup/templates/default/``.
+
+Notification templates can be overridden by providing a custom template file in
+the override directory at
+``/etc/proxmox-backup/notification-templates/default/``. When rendering a
+notification of a given type, Proxmox Backup Server 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>.txt.hbs``. For instance, the file
+``gc-err-body.txt.hbs`` contains the template for rendering notifications for
+garbage collection errors, while ``package-updates-subject.txt.hbs`` is used to
+render the subject line of notifications for available package updates.
-- 
2.39.5



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2025-04-09  9:49 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-04-09  8:46 [pbs-devel] [PATCH proxmox-backup v2 1/3] docs: notifications: add section about how to use custom templates Lukas Wagner
2025-04-09  8:46 ` [pbs-devel] [PATCH proxmox-backup v2 2/3] docs: notifications: reflow text to 80 characters Lukas Wagner
2025-04-09  8:46 ` [pbs-devel] [PATCH proxmox-backup v2 3/3] docs: notification: use unicode arrow instead of -> Lukas Wagner
2025-04-09  9:05 ` [pbs-devel] [PATCH proxmox-backup v2 1/3] docs: notifications: add section about how to use custom templates Lukas Wagner
2025-04-09  9:49 ` [pbs-devel] applied: " Thomas Lamprecht

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