Install¶

Websockets server¶

Important note: you have to use the database_channels branch from the django-instant repository for this module to work for the moment (it uses advanced features that have not yet landed mainstream).

Instructions are here

pip install redis django-mqueue

Add to INSTALLED_APPS;

'rechat',
'mqueue',

Set the urls:

from instant.views import instant_auth

urlpatterns = [
     # ...
     url(r'^centrifuge/auth/$', instant_auth, name='instant-auth'),
     url('^chat/', include('rechat.urls')),
     ]

Run the migrations

Settings¶

# Required

SITE_SLUG = "mysite"
INSTANT_USERS_CHANNELS = [
 ["$" + SITE_SLUG + "_chat", ["/chat"]]
]

# Optional

# default: True
USE_CACHE = False
# default: 30
RECHAT_CACHE_ITEMS = 20
# default: 60*60*12 (12 hours)
CHAT_CACHE_TTL = 60*60
# default: localhost
RECHAT_REDIS_HOST = 'ip_here'
# default: 6379
RECHAT_REDIS_PORT = 4867
# default: 0
RECHAT_REDIS_DB = 1

You will need Redis to be installed to use the cache.

Only the logged in users can chat.

Templates¶

Create a

Create a templates/instant/handlers/default.js Fill it with this content:

{% include "rechat/js/handler.js" %}

To create a custom handler for a room create a templates/instant/handlers/<room_name>.js