The CachePilot beta is open. Join the beta for free

Migrating

How to switch from Redis Object Cache to CachePilot.

CachePilot reads the WP_REDIS_* constants that Redis Object Cache uses, backs up the existing object-cache.php and installs its own drop-in. In our comparison with Redis Object Cache 3.0.0, front-end requests were 10 to 15 % faster.

What stays and what changes

Your Redis server and your constants stay. The drop-in and the tools around it change.

Stays

Your configuration

Nothing in wp-config.php has to change for CachePilot to connect.

  • The Redis server and its password
  • WP_REDIS_HOST, WP_REDIS_PORT and WP_REDIS_DATABASE
  • WP_REDIS_PREFIX, if you set one
  • TLS through WP_REDIS_SCHEME

Constants CachePilot does not know are ignored.

Changes

The drop-in and what runs on top

CachePilot installs its own object-cache.php and starts Autopilot.

  • The old drop-in is backed up as object-cache.php.bak plus a timestamp
  • Autopilot switches on the modules that fit
  • An optional page cache served before WordPress loads
  • An admin with Overview, log and statistics

The keys under the CachePilot prefix are emptied once on install.

Which wp-config constants CachePilot reads

CachePilot uses the constant names of Redis Object Cache. This table lists every one it reads.

wp-config constants read by CachePilot 1.4.2
ConstantWhat CachePilot does with it
Constant: WP_REDIS_HOSTWhat CachePilot does with it: Host name, IP address or socket path of Redis; setup uses it first
Constant: WP_REDIS_PORTWhat CachePilot does with it: TCP port
Constant: WP_REDIS_PASSWORDWhat CachePilot does with it: Password for AUTH
Constant: WP_REDIS_DATABASEWhat CachePilot does with it: Number of the Redis database
Constant: WP_REDIS_PREFIXWhat CachePilot does with it: Prefix in front of every key
Constant: WP_REDIS_TIMEOUTWhat CachePilot does with it: Connect timeout in seconds
Constant: WP_REDIS_SCHEMEWhat CachePilot does with it: tls, ssl, tlsv1.2 or tlsv1.3 switch TLS on
Constant: WP_REDIS_SSL_CONTEXTWhat CachePilot does with it: SSL context options for the TLS connection
Source: CachePilot 1.4.2, src/Core/Config.php

The switch in four steps

01

Keep your constants

Leave the WP_REDIS_* lines in wp-config.php as they are.

02

Deactivate Redis Object Cache

Deactivate and delete the plugin. If its drop-in is still in wp-content, CachePilot backs it up.

03

Install CachePilot

Upload the ZIP from your beta account under Plugins, Add New Plugin, Upload Plugin and activate it.

04

Check the result

Run wp cachepilot test or open CachePilot, Overview. Redis should show as connected.

The switch on a test site

The video shows the four steps on a test installation. It has no sound; the transcript below holds the text of every scene.

Switching a test site from Redis Object Cache to CachePilot 1.4.2. No sound; the transcript below has every scene.
Transcript of the video
  1. wp-config.php with the WP_REDIS_HOST, WP_REDIS_PORT and WP_REDIS_DATABASE constants.
  2. Plugins: Redis Object Cache is deactivated and deleted. It removes its own drop-in.
  3. Plugins: CachePilot is installed and activated.
  4. The file list of wp-content shows the new drop-in object-cache.php.
  5. CachePilot, Autopilot: the drop-in was missing, Autopilot installed it and switched on the modules.
  6. A terminal runs wp cachepilot test and reports that Redis and the object cache work.

Questions about the switch

What to expect when you move from Redis Object Cache.

Do I lose cached data?

The cache starts empty under the CachePilot prefix. WordPress fills it again with the next page views.

Can I go back?

Yes. Deactivate CachePilot and activate Redis Object Cache again. CachePilot removes its keys from Redis on deactivation.

Does CachePilot support Redis Cluster like some other plugins?

No. CachePilot connects to one Redis server. Redis Cluster and Sentinel are not supported.

How was the speed compared?

On a live WooCommerce store with WPML, WCML and Elementor, median server time of 11 rounds without page cache. See the benchmarks.

Do I need the page cache of CachePilot?

No. If you keep another page cache plugin, CachePilot runs the object cache only.

Beta

Switch one site first.

Join the beta, move a staging site and compare the Overview with what you had. Questions go through the feedback form in your account.