WordPress Cache Management¶

WHM Plugin - LiteSpeed Cache For WordPress Management¶

This page covers the various cache management options available through our WHM plugin's GUI interface. Most of these options are also available through the command line as the root user using our lscmctl CLI script.

The LiteSpeed WHM plugin contains a section for managing LiteSpeed Cache for WordPress. This guide will lead you through the different operations and management actions you can take when using our plugin.

If you do not see the LiteSpeed Cache For WordPress Management section on your LiteSpeed WHM plugin screen, please upgrade LiteSpeed Web Server to v5.1.x at the minimum.

You must have a license with LSCache enabled to use these features. See How To Get LSCache.

Cache Root Setup¶

Equivalent CLI commands: setcacheroot

Example: ./lscmctl setcacheroot [Go to CLI section]

Click WHM Plugin > LiteSpeed Configuration > Cache Root Setup

This screen searches for Server level cache root definitions in either the /usr/local/apache/conf/includes/pre_main_global.conf file or in the LiteSpeed Web Server Web Admin under Server > Cache > Cache Storage Settings > Storage Path setting.

If it is defined in pre_main_global.conf it should look something like this:

<IfModule LiteSpeed>
CacheRoot /home/lscache/
</IfModule>

Where /home/lscache/ is the CacheRoot path. In this case, the Server level cache root will be set to /home/lscache/

This screen searches for VHost level cache root definitions in the /usr/local/apache/conf/userdata/lscache_vhosts.conf file.

If it is defined in lscache_vhosts.conf it should look something like this:

<IfModule LiteSpeed>
CacheRoot lscache
</IfModule>

Where lscache is the CacheRoot path. In this case, the VHost level cache root will be set to /home/<user_folder>/lscache

The Set Missing Cache Roots button sets Server level and VHost level Cache Root definitions if they are detected as not set.

Getting Started¶

From the initial plugin screen you should be presented with 5 different options under the LiteSpeed Cache For WordPress Management section.

• Manage Cache Installations allows you to manage LiteSpeed Cache for WordPress on your individual WordPress installations.
• Mass Enable Cache & Mass Disable Cache can be used to enable/disable the LiteSpeed Cache Plugin for WordPress on all discovered WordPress installations which are not flagged (more on flags later).
• Version Manager displays the currently active LSCache for WordPress version (more on the Active Version later). It also allows you to adjust this active LSCache for WordPress version and to upgrade and downgrade LSCache for WordPress installations based on their current version.
• WordPress Dash Notifier is used to recommend a plugin or broadcast a message to all discovered WordPress installations using the Dash Notifier plugin for WordPress.
• QUIC.cloud IPs is an informational page listing IPs used by the QUIC.cloud service. These IPs should be whitelisted in your server's firewall if you plan to use QUIC.cloud services.
• Cache Redis for Users installs and activates Redis for each user you wish to configure object cache for. This only operates in environments where you have a sandboxed (caged) system like CloudLinux or LiteSpeed Containers. Each user's cached data is independent, guaranteeing speed and security.

Manage Cache Installations¶

Equivalent CLI commands: scan, scannew, enable, disable, flag, unflag, status

Example: ./lscmctl scannew [Go to CLI section]

The manage view is where most of the magic happens. Here you can manage the LiteSpeed Cache Plugin for WordPress for your WordPress installations individually or in small groups. (There is nothing wrong with big groups, but that is what Mass Enable Cache and Mass Disable Cache are for)

The first time, a user may see only a Scan button available

After a scan and cache is enabled, it will look like this

Starting from the actual table we have the following fields:

• Discovered WordPress Installations - This field will contain the path of each WordPress installation discovered during the last scan operation.

• Actions - This field contains action buttons that perform a specific action only for the related WordPress installation. These actions include Enable/Disable the LiteSpeed Cache Plugin for WordPress, and Refresh Status which updates the current status of LiteSpeed Cache for WordPress for this installation only.

• Cache Status - Displays the last known status of LiteSpeed Cache for WordPress for the listed WordPress installation.

• Flag - Click to set Flag/Unflag. This field can either be blank or display a flag icon. While an installation is flagged, displaying the flag icon, it will be excluded from all future Mass Enable/Disable operations.

Looking at the top row of buttons, we have Scan/Re-scan, Discover New, and Refresh Status.

• Scan/Re-scan - Discovers all WordPress installations under each cPanel users public_html folder. These discovered installations will then be saved to a data file and displayed in the manager screen. If this data file is removed or corrupted, simply scan again to repopulate the list.

• Discover New - Discovers all WordPress installations belonging to users not already listed in the Discovered WordPress Installations section. This will NOT discover new WordPress installations for existing users. For these cases, Scan/ Rescan should be used instead.

• Refresh Status - Each listed WordPress installation will have a Cache Status of either Enabled or Disabled reflecting the status of the LiteSpeed Cache Plugin for WordPress for that installation. The Refresh Status button will update this value to the most current status for all listed WordPress installations.

Moving on we have the the bottom row of buttons which are used to perform group operations. These buttons work in tandem with the check-boxes found next to each discovered installation to allow you to perform some basic operations for only the selected group.

• Enable Selected & Disable Selected - These buttons allow you to enable and disable the LiteSpeed Cache Plugin for WordPress for the selected WordPress installations.

• Flag Selected & Unflag Selected - These buttons allow you to set or unset the flag field for the selected WordPress Installation. Flagged installations will be excluded from Mass Enable Cache and Mass Disable Cache operations.

• LiteSpeed Cache Plugin Version - This label shows the currently active version of the LSCache Plugin for WordPress. Clicking the version number listed here will take you to the Version Manager screen.

Mass Enable Cache & Mass Disable Cache¶

Equivalent CLI commands: enable, disable

Example: ./lscmctl enable -m [Go to CLI section]

Both of these selections behave in a very similar way by allowing you to enable/disable the LiteSpeed Cache Plugin for WordPress en masse.

When Mass Enabling/Disabling the LiteSpeed Cache Plugin for WordPress, all WordPress installations that are not currently flagged in the Manage screen will have the LiteSpeed Cache Plugin for WordPress installed/removed. If a WordPress installation is detected as manually disabled, the WHM plugin will flag it and skip it. During this operation, you should see the following output screen.

After this operation is complete you will get a short summary message letting you know how many installations had LiteSpeed Cache for WordPress enabled/disabled successfully and how many failed, as well as how many flagged installations were detected and skipped over. You will also be provided with both an error log and a success log shown under these results listing the installations that were enabled and those that failed along with the related error messages.

Version Manager¶

Equivalent CLI commands: setversion, upgrade

Example: ./lscmctl setversion --latest [Go to CLI section]

• Set Active Version - Allows you to change the Active Version of the LiteSpeed Cache Plugin for WordPress. The Active Version is the LSCache for WordPress version that is used when the WHM plugin enables or mass enables caching for WordPress installations.

• Force Version Change For All Existing Installations - Allows you to change the version of existing LiteSpeed Cache Plugin for WordPress installations, allowing you to select which to change based on current cache version.

WordPress Dash Notifier¶

Equivalent CLI commands: dashnotify, dashnotifyremove

Example: ./lscmctl dashnotify -m -plugin litespeed-cache -msgfile /path/to/msg/file [Go to CLI section]

The WordPress Dash Notifier feature is used to recommend a WordPress plugin or broadcast an informational message to all discovered WordPress installations. These messages will appear in the WordPress Dashboard of each site.

This tool is especially useful for hosting providers who wish to suggest the LiteSpeed Cache Plugin for WordPress to their clients, rather than installing it directly for them via Mass Enable.

Recommend A Plugin¶

Plugin Slug - The unique slug of a valid WordPress plugin. A download/activate button for this plugin will be included in the displayed notification message.

A plugin's slug can be found by going to the plugin's page in the WordPress Plugin Directory and taking the last part of the URL. An entered slug can be verified by clicking the Verify button.

WordPress Dashboard Message - A message displayed when recommending a plugin. Simple text and HTML are supported.

