Mercurial > prosody-modules
changeset 2918:d2d0715f30d9
mod_conversejs/README: Expand config section
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sat, 10 Mar 2018 00:04:47 +0100 |
| parents | cd5e6534b813 |
| children | 0ea93da47db9 |
| files | mod_conversejs/README.markdown |
| diffstat | 1 files changed, 28 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_conversejs/README.markdown Fri Mar 09 21:58:47 2018 +0100 +++ b/mod_conversejs/README.markdown Sat Mar 10 00:04:47 2018 +0100 @@ -17,14 +17,35 @@ Configuration ============= -The module itself has no configuration. It uses -[authentication settings][doc:authentication] to determine whether to -configure Converse.js to use `login` or `anonymous` mode. +The module uses general Prosody options for basic configuration. It +should just work after loading it. + +``` {.lua} +modules_enabled = { + -- other modules... + "conversejs"; +} +``` + +Authentication +-------------- -It also determines the [BOSH][mod_bosh] and [WebSocket][mod_websocket] -URL automatically, see their respective documentation for how to configure -them. +[Authentication settings][doc:authentication] are used determine +whether to configure Converse.js to use `login` or `anonymous` mode. + +Connection methods +------------------ -See Prosodys [HTTP configuration][doc:http] for HTTP related options. +It also determines the [BOSH][mod_bosh] and +[WebSocket][mod_websocket] URL automatically, see their respective +documentation for how to configure them. Both connection methods are +loaded automatically. + +HTTP +---- + +See Prosodys [HTTP configuration][doc:http] for HTTP related +options. +