From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <pbs-devel-bounces@lists.proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id B99111FF187 for <inbox@lore.proxmox.com>; Wed, 9 Apr 2025 10:46:38 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id B768C666D; Wed, 9 Apr 2025 10:46:34 +0200 (CEST) From: Lukas Wagner <l.wagner@proxmox.com> To: pbs-devel@lists.proxmox.com Date: Wed, 9 Apr 2025 10:46:26 +0200 Message-Id: <20250409084628.125951-1-l.wagner@proxmox.com> X-Mailer: git-send-email 2.39.5 MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.014 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH proxmox-backup v2 1/3] docs: notifications: add section about how to use custom templates X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion <pbs-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/> List-Post: <mailto:pbs-devel@lists.proxmox.com> List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe> Reply-To: Proxmox Backup Server development discussion <pbs-devel@lists.proxmox.com> Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com> 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