Stored Messages - Saved messages (including Plugin Slug) that can be loaded or deleted. "default" message cannot be deleted.

Save As - Save the current WordPress Dashboard Message and Plugin Slug using a unique ID (a-zA-Z0-9_-).

Testing / Preview - This option allows you to Deploy / Notify a plugin recommendation or Remove a notification from a single WordPress installation by providing it's path. As the name implies, this is useful for testing how messages will be displayed before notifying en mass.

Mass Deploy / Notify - Recommend a plugin to all discovered WordPress installations. This will install the Dash Notifier plugin for WordPress on all discovered installations and display the recommendation message in their WordPress Dashboard.

Mass Remove - Remove plugin recommendation message (and Dash Notifier plugin) from all discovered WordPress installations.

End Result¶

1. User does not have the plugin ('litespeed-cache') installed:

2. User has plugin ('litespeed-cache') installed, but deactivated:

3. User has 'litespeed-cache' plugin installed and active

   No message will be displayed

Broadcast A Message¶

WordPress Dashboard Message - A message displayed when recommending a plugin. Simple text and HTML are supported.

Stored Messages - Saved messages that can be loaded or deleted.

Save As - Save the current WordPress Dashboard Message using a unique ID (a-zA-Z0-9_-).

Testing / Preview - This option allows you to Deploy / Notify a notification message or Remove a notification from a single WordPress installation by providing it's path. As the name implies, this is useful for testing how messages will be displayed before notifying en mass.

Mass Deploy / Notify - Broadcast a notification message to all discovered WordPress installations. This will install the Dash Notifier plugin for WordPress on all discovered installations and display the notification message in their WordPress Dashboard.

Mass Remove - Remove notification message (and Dash Notifier plugin) from all discovered WordPress installations.

End Result¶

Other Info¶

• WordPress users who click the Dismiss button will not be re-notified if the provided dashboard message (and plugin slug when recommending a plugin) match those of the dismissed message.

• WordPress users who click the Never Notify Me Again button will have the Dash Notifier plugin uninstalled and a .dash_notifier_bypass file created in their installation's root directory. These users will not be notified of any further messages while this file exists.

QUIC.cloud IPs¶

This is an informational page that lists out IPs used when communicating with QUIC.cloud through the LiteSpeed Cache for WordPress plugin (Image Optimization, API calls, etc). The listed IPs are updated in real time and should be whitelisted to avoid issues when using these services.

Cache Redis for Users¶

This page lists all of the users on your system. As stated on the screen, this facility is for caged environments like CloudLinux or LiteSpeed Containers.

• CloudLinux: Turning on a caged environment is described in the CloudLinux documentation and here
• LiteSpeed Containers: Turning on LiteSpeed Containers is described in Namespace Containers

When enabled, it installs a Redis Service requiring some memory and disk space for each user in their home directory and works in conjunction with configuration in LiteSpeed Cache.

Each row contains 2 columns of icons. The first column is for full enable and disable of the Redis service for the user:

• To install a Redis service for a particular user press the enable icon on the line for that user:
• Once you have installed the Redis Service you will see the screen refreshed and the icon for that user will appear disabled. This icon is also used for services which are set up and where the service is currently disabled.
• To remove the Redis service for a particular user press the disable icon on the line for that user:

The second column is for finer management of the service definition:

• To set up the service so that a user in cPanel or an administrator later can enable it press the set up icon: .
• To disable the service for a running user, but leave the service so it can be enabled by the cPanel user, press the disable service icon: . If using the default service defintion this may be in the first column.
• To remove the setup so that the user in cPanel can no longer start the service, press the remove setup icon: .

Service MB: Each user gets their own instance of Redis and you can specify the size of the instance. The size is in MB and can be any value from 1 to 1024 with a default of 64. A cPanel user can use the Plugin to enable or disable the service, but you must specify a default or it must be enabled here first and the size specified here is the size used. To change the size, you must disable the service, specify the size and reenable it.

The buttons under the table will change based on boxes checked and the state of the Redis service for each user. When you check a box, only those users with exactly the same state can be checked as well.

