From 17e08fd332164aaded21d5501a989939aa4836b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 5 Dec 2023 12:29:33 +0000 Subject: [PATCH] fix(docs): Update env file for Unix socket Added note to the CACHE_URL variable to clarify Unix socket usage Part-of: --- api/config/settings/common.py | 4 ++-- deploy/env.prod.sample | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/api/config/settings/common.py b/api/config/settings/common.py index 2ea42cd5c..b7040a707 100644 --- a/api/config/settings/common.py +++ b/api/config/settings/common.py @@ -830,7 +830,7 @@ If you're using password auth (the extra slash is important) .. note:: If you want to use Redis over unix sockets, you also need to update - :attr:`CELERY_BROKER_URL`, because the scheme differ from the one used by + :attr:`CELERY_BROKER_URL`, because the scheme differs from the one used by :attr:`CACHE_URL`. """ @@ -881,7 +881,7 @@ to use a different server or use Redis sockets to connect. Example: -- ``redis://127.0.0.1:6379/0`` +- ``unix://127.0.0.1:6379/0`` - ``redis+socket:///run/redis/redis.sock?virtual_host=0`` """ diff --git a/deploy/env.prod.sample b/deploy/env.prod.sample index 0ff7a5be1..1ea36c651 100644 --- a/deploy/env.prod.sample +++ b/deploy/env.prod.sample @@ -99,7 +99,7 @@ REVERSE_PROXY_TYPE=nginx # # If you want to use Redis over unix sockets, you'll actually need two variables: # For the cache part: -# CACHE_URL=redis:///run/redis/redis.sock?db=0 +# CACHE_URL=unix:///run/redis/redis.sock?db=0 # For the Celery/asynchronous tasks part: # CELERY_BROKER_URL=redis+socket:///run/redis/redis.sock?virtual_host=0