2018-09-23 21:26:03 +02:00
# Converse
2016-05-20 11:46:53 +02:00
2018-02-21 10:41:57 +01:00
[](https://inverse.chat/#converse/room?jid=discuss@conference.conversejs.org)
2018-03-17 00:40:03 +01:00
[](https://travis-ci.org/conversejs/converse.js)
2017-03-15 12:04:10 +01:00
[](https://www.bountysource.com/teams/converse.js/issues?tracker_ids=194169)
[](https://hosted.weblate.org/engage/conversejs/?utm_source=widget)
2016-05-20 11:46:53 +02:00
2018-09-23 21:26:03 +02:00
[Converse ](https://conversejs.org ) is a web based [XMPP/Jabber ](https://xmpp.org ) chat client.
2016-05-20 11:46:53 +02:00
2018-09-23 21:26:03 +02:00
You can either use it as a webchat app, or you can integrate it into your own website.
2018-09-24 09:52:09 +02:00
It's 100% client-side JavaScript, HTML and CSS and the only backend required
2018-09-23 21:26:03 +02:00
is a modern XMPP server.
2016-05-20 11:46:53 +02:00
2017-12-06 11:40:04 +01:00
Please support this project via [Patreon ](https://www.patreon.com/jcbrand ) or [Liberapay ](https://liberapay.com/jcbrand )
2017-12-05 14:11:48 +01:00
2016-06-21 09:07:22 +02:00
## Demo
2016-05-20 11:46:53 +02:00
2018-09-23 21:26:03 +02:00
Converse is hosted and can be used at [https://conversejs.org ](https://conversejs.org ).
2017-06-14 15:42:25 +02:00
A demo showing anonymous login is available at [https://conversejs.org/demo/anonymous.html ](https://conversejs.org/demo/anonymous.html )
and a demo which shows how you can embed a single chat room into a page is
avialable at [https://conversejs.org/demo/embedded.html ](https://conversejs.org/demo/embedded.html ).
2018-09-23 21:26:03 +02:00
### Converse in overlay mode
2017-06-14 15:42:25 +02:00
2018-09-23 21:26:03 +02:00
2017-07-05 13:02:36 +02:00
2018-09-23 21:26:03 +02:00
## Converse in fullpage mode
2017-06-14 15:42:25 +02:00
2018-09-23 21:26:03 +02:00
2016-06-21 09:07:22 +02:00
## Documentation
The developer/integrator documentation can be found at [https://conversejs.org/docs/html ](https://conversejs.org/docs/html ).
You'll probably want to begin with the [quickstart guide ](https://conversejs.org/docs/html/quickstart.html ),
which shows you how to use the CDN (content delivery network) to quickly get a demo up and running.
## Features
2018-09-08 02:16:04 +02:00
- Available as overlayed chat boxes or as a fullscreen application. See [inverse.chat ](https://inverse.chat ) for the fullscreen version.
2019-09-24 15:33:41 +02:00
- Custom status messages
- Desktop notifications
2018-03-17 00:40:03 +01:00
- A [plugin architecture ](https://conversejs.org/docs/html/plugin_development.html ) based on [pluggable.js ](https://conversejs.github.io/pluggable.js/ )
2018-07-21 08:20:40 +02:00
- Multi-user chat rooms [XEP 45 ](https://xmpp.org/extensions/xep-0045.html )
2018-09-08 02:16:04 +02:00
- Chatroom bookmarks [XEP 48 ](https://xmpp.org/extensions/xep-0048.html )
2018-07-21 08:20:40 +02:00
- Direct invitations to chat rooms [XEP 249 ](https://xmpp.org/extensions/xep-0249.html )
- vCard support [XEP 54 ](https://xmpp.org/extensions/xep-0054.html )
- Service discovery [XEP 30 ](https://xmpp.org/extensions/xep-0030.html )
- In-band registration [XEP 77 ](https://xmpp.org/extensions/xep-0077.html )
- Roster item exchange [XEP 144 ](https://xmpp.org/extensions/tmp/xep-0144-1.1.html )
2016-05-20 11:46:53 +02:00
- Chat statuses (online, busy, away, offline)
2018-07-21 08:20:40 +02:00
- Typing and state notifications [XEP 85 ](https://xmpp.org/extensions/xep-0085.html )
2018-09-08 02:16:04 +02:00
- File sharing / HTTP File Upload [XEP 363 ](https://xmpp.org/extensions/xep-0363.html )
- Messages appear in all connnected chat clients / Message Carbons [XEP 280 ](https://xmpp.org/extensions/xep-0280.html )
2018-07-21 08:20:40 +02:00
- Third person "/me" messages [XEP 245 ](https://xmpp.org/extensions/xep-0245.html )
- XMPP Ping [XEP 199 ](https://xmpp.org/extensions/xep-0199.html )
- Server-side archiving of messages [XEP 313 ](https://xmpp.org/extensions/xep-0313.html )
- Hidden Messages (aka Spoilers) [XEP 382 ](https://xmpp.org/extensions/xep-0382.html )
- Client state indication [XEP 352 ](https://xmpp.org/extensions/xep-0352.html )
- Last Message Correction [XEP 308 ](https://xmpp.org/extensions/xep-0308.html )
2018-09-08 02:16:04 +02:00
- OMEMO encrypted messaging [XEP 384 ](https://xmpp.org/extensions/xep-0384.html" )
2019-09-24 15:33:41 +02:00
- Anonymous logins, see the [anonymous login demo ](https://conversejs.org/demo/anonymous.html )
- Message Retractions [XEP-424 ](https://xmpp.org/extensions/xep-0424.html )
- Message Moderation [XEP-425 ](https://xmpp.org/extensions/xep-0425.html )
- Translated into over 30 languages
2016-05-20 11:46:53 +02:00
2016-06-21 09:07:22 +02:00
## Integration into other frameworks
2016-05-20 11:46:53 +02:00
2018-09-08 02:16:04 +02:00
- ** [Prosody ](https://prosody.im/ )**: [mod_conversejs ](https://modules.prosody.im/mod_conversejs.html )
- ** [Openfire ](https://www.igniterealtime.org/projects/openfire/index.jsp )**: [inverse.jar ](https://www.igniterealtime.org/projects/openfire/plugins.jsp )
2018-07-21 08:20:40 +02:00
- ** [Ruby on Rails ](https://rubyonrails.org )**: [conversejs-rails ](https://github.com/mikemarsian/conversejs-rails )
- ** [Django ](https://www.djangoproject.com )**: [django-conversejs ](https://pypi.python.org/pypi/django-conversejs ) or [django-xmpp ](https://github.com/fpytloun/django-xmpp )
2018-09-08 02:16:04 +02:00
- ** [Patternslib ](http://patternslib.com )**: [patterns.converse ](https://github.com/jcbrand/patterns.converse )
2018-07-21 08:20:40 +02:00
- ** [Roundcube ](https://roundcube.net )**: [roundcube-converse.js-xmpp-plugin ](https://github.com/devurandom/roundcube-converse.js-xmpp-plugin )
- ** [Wordpress ](https://wordpress.org )**: [ConverseJS ](https://wordpress.org/plugins/conversejs/ )
2018-09-08 02:16:04 +02:00
- ** [Plone ](https://plone.com )**: [collective.converse ](https://github.com/collective/collective.converse )
2018-07-21 08:20:40 +02:00
- ** [Alfresco ](https://www.alfresco.com )**: [alfresco-js-chat-share ](https://github.com/keensoft/alfresco-js-chat-share )
- ** [Friendica ](https://friendi.ca )**: [converse ](https://github.com/friendica/friendica-addons/tree/master/xmpp/converse )
- ** [Tiki Wiki CMS Groupware ](https://tiki.org )**: [built-in optional feature ](https://doc.tiki.org/XMPP )
2016-05-20 11:46:53 +02:00
2016-06-21 09:07:22 +02:00
## Tests
2016-05-20 11:46:53 +02:00
2016-10-07 10:35:57 +02:00
We use behavior-driven tests written with [jasmine.js ](https://jasmine.github.io/ ).
2016-05-20 11:46:53 +02:00
2018-03-17 00:40:03 +01:00
Open [tests.html ](https://github.com/conversejs/converse.js/blob/master/tests.html ) in your browser, and the tests will run automatically.
2016-05-20 11:46:53 +02:00
2016-06-21 09:07:22 +02:00
## Licence
2016-05-20 11:46:53 +02:00
`Converse.js` is released under the [Mozilla Public License (MPL) ](https://www.mozilla.org/MPL/2.0/index.txt ).
2018-09-03 14:06:18 +02:00
## Attribution
Emoji images are courtesy of [Twemoji ](https://emojitwo.github.io/ ).
2016-06-21 09:07:22 +02:00
## Support
2016-05-20 11:46:53 +02:00
2018-03-17 00:40:03 +01:00
Issues can be logged on the [Github issue tracker ](https://github.com/conversejs/converse.js/issues ).
2018-01-29 16:06:07 +01:00
## Donations
A heartfelt thanks for everyone who has supported this project over the years.
Many people have contributed testing, bugfixes, features and corrections.
2019-02-05 21:50:30 +01:00
We accept donations via [Patreon ](https://www.patreon.com/jcbrand ) and [Liberapay ](https://liberapay.com/jcbrand ).