• Disable: The same as pressing the disable icon for each user checked.
• Enable: The same as pressing the enable icon for each user checked without a setup.
• Disable Service: The same as pressing the disable service icon for each user checked.
• Set up: The same as pressing the set up icon for each user checked.
• Remove Setup: The same as pressing the remove setup icon for each user checked.
• Enable Service: The same as pressing the enable icon for each user checked who is setup but who's service is disabled.
• Flush All Users: Sends a Redis flushall command to all active Redis services to clear the cache.
• Flush: Sends a Redis flushall command to all active Redis service users checked.

Enable default. Size (MB): If you wish to allow users to enable their own services in cPanel, you can specify a size here and then press the Set Default button. If there are existing services you can change the size of the definitions and press the Set Default button which will cause the services to be restarted. Once a default is specified you or the users can enable or disable individual users Redis services. Once you have a default enabled, you can press the Remove Default button, which will remove the default definition and disable all of the services.

Optional Redis Config File: Specify a file containing Redis configuration parameters. We recommend that this file be named /usr/local/lsws/lsns/conf/redis.conf. The contents are usually as simple as:

maxmemory-policy allkeys-lru

How it works¶

The Redis service is created specific to that user and with a socket within the user's home directory. For CloudLinux the socket is in $HOME/.cagefs/tmp/redis.sock and for LiteSpeed Containers it is in $HOME/.lsns/tmp/redis.sock. As caged environments these directories are mounted to /tmp for the user resulting in a consistent socket name of /tmp/redis.sock for all users.

For LiteSpeed Containers the Troubleshooting section describes steps to help you enter and otherwise diagnose issues with caging. For CloudLinux there are many tools to help you identify caging issues.

Configuring Cache to Use Redis¶

To use the Redis feature, you must configure it within the LiteSpeed WordPress Cache admin panel within cPanel > Tools > WP Toolkit > WordPress > Plugins > Manage in WordPress > LiteSpeed Cache > Cache > Object:

• Object Cache On. There is a Status block which must say Redis Extension: *Enabled*. If it says *Disabled* you must install the Redis Extension within WHM > Software > Module Installers > PHP Pecl Manage > Select your version of PHP > Search for and Install Redis and reenter cPanel.
• Method: Redis
• Host: /tmp/redis.sock
• Port: 0

Press the Save Changes button. More details configuring LiteSpeed WP Cache are described here.

Testing Caching¶

To test your domains, you should see X-LiteSpeed-Cache: hit in the response header. Check here for detailed verification steps.

If X-LiteSpeed-Cache: hit cannot be seen, you may need to do more troubleshooting. For example: check if the LSCache feature has been enabled in your license, if other cache plugins have been disabled, or if cache root and cache policy have been set, etc.

Command-Line Interface - LiteSpeed Cache For WordPress Management¶

This section covers the various cache management options available through our lsmctl cli script. Most of these options are also available through our WHM plugin for cPanel.

As of LiteSpeed Enterprise 5.1.14, a command-line interface script was added under /usr/local/lsws/admin/misc/lscmctl for executing basic cache management actions through the terminal or in a cron job. As of versions 1.4 of the script, the ability to recommend a plugin or broadcast a message to all discovered WordPress installations is also available. The help page for this script is included below.

Learn more about the CLI script on our blog.

Supported Control Panel Environments: cPanel/WHM and Plesk

LiteSpeed Cache Manager CLI Tool v1.12


Usage: ./lscmctl [-php path/to/php] command [flag/parameter]


Possible Commands:

setcacheroot [-svr <cache root>] [-vh <cache root>]
    List/Set server and/or virtual host cache roots. This command will list the
current server and virtual host cache roots when no additional input is given.
Use -svr and -vh to set those cache roots. The '$' character is not allowed
when setting virtual host cache root. Virtual host cache root values starting
with a '/' will automatically have '/$vh_user' appended to the end (this format
was chosen to maintain compatibility with CageFS).

setversion [{--list | --latest | <version>}]
    List/Set active LSCWP version. This command will list the currently active
version when no additional input is given. Use --list to show available
versions or --latest to switch to the latest available version. A valid version
number can also be provided to switch to that version specifically. This must
be set before performing other lscmctl operations.

scan [-n] [-e]
    Scan for all WordPress installations. This command will create an lscm.data
file under the "lsws/admin/lscdata" directory. Add the -n flag to only discover
new installations. By adding the -e flag, LSCWP will be enabled on all known
installations after scanning is complete.

scannew [-en]
    Scan for WordPress installations not already discovered in a previous scan.
This command will create an lscm.data file under the "lsws/admin/lscdata"
directory. By adding the -en flag, LSCWP will be enabled only on newly
discovered installations after scanning is complete. If you would rather enable
LSCWP for all known installations, after scanning for previously undiscovered
installations, please use command 'scan -n -e' instead.

enable {-m | <wp path>}
    Enables LSWCP for all discovered WordPress installations with the -m
parameter or a single installation by providing the path to the WordPress
installation directory.

disable {-m | <wp path>}
    Disables LSWCP for all discovered WordPress installations with the -m
parameter or a single installation by providing the path to the WordPress
installation directory.

upgrade {-m | <wp path>}
    Upgrade LSWCP for all discovered WordPress installations to the current
active version with the -m parameter or a single installation by providing the
path to the WordPress installation directory.

flag <wp path>
    Flag a single WordPress installation. Flagged installations will be skipped
during mass operations.

unflag {-m | <wp path>}
    Unflag all discovered WordPress installations with the -m parameter or a
single installation by providing the path to the WordPress installation
directory. Flagged installations will be skipped during mass operations.

status <wp path>
    Get the most up to date LSCWP status for the provided WordPress
installation.

dashnotify {-m | -wppath <wp path>} [-plugin <plugin slug>] {-msgfile <message file path> | -msg <message>}
    Notify all discovered WordPress installations with the provided message
(plain text or HTML) using the Dash Notifier WordPress plugin with the -m
parameter or a single installation by providing the path to the WordPress
installation directory. A plugin slug can be included to have an
install/activate button for that plugin added to the message as well.
Installations containing a '.dash_notifier_bypass' file will not be notified.

dashnotifyremove {-m | <wp path>}
    Remove Dash Notifier plugin (and notification messages) from all discovered
WordPress installations with the -m parameter or a single installation by
providing the path to the WordPress installation directory.

cpanelplugin {--install | --uninstall | -autoinstall [{0 | 1}] | --fixconf}
    [cPanel/WHM Environment Only] Install or uninstall the LiteSpeed user-end
plugin for cPanel for all cPanel accounts using the '--install' and
'--uninstall' input flags. The plugin will appear as "LiteSpeed Web Cache
Manager" under 'Advanced' in the user's cPanel dashboard. The '-autoinstall'
input param can be used to check the current auto install status. When turned
on, the cPanel plugin will be automatically installed when installing/updating
the WHM plugin. Use '-autoinstall {0 | 1}' to manually turn this off and on
respectively. The '--fixConf' input param can be used to re-populate the cPanel
plugin's configuration file values in case of an issue.

addinstalls {-wpinstall <wp path> <docroot> <server name> <site url>} | -wpinstallsfile <installs file path>}
    Add a WordPress installation to existing scan data. This "custom" data will
be stored in it's own lscm.data.cust data file under the "lsws/admin/lscdata"
directory. A single installation can be added using the -wpinstall parameter
with space separated list of installation info in the required order (<wp path>
<docroot> <server name> <site url>). Multiple installations can be added at
once using the -wpinstallsfile parameter to provide the path to an installs
file containing a newline separated list of installation info in the expected
format.

--update-lib
    Update the lscmctl script and the required shared library to their latest
versions only if the currently installed versions are no longer supported.

--force-update-lib
    Force update the lscmctl script and the required shared library to their
latest versions. It is not recommended that this command be included in any
cron jobs, use command '--update-lib' instead.


