Skip to main content

Adds converse.js (javascript XMPP client) to Django

Project description

This app aims to make easier to integrate Converse.js into Django.

Currently django-conversejs provides:

  • A minified distribution of converse.js

  • Template tags to help you to include converse.js on your Django project

  • A database model to store the XMPP user and password for each user

  • Converse.js configurations through

  • Single-sign-on (SSO) like experience

Installing and configuring

Install pure-sasl from TracyWebTech/digestmd5 branch:

pip install git+

Install django-conversejs:

pip install git+

Add conversejs to installed apps in your


Configure the BOSH service URL in your


Load the static files in your templates using django-conversejs custom tags:

{% load conversejs %}
  {% conversejs_static %}

Load the chat panel and the Javascript initilizalizer also using our custom tags:

{% load conversejs %}

  {% conversejs_chatpanel %}
  {% conversejs_initialize %}

Update database schema:

python syncdb
python migrate # optional

Adding an XMPP account

  • Log in the Django Admin

  • Add an XMPP account by clicking in the ‘+ Add’ button

  • Choose the user from the select box and them type the JabberID and password for the account

Now everytime the select user your logs in your site he will be automatically logged in the XMPP server using the credentials you provided.

Enabling XMPP auto registration

By enabling auto registration django-conversejs will attempt to create a new XMPP account for every user that doesn’t have one as soon as they login in your site.

To enable you just need to add the CONVERSEJS_AUTO_REGISTER option to your setting it to the domain of your XMPP service. Notice that the XMPP server and the BOSH service URL are two different things.

For example:



In the example above Django will get the username from request.user.username and try to register under the xmpp domain, so if an user john logs in it would try to register

If registration fails for any reason django-conversejs will attempt again on every request. That’s something to be improved.


If you want to create custom forms to keep the look and feel of your site you can use conversejs.forms as a start point.

Converse.js Version

We currently ship Converse.js v0.6.3.

If you need a newer version, please open an issue or a pull request.


  • Allow user reset XMPP account password. That’s useful to allow the use of other xmpp clients.

  • Allow user to set avatar

  • Auto update XMPP name and email when those are updated in django (using signals)


django-conversejs depends of pure-sasl, a Python library to perform SASL authentication.

Currently the stable version of pure-sasl has a bug which doesn’t allow us to use DIGEST-MD5 authentication, which happens to be the most recommend authentication method. That’s why this instructions ask you to install pure-sasl from a repository which is not the official one. As soon as pure-sasl authors get the bugs fixed we’ll update the instructions.

Sorry for the inconvenience.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-conversejs-0.2.4.tar.gz (161.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page