mirror of https://github.com/0rangebananaspy/authelia.git synced 2024-09-14 22:47:21 +07:00

feat(notification): password reset notification custom templates (#2828 )

Implemented a system to allow overriding email templates, including the remote IP, and sending email notifications when the password was reset successfully.

Closes #2755, Closes #2756

Co-authored-by: Manuel Nuñez <@mind-ar>
Co-authored-by: James Elliott <james-d-elliott@users.noreply.github.com>

2022-04-03 22:24:51 +10:00

2.6 KiB

Raw Blame History

layout	title	parent	nav_order	has_children
default	Notifier	Configuration	8	true

Notifier

Authelia sometimes needs to send messages to users in order to verify their identity.

Configuration

notifier:
  disable_startup_check: false
  template_path: /path/to/templates/folder
  filesystem: {}
  smtp: {}

Options

disable_startup_check

type: boolean {: .label .label-config .label-purple } default: false {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

The notifier has a startup check which validates the specified provider configuration is correct and will be able to send emails. This can be disabled with the disable_startup_check option:

template_path

type: string {: .label .label-config .label-purple } default: "" {: .label .label-config .label-blue } required: no {: .label .label-config .label-green }

This option allows the administrator to set custom templates for notifications the templates folder should contain the following files

File	Description
PasswordResetStep1.html	HTML Template for Step 1 of password reset process
PasswordResetStep1.txt	Text Template for Step 1 of password reset process
PasswordResetStep2.html	HTML Template for Step 2 of password reset process
PasswordResetStep2.txt	Text Template for Step 2 of password reset process

Note:

if you don't define some of these files, a default template is used for that notification

In template files, you can use the following variables:

File	Description
`{{.title}}`	A predefined title for the email. It will be `"Reset your password"` or `"Password changed successfully"`, depending on the current step
`{{.url}}`	The url that allows to reset the user password
`{{.displayName}}`	The name of the user, i.e. `John Doe`
`{{.button}}`	The content for the password reset button, it's hardcoded to `Reset`
`{{.remoteIP}}`	The remote IP address that initiated the request or event

Example

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

filesystem

The filesystem provider.

smtp

The smtp provider.

2.6 KiB Raw Blame History