Skip to content

Commit

Permalink
Merge pull request #257 from charleswhchan/clarify-ws4redis-expire
Browse files Browse the repository at this point in the history
Fixes #250
  • Loading branch information
jrief committed Apr 8, 2018
2 parents 1d96a96 + a92a282 commit 5c19dae
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ If your Redis instance is accessed via a Unix Domain Socket, you can configure t
'db': 5
}
**Websocket for Redis** can be configured with ``WS4REDIS_EXPIRE``, to additionally persist messages
published on the message queue. This is advantageous in situations, where clients shall be able
to access the published information after reconnecting the websocket, for instance after a page
is reloaded.
**Websocket for Redis** can be configured with ``WS4REDIS_EXPIRE``, to persist messages
published on the message queue for extended periods of time. This is advantageous in situations,
where clients shall be able to access the published information after reconnecting the websocket,
for instance after a page is reloaded.

This directive sets the number in seconds, each received message is persisted by Redis, additionally
of being published on the message queue
Expand All @@ -103,6 +103,9 @@ of being published on the message queue
WS4REDIS_EXPIRE = 7200
The default value is 3600. To turn off persistence, set this value to 0 and messages will expire
immediate after (trying) to dispatch to the Websocket.

**Websocket for Redis** can prefix each entry in the datastore with a string. By default, this
is empty. If the same Redis connection is used to store other kinds of data, in order to avoid name
clashes you're encouraged to prefix these entries with a unique string, say
Expand Down

0 comments on commit 5c19dae

Please sign in to comment.