Mercurial > prosody-modules
comparison mod_client_management/README.md @ 5294:385346b6c81d
mod_client_management: New module for users to view/manage permitted clients
This is just the data and API part.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 30 Mar 2023 11:32:50 +0100 |
| parents | |
| children | 7c123d3285de |
comparison
equal
deleted
inserted
replaced
| 5293:f60287bba62c | 5294:385346b6c81d |
|---|---|
| 1 --- | |
| 2 labels: | |
| 3 - Stage-Beta | |
| 4 summary: "Manage clients with access to your account" | |
| 5 rockspec: | |
| 6 dependencies: | |
| 7 - mod_sasl2_fast | |
| 8 --- | |
| 9 | |
| 10 This module allows a user to identify what currently has access to their | |
| 11 account. | |
| 12 | |
| 13 This module depends on [mod_sasl2_fast] and mod_tokenauth (bundled with | |
| 14 Prosody). Both will be automatically loaded if this module is loaded. | |
| 15 | |
| 16 ## Configuration | |
| 17 | |
| 18 | Name | Description | Default | | |
| 19 |---------------------------|--------------------------------------------------------|-----------------| | |
| 20 | enforce_client_ids | Only allow SASL2-compatible clients | `false` | | |
| 21 | |
| 22 When `enforce_client_ids` is not enabled, the client listing may be less accurate due to legacy clients, | |
| 23 which can only be tracked by their resource, which is public information, not necessarily unique to a | |
| 24 client instance, and is also exposed to other XMPP entities the user communicates with. | |
| 25 | |
| 26 When `enforce_client_ids` is enabled, clients that don't support SASL2 and provide a client id will be | |
| 27 denied access. | |
| 28 | |
| 29 ## Compatibility | |
| 30 | |
| 31 Requires Prosody trunk (as of 2023-03-29). Not compatible with Prosody 0.12 | |
| 32 and earlier. |