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
2013-04-21 00:06:18 +02:00
Converse.js_ is a web based `XMPP/Jabber`_ 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
* Multi-user chat in chatrooms
* vCard support
* Service discovery
* Contact rosters
* Manually or automically subscribe to other contacts
2013-04-12 16:16:17 +02:00
* Accept or decline contact requests
2013-07-28 23:39:11 +02:00
* Roster item exchange
* Chat statuses (online, busy, away, offline)
2013-04-12 16:16:17 +02:00
* Custom status messages
* Typing notifications
2012-10-23 21:54:32 +02:00
* Third person messages (/me )
2013-10-04 09:03:50 +02:00
* Translated into multiple languages (af, de, es, fr, it, hu, pt-BR, ru)
2013-09-17 09:43:59 +02:00
* Off-the-record encryption support (via `OTR.js <http://arlolra.github.io/otr> `_ )
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
---------------------------------
2013-10-19 23:30:49 +02: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.
* `Django <http://www.djangoproject.com> `_ :
`django-conversejs <https://pypi.python.org/pypi/django-conversejs> `_ is an app that makes it easer to integrate *Converse.js* into Django.
* `Roundcube <http://roundcube.net> `_ :
`roundcube-converse.js-xmpp-plugin <https://github.com/thomascube/roundcube-converse.js-xmpp-plugin> `_ is a plugin for Roundcube Webmail.
2013-10-19 23:25:16 +02:00
2013-07-28 23:39:11 +02:00
----
Demo
----
A live demo is available at `conversejs.org`_
-----
Tests
-----
We use behavior-driven tests written with jasmine.js_. They can run in your
2013-08-05 09:38:34 +02:00
browser or in the command line via phantom.js_.
2013-07-28 23:39:11 +02:00
2013-07-28 23:47:12 +02:00
-------------
Documentation
-------------
The developer/integrator documentation can be found at `<http://conversejs.org/docs/html>`_ .
2013-07-28 23:39:11 +02:00
2013-04-12 16:16:17 +02:00
------------
Dependencies
------------
2012-10-23 21:50:12 +02:00
2013-04-12 16:16:17 +02:00
It depends on quite a few third party libraries, including:
2012-10-23 22:38:56 +02:00
2013-07-28 23:39:11 +02:00
* jquery_
2013-04-12 16:16:17 +02:00
* strophe.js_
* backbone.js_
2012-10-23 21:01:24 +02:00
-------
Licence
-------
2012-10-23 21:54:32 +02:00
`` Converse.js `` is released under both the MIT_ and GPL_ licenses.
2012-10-23 21:01:24 +02:00
2013-10-16 11:49:05 +02:00
------
Donate
------
2013-11-06 09:14:58 +01:00
* Bitcoin: 16FsPqE9DhFTryxrUenpsGX4LJ1TPu8GqS
* Litecoin: LLvLH6qJch7HAamLguHkwobCrxmHLhiwZw
2013-10-16 11:49:05 +02:00
2013-04-12 16:16:17 +02:00
.. _Converse.js: http://conversejs.org
2012-10-23 21:01:24 +02:00
.. _strophe.js: http://strophe.im/strophejs
.. _backbone.js: http:/backbonejs.org
.. _require.js: http:/requirejs.org
.. _collective.xmpp.chat: http://github.com/collective/collective.xmpp.chat
.. _Plone: http://plone.org
2013-04-21 00:06:18 +02:00
.. _`XMPP/Jabber`: http://xmpp.org
2012-10-23 21:01:24 +02:00
.. _MIT: http://opensource.org/licenses/mit-license.php
.. _GPL: http://opensource.org/licenses/gpl-license.php
2012-10-23 22:38:56 +02:00
.. _here: http://opkode.com/media/blog/instant-messaging-for-plone-with-javascript-and-xmpp
2013-04-12 16:16:17 +02:00
.. _Screencast2: http://opkode.com/media/blog/2013/04/02/converse.js-xmpp-instant-messaging-with-javascript
.. _`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
2013-07-28 23:47:12 +02:00
.. _`conversejs.org`: http://conversejs.org
2013-07-28 23:39:11 +02:00
.. _jquery: http://jquery.com
.. _jasmine.js: http://pivotal.github.io/jasmine
.. _phantom.js: http://phantomjs.org
.. _`Travis-CI`: https://travis-ci.org
