Mercurial > prosody-modules

view mod_email_pass/README.markdown @ 5519:83ebfc367169

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Return Authentication Time per OpenID Core Section 2 Mandatory To Implement, either MUST include or OPTIONAL depending on things we don't look at, so might as well include it all the time. Since we do not persist authentication state with cookies or such, the authentication time will always be some point between the user being sent to the authorization endpoint and the time they are sent back to the client application.
author Kim Alvefur <zash@zash.se>
date Mon, 05 Jun 2023 22:32:44 +0200
parents 4d73a1a6ba68
children
line wrap: on
line source

---
labels:
- 'Stage-Beta'
...

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

This module aims to help in the procedure of user password restoration.
To start the restoration, the user must go to an URL provided by this
module, fill the JID and email and submit the request.

The module will generate a token valid for 24h and send an email with a
specially crafted url to the vCard email address. If the user goes to
this url, will be able to change his password.

Usage
=====

Simply add "email\_pass" to your modules\_enabled list and copy files
"**mod\_email\_pass.lua**" and "**vcard.lib.lua**" to prosody modules
folder. This module need to that **https\_host** or **http\_host** must
be configured. This parameter is necessary to construct the URL that has
been sended to the user.

This module only send emails to the vCard user email address, then the
user must set this address in order to be capable of do the restoration.

Configuration
=============

  --------------- ------------------------------------------------------------
  smtp\_server    The Host/ip of your SMTP server
  smtp\_port      Port used by your SMTP server. Default 25
  smtp\_ssl       Use of SMTP SSL legacy (No STARTTLS)
  smtp\_user      Username used to do SMTP auth
  smtp\_pass      Password used to do SMTP auth
  smtp\_address   EMail address that will be apears as From in mails
  msg\_subject    Subject used for messages/mails
  msg\_body       Message send when password has been changed
  url\_path       Path where the module will be visible. Default /resetpass/
  --------------- ------------------------------------------------------------

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

  ----- -------
  0.9   Works
  ----- -------