Cache Management CLI¶

Our lscmctl CLI script provides command-line access to many of the options available through our WHM plugin for cPanel.

The command-line interface script is located at /usr/local/lsws/admin/misc/lscmctl and is used to execute basic cache-management actions through the terminal or in a cron job. You may also recommend a plugin or broadcast a message to all discovered WordPress installations through the CLI tool.

Syntax:

./lscmctl [-php path/to/php] <command> [parameters]

The following commands are available:

setcacheroot¶

./lscmctl setcacheroot [-svr <cache root>] [-vh <cache root>]

List or set server or virtual host cache root. 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).

./lscmctl setcacheroot

./lscmctl setcacheroot -vh /path/to/ssd/lscache

setversion¶

./lscmctl setversion [{--list | --latest | <version>}]

List or set the 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.

./lscmctl setversion

./lscmctl setversion --list

./lscmctl setversion --latest

./lscmctl setversion 7.5

scan¶

./lscmctl 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.

./lscmctl scan

scannew¶

./lscmctl 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 scan -n -e instead, as described here.

./lscmctl -php /path/to/php/ scannew

enable¶

./lscmctl enable {-m | <wp path>}

Enable LSWCP for all discovered WordPress installations or for a single installation.

By adding the -m flag, LSCWP will be enabled for all discovered WordPress installations. By providing the path to a WordPress installation directory, LSCWP will be enabled for only that installation.

./lscmctl enable -m

disable¶

./lscmctl disable {-m | <wp path>}

Disable LSWCP for all discovered WordPress installations or for a single installation.

By adding the -m flag, LSCWP will be disabled for all discovered WordPress installations. By providing the path to a WordPress installation directory, LSCWP will be disabled for only that installation.

./lscmctl disable /home/user/public_html/wp

upgrade¶

./lscmctl upgrade {-m | <wp path>}

Upgrade LSWCP to the current active version for all discovered WordPress installations or for a single installation.

By adding the -m flag, LSCWP will be upgraded for all discovered WordPress installations. By providing the path to a WordPress installation directory, LSCWP will be upgraded for only that installation.

flag¶

./lscmctl flag <wp path>

Flag a single WordPress installation. Flagged installations will be skipped during mass operations.

unflag¶

./lscmctl unflag {-m | <wp path>}

Unflag all discovered WordPress installations or a single installation. Flagged installations will be skipped during mass operations.

By adding the -m flag, all discovered WordPress installations will be unflagged. By providing the path to a WordPress installation directory, only that installation will be unflagged.

status¶

./lscmctl status <wp path>

Get the most up to date LSCWP status for the provided WordPress installation.

./lscmctl status /home/user/public_html/wp

dashnotify¶

./lscmctl dashnotify {-m | -wppath <wp path>} [-plugin <plugin slug>] {-msgfile <message file path> | -msg <message>}

Notify all discovered WordPress installations or a single installation with the provided message using the Dash Notifier WordPress plugin. Installations containing a .dash_notifier_bypass file will not be notified.

By adding the -m flag, all discovered WordPress installations will be notified. By providing the path to a WordPress installation directory, only that installation will be notified. A plugin slug can be included to have an install/activate button for that plugin added to the message as well.

./lscmctl dashnotify -wppath /path/to/wp/install -msg "Hello World!"

./lscmctl dashnotify -m -plugin litespeed-cache -msgfile /path/to/msg/file

dashnotifyremove¶

./lscmctl dashnotifyremove {-m | <wp path>}

Remove Dash Notifier plugin (and notification messages) from all discovered WordPress installations or a single installation.

By adding the -m flag, Dash Notifier will be removed from all discovered WordPress installations. By providing the path to a WordPress installation directory, Dash Notify will be removed from only that installation.

./lscmctl dashnotifyremove -m

cpanelplugin¶

./lscmctl cpanelplugin {--install | --uninstall | -autoinstall [{0 | 1}] | --fixconf}

Install or uninstall the LiteSpeed user-end plugin for cPanel for all cPanel accounts. The plugin will appear as LiteSpeed Web Cache Manager under Advanced in the user's cPanel dashboard.

The -autoinstall input parameter 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 parameter can be used to re-populate the cPanel plugin's configuration file values in case of an issue.

./lscmctl cpanelplugin --install

./lscmctl cpanelplugin -autoinstall 0

addinstalls¶

./lscmctl 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 a 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¶

./lscmctl --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. No parameters.

--force-update-lib¶

./lscmctl --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 the --update-lib command instead.

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 following command:

crontab -e

After that, you can add a CLI command in the usual cronjob format, similar to the following examples.

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

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