Differences

This shows you the differences between two versions of the page.

--- litespeed_wiki:cpanel:cli-lscwp-management [2019/07/01 18:07]
Michael Alegre
+++ litespeed_wiki:cpanel:cli-lscwp-management [2019/07/01 18:10]
Michael Alegre [Command-Line Interface - LiteSpeed Cache For WordPress Management] Updated script help page to match v1.7 help output.
@@ Line 3: / Line 3: @@
 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.
+[[https://blog.litespeedtech.com/2017/06/28/wpw-autodiscovery-lscache-and-the-command-line/|Learn more about the CLI script on our blog.]]
 **Supported Control Panel Environments:** cPanel/WHM and Plesk
-[[https://blog.litespeedtech.com/2017/06/28/wpw-autodiscovery-lscache-and-the-command-line/|Learn more about the CLI script on our blog.]]
 **Note:** You must have a license with LSCache enabled to use these features. **[[litespeed_wiki:licenses:add-lscache|How To Get LSCache]]**
 <code>
-LiteSpeed Cache Manager CLI Tool v1.4
+LiteSpeed Cache Manager CLI Tool v1.7
 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
@@ Line 59: / Line 59: @@
 during mass operations.
-unflag <wp path>
+unflag {-m | <wp path>}
-    Unflag a single WordPress installation. Flagged installations will be
+    Unflag all discovered WordPress installations with the -m parameter or a
-skipped during mass operations.
+single installation by providing the path to the WordPress installation
+directory. Flagged installations will be skipped during mass operations.
 status <wp path>
@@ Line 73: / Line 74: @@
 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 notfiied.
+Installations containing a '.dash_notifier_bypass' file will not be notified.
 dashnotifyremove {-m | <wp path>}
@@ Line 80: / Line 81: @@
 providing the path to the WordPress installation directory.
-cpanelplugin {--install | --uninstall}
+cpanelplugin {--install | --uninstall | -autoinstall [{0 | 1}]}
     [cPanel/WHM Environment Only] Install or uninstall the LiteSpeed user-end
-plugin for cPanel for all cPanel accounts. The plugin will appear as "LiteSpeed
+plugin for cPanel for all cPanel accounts using the '--install' and
-Web Cache Manager" under 'Advanced' in the user's cPanel dashboard.
+'--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.
+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.
@@ Line 109: / Line 125: @@
   ./lscmctl scan
-  Discover new installations only, passing in path to php binary:
+  Discover new installations only, passing in path to PHP binary:
   ./lscmctl -php /path/to/php/ scan -n
@@ Line 132: / Line 148: @@
   [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
 </code>
 ===== Scan And Enable Using A CronJob =====