5 .. figure:: https://api.travis-ci.org/jcbrand/converse.js.png?branch=master
8 `Converse.js <https://conversejs.org>`_ is a web based `XMPP/Jabber <http://xmpp.org>`_
9 instant messaging client.
11 It enables you to add chat functionality to your website, independent of any
12 specific backend. You will however need an XMPP server to connect to, either
13 your own, or a public one.
19 It has the following features:
22 * Multi-user chat rooms `XEP 45 <http://xmpp.org/extensions/xep-0045.html>`_
23 * Direct invitations to chat rooms `XEP 249 <http://xmpp.org/extensions/xep-0249.html>`_
24 * vCard support `XEP 54 <http://xmpp.org/extensions/xep-0054.html>`_
25 * Service discovery `XEP 30 <http://xmpp.org/extensions/xep-0030.html>`_
26 * In-band registration `XEP 77 <http://xmpp.org/extensions/xep-0077.html>`_
27 * Contact rosters and groups
28 * Contact subscriptions
29 * Roster item exchange `XEP 144 <http://xmpp.org/extensions/tmp/xep-0144-1.1.html>`_
30 * Chat statuses (online, busy, away, offline)
31 * Custom status messages
32 * Typing and state notifications `XEP 85 <http://xmpp.org/extensions/xep-0085.html>`_
33 * Messages appear in all connnected chat clients `XEP 280 <http://xmpp.org/extensions/xep-0280.html>`_
34 * Third person "/me" messages `XEP 245 <http://xmpp.org/extensions/xep-0245.html>`_
35 * XMPP Ping `XEP 199 <http://xmpp.org/extensions/xep-0199.html>`_
36 * Server-side archiving of messages `XEP 313 <http://xmpp.org/extensions/xep-0313.html>`_
37 * Client state indication `XEP 352 <http://xmpp.org/extensions/xep-0352.html>`_
38 * Off-the-record encryption
39 * Translated into 16 languages
45 * `In a static HTML page`_. Here we chat to external XMPP accounts on Jabber.org and Gmail.
46 * `Integrated into a Plone site`_ via collective.xmpp.chat.
47 * `Off-the-record encryption <https://opkode.com/media/blog/2013/11/11/conversejs-otr-support>`_ in Converse 0.7.
49 Integration into other frameworks
50 ---------------------------------
52 * `Plone <http://plone.org>`_:
53 `collective.xmpp.chat <http://github.com/collective/collective.xmpp.chat>`_ is an add-on for Plone that uses *Converse.js*. Together with `collective.xmpp.core <http://github.com/collective/collective.xmpp.core>`_, it provides for single-signon-support (SSO) and also enables you to manually or automatically register your Plone users onto your XMPP server.
54 * `Django <http://www.djangoproject.com>`_:
55 `django-conversejs <https://pypi.python.org/pypi/django-conversejs>`_ is an app that makes it easer to integrate *Converse.js* into Django.
56 `django-xmpp <https://github.com/fpytloun/django-xmpp>`_ adds XMPP chat integration with converse.js by letting Ejabberd authenticate against your Django site.
57 * `Roundcube <http://roundcube.net>`_:
58 `roundcube-converse.js-xmpp-plugin <https://github.com/priyadi/roundcube-converse.js-xmpp-plugin>`_ is an addon for Roundcube Webmail.
59 * `Wordpress <http://wordpress.org>`_:
60 `ConverseJS <http://wordpress.org/plugins/conversejs>`_
61 * `Patternslib <http://patternslib.com>`_:
62 `patterns.converse <https://github.com/jcbrand/patterns.converse>`_ provides a Patternslib pattern for Converse.js
63 * `Alfresco <http://www.alfresco.com>`_:
64 `alfresco-js-chat-share`_: `alfresco-js-chat-share <https://github.com/keensoft/alfresco-js-chat-share>`_
70 A live demo is available at `<https://conversejs.org>`_
76 We use behavior-driven tests written with `jasmine.js <http://pivotal.github.io/jasmine>`_.
78 Open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html>`_
79 in your browser, and the tests will run automatically.
85 The developer/integrator documentation can be found at `<https://conversejs.org/docs/html>`_.
91 ``Converse.js`` is released under the `Mozilla Public License (MPL) <https://www.mozilla.org/MPL/2.0/index.txt>`_.
97 For support queries and discussions, please join the mailing list: conversejs@librelist.com
99 Also take a look at the `mailing list archives <http://librelist.com/browser/conversejs>`_.
101 Issues can be logged on the `Github issue tracker <https://github.com/jcbrand/converse.js/issues>`_.
103 ----------------------------------
104 Donations and tips are appreciated
105 ----------------------------------
107 * Bitcoin: 16FsPqE9DhFTryxrUenpsGX4LJ1TPu8GqS
109 .. _`Integrated into a Plone site`: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
110 .. _`In a static HTML page`: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript