Skip to content

Commit cfeaa88

Browse files
committed
chore(administration): Generate system config documentation from config.sample.php
1 parent 6eae4a1 commit cfeaa88

1 file changed

Lines changed: 94 additions & 0 deletions

File tree

admin_manual/configuration_server/config_sample_php_parameters.rst

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2809,6 +2809,96 @@ Cache Key Prefix for Redis or Memcached
28092809

28102810
Defaults to ``''`` (empty string)
28112811

2812+
memcache.kvstore
2813+
^^^^^^^^^^^^^^^^
2814+
2815+
2816+
::
2817+
2818+
'memcache.kvstore' => [
2819+
2820+
Connection details for the Key-Value store used for in-memory caching,
2821+
for example when using Valkey or Redis.
2822+
2823+
This is the brand-independent successor of the ``redis`` and
2824+
``redis.cluster`` options below and supports the latest Valkey and Redis
2825+
releases. Three topologies are supported:
2826+
a single server, a Sentinel managed replication set, and a
2827+
server cluster. Configure exactly one of ``server``, ``sentinel`` or
2828+
``seeds``.
2829+
2830+
For enhanced security, it is recommended to configure ACLs in
2831+
the cache server and configure the ``user`` and ``password`` (or a TLS
2832+
client certificate). Alternatively, you can also configure the cache
2833+
server to just use a ``password``.
2834+
See https://valkey.io/topics/security/ for more information when using Valkey.
2835+
2836+
server
2837+
^^^^^^
2838+
2839+
2840+
::
2841+
2842+
'server' => [
2843+
'host' => 'localhost', // can also be a Unix domain socket: '/tmp/cache.sock'
2844+
'port' => 6379, // ignored for Unix domain sockets
2845+
// Protocol used to connect. One of 'tcp', 'tls' or 'unix'.
2846+
// When omitted it is derived from the host (a leading '/' means 'unix').
2847+
'protocol' => 'tcp',
2848+
],
2849+
2850+
Single server setup.
2851+
2852+
Also used as the connection template for the ``sentinel`` managed
2853+
primary / replica connections.
2854+
2855+
Sentinel managed replication setup.
2856+
-----------------------------------
2857+
2858+
Provide the name of the monitored service and one entry per Sentinel
2859+
node. Each seed uses the same format as the ``server`` entry above.
2860+
Uncomment to enable and remove the ``server`` / ``seeds`` entries.
2861+
2862+
2863+
user
2864+
^^^^
2865+
2866+
2867+
::
2868+
2869+
//'seeds' => [
2870+
// ['host' => 'localhost', 'port' => 7000],
2871+
// ['host' => 'localhost', 'port' => 7001],
2872+
//],
2873+
2874+
// Optional: username, only sent when the cache server uses ACLs.
2875+
'user' => '',
2876+
// Optional: if not defined, no password will be used.
2877+
'password' => '',
2878+
// Optional: select a numbered database. Only supported for single
2879+
// servers and Sentinel setups, clusters always use database 0.
2880+
'dbindex' => 0,
2881+
// Optional: connection timeout in seconds (float). 0 means no timeout.
2882+
'timeout' => 0.0,
2883+
// Optional: read/write timeout in seconds (float). 0 means no timeout.
2884+
'read_timeout' => 0.0,
2885+
// Optional: keep the connection open across requests. Defaults to false.
2886+
'persistent' => false,
2887+
// Optional: when the 'tls' protocol is used, provide the SSL context.
2888+
// SSL context options, see https://www.php.net/manual/en/context.ssl.php
2889+
//'ssl_context' => [
2890+
// 'local_cert' => '/certs/cache.crt',
2891+
// 'local_pk' => '/certs/cache.key',
2892+
// 'cafile' => '/certs/ca.crt',
2893+
//],
2894+
],
2895+
2896+
Cluster setup.
2897+
2898+
Provide some or all of the cluster nodes to bootstrap discovery.
2899+
Each seed uses the same format as the ``server`` entry above.
2900+
Uncomment to enable and remove the ``server`` / ``sentinel`` entries.
2901+
28122902
redis
28132903
^^^^^
28142904

@@ -2841,6 +2931,8 @@ for more information.
28412931
We also support Redis SSL/TLS encryption as of version 6.
28422932
See https://redis.io/topics/encryption for more information.
28432933

2934+
.. deprecated:: 34.0.0 use `memcache.kvstore` instead which supports also Valkey.
2935+
28442936
redis.cluster
28452937
^^^^^^^^^^^^^
28462938

@@ -2891,6 +2983,8 @@ See https://redis.io/topics/cluster-spec for details about the Redis cluster
28912983
Authentication works with phpredis version 4.2.1+. See
28922984
https://github.com/phpredis/phpredis/commit/c5994f2a42b8a348af92d3acb4edff1328ad8ce1
28932985

2986+
.. deprecated:: 34.0.0 use `memcache.kvstore` instead which supports also Valkey.
2987+
28942988
memcached_servers
28952989
^^^^^^^^^^^^^^^^^
28962990

0 commit comments

Comments
 (0)