Mercurial > prosody-modules

comparison mod_register_apps/README.markdown @ 4113:c85af57e82e0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
4112:d0366474aace 4113:c85af57e82e0
14 It also contains the logos of a number of popular XMPP clients, and serves 14 It also contains the logos of a number of popular XMPP clients, and serves
15 them over HTTP for other modules to reference when serving web pages. 15 them over HTTP for other modules to reference when serving web pages.
16 16
17 # Configuration 17 # Configuration
18 18
19 There is one configuration option, `site_apps`, which contains the list 19 | Field | Description |
20 |----------------------|--------------------------------------------------------------------------|
21 | site_apps | A list of apps and their metadata |
22 | site_apps_show | A list of app ids to only show |
23 | site_apps_hide | A list of app ids to never show |
24
25 An "app id" is the lower case app name, with any spaces replaced by `-`. E.g. "My Chat" would be `"my-chat"`.
26
27 The module comes with a preconfigured `site_apps` containing popular clients. Patches are welcome to
28 add/update this list as needed!
29
30 If you want to limit to just displaying a subset of the apps on your server, use the `site_apps_show`
31 option, e.g. `site_apps_show = { "conversations", "siskin-im" }`. To never show specific apps, you
32 can use `site_apps_hide`, e.g. `site_apps_hide = { "pidgin" }`.
33
34 # App metadata format
35
36 The configuration option `site_apps` contains the list
20 of apps and their metadata. 37 of apps and their metadata.
21 38
22 ``` {.lua} 39 ``` {.lua}
23 -- Example site_apps config with two clients 40 -- Example site_apps config with two clients
24 site_apps = { 41 site_apps = {