skip to navigation
skip to content

Not Logged In

collective.xmpp.chat 0.2b2

XMPP-based instant Messaging for Plone

Latest Version: 0.3.1

Introduction
============

``collective.chat.xmpp`` provides instant messaging for Plone_. It uses the
XMPP_ protocol and requires an XMPP server (such as ejabberd_) for the message handling.

Features
========

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

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

* `XEP-0045`_ Multi-user Chat
* `XEP-0071`_ XHTML-IM.
* `XEP-0144`_ Roster Item Exchange.
* `XEP-0124`_ Bidirectional-streams Over Synchronous HTTP (BOSH)
* `XEP-0206`_ XMPP over BOSH

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.

Important details for developers
================================

Since  `a recent commit`_ this package now makes
use of a git submodule (specifically the the ./browser/resources dir).

Once you have cloned this repo, you need to run two commands:

  ::

    git submodule init
    git submodule update

For more information on submodules and how to work with them, `refer to the git book`_.


.. _XEP-0045: http://xmpp.org/extensions/xep-0045.html
.. _XEP-0071: http://xmpp.org/extensions/xep-0071.html
.. _XEP-0144: http://xmpp.org/extensions/xep-0144.html
.. _XEP-0124: http://xmpp.org/extensions/xep-0124.html
.. _XEP-0206: http://xmpp.org/extensions/xep-0206.html
.. _collective.xmpp.core: http://github.com/collective/collective.xmpp.core
.. _collective.xmpp.buildout: http://github.com/collective/collective.xmpp.buildout
.. _Plone: http://plone.org
.. _XMPP: http://xmpp.org
.. _ejabberd: ejabberd.im
.. _a recent commit: https://github.com/collective/collective.xmpp.chat/commit/a6f41258b55709fd734d5f432d42d6f04d61d538
.. _refer to the git book: http://git-scm.com/book/en/Git-Tools-Submodules

=========
Changelog
=========

------------------
0.2b2 (Unreleased)
------------------

- Fixed MANIFEST.in to include the resources dir.
  [jcbrand]

0.2b1 (2013-01-16)
------------------

- Added Spanish translation.
  [macagua]
- Added improvements about i18n support.
  [macagua]
- Fixed JS resources order, otherwise the users were "Unable to pre-bind ..."
  [alecghica]
- Remove javascript and stylesheets dirs and replace with 'resources' dir which
  is a git submodule pointing to the converse.js repo.
  [jcbrand]
- Separate messages from different days
  [jcbrand]
- Add /help command for both single and group chat. Add /clear command for
  single user chat.
  [jcbrand]
- Fixes for IE8
  [jcbrand]

0.2a3 (2012-11-19)
------------------

- Bugfix. Unable to join chatroom when user with same first name already joined.
  [jcbrand]

0.2a2 (2012-11-09)
------------------

- Add support for chatting with having multiple tabs open.
  [jcbrand]
- Chatboxes now show the user's profile photo and a link to their profile.
  [jcbrand]
- Some CSS and JS fixes.
  [jcbrand]

0.1 (2012-10-18)
----------------

- Initial release. (Please consider this an alpha release).
  [jcbrand]
 
File Type Py Version Uploaded on Size
collective.xmpp.chat-0.2b2.zip (md5) Source 2013-01-16 552KB
  • Downloads (All Versions):
  • 80 downloads in the last day
  • 506 downloads in the last week
  • 1476 downloads in the last month