Mercurial > prosody-modules
comparison mod_email_pass/README.markdown @ 1803:4d73a1a6ba68
Convert all wiki pages to Markdown
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 28 Aug 2015 18:03:58 +0200 |
| parents | mod_email_pass/README.wiki@29f3d6b7ad16 |
| children |
comparison
equal
deleted
inserted
replaced
| 1802:0ab737feada6 | 1803:4d73a1a6ba68 |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - 'Stage-Beta' | |
| 4 ... | |
| 5 | |
| 6 Introduction | |
| 7 ============ | |
| 8 | |
| 9 This module aims to help in the procedure of user password restoration. | |
| 10 To start the restoration, the user must go to an URL provided by this | |
| 11 module, fill the JID and email and submit the request. | |
| 12 | |
| 13 The module will generate a token valid for 24h and send an email with a | |
| 14 specially crafted url to the vCard email address. If the user goes to | |
| 15 this url, will be able to change his password. | |
| 16 | |
| 17 Usage | |
| 18 ===== | |
| 19 | |
| 20 Simply add "email\_pass" to your modules\_enabled list and copy files | |
| 21 "**mod\_email\_pass.lua**" and "**vcard.lib.lua**" to prosody modules | |
| 22 folder. This module need to that **https\_host** or **http\_host** must | |
| 23 be configured. This parameter is necessary to construct the URL that has | |
| 24 been sended to the user. | |
| 25 | |
| 26 This module only send emails to the vCard user email address, then the | |
| 27 user must set this address in order to be capable of do the restoration. | |
| 28 | |
| 29 Configuration | |
| 30 ============= | |
| 31 | |
| 32 --------------- ------------------------------------------------------------ | |
| 33 smtp\_server The Host/ip of your SMTP server | |
| 34 smtp\_port Port used by your SMTP server. Default 25 | |
| 35 smtp\_ssl Use of SMTP SSL legacy (No STARTTLS) | |
| 36 smtp\_user Username used to do SMTP auth | |
| 37 smtp\_pass Password used to do SMTP auth | |
| 38 smtp\_address EMail address that will be apears as From in mails | |
| 39 msg\_subject Subject used for messages/mails | |
| 40 msg\_body Message send when password has been changed | |
| 41 url\_path Path where the module will be visible. Default /resetpass/ | |
| 42 --------------- ------------------------------------------------------------ | |
| 43 | |
| 44 Compatibility | |
| 45 ============= | |
| 46 | |
| 47 ----- ------- | |
| 48 0.9 Works | |
| 49 ----- ------- |