Mercurial > prosody-modules
diff mod_register_apps/README.markdown @ 4113:c85af57e82e0
mod_register_apps: Add site_apps_show and site_apps_hide options (thanks meaz)
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Sat, 12 Sep 2020 10:42:37 +0100 |
parents | fdc84741258d |
children | ad9ce6750880 |
line wrap: on
line diff
--- a/mod_register_apps/README.markdown Sat Sep 12 10:28:28 2020 +0100 +++ b/mod_register_apps/README.markdown Sat Sep 12 10:42:37 2020 +0100 @@ -16,7 +16,24 @@ # Configuration -There is one configuration option, `site_apps`, which contains the list +| Field | Description | +|----------------------|--------------------------------------------------------------------------| +| site_apps | A list of apps and their metadata | +| site_apps_show | A list of app ids to only show | +| site_apps_hide | A list of app ids to never show | + +An "app id" is the lower case app name, with any spaces replaced by `-`. E.g. "My Chat" would be `"my-chat"`. + +The module comes with a preconfigured `site_apps` containing popular clients. Patches are welcome to +add/update this list as needed! + +If you want to limit to just displaying a subset of the apps on your server, use the `site_apps_show` +option, e.g. `site_apps_show = { "conversations", "siskin-im" }`. To never show specific apps, you +can use `site_apps_hide`, e.g. `site_apps_hide = { "pidgin" }`. + +# App metadata format + +The configuration option `site_apps` contains the list of apps and their metadata. ``` {.lua}