From d76b54692903741036fa97df730fada4ac9243cf Mon Sep 17 00:00:00 2001
From: Steve Foster <steve.p.foster@gmail.com>
Date: Fri, 29 Dec 2023 23:03:02 +1300
Subject: [PATCH] docs: update redis cache client options (#10521)

Between v3 and v4 in node-redis the client options changed for a collection of socket related
paramaters. In the caching documentation the v3 format for used for `host` and `socket`. When
following the documented example the redis client would default to `localhost` even when a
different value for `host` was specified.

Closes: #9987
---
 docs/caching.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/docs/caching.md b/docs/caching.md
index d1000eada..6bf4f3be1 100644
--- a/docs/caching.md
+++ b/docs/caching.md
@@ -137,8 +137,10 @@ Example:
     cache: {
         type: "redis",
         options: {
-            host: "localhost",
-            port: 6379
+            socket: {
+                host: "localhost",
+                port: 6379
+            }
         }
     }
 }
@@ -240,8 +242,10 @@ Example:
     cache: {
         type: "redis",
         options: {
-            host: "localhost",
-            port: 6379
+            socket: {
+                host: "localhost",
+                port: 6379
+            }
         },
         ignoreErrors: true
     }