Skip to content

Improve readability and completedness for Redis #9093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skjnldsv merged 7 commits into from
Mar 16, 2023
Merged

Improve readability and completedness for Redis #9093

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2214d47
Improve readability and completedness for Redis
martin-rueegg Jul 15, 2022
b502cc7
Note on Redis for local cache
martin-rueegg Jul 29, 2022
27c42ea
Update admin_manual/configuration_server/caching_configuration.rst
martin-rueegg Sep 2, 2022
d038bab
Update admin_manual/configuration_server/caching_configuration.rst
martin-rueegg Sep 2, 2022
5372491
Incorporating review feedback
martin-rueegg Sep 2, 2022
11d84a4
Incorporating note from #9125
martin-rueegg Sep 2, 2022
be1014c
Remove extra line
martin-rueegg Sep 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 117 additions & 38 deletions admin_manual/configuration_server/caching_configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,32 +87,120 @@ You can verify that the Redis daemon is running with ``ps ax``::
22203 ? Ssl 0:00 /usr/bin/redis-server 127.0.0.1:6379

Restart your Web server, add the appropriate entries to your ``config.php``, and
refresh your Nextcloud admin page. This example ``config.php`` configuration uses
Redis for the distributed server cache::
refresh your Nextcloud admin page.

'memcache.distributed' => '\OC\Memcache\Redis',
'redis' => [
'host' => 'redis-host.example.com',
'port' => 6379,
],
Redis configuration in Nextcloud (config.php)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For best performance, use Redis for file locking by adding this::

'memcache.locking' => '\OC\Memcache\Redis',

Further more, you can use Redis for the distributed server cache::

'memcache.distributed' => '\OC\Memcache\Redis',
Comment thread
martin-rueegg marked this conversation as resolved.
Comment thread
martin-rueegg marked this conversation as resolved.
Outdated

Additionally, you can use Redis for the local cache like so::

'memcache.local' => '\OC\Memcache\Redis',
Comment thread
martin-rueegg marked this conversation as resolved.
Outdated

When using Redis for any of the above cache settings, you also need to
specify either the ``redis`` or ``redis.cluster`` configuration in ``config.php``.

The following options are available to configure when using a single redis server (all but ``host`` and ``port`` are optional. For the latter two see next sections)::

'memcache.locking' => '\OC\Memcache\Redis',
'memcache.distributed' => '\OC\Memcache\Redis',
'memcache.local' =>'\OC\Memcache\Redis' ,
'redis' => [
// 'host' => see connection parameters below
// 'port' => see connection parameters below
'user' => 'nextcloud',
'password' => 'password',
'dbindex' => 0,
'timeout' => 1.5,
'read_timeout' => 1.5,
]

The following options are available to configure when using a redis cluster (all but ``seeds`` are optional)::

'memcache.locking' => '\OC\Memcache\Redis',
'memcache.distributed' => '\OC\Memcache\Redis',
'memcache.local' =>'\OC\Memcache\Redis' ,
'redis.cluster' => [
'seeds' => [ // provide some/all of the cluster servers to bootstrap discovery, port required
'cache-cluster:7000',
'cache-cluster:7001',
'cache-cluster:7002',
'cache-cluster:7003',
'cache-cluster:7004',
'cache-cluster:7005'
],
'failover_mode' => \RedisCluster::FAILOVER_ERROR
'timeout' => 0.0,
'read_timeout' => 0.0,
'user' => 'nextcloud',
'password' => 'password',
'dbindex' => 0,
]


Connecting to Single Redis Server over TCP
Comment thread
martin-rueegg marked this conversation as resolved.
Outdated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To connect to a remote or local Redis server over TCP use::

'redis' => [
'host' => 'redis-host.example.com',
'port' => 6379,
],


Connecting to single Redis server over TLS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To connect via TCP over TLS, add the following configuration::

'redis' => [
'host' => 'tls://127.0.0.1',
'port' => 6379,
'ssl_context' => [
'local_cert' => '/certs/redis.crt',
'local_pk' => '/certs/redis.key',
'cafile' => '/certs/ca.crt',
'verify_peer_name' => false
]
]


Connecting to Redis cluster over TLS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To connect via TCP over TLS, add the following configuration::

'redis.cluster' => [
'seeds' => [ // provide some/all of the cluster servers to bootstrap discovery, port required
'cache-cluster:7000',
'cache-cluster:7001',
],
'ssl_context' => [
'local_cert' => '/certs/redis.crt',
'local_pk' => '/certs/redis.key',
'cafile' => '/certs/ca.crt',
'verify_peer_name' => false
]
]


Connecting to single Redis server over UNIX socket
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you want to connect to Redis configured to listen on an Unix socket (which is
recommended if Redis is running on the same system as Nextcloud) use this example
``config.php`` configuration::

'memcache.local' => '\OC\Memcache\APCu',
'memcache.distributed' => '\OC\Memcache\Redis',
'redis' => [
'host' => '/run/redis/redis-server.sock',
'port' => 0,
'dbindex' => 0,
'password' => 'secret',
'timeout' => 1.5,
],
'redis' => [
'host' => '/run/redis/redis-server.sock',
'port' => 0,
],

Only "host" and "port" variables are required, the other ones are optional.

Expand All @@ -131,15 +219,19 @@ You might need to restart apache for the changes to take effect::
Redis is very configurable; consult `the Redis documentation
<http://redis.io/documentation>`_ to learn more.

**Using the Redis session handler:** If you are using Redis for locking and/or caching,

Using the Redis session handler
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you are using Redis for locking and/or caching,
you may also wish to use Redis for session management. Redis can be used for centralized
session management across multiple Nextcloud application servers, unlike the standard
`files` handler. If you use the Redis handler, though, you *MUST* ensure that session
locking is enabled. As of this writing, the Redis session handler does *NOT* enable
session locking by default, which can lead to session corruption in some Nextcloud apps
that make heavy use of session writes such as Talk. In addition, even when session locking
is enabled, if the application fails to acquire a lock, the Redis session handler does not
currently return an error. Adding the following settings in your `php.ini` file will
currently return an error. Adding the following settings in your ``php.ini`` file will
prevent session corruption when using Redis as your session handler: ::

redis.session.locking_enabled=1
Expand All @@ -149,23 +241,6 @@ prevent session corruption when using Redis as your session handler: ::
More information on configuration of phpredis session handler can be found on the
`PhpRedis GitHub page <https://github.com/phpredis/phpredis>`_

**Connecting to Redis over TLS:** ::

'memcache.locking' => '\OC\Memcache\Redis',
'memcache.distributed' => '\OC\Memcache\Redis',
'memcache.local' =>'\OC\Memcache\Redis' ,
'redis' => [
'host' => 'tls://127.0.0.1',
'port' => 6379,
'user' => 'nextcloud',
'password' => 'password',
'ssl_context' => [
'local_cert' => '/certs/redis.crt',
'local_pk' => '/certs/redis.key',
'cafile' => '/certs/ca.crt',
'verify_peer_name' => false
]
]

Memcached
---------
Expand Down Expand Up @@ -196,9 +271,13 @@ You can verify that the Memcached daemon is running with ``ps ax``::
127.0.0.1

Restart your Web server, add the appropriate entries to your
``config.php``, and refresh your Nextcloud admin page. This example uses APCu
for the local cache, Memcached as the distributed memcache, and lists all the
servers in the shared cache pool with their port numbers::
``config.php``, and refresh your Nextcloud admin page.

Memcached configuration in Nextcloud (config.php)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This example uses APCu for the local cache, Memcached as the distributed memcache,
and lists all the servers in the shared cache pool with their port numbers::

'memcache.local' => '\OC\Memcache\APCu',
'memcache.distributed' => '\OC\Memcache\Memcached',
Expand Down