Example Usage:

  List server and virtual host cache roots:
  ./lscmctl setcacheroot

  Set virtual host cache root:
  ./lscmctl setcacheroot -vh /path/to/ssd/lscache

  Display currently active LSCWP version:
  ./lscmctl setversion

  Display selectable LSCWP versions:
  ./lscmctl setversion --list

  Set active LSCWP version to latest available:
  ./lscmctl setversion --latest

  Set active LSCWP version to v1.5:
  ./lscmctl setversion 1.5

  Discover all installations:
  ./lscmctl scan

  Discover new installations only, passing in path to PHP binary:
  ./lscmctl -php /path/to/php/ scannew

  Enable LSCWP on all discovered installations:
  ./lscmctl enable -m

  Disable LSCWP for a single installation:
  ./lscmctl disable /home/user/public_html/wp

  Get LSCWP status for a single installation:
  ./lscmctl status /home/user/public_html/wp

  Send a simple dashboard message to a single discovered WordPress installation:
  ./lscmctl dashnotify -wppath /path/to/wp/install -msg "Hello World!"

  Broadcast a dashboard message recommending the LiteSpeed Cache for WordPress plugin to all discovered WordPress installations:
  ./lscmctl dashnotify -m -plugin litespeed-cache -msgfile /path/to/msg/file

  Remove dashboard notifications (and Dash Notifier plugin) from all discovered WordPress installations:
  ./lscmctl dashnotifyremove -m

  [cPanel/WHM Environment Only] Install the LiteSpeed user-end plugin for cPanel for all cPanel accounts:
  ./lscmctl cpanelplugin --install

  [cPanel/WHM Environment Only] Turn off auto install for the LiteSpeed user-end plugin for cPanel:
  ./lscmctl cpanelplugin -autoinstall 0

  Add a single WordPress Installations to custom data file.:
  ./lscmctl addinstalls -wpinstall /home/user/public_html/wp /home/user/public_html user.com user.com/wp

  Add multiple WordPress Installations to custom data file using an installs file.:
  ./lscmctl addinstalls -wpinstallsfile /path/to/installs/file

Scan And Enable Using A CronJob¶

If you do not want to continue manually running the CLI script you can set up a cronjob to run the script at fixed intervals instead.

First, as root, open crontab cronjobs with command

crontab -e

After that, you can add one of the following lines, in the usual cronjob format, similar to the following, depending on your intended use:

• Perform a full re-scan and enable LSCWP for all discovered installations

  00 03 * * * /usr/local/lsws/admin/misc/lscmctl scan -e
  

OR

• Scan only for new installations and enable LSCWP for all known installations

  00 03 * * * /usr/local/lsws/admin/misc/lscmctl scan -n -e
  

OR

• (Recommended) Scan only for new installations and enable LSCWP only for those newly discovered installations

  00 03 * * * /usr/local/lsws/admin/misc/lscmctl scannew -en
  

All of these potential commands will run the chosen CLI script command daily at 3am.

Customize LiteSpeed Cache Plugin For WordPress Before Installation¶

The following customizations will apply to all LiteSpeed Cache Plugin for WordPress installations made through the WHM Plugin's LiteSpeed Cache For WordPress Management feature or through the lscmctl Command-Line LiteSpeed Cache For WordPress Management Script.

Initial Configuration¶

Customized Default Setting Values¶

It is possible to customize your own set of default values for first-time LiteSpeed Cache Plugin for WordPress installations.

To apply this customization, simply copy LiteSpeed Cache Plugin for WordPress' configuration file litespeed-cache/data/const.default.ini to the LiteSpeed Cache Plugin for WordPress local source directory at /usr/src/litespeed-wp-plugin/ and change the new configuration as necessary.

Edit this file to add settings, or remove settings, or change default setting values for the LiteSpeed Cache Plugin For WordPress.
These new defaults will be applied to all first-time installations. Settings can be safely removed or otherwise left out of this file if you do not plan to change the default values for those settings.

Troubleshooting¶

For help with troubleshooting common plugin issues, take a look at our Troubleshooting Page.