prosody-modules
fe8222112cf4
mod_compat_roles/README.md
Software / code / prosody-modules
File
mod_compat_roles/README.md @ 6199:fe8222112cf4
mod_conversejs: Serve base app at /
This makes things slightly less awkward for the browser to figure out which
URLs belong to a PWA. The app's "start URL" was previously without the '/' and
therefore was not considered within the scope of the PWA. Now the canonical
app URL will always have a '/'.
Prosody/mod_http should take care of redirecting existing links without the
trailing / to the new URL.
If you have an installation at https://prosody/conversejs then it is now at
https://prosody/conversejs/ (the first URL will now redirect to the second
URL if you use it).
The alternative would be to make the PWA scope include the parent, i.e.
the whole of https://prosody/ in this case. This might get messy if other
PWAs are provided by the same site or Prosody installation, however.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Tue, 11 Feb 2025 13:18:38 +0000 |
| parent | 6003:fe081789f7b5 |
line wrap: on
line source
--- labels: - Stage-Alpha summary: Compatibility layer for Prosody's future roles API --- Introduction ============ This module provides compatibility with Prosody's new role and permissions system. It aims to run on Prosody 0.11 and 0.12, providing a limited version of the new API backed by is_admin() (which is not going to be present in trunk and future Prosody versions). It is designed for use by modules which want to be compatible with Prosody versions with and without the new permissions API. Configuration ============= There is no configuration. Usage (for developers) ====================== If you are a module developer, and want your module to work with Prosody trunk and future releases, you should avoid the `usermanager.is_admin()` function. Instead, depend on this module: ``` module:depends("compat_roles") ``` Then use `module:may()` instead: ``` if module:may(":do-something") then -- Blah end ``` For more information on the new role/permissions API, check Prosody's developer documentation at https://prosody.im/doc/developers/permissions Compatibility ============= Requires Prosody 0.11 or 0.12.
