view mod_invites/README.markdown @ 3989:32d7f05e062f

mod_auth_custom_http: Unlock globals while loading socket.http ltn12 tries to set a global and isn't caught by the require sandboxing. Lua 5.2 issue?
author Matthew Wild <mwild1@gmail.com>
date Thu, 23 Apr 2020 15:39:12 +0100
parents 824447fc7759
children 96838617695a
line wrap: on
line source


This module manages the creation and consumption of invite codes for the
host(s) it is loaded onto. It currently does not expose any admin/user-facing
functionality (though in the future it will probably gain a way to view/manage
pending invites).

Other modules can use the API from this module to create invite tokens which
can be used to e.g. register accounts or create automatic subscription approvals.

# Configuration

``` {.lua}
-- Configure the number of seconds a token is valid for (default 7 days)
invite_expiry = 86400 * 7
```

Note that all modules that use this API will automatically load this module,
so adding it to modules_enabled is generally not necessary.

# Compatibility

0.11 and later.