mod_password_reset/README.markdown
author Ben Smith <bens@effortlessis.com>
Tue, 14 May 2024 07:31:34 -0700
changeset 5912 dcea4b4c415d
parent 5085 660160fe97fa
permissions -rw-r--r--
Tweaking documentation to clarify that Oauth2 can be used for VirtualHosts and Component installations.

---
labels:
- 'Stage-Alpha'
summary: 'Enables users to reset their password via a link'
rockspec:
  build:
    copy_directories:
    - password_reset
...

Introduction
============

This module allows users to reset their password via a simple link to a web page.

Reset links may be generated by an admin through their XMPP client using the ad-hoc
command that this module provides. Alternatively other modules may reuse this module
to generate links and e.g. send them via email to the user directly.

A link is only valid for a single reset, and expires after a duration (24 hours by default).

This module depends on Prosody's internal webserver.

Compatibility
=============

  ----- -------
  0.10  Works
  ----- -------
  trunk Works
  ----- -------