README.PhpRedis.txt in Redis 7

PhpRedis cache backend
======================

This client, for now, is only able to use the PhpRedis extension.

This code is ALPHA code. This means: DO NOT USE IT IN PRODUCTION. Not until
I don't ship any BETA release as a full Drupal.org module.

Get PhpRedis
------------

You can download this library at:

  https://github.com/nicolasff/phpredis

This is PHP extension, too recent for being packaged in most distribution, you
will probably need to compile it yourself.

Tell Drupal to use the cache backend
------------------------------------

Usual cache backend configuration, as follows, to add into your settings.php
file like any other backend:

  $conf['cache_backends'][]            = 'sites/all/modules/redis/phpredis.cache..inc';
  $conf['cache_class_cache']           = 'Redis_Cache_PhpRedis';
  $conf['cache_class_cache_menu']      = 'Redis_Cache_PhpRedis';
  $conf['cache_class_cache_bootstrap'] = 'Redis_Cache_PhpRedis';
  // ... Any other bins.

Default behavior is to connect via tcp://localhost:6379 but you might want to
connect differently.

Tell Drupal to use the lock backend
-----------------------------------

Usual lock backend override, update you settings.php file as this:

  $conf['lock_inc'] = 'sites/all/modules/custom/redis/phpredis.lock.inc';

Connect via UNIX socket
-----------------------

Just add this line to your settings.php file:

  $conf['redis_cache_socket'] = '/tmp/redis.sock';

Don't forget to change the path depending on you operating system.

Connect to a remote host and database
-------------------------------------

See README.txt file.

For this particular implementation, host settings are overridden by the
UNIX socket parameter. Database setting of course is not.