Websockets for Django applications using Redis as message queue

This module implements websockets on top of Django without requiring any additional framework. For messaging it uses the Redis datastore. In a production environment, it is intended to work under uWSGI and behind NGiNX. In a development environment, it can be used with manage runserver.

Project’s home

Check for the latest release of this project on Github.

Please report bugs or ask questions using the Issue Tracker.

Contents

• Introduction
  • The WSGI protocol can not support websockets
  • uWSGI
  • Using Redis as a message queue
    • Scalability
• Installation and Configuration
  • Installation
    • Dependencies
  • Configuration
    • Check your Installation
  • Replace memcached with Redis
• Running WebSocket for Redis
  • Django with WebSockets for Redis in development mode
  • Django with WebSockets for Redis as a stand alone uWSGI server
    • Serving static files
  • Django with WebSockets for Redis behind NGiNX using uWSGI
  • Django with WebSockets for Redis behind Apache-2.4 using uWSGI
  • Django with WebSockets for Redis as a stand alone uWSGI server in emperor mode
    • Serving static files
    • PCRE Support
• Using Websockets for Redis
  • Client side
    • A minimal client in pure JavaScript
    • Client JavaScript depending on jQuery (recommended)
  • Server Side
    • RedisSubscriber
    • RedisPublisher
    • Subscribe to Broadcast Notifications
    • Subscribe to User Notification
    • Subscribe to Group Notification
    • Subscribe to Session Notification
    • Publish for Broadcast, User, Group and Session
    • Message echoing
    • Persisting messages
    • Safety considerations
• Sending and receiving heartbeat messages
  • The client part
  • The server part
• Application Programming Interface
  • Use RedisPublisher from inside Django views
    • Replace RedisSubscriber for the Websocket loop
• Testing Websockets for Redis
  • A simple Chat server
    • Simple Broadcasting
    • Testing uWSGI
  • Running Unit Tests
  • Running Stress Tests
• Debugging
  • Django Loop and Websocket Loop
  • Query the datastore
    • keys
    • get
    • subscribe
• Release History
  • 0.5.2
  • 0.5.1
  • 0.5.0
  • 0.4.8
  • 0.4.7
  • 0.4.6
  • 0.4.5
  • 0.4.4
  • 0.4.3
  • 0.4.2
  • 0.4.1
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.2
  • 0.1.1
  • 0.1.0
• Credits to Others
  • AngularJS
  • Current solutions
  • uWSGI

Indices and tables

• Index
• Module Index
• Search Page