xmpp.chapril.org-conversejs/README.md
2018-09-10 16:11:11 +02:00

7.7 KiB

converse.js

XMPP Chat Travis Bountysource bounties Translation status

Converse.js is a web based XMPP/Jabber instant messaging client.

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.

Please support this project via Patreon or Liberapay

Demo

Converse.js is hosted and can be used at https://conversejs.org.

A demo showing anonymous login is available at 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.

Converse.js: As seen on the conversejs.org website

Screenshot of Converse

inVerse: a fullscreen version of converse.js

Converse.js is also available in a fullscreen version, hosted at inverse.chat

Screenshot of Converse in fullscreen mode

Documentation

The developer/integrator documentation can be found at https://conversejs.org/docs/html.

You'll probably want to begin with the quickstart guide, which shows you how to use the CDN (content delivery network) to quickly get a demo up and running.

Features

  • Available as overlayed chat boxes or as a fullscreen application. See inverse.chat for the fullscreen version.
  • A plugin architecture based on pluggable.js
  • Single-user and group chats
  • Contacts and groups
  • Multi-user chat rooms XEP 45
  • Chatroom bookmarks XEP 48
  • Direct invitations to chat rooms XEP 249
  • vCard support XEP 54
  • Service discovery XEP 30
  • In-band registration XEP 77
  • Roster item exchange XEP 144
  • Chat statuses (online, busy, away, offline)
  • Custom status messages
  • Typing and state notifications XEP 85
  • Desktop notifications
  • File sharing / HTTP File Upload XEP 363
  • Messages appear in all connnected chat clients / Message Carbons XEP 280
  • Third person "/me" messages XEP 245
  • XMPP Ping XEP 199
  • Server-side archiving of messages XEP 313
  • Hidden Messages (aka Spoilers) XEP 382
  • Client state indication XEP 352
  • Last Message Correction XEP 308
  • Off-the-record encryption
  • OMEMO encrypted messaging XEP 384
  • Supports anonymous logins, see the anonymous login demo.
  • Translated into 17 languages

Integration into other frameworks

Screencasts

Note: These screencasts are already quite old! Converse.js has grown and evolved further since then.

Tests

We use behavior-driven tests written with jasmine.js.

Open tests.html in your browser, and the tests will run automatically.

Licence

Converse.js is released under the Mozilla Public License (MPL).

Attribution

Emoji images are courtesy of Twemoji.

Support

For support queries and discussions, please join the mailing list: conversejs@librelist.com

Also take a look at the mailing list archives.

Issues can be logged on the Github issue tracker.

Donations

A heartfelt thanks for everyone who has supported this project over the years. Many people have contributed testing, bugfixes, features and corrections.

Recently we have started accepting donations via Patreon and Liberapay.

The following people are making recurring donations:

Additionally this project is supported by

  • KeyCDN
  • Wikisuite