From 76962f8d8c1fe99507ccbe1b6cfcee7225f28b7d Mon Sep 17 00:00:00 2001 From: Nicholas Charriere Date: Sun, 1 Jul 2018 10:25:55 -0700 Subject: [PATCH] Add REDIS_PREFIX documentation --- README.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 2504f20..ef0391e 100644 --- a/README.rst +++ b/README.rst @@ -68,7 +68,7 @@ Configuration You can configure the following via environment variables. -`SECRET_KEY` this should be a unique key that's used to sign key. This should +`SECRET_KEY` unique key that's used to sign key. This should be kept secret. See the `Flask Documentation`__ for more information. .. __: http://flask.pocoo.org/docs/quickstart/#sessions @@ -88,7 +88,9 @@ need to change this. `SNAPPASS_REDIS_DB` is the database that you want to use on this redis server. Defaults to db 0 -`REDIS_URL` is optional and, if set, will be used instead of `REDIS_HOST`, `REDIS_PORT`, and `SNAPPASS_REDIS_DB` to configure the Redis client object. For example: redis://username:password@localhost:6379/0 +`REDIS_URL` (optional) will be used instead of `REDIS_HOST`, `REDIS_PORT`, and `SNAPPASS_REDIS_DB` to configure the Redis client object. For example: redis://username:password@localhost:6379/0 + +`REDIS_PREFIX` (optional, defaults to `"snappass"`) prefix used on redis keys to prevent collisions with other potential clients Docker ------