Mercurial > prosody-modules
comparison mod_invites/README.markdown @ 3776:80830d97da81
mod_invites: New module providing an API to create/manage invite tokens
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Fri, 27 Dec 2019 10:31:33 +0000 |
| parents | |
| children | 824447fc7759 |
comparison
equal
deleted
inserted
replaced
| 3775:d60efdb947fd | 3776:80830d97da81 |
|---|---|
| 1 | |
| 2 This module manages the creation and consumption of invite codes for the | |
| 3 host(s) it is loaded onto. It currently does not expose any admin/user-facing | |
| 4 functionality (though in the future it will probably gain a way to view/manage | |
| 5 pending invites). | |
| 6 | |
| 7 Other modules can use the API from this module to create invite tokens which | |
| 8 can be used to e.g. register accounts or create automatic subscription approvals. | |
| 9 | |
| 10 # Configuration | |
| 11 | |
| 12 `` {.lua} | |
| 13 -- Configure the number of seconds a token is valid for (default 7 days) | |
| 14 invite_expiry = 86400 * 7 | |
| 15 ``` | |
| 16 | |
| 17 Note that all modules that use this API will automatically load this module, | |
| 18 so adding it to modules_enabled is generally not necessary. | |
| 19 | |
| 20 # Compatibility | |
| 21 | |
| 22 0.11 and later. |