From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id A50141FF187 for ; Wed, 9 Apr 2025 09:56:14 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 5D7044CE3; Wed, 9 Apr 2025 09:56:09 +0200 (CEST) Mime-Version: 1.0 Date: Wed, 09 Apr 2025 09:56:05 +0200 Message-Id: From: "Alexander Zeidler" To: "Proxmox VE development discussion" References: <20250409074713.55474-1-l.wagner@proxmox.com> In-Reply-To: <20250409074713.55474-1-l.wagner@proxmox.com> X-SPAM-LEVEL: Spam detection results: 0 AWL 0.086 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: Re: [pve-devel] [PATCH pve-docs] notifications: add section about how to use custom templates X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" 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 Reviewed-by: Alexander Zeidler > --- > 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 > +`-..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 `-body.html.hbs` as well as the `-body.txt.hbs` template > +will be used when rendering the email message. All other notification > +target types only use the `-body.txt.hbs` template. _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel