humanmade/wp-redis-predis-client

Name: wp-redis-predis-client

Owner: Human Made

Description: An alternative Redis client for use with WP Redis. Enables TLS connections.

Created: 2017-08-16 03:07:39.0

Updated: 2018-02-22 17:40:51.0

Pushed: 2017-10-24 23:25:51.0

Homepage:

Size: 50

Language: PHP

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

WP Redis - Predis Client
An alternative Redis client for use with WP Redis. Enables TLS connections.
Build status Codecov
A Human Made project. Maintained by @nathanielks.

WP Redis - Predis Client

This is a package that enables the use of Predis as a Redis Client as opposed to PHPRedis for WP Redis. Predis has the distinct advantage of connecting to Redis via TLS, encrypting traffic in-transit. Requires WP Redis >= 0.7.0.

Getting Started
Requiring Files
Composer

When using Composer, functions.php file will automatically be loaded whenever you include Composer's autoloader in your project.

Manually Requiring

The only file needing require_onceing for WP Predis to work correctly is functions.php (which is automatically included via vendor/autoload.php, which is generated by Composer). Download this repo somewhere in your project, run composer install, and include vendor/autoload.php somewhere early (such as wp-config.php):

ire_once '/path/to/wp-redis-predis-client/vendor/autoload.php';
Object Cache stub

Now that files have been included, it's recommended you use the included object-cache.php file instead of the one included with WP Redis. It will add the required filters for WP Predis to work and then include WP Redis' object-cache.php file. Once object-cache.php is in wp-content (or whatever content directory you are using), you're good to go!

Configuring Predis

WP Redis - Predis Client adheres to WP Redis' configuration details. Predis also takes an additional argument, ssl, for configuring TLS connections. See PHP's SSL Context options for more details.

al $redis_server;
is_server = array(
'host' => '127.0.0.1',
'port' => 6379,
'ssl'  => array(
    'local_cert' => '/path/to/certificate_and_key.pem',
    'verify_peer' => true,
),


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.