Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
1311ae06
Commit
1311ae06
authored
May 21, 2013
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Make config options alphabetical. Add hide_muc_server
parent
a48a1f3d
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
55 additions
and
35 deletions
+55
-35
docs/source/index.rst
docs/source/index.rst
+55
-35
No files found.
docs/source/index.rst
View file @
1311ae06
...
@@ -80,9 +80,62 @@ website. This will remove the need for any cross-domain XHR support.
...
@@ -80,9 +80,62 @@ website. This will remove the need for any cross-domain XHR support.
Converse.js Configuration variables:
Converse.js Configuration variables:
====================================
====================================
animate
=======
Default = True
Show animations, for example when opening and closing chat boxes.
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_subscribe
==============
Default = False
If true, the user will automatically subscribe back to any contact requests.
bosh_service_url
================
Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.
See `here`_ for more information.
fullname
========
If you are using prebinding, you need to specify the fullname of the currently
logged in user.
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.
prebind
prebind
========
========
Default = False
Use this option when you want to attach to an existing XMPP connection that was
Use this option when you want to attach to an existing XMPP connection that was
already authenticated (usually on the backend before page load).
already authenticated (usually on the backend before page load).
...
@@ -105,24 +158,12 @@ have to write a Javascript snippet to attach to the set up connection::
...
@@ -105,24 +158,12 @@ have to write a Javascript snippet to attach to the set up connection::
The backend must authenticate for you, and then return a SID (session ID) and
The backend must authenticate for you, and then return a SID (session ID) and
RID (Request ID), which you use when you attach to the connection.
RID (Request ID), which you use when you attach to the connection.
fullname
========
If you are using prebinding, you need to specify the fullname of the currently
logged in user.
bosh_service_url
================
Connections to an XMPP server depend on a BOSH connection manager which acts as
a middle man between HTTP and XMPP.
See `here`_ for more information.
xhr_user_search
xhr_user_search
===============
===============
Default = False
There are two ways to add users.
There are two ways to add users.
* The user inputs a valid JID (Jabber ID), and the user is added as a pending
* The user inputs a valid JID (Jabber ID), and the user is added as a pending
...
@@ -132,27 +173,6 @@ contact.
...
@@ -132,27 +173,6 @@ contact.
This setting enables the second mechanism, otherwise by default the first will
This setting enables the second mechanism, otherwise by default the first will
be used.
be used.
auto_subscribe
==============
If true, the user will automatically subscribe back to any contact requests.
auto_list_rooms
===============
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.
animate
=======
Show animations, for example when opening and closing chat boxes.
.. _`here`: http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l
.. _`here`: http://metajack.im/2008/09/08/which-bosh-server-do-you-need/l
.. _`HTTP`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
.. _`HTTP`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment