Difference between revisions of "Redis cache store"

Jump to: navigation, search
m
m
 
Line 23: Line 23:
  
 
==Configuring Redis in Moodle==
 
==Configuring Redis in Moodle==
* Navigate to Site admin > Plugins > Caching > Configuration
+
* Navigate to Site admin > Plugins > Caching > Configuration.
* When installed, Moodle you should see a tick next to its name and the link to add an instance.
+
* When installed, you should see a tick next to "Redis" under "Installed cache stores" and a link to add an instance.
 
[[File:Redis_cache_ready.png]]
 
[[File:Redis_cache_ready.png]]
* Click Add instance.
+
* Click "Add instance".
** Give it a name, like "Redis1" and set the IP:port for the Redis server. If it is on the same machine with the default port, this would be 127.0.0.1:6379.  
+
** Give your Redis instance a name, like "Redis1" and set the IP:port for the Redis server. If it is on the same machine, the default would be 127.0.0.1:6379.  
** The new instance should appear under Configured store instances with a Ready tick.
+
** The new instance should appear under "Configured store instances" with a "Ready" tick.
* Under Stores used when no mapping is present, click Edit mappings. Set Redis1 (or the name used earlier) for the Application and Session caches.
+
* Under "Stores used when no mapping is present" click '''Edit mappings". Set "Redis1" (or the name used earlier) for the "Application" and "Session" caches.
 
[[File:Set_Redis_as_default_Application_and_Session_cache.png]]
 
[[File:Set_Redis_as_default_Application_and_Session_cache.png]]
 
* After saving this, you should see Redis as the cache for most cache stores.
 
* After saving this, you should see Redis as the cache for most cache stores.
 
  
 
==See also==
 
==See also==

Latest revision as of 19:16, 16 November 2019

The Redis cache store is one of the best options to handle session and application cache as it supports: data guarantee, locking, key awareness. (and also can be used for user's sessions caching in the config.php file)

Before Redis is available as a cache store, you will need to install Redis service (daemon) on your Moodle server, locally in case of a single Moodle app node architecture or externally if you are using a cluster of Moodle nodes. only then, you can configure Redis as an application or session level cache store.

If you are configuring a cluster of Moodle servers/nodes, the Redis service (daemon) should be installed on an external server and all Moodle nodes (servers/instances) should point to that external Redis. So all user's data is available when the user is using (connected to) any of the Moodle nodes. An external Redis (NoSQL) service can be installed on the main SQL server alongside the MySQL/MariaDB service, just make sure you have enough memory allocated on that server for both services.

A good practice is to give the Redis cache store prefix a proper short name and not leave it empty, as later on, it might conflict with user's session Redis cache you might choose to use, or other Moodle instances that will be installed on the same server. for example "my-school-name_cs_", where you replace "my-school-name" with your short school name. (and if you are also using a user's session store on the config.php file, you might like to prefix it with "my-school-name_us_")

When using a cluster setup with several Moodle instances on each node that belong to different Schools/Institutes/clients, make sure that you use the same Prefix for all Moodle instances that are on different nodes and are of the same School/Institute/Client.

Installing Redis server

Installing Redis php driver

  • For CentOS, you can use either Remi or IUS repositories, and install the php71u-pecl-redis driver.
  • Redis php-fpm 7 driver on Ubuntu 14.04
  • Windows PHP extensions including DLLs for Windows. Check your PHP version, CPU (64bit or x86) and thread-safe value (see Site Admin > Server > PHP Info) to get the right version; add DLL file to ext directory, add 'extension=php_redis.dll' entry to php.ini and restart your web server.

Configuring Redis in Moodle

  • Navigate to Site admin > Plugins > Caching > Configuration.
  • When installed, you should see a tick next to "Redis" under "Installed cache stores" and a link to add an instance.

Redis cache ready.png

  • Click "Add instance".
    • Give your Redis instance a name, like "Redis1" and set the IP:port for the Redis server. If it is on the same machine, the default would be 127.0.0.1:6379.
    • The new instance should appear under "Configured store instances" with a "Ready" tick.
  • Under "Stores used when no mapping is present" click Edit mappings". Set "Redis1" (or the name used earlier) for the "Application" and "Session" caches.

Set Redis as default Application and Session cache.png

  • After saving this, you should see Redis as the cache for most cache stores.

See also