2012-10-23 21:01:24 +02:00
===========
2012-07-21 11:14:22 +02:00
converse.js
===========
2013-10-03 12:35:54 +02:00
.. figure :: https://api.travis-ci.org/jcbrand/converse.js.png?branch=master
:alt: Build Status
2014-03-18 02:12:25 +01:00
`Converse.js <https://conversejs.org> `_ is a web based `XMPP/Jabber <http://xmpp.org> `_
instant messaging client.
2012-10-23 21:01:24 +02:00
2013-07-28 23:39:11 +02:00
It enables you to add chat functionality to your website, independent of any
specific backend. You will however need an XMPP server to connect to, either
your own, or a public one.
2013-03-01 09:55:54 +01:00
2012-10-23 21:55:58 +02:00
--------
Features
--------
2012-10-23 21:01:24 +02:00
It has the following features:
2013-07-28 23:39:11 +02:00
* Single-user chat
2014-11-25 10:59:59 +01:00
* Multi-user chat rooms `XEP 45 <http://xmpp.org/extensions/xep-0045.html> `_
* Direct invitations to chat rooms `XEP 249 <http://xmpp.org/extensions/xep-0249.html> `_
* vCard support `XEP 54 <http://xmpp.org/extensions/xep-0054.html> `_
* Service discovery `XEP 30 <http://xmpp.org/extensions/xep-0030.html> `_
2014-11-25 11:00:31 +01:00
* In-band registration `XEP 77 <http://xmpp.org/extensions/xep-0077.html> `_
2014-11-25 10:59:59 +01:00
* Contact rosters and groups
* Contact subscriptions
* Roster item exchange `XEP 144 <http://xmpp.org/extensions/tmp/xep-0144-1.1.html> `_
2013-07-28 23:39:11 +02:00
* Chat statuses (online, busy, away, offline)
2013-04-12 16:16:17 +02:00
* Custom status messages
2015-05-29 10:07:40 +02:00
* Typing and state notifications `XEP 85 <http://xmpp.org/extensions/xep-0085.html> `_
2014-11-25 11:03:31 +01:00
* Messages appear in all connnected chat clients `XEP 280 <http://xmpp.org/extensions/xep-0280.html> `_
2015-05-29 10:07:40 +02:00
* Third person "/me" messages `XEP 245 <http://xmpp.org/extensions/xep-0245.html> `_
* XMPP Ping `XEP 199 <http://xmpp.org/extensions/xep-0199.html> `_
2015-07-29 14:20:39 +02:00
* Server-side archiving of messages `XEP 313 <http://xmpp.org/extensions/xep-0313.html> `_
2015-05-29 10:07:40 +02:00
* Client state indication `XEP 352 <http://xmpp.org/extensions/xep-0352.html> `_
2014-11-25 10:59:59 +01:00
* Off-the-record encryption
2015-05-29 10:07:40 +02:00
* Translated into 16 languages
2013-04-12 16:16:17 +02:00
-----------
Screencasts
-----------
* `In a static HTML page`_ . Here we chat to external XMPP accounts on Jabber.org and Gmail.
* `Integrated into a Plone site`_ via collective.xmpp.chat.
2013-11-13 08:31:07 +01:00
* `Off-the-record encryption <https://opkode.com/media/blog/2013/11/11/conversejs-otr-support> `_ in Converse 0.7.
2013-04-12 16:16:17 +02:00
2013-10-19 23:25:16 +02:00
Integration into other frameworks
---------------------------------
2016-03-09 12:22:14 +01:00
* `Django <http://www.djangoproject.com> `_ :
2013-10-19 23:30:49 +02:00
`django-conversejs <https://pypi.python.org/pypi/django-conversejs> `_ is an app that makes it easer to integrate *Converse.js* into Django.
2015-06-22 20:04:08 +02:00
`django-xmpp <https://github.com/fpytloun/django-xmpp> `_ adds XMPP chat integration with converse.js by letting Ejabberd authenticate against your Django site.
2016-03-09 12:22:14 +01:00
* `Plone <http://plone.org> `_ :
`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.
* `Roundcube <http://roundcube.net> `_ :
2013-11-15 17:02:55 +01:00
`roundcube-converse.js-xmpp-plugin <https://github.com/priyadi/roundcube-converse.js-xmpp-plugin> `_ is a plugin for Roundcube Webmail.
2014-01-15 01:03:14 +01:00
* `Wordpress <http://wordpress.org> `_ :
2014-01-15 01:06:08 +01:00
`ConverseJS <http://wordpress.org/plugins/conversejs> `_
2014-03-22 01:03:34 +01:00
* `Patternslib <http://patternslib.com> `_ :
2014-08-25 18:08:35 +02:00
`patterns.converse <https://github.com/jcbrand/patterns.converse> `_ provides a Patternslib pattern for Converse.js
* `Alfresco <http://www.alfresco.com> `_ :
`alfresco-js-chat-share`_: `alfresco-js-chat-share <https://github.com/keensoft/alfresco-js-chat-share> `_
2016-03-09 12:22:14 +01:00
* `Friendica <http://friendica.com> `_ :
`converse <https://github.com/friendica/friendica-addons/tree/master/xmpp/converse> `_
2013-10-19 23:25:16 +02:00
2013-07-28 23:39:11 +02:00
----
Demo
----
2014-03-18 02:12:25 +01:00
A live demo is available at `<https://conversejs.org>`_
2013-07-28 23:39:11 +02:00
-----
Tests
-----
2014-03-18 02:12:25 +01:00
We use behavior-driven tests written with `jasmine.js <http://pivotal.github.io/jasmine> `_ .
2014-03-22 01:03:34 +01:00
Open `tests.html <https://github.com/jcbrand/converse.js/blob/master/tests.html> `_
in your browser, and the tests will run automatically.
2013-07-28 23:39:11 +02:00
2013-07-28 23:47:12 +02:00
-------------
Documentation
-------------
2014-03-18 02:12:25 +01:00
The developer/integrator documentation can be found at `<https://conversejs.org/docs/html>`_ .
2012-10-23 21:01:24 +02:00
-------
Licence
-------
2014-03-22 01:03:34 +01:00
`` Converse.js `` is released under the `Mozilla Public License (MPL) <https://www.mozilla.org/MPL/2.0/index.txt> `_ .
2012-10-23 21:01:24 +02:00
2014-02-12 12:03:44 +01:00
-------
Support
-------
For support queries and discussions, please join the mailing list: conversejs@librelist.com
2014-05-05 21:53:17 +02:00
2014-04-29 14:44:55 +02:00
Also take a look at the `mailing list archives <http://librelist.com/browser/conversejs> `_ .
2014-02-12 12:03:44 +01:00
Issues can be logged on the `Github issue tracker <https://github.com/jcbrand/converse.js/issues> `_ .
2013-04-12 16:16:17 +02:00
.. _`Integrated into a Plone site`: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
.. _`In a static HTML page`: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
