Skip to content

Commit 0f2035d

Browse files
authored
Don't have redis-cluster as possible cache/session adapter in docs (#30794) (#30806)
1 parent 954962c commit 0f2035d

File tree

2 files changed

+10
-13
lines changed

2 files changed

+10
-13
lines changed

custom/conf/app.example.ini

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1430,7 +1430,7 @@ LEVEL = Info
14301430
;; Batch size to send for batched queues
14311431
;BATCH_LENGTH = 20
14321432
;;
1433-
;; Connection string for redis queues this will store the redis or redis-cluster connection string.
1433+
;; Connection string for redis queues this will store the redis (or Redis cluster) connection string.
14341434
;; When `TYPE` is `persistable-channel`, this provides a directory for the underlying leveldb
14351435
;; or additional options of the form `leveldb://path/to/db?option=value&....`, and will override `DATADIR`.
14361436
;CONN_STR = "redis://127.0.0.1:6379/0"
@@ -1702,9 +1702,8 @@ LEVEL = Info
17021702
;; For "memory" only, GC interval in seconds, default is 60
17031703
;INTERVAL = 60
17041704
;;
1705-
;; For "redis", "redis-cluster" and "memcache", connection host address
1706-
;; redis: `redis://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s`
1707-
;; redis-cluster: `redis+cluster://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s`
1705+
;; For "redis" and "memcache", connection host address
1706+
;; redis: `redis://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` (or `redis+cluster://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` for a Redis cluster)
17081707
;; memcache: `127.0.0.1:11211`
17091708
;; twoqueue: `{"size":50000,"recent_ratio":0.25,"ghost_ratio":0.5}` or `50000`
17101709
;HOST =
@@ -1736,15 +1735,14 @@ LEVEL = Info
17361735
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
17371736
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
17381737
;;
1739-
;; Either "memory", "file", "redis", "redis-cluster", "db", "mysql", "couchbase", "memcache" or "postgres"
1738+
;; Either "memory", "file", "redis", "db", "mysql", "couchbase", "memcache" or "postgres"
17401739
;; Default is "memory". "db" will reuse the configuration in [database]
17411740
;PROVIDER = memory
17421741
;;
17431742
;; Provider config options
17441743
;; memory: doesn't have any config yet
17451744
;; file: session file path, e.g. `data/sessions`
1746-
;; redis: `redis://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s`
1747-
;; redis-cluster: `redis+cluster://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s`
1745+
;; redis: `redis://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` (or `redis+cluster://127.0.0.1:6379/0?pool_size=100&idle_timeout=180s` for a Redis cluster)
17481746
;; mysql: go-sql-driver/mysql dsn config string, e.g. `root:password@/session_table`
17491747
;PROVIDER_CONFIG = data/sessions ; Relative paths will be made absolute against _`AppWorkPath`_.
17501748
;;

docs/content/administration/config-cheat-sheet.en-us.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ Configuration at `[queue]` will set defaults for queues with overrides for indiv
487487
- `DATADIR`: **queues/common**: Base DataDir for storing level queues. `DATADIR` for individual queues can be set in `queue.name` sections. Relative paths will be made absolute against `%(APP_DATA_PATH)s`.
488488
- `LENGTH`: **100000**: Maximal queue size before channel queues block
489489
- `BATCH_LENGTH`: **20**: Batch data before passing to the handler
490-
- `CONN_STR`: **redis://127.0.0.1:6379/0**: Connection string for the redis queue type. For `redis-cluster` use `redis+cluster://127.0.0.1:6379/0`. Options can be set using query params. Similarly, LevelDB options can also be set using: **leveldb://relative/path?option=value** or **leveldb:///absolute/path?option=value**, and will override `DATADIR`
490+
- `CONN_STR`: **redis://127.0.0.1:6379/0**: Connection string for the redis queue type. If you're running a Redis cluster, use `redis+cluster://127.0.0.1:6379/0`. Options can be set using query params. Similarly, LevelDB options can also be set using: **leveldb://relative/path?option=value** or **leveldb:///absolute/path?option=value**, and will override `DATADIR`
491491
- `QUEUE_NAME`: **_queue**: The suffix for default redis and disk queue name. Individual queues will default to **`name`**`QUEUE_NAME` but can be overridden in the specific `queue.name` section.
492492
- `SET_NAME`: **_unique**: The suffix that will be added to the default redis and disk queue `set` name for unique queues. Individual queues will default to **`name`**`QUEUE_NAME`_`SET_NAME`_ but can be overridden in the specific `queue.name` section.
493493
- `MAX_WORKERS`: **(dynamic)**: Maximum number of worker go-routines for the queue. Default value is "CpuNum/2" clipped to between 1 and 10.
@@ -760,12 +760,11 @@ and
760760

761761
## Cache (`cache`)
762762

763-
- `ENABLED`: **true**: Enable the cache.
764-
- `ADAPTER`: **memory**: Cache engine adapter, either `memory`, `redis`, `redis-cluster`, `twoqueue` or `memcache`. (`twoqueue` represents a size limited LRU cache.)
763+
- `ADAPTER`: **memory**: Cache engine adapter, either `memory`, `redis`, `twoqueue` or `memcache`. (`twoqueue` represents a size limited LRU cache.)
765764
- `INTERVAL`: **60**: Garbage Collection interval (sec), for memory and twoqueue cache only.
766-
- `HOST`: **_empty_**: Connection string for `redis`, `redis-cluster` and `memcache`. For `twoqueue` sets configuration for the queue.
765+
- `HOST`: **_empty_**: Connection string for `redis` and `memcache`. For `twoqueue` sets configuration for the queue.
767766
- Redis: `redis://:[email protected]:6379/0?pool_size=100&idle_timeout=180s`
768-
- Redis-cluster `redis+cluster://:[email protected]:6379/0?pool_size=100&idle_timeout=180s`
767+
- For a Redis cluster: `redis+cluster://:[email protected]:6379/0?pool_size=100&idle_timeout=180s`
769768
- Memcache: `127.0.0.1:9090;127.0.0.1:9091`
770769
- TwoQueue LRU cache: `{"size":50000,"recent_ratio":0.25,"ghost_ratio":0.5}` or `50000` representing the maximum number of objects stored in the cache.
771770
- `ITEM_TTL`: **16h**: Time to keep items in cache if not used, Setting it to -1 disables caching.
@@ -778,7 +777,7 @@ and
778777

779778
## Session (`session`)
780779

781-
- `PROVIDER`: **memory**: Session engine provider \[memory, file, redis, redis-cluster, db, mysql, couchbase, memcache, postgres\]. Setting `db` will reuse the configuration in `[database]`
780+
- `PROVIDER`: **memory**: Session engine provider \[memory, file, redis, db, mysql, couchbase, memcache, postgres\]. Setting `db` will reuse the configuration in `[database]`
782781
- `PROVIDER_CONFIG`: **data/sessions**: For file, the root path; for db, empty (database config will be used); for others, the connection string. Relative paths will be made absolute against _`AppWorkPath`_.
783782
- `COOKIE_SECURE`:**_empty_**: `true` or `false`. Enable this to force using HTTPS for all session access. If not set, it defaults to `true` if the ROOT_URL is an HTTPS URL.
784783
- `COOKIE_NAME`: **i\_like\_gitea**: The name of the cookie used for the session ID.

0 commit comments

Comments
 (0)