Skip to content
This repository
branch: master
README.rst

Introduction

collective.chat.xmpp provides instant messaging for Plone.

It provides a web-based chat client, by means of Converse.js, a javascript library which makes use of the open and very popular XMPP messaging protocol.

You will need an XMPP server (such as ejabberd) for the message handling.

Features

  • Manually or automatically subscribe to other users.
  • With manual roster subscriptions, you can accept or decline contact requests.
  • Chat statuses (online, busy, away, offline)
  • Custom status messages
  • Typing notifications (i.e when the contact is typing)
  • Third person messages (/me )
  • Multi-user chat in chatrooms
  • Chatrooms can be configured (privacy, persistency etc.)
  • Topics can be set for chatrooms
  • Full name and profile picture support (via VCards)

Installation

XMPP integration with Plone is provided by the collective.xmpp.core package. Please refer to its README on how to set it up.

You can use the buildout at collective.xmpp.buildout.

The buildout in this egg is used for development purposes.

You'll need to have a working XMPP server and access to the administration account on the server.

Your XMPP server will have to support the following extensions

Configuration

You'll need to have an administrator account on the Jabber server you'll be using. Refer to the collective.xmpp.core README for information on how to set this up.

Once you've installed collective.xmpp.chat, you should go to the Plone registry in the control panel and set the XMPP Domain as well as the XMPP Admin JID and XMPP Admin Password values.

Additionally you have the option Auto-subscribe XMPP users, which is disabled by default.

Enable this option if you don't want your users to manually maintain their rosters (i.e subscribing and unsubscribing to one another) and would rather have everyone subscribe to everyone else. Be careful however, this might cause a lot of overhead (and therefore be quite slow) on sites with large userbases.

Something went wrong with that request. Please try again.