Notification Templates

This section contains reference documentation for Authelia's notification templates.

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.

Template Names

TemplateDescription
IdentityVerificationUsed to render notifications sent when registering devices or resetting passwords
PasswordResetUsed to render notifications sent when password has successfully been reset

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

Placeholder Variables

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

PlaceholderTemplatesDescription
{{ .LinkURL }}IdentityVerificationThe URL associated with the notification if applicable.
{{ .LinkText }}IdentityVerificationThe display value for the URL associated with the notification if applicable.
{{ .Title }}AllA predefined title for the email.
It will be "Reset your password" or "Password changed successfully", depending on the current step.
{{ .DisplayName }}AllThe name of the user, i.e. John Doe
{{ .RemoteIP }}AllThe remote IP address (client) that initiated the request or event.

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.