Getting Started with Relay and Object Cache Pro

3 min read

Table of Contents

  1. Introduction
  2. Relay and OCP Licensing
  3. Activate Relay and OCP on Your Websites
  4. Staging, Cloning, and Cloneover

Important

This article details the current workflow for installing, activating, and managing Relay and Object Cache Pro licensing. This workflow will change as our integration into the dashboard progresses.

Introduction

Relay is a new powerhouse in the WordPress performance world that allows you to cache your database for ultra-fast dynamic page loading, with the additional benefit of saving server resources with Relay Redis and Object Cache Pro.

Relay

Relay keeps a super-efficient partial replica of Redis data in PHP’s memory, offering a massive boost to WordPress speed. It effortlessly manages millions of requests per second, minimizing Redis communication and saving server resources and bandwidth.

Object Cache Pro (OCP)

Object Cache Pro is the upgrade to the free Redis object cache plugin. When combined with Relay, this is extremely powerful for WooCommerce, LMS sites, BuddyBoss, or any dynamic sites where users are actively logged in/managing the backend.

Installation

This currently needs to be done by connecting to your server via SSH and using GP-CLI. If this is the first time connecting to your server, please see the following guides:

Relay and OCP Licensing

Licensing for Relay and the Object Cache Pro plugin covers usage for 1 website URL and all staging sites across multiple servers.

For example, if your domain is mybusiness.com, your license also covers staging.mybusiness.com, and this site can live on multiple servers and still use the same license on each server.

If you also wanted to use it on a subdomain, for example, shop.mybusiness.com, this would require its own license.

Collecting Your Licenses

If you’re on our Developer Plus plan and/or you’ve purchased Relay and OCP licenses, please submit a support ticket to our team, and we’ll generate and provide you with your licenses.

Activate Relay and OCP on Your Websites

You can activate Relay and Object Cache Pro for your websites via GP-CLI. 

Relay Activation

You will need to contact our support team and let them know which server/s you would like to activate Relay on. They will then install Relay on your server and you can begin activating it on your websites. This, like the GP-CLI below, is temporary until our application integration rolls out (coming very soon).

Enable Command

Connect to your server and run the following command (replacing {site.url}, {ocp.license}, and {relay.license} with the appropriate information):

gp site {site.url} -enable-object-cache {ocp.license} -relay {relay.license}

For example:

gp site yourwebsite.com -enable-object-cache 5Ke3SM5yAcxlAlL4XeoTbswH9 -relay nd3ohEc6JuXocyNkcevOnzgXp

Disable Command

gp site {site.com} -disable-object-cache {ocp.license} -relay {relay.license}

For example:

gp site yourwebsite.com -disable-object-cache 5Ke3SM5yAcxlAlL4XeoTbswH9 -relay nd3ohEc6JuXocyNkcevOnzgXp

Staging, Cloning, and Cloneover

Right now, we have a guard in place that will run a check at the beginning of the staging or cloning process, and if Object Cache Pro is detected at either the source site or destination site. If detected, we will send a notification to your dashboard stating that you might need to take further action via GP-CLI for the destination website in order to continue using Relay and OCP or deactivate it.

Below is a quick breakdown.

Staging and Cloning/Cloneover to the Same URL

  1. A notification will be sent if either the source or destination site has Relay and OCP enabled.
  2. If there’s a mismatch, and you want OCP to be enabled on the destination after the process completes, you must follow up with the activation command detailed above with the appropriate licenses.
  3. Staging and Production sites share the same licenses, as do all sites with the same domain.

Cloning/Cloneover to a New URL

  1. A notification will be sent if either the source or destination site has Relay and OCP enabled.
  2. If you want OCP to be enabled on the destination after the process completes, you must follow up the cloning process with the activation command detailed above with a new license.