mirrors
/
authelia
mirror of https://github.com/authelia/authelia.git
0
0
Fork 0
Code Issues Projects Releases Wiki Activity
authelia/docs/content/reference/guides/notification-templates.md

6.1 KiB
Raw Permalink Blame History

title description summary date draft images weight toc seo
Notification Templates A reference guide on overriding notification templates This section contains reference documentation for Authelia's notification templates. 2022-06-15T17:51:47+10:00 false
220 true
title description canonical noindex
false

Authelia uses templates to generate the HTML and plaintext emails sent via the notification service. Each template has two extensions; .html for HTML templates, and .txt for plaintext templates.

This guide effectively documents the usage of the template_path notification configuration option.

Important Notes

  1. The templates are not covered by our stability guarantees as per our Versioning Policy. While we aim to avoid changes to the templates which would cause users to have to manually change them changes may be necessary in order to facilitate bug fixes or generally improve the templates.
    1. It is your responsibility to ensure your templates are up to date. We make no efforts in facilitating this.
  2. We may not be able to offer any direct support in debugging these templates. We only offer support and fixes to the official templates.
  3. All templates MUST be encoded in UTF-8 with CRLF line endings. The line endings MUST NOT be a simple LF.

Template Names

Template Description
Event Used to render notifications sent about events
IdentityVerificationOTC Used to render notifications sent when stateful validation is required such as managing credentials
IdentityVerificationJWT Used to render notifications sent when stateless validation is required such as resetting passwords

For example, to modify the IdentityVerificationJWT HTML template, if your template_path was configured as /config/email_templates, you would create the /config/email_templates/IdentityVerificationJWT.html file to override the HTML IdentityVerificationJWT template.

Placeholder Variables

In template files, you can use the following placeholders which are automatically injected into the templates:

Placeholder Templates Description
{{ .LinkURL }} IdentityVerificationJWT, IdentityVerificationOTC The URL associated with the notification if applicable.
{{ .LinkText }} IdentityVerificationJWT, IdentityVerificationOTC The display value for the URL associated with the notification if applicable.
{{ .RevocationLinkURL }} IdentityVerificationJWT, IdentityVerificationOTC The Revocation URL associated with the notification if applicable.
{{ .RevocationLinkText }} IdentityVerificationJWT, IdentityVerificationOTC The display value for the Revocation URL associated with the notification if applicable.
{{ .BodyPrefix }} Event Prefix for the body event.
{{ .BodyEvent }} Event The event description.
{{ .Title }} All A predefined title for the email.
It will be "Reset your password" or "Password changed successfully", depending on the current step.
{{ .DisplayName }} All The name of the user, i.e. John Doe
{{ .RemoteIP }} All The remote IP address (client) that initiated the request or event.
{{ .Domain }} All The relevant domain for Authelia.

Examples

This is a basic example:

<body>
  <h1>{{ .Title }}</h1>
  Hi {{ .DisplayName }}<br/>
  This email has been sent to you in order to validate your identity.
  Click <a href="{{ .LinkURL }}">here</a> to change your password.
</body>

Some Additional examples for specific purposes can be found in the examples directory on GitHub.

Original Templates

The original template content can be found on GitHub.

Functions

Several functions are implemented with the email templates. See the Templating Reference Guide for more information.