From 0226c9f8176b34d051191a7f3c0990dd866ddb52 Mon Sep 17 00:00:00 2001 From: AJIOB Date: Thu, 1 Feb 2024 11:38:04 +0300 Subject: [PATCH] Improve Redis docs --- docs/Redis.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/Redis.md b/docs/Redis.md index 61b186d59..bd288505a 100644 --- a/docs/Redis.md +++ b/docs/Redis.md @@ -1,7 +1,24 @@ # Redis -Set `SCCACHE_REDIS` to a [Redis](https://redis.io/) url in format `redis://[:@][:port][/]` to store the cache in a Redis instance. Redis can be configured as a LRU (least recently used) cache with a fixed maximum cache size. Set `maxmemory` and `maxmemory-policy` according to the [Redis documentation](https://redis.io/topics/lru-cache). The `allkeys-lru` policy which discards the *least recently accessed or modified* key fits well for the sccache use case. +Set `SCCACHE_REDIS` to a [Redis](https://redis.io/) url in format `redis://[[]:@][:port][/?db=]` to store the cache in a Redis instance. Redis can be configured as a LRU (least recently used) cache with a fixed maximum cache size. Set `maxmemory` and `maxmemory-policy` according to the [Redis documentation](https://redis.io/topics/lru-cache). The `allkeys-lru` policy which discards the *least recently accessed or modified* key fits well for the sccache use case. Redis over TLS is supported. Use the [`rediss://`](https://www.iana.org/assignments/uri-schemes/prov/rediss) url scheme (note `rediss` vs `redis`). Append `#insecure` the the url to disable hostname verification and accept self-signed certificates (dangerous!). Note that this also disables [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). Set `SCCACHE_REDIS_TTL` in seconds if you don't want your cache to live forever. This will override the default behavior of redis. + +## Examples + +Use the local Redis instance with no password: +```sh +SCCACHE_REDIS=redis://localhost +``` + +Use the local Redis instance on port `6379` with password `qwerty`: +```sh +SCCACHE_REDIS=redis://:qwerty@localhost:6379 +``` + +Use the `192.168.1.10` Redis instance on port `6380` with username `alice`, password `qwerty123` and database `12` via TLS connection: +```sh +SCCACHE_REDIS=rediss://alice:qwerty123@192.168.1.10:6380/?db=12 +```