Skip to content

Commit a68423b

Browse files
authored
docs: document default password reset URL (#14688)
Fixes #14575
1 parent bbdfdb8 commit a68423b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/authentication/email.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,13 @@ The following options are available:
116116
| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users attempting to reset their password. [More details](#generateEmailHTML). |
117117
| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users attempting to reset their password. [More details](#generateEmailSubject). |
118118

119+
<Banner type="success">
120+
**Tip:** Payload provides a built-in password reset page. If you don't need a
121+
custom frontend, you can link directly to `${serverURL}/admin/reset/${token}`.
122+
The admin and reset routes are configurable via `config.routes.admin` and
123+
`config.admin.routes.reset` respectively.
124+
</Banner>
125+
119126
#### generateEmailHTML
120127

121128
This function allows for overriding the HTML within emails that are sent to users attempting to reset their password. The function should return a string that supports HTML, which can be a full HTML email.

0 commit comments

Comments
 (0)