Advanced Kirby Redis Cache-Driver

Advanced Redis cache-driver for Kirby CMS with in-memory store, transactions and preloading

Installation

• unzip master.zip as folder site/plugins/kirby3-redis-cachedriver or
• git submodule add https://github.com/bnomei/kirby3-redis-cachedriver.git site/plugins/kirby3-redis-cachedriver or
• composer require bnomei/kirby3-redis-cachedriver

Why Redis?

Memcached and APCu have more restrictive defaults. Redis does not have these limitations and is by very fast with proper configuration.

Defaults for	Memcached	APCu	Redis
max memory size	64MB	32MB	0 (none)
size of key/value pair	1MB	4MB	512MB

Tip

From my experience Memcached is very slow compared to APCu or Redis. Just do not use it.

Setup Cache

Set your Kirby Cache-Driver to adredis for Plugin caches or in your site/config/config.php. All Redis-related params can be callbacks. You might even load values from an .env File.

site/config/config.php

return [
    'bnomei.turbo.cache.content' => [
        'type' => 'adredis',
        'host' => function() { return env('REDIS_HOST'); },
        'port' => function() { return env('REDIS_PORT'); },
        // 'database' => function() { return env('REDIS_DATABASE'); },
        // 'password' => function() { return env('REDIS_PASSWORD'); },
    ],
];

Note

Why adredis? Because Kirby v5 ships with a built-in cache-driver for redis aptly named redis. The one from this plugin add in-memory store, transactions and preloading.

(optional) Setup Cache for Content Files

Combine this plugin with Kirby Turbo to set up a cache for content files.

How to use Redis Cache Driver with Kirby or other plugins

You must set the cache drivers for the desired cache (or sub-cache) to type of adredis, with additional options if needed.

site/config/config.php

<?php
return [
    'otherVendor.pluginName.cache' => ['type' => 'adredis', /*...*/],
    
    // like
    'bnomei.fingerprint.cache' => ['type' => 'adredis', /*...*/],
    'bnomei.lapse.cache' => ['type' => 'adredis', /*...*/],
    'bnomei.turbo.cache.cmd' => ['type' => 'adredis', /*...*/],
    'bnomei.turbo.cache.model' => ['type' => 'adredis', /*...*/],
    
    // (optional) use a fast cache for Kirby's uuids
    'cache' => [
        'uuid' => ['type' => 'adredis', /*...*/],
    ],
    
    //... other options
];

Usage

Cache methods

$redis = \Bnomei\Redis::singleton();
$redis->set('key', 'value', $expireInMinutes);
$value = $redis->get('key', $default);
$redis->remove('key');
$redis->flushstore(); // data in memory
$redis->flush(); // memory and prefixed values
$redis->flushdb(); // DANGER: flushes full redis db!!!

Warning

When Kirby's global debug config is set to true no caches will be read and on init the cache will be flushed everytime, but entries will be created.

Predis Client

$redis = new \Bnomei\Redis($options, $optionsClient);
$client = $redis->redisClient();
$dbsize = $client->dbsize(); // https://bit.ly/2Z8YKyN

Benchmark

$redis = new \Bnomei\Redis($options, $optionsClient);
$redis->benchmark(1000);

redis : 0.29747581481934
file : 0.24331998825073

Note

The benchmark will create and remove a lot of cache files and entries on redis

Settings

bnomei.redis-cachedriver.	Default	Description
store	true	keep accessed cache items stored in PHP memory for faster recurring access
store-ignore	``	if key contains that string then ignore
preload	true	bool
host	127.0.0.1
port	6379

Dependencies

• nrk/predis

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.