view mod_password_reset/README.markdown @ 5734:cef8bce2d71b

luacheck: Add new module API methods from trunk See * trunk rev 4d4f9e42bcf8 * trunk rev 65fb0d7a2312 * trunk rev c9ef35fab0b1
author Kim Alvefur <zash@zash.se>
date Mon, 27 Nov 2023 07:10:06 +0100
parents 660160fe97fa
children
line wrap: on
line source

---
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
  ----- -------