From 7cd5a02ee93e96bd503e0a0992ff66695eb9956f Mon Sep 17 00:00:00 2001 From: Arne Schauf Date: Thu, 17 Sep 2015 18:06:26 +0200 Subject: [PATCH] update some doc about the redis backend --- docs/backends.rst | 14 ++++++++++++++ docs/deploying.rst | 7 ++++++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/backends.rst b/docs/backends.rst index e79dda9..b80911a 100644 --- a/docs/backends.rst +++ b/docs/backends.rst @@ -21,6 +21,20 @@ Database Redis ----- +To use the Redis backend you have to install the redis package:: + + pip install -U redis + +Also you need to set the following in the ``CHANNEL_BACKENDS`` setting:: + + CHANNEL_BACKENDS = { + "default": { + "BACKEND": "channels.backends.redis_py.RedisChannelBackend", + "HOST": "redis-hostname", + }, + } + + Writing Custom Backends ----------------------- diff --git a/docs/deploying.rst b/docs/deploying.rst index 5a47e36..49433b7 100644 --- a/docs/deploying.rst +++ b/docs/deploying.rst @@ -36,11 +36,16 @@ here's an example for a remote Redis server:: CHANNEL_BACKENDS = { "default": { - "BACKEND": "channels.backends.redis.RedisChannelBackend", + "BACKEND": "channels.backends.redis_py.RedisChannelBackend", "HOST": "redis-channel", }, } +To use the Redis backend you have to install the redis package:: + + pip install -U redis + + Make sure the same setting file is used across all your workers, interfaces and WSGI apps; without it, they won't be able to talk to each other and things will just fail to work.