File

mod_password_reset/README.markdown @ 5931:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parent 5081:660160fe97fa
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
  ----- -------