xmpp.chapril.org-conversejs/docs/source
JC Brand ea36d53f78 Re-add the keepalive options.
It's unlikely that `keepalive` needs to be set to `false`, but there are
some edge cases where it might be useful.

Here's a breakdown of the different configurations of `keepalive` and `auto_join`:

---

* auto_login: false, keepalive: true

This is the default config. Users need to log in manually, but then
Converse will try to reconnect them when the page reloads.

* auto_login: true, keepalive: true

Also very popular configuration. Used with `credentials_url` or `prebind_url`.

* auto_login = `true`, keepalive = `false`

Not sure what this could be useful for. No currently known application.

* auto_login = `false`, keepalive = `false`

Useful when you want some kind of specific action to trigger login, but
you don't want to maintain that state across page reloads.

Also relevant when using a websocket connection with anonymous login.
With websocket it's impossible to maintain anonymous sessions across page
reload because the the session gets removed server-side as soon as the
websocket connection drops and the server won't accept a full JID with
password for an anonymous connection anyway (which could happen upon
page reload when Converse tries to login in again if `keepalive` was `true`).
2019-07-26 18:08:38 +02:00
..
_static Load converse.js in the API docs and update favicon 2019-03-30 12:54:56 +01:00
_templates Refactor MAM and clear private chats upon reconnection 2019-05-22 14:10:19 +02:00
api Update the developer documentation 2018-09-18 11:17:27 +02:00
images Remove user manual images. 2018-12-21 16:08:29 +01:00
builds.rst Fix path to converse.css and add some mockup fixes 2019-06-04 11:12:22 +02:00
conf.json Add logo and custom CSS for the API docs 2019-03-22 15:22:21 +01:00
conf.py New release 4.2.0 2019-04-04 12:33:08 +02:00
configuration.rst Re-add the keepalive options. 2019-07-26 18:08:38 +02:00
dependencies.rst Fixes #641. 2019-05-15 13:03:13 +02:00
development.rst Update developer documentation and buildout dependencies 2019-07-25 12:33:46 +02:00
documentation.rst Add Make recipes for buildout and Sphinx and update docs 2018-12-19 11:03:54 +01:00
features.rst Add undocumented events and setting. Link to OMEMO docs 2019-02-25 14:32:33 +01:00
index.rst Replace http: with https: in xmpp.org links 2019-03-04 17:49:44 +01:00
jsdoc_intro.md Remove old API and events docs 2019-06-05 11:35:48 +02:00
other_frameworks.rst Move BOSH code into a plugin 2019-06-05 11:35:48 +02:00
plugin_development.rst Update developer documentation and buildout dependencies 2019-07-25 12:33:46 +02:00
quickstart.rst Update quickstart docs 2019-05-28 17:12:50 +02:00
security.rst Update the developer documentation 2018-09-18 11:17:27 +02:00
setup.rst Move BOSH code into a plugin 2019-06-05 11:35:48 +02:00
style_guide.rst Update developer documentation and buildout dependencies 2019-07-25 12:33:46 +02:00
testing.rst Update the developer documentation 2018-09-18 11:17:27 +02:00
theming.rst Update the developer documentation 2018-09-18 11:17:27 +02:00
translations.rst Update the developer documentation 2018-09-18 11:17:27 +02:00
troubleshooting.rst Mention in docs that you can enable debugging via URL 2019-04-16 14:38:38 +02:00