875 lines
27 KiB
ReStructuredText
875 lines
27 KiB
ReStructuredText
.. raw:: html
|
|
|
|
<div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/configuration.rst">Edit me on GitHub</a></div>
|
|
|
|
=============
|
|
Configuration
|
|
=============
|
|
|
|
.. contents:: Table of Contents
|
|
:depth: 2
|
|
:local:
|
|
|
|
The included minified JS and CSS files can be used for demoing or testing, but
|
|
you'll want to configure *Converse.js* to suit your needs before you deploy it
|
|
on your website.
|
|
|
|
*Converse.js* is passed its configuration settings when you call its *initialize* method.
|
|
|
|
You'll most likely want to call the *initialize* method in your HTML page. For
|
|
an example of how this is done, please see the bottom of the *./index.html* page.
|
|
|
|
Please refer to the `Configuration variables`_ section below for info on
|
|
all the available configuration settings.
|
|
|
|
After you have configured *Converse.js*, you'll have to regenerate the minified
|
|
JS file so that it will include the new settings. Please refer to the
|
|
:ref:`minification` section for more info on how to do this.
|
|
|
|
.. _`configuration-variables`:
|
|
|
|
Configuration variables
|
|
=======================
|
|
|
|
authentication
|
|
--------------
|
|
|
|
* Default: ``login``
|
|
* Allowed values: `login`_, `anonymous`_, `prebind`_
|
|
|
|
This option states the way converse.js will authenticate.
|
|
|
|
login
|
|
~~~~~
|
|
|
|
The default means is ``login``, which means that the user either logs in manually with their
|
|
username and password, or automatically if used together with ``auto_login=true``
|
|
and ``jid`` and ``password`` values. See `auto_login`_.
|
|
|
|
anonymous
|
|
~~~~~~~~~
|
|
|
|
This enables anonymous login if the XMPP server supports it. This option can be
|
|
used together with `auto_login`_ to automatically and anonymously log a user in
|
|
as soon as the page loads.
|
|
|
|
prebind
|
|
~~~~~~~
|
|
|
|
See also: :ref:`session-support`
|
|
|
|
Use this option when you want to attach to an existing XMPP
|
|
`BOSH <https://en.wikipedia.org/wiki/BOSH>`_ session.
|
|
|
|
Usually a BOSH session is set up server-side in your web app.
|
|
|
|
Attaching to an existing BOSH session that was set up server-side is useful
|
|
when you want to maintain a persistent single session for your users instead of
|
|
requiring them to log in manually.
|
|
|
|
When a BOSH session is initially created, you'll receive three tokens.
|
|
A JID (jabber ID), SID (session ID) and RID (Request ID).
|
|
|
|
Converse.js needs these tokens in order to attach to that same session.
|
|
|
|
There are two complementary configuration settings to ``prebind``.
|
|
They are :ref:`keepalive` and `prebind_url`_.
|
|
|
|
``keepalive`` can be used keep the session alive without having to pass in
|
|
new RID and SID tokens to ``converse.initialize`` every time you reload the page.
|
|
This removes the need to set up a new BOSH session every time a page loads.
|
|
You do however still need to supply the user's JID so that converse.js can be
|
|
sure that the session it's resuming is for the right user.
|
|
|
|
`prebind_url`_ lets you specify a URL which converse.js will call whenever a
|
|
new BOSH session needs to be set up.
|
|
|
|
Here's an example of converse.js being initialized with these three options:
|
|
|
|
.. code-block:: javascript
|
|
|
|
converse.initialize({
|
|
bosh_service_url: 'https://bind.example.com',
|
|
keepalive: true,
|
|
jid: 'me@example.com',
|
|
authentication: 'prebind',
|
|
prebind_url: 'http://example.com/api/prebind',
|
|
allow_logout: false
|
|
});
|
|
|
|
allow_chat_pending_contacts
|
|
---------------------------
|
|
|
|
* Default: ``false``
|
|
|
|
Allow the user to chat with pending contacts.
|
|
|
|
allow_contact_removal
|
|
---------------------
|
|
|
|
* Default: ``true``
|
|
|
|
Allow the user to remove roster contacts by clicking on the delete icon
|
|
(i.e. traschcan) next to a contact's name in the roster.
|
|
|
|
allow_contact_requests
|
|
----------------------
|
|
|
|
* Default: ``true``
|
|
|
|
Allow users to add one another as contacts. If this is set to false, the
|
|
**Add a contact** widget, **Contact Requests** and **Pending Contacts** roster
|
|
sections will all not appear. Additionally, all incoming contact requests will be
|
|
ignored.
|
|
|
|
allow_dragresize
|
|
----------------
|
|
|
|
* Default: ``true``
|
|
|
|
Allow users to resize chats by dragging the edges. The min-height and min-width
|
|
CSS properties set on a chat boxes (specifically on the ``#converse.js .chatbox > .box-flyout`` element)
|
|
will be honored, IF they are set in pixels.
|
|
|
|
allow_muc
|
|
---------
|
|
|
|
* Default: ``true``
|
|
|
|
Allow multi-user chat (muc) in chatrooms. Setting this to ``false`` will remove
|
|
the ``Chatrooms`` tab from the control box.
|
|
|
|
allow_otr
|
|
---------
|
|
|
|
* Default: ``true``
|
|
|
|
Allow Off-the-record encryption of single-user chat messages.
|
|
|
|
allow_registration
|
|
------------------
|
|
|
|
* Default: ``true``
|
|
|
|
Support for `XEP-0077: In band registration <http://xmpp.org/extensions/xep-0077.html>`_
|
|
|
|
Allow XMPP account registration showing the corresponding UI register form interface.
|
|
|
|
animate
|
|
-------
|
|
|
|
* Default: ``true``
|
|
|
|
Show animations, for example when opening and closing chat boxes.
|
|
|
|
archived_messages_page_size
|
|
---------------------------
|
|
|
|
* Default: ``20``
|
|
|
|
See also: `message_archiving`
|
|
|
|
This feature applies to `XEP-0313: Message Archive Management (MAM) <https://xmpp.org/extensions/xep-0313.html>`_
|
|
and will only take effect if your server supports MAM.
|
|
|
|
It allows you to specify the maximum amount of archived messages to be returned per query.
|
|
When you open a chat box or room, archived messages will be displayed (if
|
|
available) and the amount returned will be no more than the page size.
|
|
|
|
You will be able to query for even older messages by scrolling upwards in the chat box or room
|
|
(the so-called infinite scrolling pattern).
|
|
|
|
auto_list_rooms
|
|
---------------
|
|
|
|
* Default: ``false``
|
|
|
|
If true, and the XMPP server on which the current user is logged in supports
|
|
multi-user chat, then a list of rooms on that server will be fetched.
|
|
|
|
Not recommended for servers with lots of chat rooms.
|
|
|
|
For each room on the server a query is made to fetch further details (e.g.
|
|
features, number of occupants etc.), so on servers with many rooms this
|
|
option will create lots of extra connection traffic.
|
|
|
|
auto_login
|
|
----------
|
|
|
|
* Default: ``false``
|
|
|
|
This option can be used to let converse.js automatically log the user in as
|
|
soon as the page loads.
|
|
|
|
It should be used either with ``authentication`` set to ``anonymous`` or to ``login``.
|
|
|
|
If ``authentication`` is set to ``login``, then you will also need to provide a
|
|
valid ``jid`` and ``password`` values.
|
|
|
|
This is a useful setting if you'd like to create a custom login form in your
|
|
website. You'll need to write some Javascript to accept that custom form's
|
|
login credentials, then you can pass those credentials (``jid`` and
|
|
``password``) to ``converse.initialize`` to start converse.js and log the user
|
|
into their XMPP account.
|
|
|
|
auto_away
|
|
---------
|
|
|
|
* Default: ``0``
|
|
|
|
The amount of seconds after which the user's presence status should
|
|
automatically become ``away``.
|
|
|
|
If the user's status is ``extended away``, it won't be changed to ``away``.
|
|
|
|
If the given value is negative or ``0``, this option is disabled.
|
|
|
|
auto_xa
|
|
-------
|
|
|
|
* Default: ``0``
|
|
|
|
The amount of seconds after which the user's presence status should
|
|
automatically become ``extended away``.
|
|
|
|
If the value is negative or ``0``, the function is disabled.
|
|
|
|
auto_reconnect
|
|
--------------
|
|
|
|
* Default: ``true``
|
|
|
|
Automatically reconnect to the XMPP server if the connection drops
|
|
unexpectedly.
|
|
|
|
auto_subscribe
|
|
--------------
|
|
|
|
* Default: ``false``
|
|
|
|
If true, the user will automatically subscribe back to any contact requests.
|
|
|
|
auto_join_on_invite
|
|
-------------------
|
|
|
|
* Default: ``false``
|
|
|
|
If true, the user will automatically join a chatroom on invite without any confirm.
|
|
|
|
.. _`bosh-service-url`:
|
|
|
|
bosh_service_url
|
|
----------------
|
|
|
|
* Default: ``undefined``
|
|
|
|
To connect to an XMPP server over HTTP you need a `BOSH <https://en.wikipedia.org/wiki/BOSH>`_
|
|
connection manager which acts as a middle man between the HTTP and XMPP
|
|
protocols.
|
|
|
|
The bosh_service_url setting takes the URL of a BOSH connection manager.
|
|
|
|
Please refer to your XMPP server's documentation on how to enable BOSH.
|
|
For more information, read this blog post: `Which BOSH server do you need? <http://metajack.im/2008/09/08/which-bosh-server-do-you-need>`_
|
|
|
|
A more modern alternative to BOSH is to use `websockets <https://developer.mozilla.org/en/docs/WebSockets>`_.
|
|
Please see the :ref:`websocket-url` configuration setting.
|
|
|
|
cache_otr_key
|
|
-------------
|
|
|
|
* Default: ``false``
|
|
|
|
Let the `OTR (Off-the-record encryption) <https://otr.cypherpunks.ca>`_ private
|
|
key be cached in your browser's session storage.
|
|
|
|
The browser's session storage persists across page loads but is deleted once
|
|
the tab or window is closed.
|
|
|
|
If this option is set to ``false``, a new OTR private key will be generated
|
|
for each page load. While more inconvenient, this is a much more secure option.
|
|
|
|
This setting can only be used together with ``allow_otr = true``.
|
|
|
|
.. note::
|
|
A browser window's session storage is accessible by all javascript that
|
|
is served from the same domain. So if there is malicious javascript served by
|
|
the same server (or somehow injected via an attacker), then they will be able
|
|
to retrieve your private key and read your all the chat messages in your
|
|
current session. Previous sessions however cannot be decrypted.
|
|
|
|
csi_waiting_time
|
|
----------------
|
|
|
|
* Default: ``0``
|
|
|
|
This option adds support for **XEP-0085 Chat State Indication**.
|
|
|
|
If converse.js is idle for the configured amount of seconds, a chat state
|
|
indication of ``inactive`` will be sent out to the XMPP server (if the server
|
|
supports CSI).
|
|
|
|
Afterwards, ss soon as there is any activity (for example, the mouse moves),
|
|
a chat state indication of ``active`` will be sent out.
|
|
|
|
debug
|
|
-----
|
|
|
|
* Default: ``false``
|
|
|
|
If set to true, debugging output will be logged to the browser console.
|
|
|
|
default_domain
|
|
--------------
|
|
|
|
* Default: ``undefined``
|
|
|
|
Specify a domain to act as the default for user JIDs. This allows users to log
|
|
in with only the username part of their JID, instead of the full JID.
|
|
|
|
For example, if ``default_domain`` is ``example.org``, then the user:
|
|
``johnny@example.org`` can log in with only ``johnny``.
|
|
|
|
JIDs with other domains are still allowed but need to be provided in full.
|
|
To specify only one domain and disallow other domains, see the `locked_domain`_
|
|
option.
|
|
|
|
domain_placeholder
|
|
------------------
|
|
|
|
* Default: ``e.g. conversejs.org``
|
|
|
|
The placeholder text shown in the domain input on the registration form.
|
|
|
|
expose_rid_and_sid
|
|
------------------
|
|
|
|
* Default: ``false``
|
|
|
|
Allow the prebind tokens, RID (request ID) and SID (session ID), to be exposed
|
|
globally via the API. This allows other scripts served on the same page to use
|
|
these values.
|
|
|
|
*Beware*: a malicious script could use these tokens to assume your identity
|
|
and inject fake chat messages.
|
|
|
|
forward_messages
|
|
----------------
|
|
|
|
* Default: ``false``
|
|
|
|
If set to ``true``, sent messages will also be forwarded to the sending user's
|
|
bare JID (their Jabber ID independent of any chat clients aka resources).
|
|
|
|
This means that sent messages are visible from all the user's chat clients,
|
|
and not just the one from which it was actually sent.
|
|
|
|
This is especially important for web chat, such as converse.js, where each
|
|
browser tab functions as a separate chat client, with its own resource.
|
|
|
|
This feature uses Stanza forwarding, see also `XEP 0297: Stanza Forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
|
|
|
|
For an alternative approach, see also `message_carbons`_.
|
|
|
|
fullname
|
|
--------
|
|
|
|
If you are using prebinding, can specify the fullname of the currently
|
|
logged in user, otherwise the user's vCard will be fetched.
|
|
|
|
hide_muc_server
|
|
---------------
|
|
|
|
* Default: ``false``
|
|
|
|
Hide the ``server`` input field of the form inside the ``Room`` panel of the
|
|
controlbox. Useful if you want to restrict users to a specific XMPP server of
|
|
your choosing.
|
|
|
|
hide_offline_users
|
|
------------------
|
|
|
|
* Default: ``false``
|
|
|
|
If set to ``true``, then don't show offline users.
|
|
|
|
include_offline_state
|
|
---------------------
|
|
|
|
* Default: `false`
|
|
|
|
Originally, converse.js included an `offline` state which the user could
|
|
choose (along with `online`, `busy` and `away`).
|
|
|
|
Eventually it was however decided to remove this state, since the `offline`
|
|
state doesn't propagate across tabs like the others do.
|
|
|
|
What's meant by "propagate across tabs", is that when you set the state to
|
|
`offline` in one tab, and you have instances of converse.js open in other tabs
|
|
in your browser, then those instances will not have their states changed to
|
|
`offline` as well. For the other statees the change is however propagated.
|
|
|
|
The reason for this is that according to the XMPP spec, there is no `offline`
|
|
state. The only defined states are:
|
|
|
|
* away -- The entity or resource is temporarily away.
|
|
* chat -- The entity or resource is actively interested in chattiIng.
|
|
* dnd -- The entity or resource is busy (dnd = "Do Not Disturb").
|
|
* xa -- The entity or resource is away for an extended period (xa = "eXtended Away").
|
|
|
|
Read the [relevant section in the XMPP spec](https://xmpp.org/rfcs/rfc6121.html#presence-syntax-children-show) for more info.
|
|
|
|
What used to happen in converse.js when the `offline` state was chosen, is
|
|
that a presence stanza with a `type` of `unavailable` was sent out.
|
|
|
|
This is actually exactly what happens when you log out of converse.js as well,
|
|
with the notable exception that in the `offline` state, the connection is not
|
|
terminated. So you can at any time change your state to something else and
|
|
start chatting again.
|
|
|
|
This might be useful to people, however the fact that the `offline` state
|
|
doesn't propagate across tabs means that the user experience is inconsistent,
|
|
confusing and appears "broken".
|
|
|
|
If you are however aware of this issue and still want to allow the `offline`
|
|
state, then you can set this option to `true` to enable it.
|
|
|
|
i18n
|
|
----
|
|
|
|
* Default: Auto-detection of the User/Browser language
|
|
|
|
If no locale is matching available locales, the default is ``en``.
|
|
Specify the locale/language. The language must be in the ``locales`` object. Refer to
|
|
``./locale/locales.js`` to see which locales are supported.
|
|
|
|
jid
|
|
---
|
|
|
|
The Jabber ID or "JID" of the current user. The JID uniquely identifies a user
|
|
on the XMPP network. It looks like an email address, but it's used for instant
|
|
messaging instead.
|
|
|
|
This value needs to be provided when using the :ref:`keepalive` option together
|
|
with `prebind`_.
|
|
|
|
|
|
.. _`keepalive`:
|
|
|
|
keepalive
|
|
---------
|
|
|
|
* Default: ``true``
|
|
|
|
Determines whether Converse.js will maintain the chat session across page
|
|
loads.
|
|
|
|
This setting should also be used in conjunction with ``authentication`` set to `prebind`_.
|
|
|
|
When using ``keepalive`` and ``prebind``, you will have to provide the `jid`_
|
|
of the current user to ensure that a cached session is only resumed if it
|
|
belongs to the current user.
|
|
|
|
See also:
|
|
|
|
* :ref:`session-support`
|
|
|
|
.. note::
|
|
Currently the "keepalive" setting only works with BOSH and not with
|
|
websockets. This is because XMPP over websocket does not use the same
|
|
session token as with BOSH. A possible solution for this is to implement
|
|
`XEP-0198 <http://xmpp.org/extensions/xep-0198.html>`_, specifically
|
|
with regards to "stream resumption".
|
|
|
|
locked_domain
|
|
-------------
|
|
|
|
* Default: ``undefined``
|
|
|
|
Similar to `default_domain`_ but no other domains are allowed.
|
|
|
|
message_archiving
|
|
-----------------
|
|
|
|
* Default: ``never``
|
|
|
|
Provides support for `XEP-0313: Message Archive Management <https://xmpp.org/extensions/xep-0313.html>`_
|
|
|
|
This sets the default archiving preference. Valid values are ``never``, ``always`` and ``roster``.
|
|
|
|
``roster`` means that only messages to and from JIDs in your roster will be
|
|
archived. The other two values are self-explanatory.
|
|
|
|
|
|
message_archiving_timeout
|
|
-------------------------
|
|
|
|
* Default: ``8000``
|
|
|
|
The amount of time (in milliseconds) to wait when requesting archived messages
|
|
from the XMPP server.
|
|
|
|
Used in conjunction with `message_archiving` and in context of `XEP-0313: Message Archive Management <https://xmpp.org/extensions/xep-0313.html>`_.
|
|
|
|
message_carbons
|
|
---------------
|
|
|
|
* Default: ``false``
|
|
|
|
Support for `XEP-0280: Message Carbons <https://xmpp.org/extensions/xep-0280.html>`_
|
|
|
|
In order to keep all IM clients for a user engaged in a conversation,
|
|
outbound messages are carbon-copied to all interested resources.
|
|
|
|
This is especially important in webchat, like converse.js, where each browser
|
|
tab serves as a separate IM client.
|
|
|
|
Both message_carbons and `forward_messages`_ try to solve the same problem
|
|
(showing sent messages in all connected chat clients aka resources), but go about it
|
|
in two different ways.
|
|
|
|
Message carbons is the XEP (Jabber protocol extension) specifically drafted to
|
|
solve this problem, while `forward_messages`_ uses
|
|
`stanza forwarding <http://www.xmpp.org/extensions/xep-0297.html>`_
|
|
|
|
muc_history_max_stanzas
|
|
-----------------------
|
|
|
|
* Default: ``undefined``
|
|
|
|
This option allows you to specify the maximum amount of messages to be shown in a
|
|
chat room when you enter it. By default, the amount specified in the room
|
|
configuration or determined by the server will be returned.
|
|
|
|
Please note, this option is not related to
|
|
`XEP-0313 Message Archive Management <https://xmpp.org/extensions/xep-0313.html>`_,
|
|
which also allows you to show archived chat room messages, but follows a
|
|
different approach.
|
|
|
|
If you're using MAM for archiving chat room messages, you might want to set
|
|
this option to zero.
|
|
|
|
notification_icon
|
|
-----------------
|
|
|
|
* Default: ``'/logo/conversejs.png'``
|
|
|
|
This option specifies which icon is shown in HTML5 notifications, as provided
|
|
by the ``src/converse-notification.js`` plugin.
|
|
|
|
|
|
ping_interval
|
|
-------------
|
|
|
|
* Default: ``300``
|
|
|
|
Make ping to server in order to keep connection with server killing sessions after idle timeout.
|
|
The ping are sent only if no messages are sent in the last ``ping_interval`` seconds
|
|
You need to set the value to any positive value to enable this functionality.
|
|
|
|
If you set this value to ``0`` or any negative value, il will disable this functionality.
|
|
|
|
.. _`play-sounds`:
|
|
|
|
play_sounds
|
|
-----------
|
|
|
|
* Default: ``false``
|
|
|
|
Plays a notification sound when you receive a personal message or when your
|
|
nickname is mentioned in a chat room.
|
|
|
|
Inside the ``./sounds`` directory of the Converse.js repo you'll see MP3 and Ogg
|
|
formatted sound files. We need both, because neither format is supported by all browsers.
|
|
|
|
You can set the URL where the sound files are hosted with the `sounds_path`_
|
|
option.
|
|
|
|
Requires the `src/converse-notification.js` plugin.
|
|
|
|
.. _`prebind_url`:
|
|
|
|
prebind_url
|
|
-----------
|
|
|
|
* Default: ``null``
|
|
* Type: URL
|
|
|
|
See also: :ref:`session-support`
|
|
|
|
This setting should be used in conjunction with ``authentication`` set to `prebind` and :ref:`keepalive` set to ``true``.
|
|
|
|
It allows you to specify a URL which converse.js will call when it needs to get
|
|
the RID and SID (Request ID and Session ID) tokens of a BOSH connection, which
|
|
converse.js will then attach to.
|
|
|
|
The server behind ``prebind_url`` should return a JSON encoded object with the
|
|
three tokens::
|
|
|
|
{
|
|
"jid": "me@example.com/resource",
|
|
"sid": "346234623462",
|
|
"rid": "876987608760"
|
|
}
|
|
|
|
providers_link
|
|
--------------
|
|
|
|
* Default: ``https://xmpp.net/directory.php``
|
|
|
|
The hyperlink on the registration form which points to a directory of public
|
|
XMPP servers.
|
|
|
|
|
|
roster_groups
|
|
-------------
|
|
|
|
* Default: ``false``
|
|
|
|
If set to ``true``, converse.js will show any roster groups you might have
|
|
configured.
|
|
|
|
.. note::
|
|
It's currently not possible to use converse.js to assign contacts to groups.
|
|
Converse.js can only show users and groups that were previously configured
|
|
elsewhere.
|
|
|
|
show_controlbox_by_default
|
|
--------------------------
|
|
|
|
* Default: ``false``
|
|
|
|
The "controlbox" refers to the special chatbox containing your contacts roster,
|
|
status widget, chatrooms and other controls.
|
|
|
|
By default this box is hidden and can be toggled by clicking on any element in
|
|
the page with class *toggle-controlbox*.
|
|
|
|
If this options is set to true, the controlbox will by default be shown upon
|
|
page load.
|
|
|
|
However, be aware that even if this value is set to ``false``, if the
|
|
controlbox is open, and the page is reloaded, then it will stay open on the new
|
|
page as well.
|
|
|
|
.. _`show-desktop-notifications`:
|
|
|
|
show_desktop_notifications
|
|
--------------------------
|
|
|
|
* Default: ``true``
|
|
|
|
Should HTML5 desktop notifications be shown?
|
|
|
|
Notification will be shown in the following cases:
|
|
|
|
* the browser is not visible nor focused and a private message is received.
|
|
* the browser is not visible nor focused and a groupchat message is received which mentions you.
|
|
* `auto_subscribe` is set to `false` and a new contact request is received.
|
|
|
|
Requires the `src/converse-notification.js` plugin.
|
|
|
|
show_only_online_users
|
|
----------------------
|
|
|
|
* Default: ``false``
|
|
|
|
If set to ``true``, only online users will be shown in the contacts roster.
|
|
Users with any other status (e.g. away, busy etc.) will not be shown.
|
|
|
|
sounds_path
|
|
-----------
|
|
|
|
* Default: ``/sounds/``
|
|
|
|
This option only makes sense in conjunction with the `play_sounds`_ option and
|
|
specifies the URL of the sound files to be played (exluding the file names
|
|
themselves).
|
|
|
|
In order to support all browsers we need both an MP3 and an Ogg file. Make sure
|
|
to name your files ``msg_received.ogg`` and ``msg_received.mp3``.
|
|
|
|
storage
|
|
-------
|
|
|
|
* Default: ``session``
|
|
|
|
Valid options: ``session``, ``local``.
|
|
|
|
This option determines the type of `storage <https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage>`_
|
|
(``localStorage`` or ``sessionStorage``) used by converse.js to cache user data.
|
|
|
|
Originally converse.js used only localStorage, however sessionStorage is from a
|
|
privacy perspective a better choice.
|
|
|
|
The main difference between the two is that sessionStorage only persists while
|
|
the current tab or window containing a converse.js instance is open. As soon as
|
|
it's closed, the data is cleared.
|
|
|
|
Data in localStorage on the other hand is kept indefinitely.
|
|
|
|
.. note::
|
|
Since version 0.8.0, the use of local storage is not recommended. The
|
|
statuses (online, away, busy etc.) of your roster contacts are cached in
|
|
the browser storage. If you use local storage, these values are stored for
|
|
multiple sessions, and they will likely become out of sync with your contacts'
|
|
actual statuses. The session storage doesn't have this problem, because
|
|
roster contact statuses will not become out of sync in a single session,
|
|
only across more than one session.
|
|
|
|
synchronize_availability
|
|
--------------------
|
|
|
|
* Default: ``true``
|
|
|
|
Valid options: ``true``, ``false``, ``a resource name``.
|
|
|
|
This option lets you synchronize your chat status (`online`, `busy`, `away`) with other chat clients. In other words,
|
|
if you change your status to `busy` in a different chat client, your status will change to `busy` in converse.js as well.
|
|
|
|
If set to ``true``, converse.js will synchronize with all other clients you are logged in with.
|
|
|
|
If set to ``false``, this feature is disabled.
|
|
|
|
If set to ``a resource name``, converse.js will synchronize only with a client that has that particular resource assigned to it.
|
|
|
|
use_otr_by_default
|
|
------------------
|
|
|
|
* Default: ``false``
|
|
|
|
If set to ``true``, Converse.js will automatically try to initiate an OTR (off-the-record)
|
|
encrypted chat session every time you open a chat box.
|
|
|
|
use_vcards
|
|
----------
|
|
|
|
* Default: ``true``
|
|
|
|
Determines whether the XMPP server will be queried for roster contacts' VCards
|
|
or not. VCards contain extra personal information such as your fullname and
|
|
avatar image.
|
|
|
|
visible_toolbar_buttons
|
|
-----------------------
|
|
|
|
* Default:
|
|
|
|
.. code-block:: javascript
|
|
|
|
{
|
|
call: false,
|
|
clear: true,
|
|
emoticons: true,
|
|
toggle_occupants: true
|
|
}
|
|
|
|
Allows you to show or hide buttons on the chat boxes' toolbars.
|
|
|
|
* *call*:
|
|
Provides a button with a picture of a telephone on it.
|
|
When the call button is pressed, it will emit an event that can be used by a third-party library to initiate a call.::
|
|
|
|
converse.listen.on('callButtonClicked', function(event, data) {
|
|
console.log('Strophe connection is', data.connection);
|
|
console.log('Bare buddy JID is', data.model.get('jid'));
|
|
// ... Third-party library code ...
|
|
});
|
|
* *clear*:
|
|
Provides a button for clearing messages from a chat box.
|
|
* *emoticons*:
|
|
Enables rendering of emoticons and provides a toolbar button for choosing them.
|
|
* toggle_occupants:
|
|
Shows a button for toggling (i.e. showing/hiding) the list of occupants in a chat room.
|
|
|
|
.. _`websocket-url`:
|
|
|
|
websocket_url
|
|
-------------
|
|
|
|
* Default: ``undefined``
|
|
|
|
This option is used to specify a
|
|
`websocket <https://developer.mozilla.org/en/docs/WebSockets>`_ URI to which
|
|
converse.js can connect to.
|
|
|
|
Websockets provide a more modern and effective two-way communication protocol
|
|
between the browser and a server, effectively emulating TCP at the application
|
|
layer and therefore overcoming many of the problems with existing long-polling
|
|
techniques for bidirectional HTTP (such as `BOSH <https://en.wikipedia.org/wiki/BOSH>`_).
|
|
|
|
Please refer to your XMPP server's documentation on how to enable websocket
|
|
support.
|
|
|
|
.. note::
|
|
Please note that not older browsers do not support websockets. For older
|
|
browsers you'll want to specify a BOSH URL. See the :ref:`bosh-service-url`
|
|
configuration setting).
|
|
|
|
.. note::
|
|
Converse.js does not yet support "keepalive" with websockets.
|
|
|
|
xhr_custom_status
|
|
-----------------
|
|
|
|
* Default: ``false``
|
|
|
|
.. note::
|
|
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
|
|
|
This option will let converse.js make an AJAX POST with your changed custom chat status to a
|
|
remote server.
|
|
|
|
xhr_custom_status_url
|
|
---------------------
|
|
|
|
.. note::
|
|
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
|
|
|
* Default: Empty string
|
|
|
|
Used only in conjunction with ``xhr_custom_status``.
|
|
|
|
This is the URL to which the AJAX POST request to set the user's custom status
|
|
message will be made.
|
|
|
|
The message itself is sent in the request under the key ``msg``.
|
|
|
|
xhr_user_search
|
|
---------------
|
|
|
|
* Default: ``false``
|
|
|
|
.. note::
|
|
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
|
|
|
There are two ways to add users.
|
|
|
|
* The user inputs a valid JID (Jabber ID), and the user is added as a pending contact.
|
|
* The user inputs some text (for example part of a firstname or lastname), an XHR (Ajax Request) will be made to a remote server, and a list of matches are returned. The user can then choose one of the matches to add as a contact.
|
|
|
|
This setting enables the second mechanism, otherwise by default the first will be used.
|
|
|
|
*What is expected from the remote server?*
|
|
|
|
A default JSON encoded list of objects must be returned. Each object
|
|
corresponds to a matched user and needs the keys ``id`` and ``fullname``.
|
|
|
|
.. note::
|
|
Make sure your server script sets the header `Content-Type: application/json`.
|
|
|
|
xhr_user_search_url
|
|
-------------------
|
|
|
|
.. note::
|
|
XHR stands for XMLHTTPRequest, and is meant here in the AJAX sense (Asynchronous Javascript and XML).
|
|
|
|
* Default: Empty string
|
|
|
|
Used only in conjunction with ``xhr_user_search``.
|
|
|
|
This is the URL to which an XHR GET request will be made to fetch user data from your remote server.
|
|
The query string will be included in the request with ``q`` as its key.
|
|
|
|
The data returned must be a JSON encoded list of user JIDs.
|