Differences

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

--- litespeed_wiki:cpanel:cli-lscwp-management [2018/06/12 21:33]
Michael Alegre [Scan And Enable Using A CronJob]
+++ litespeed_wiki:cpanel:cli-lscwp-management [2019/01/30 17:07]
Michael Alegre [Command-Line Interface - LiteSpeed Cache For WordPress Management]
@@ Line 7: / Line 7: @@
 <code>
-LiteSpeed Cache Manager Script Help Page
+LiteSpeed Cache Manager CLI Tool v1.3
-This script requires that you have cPanel with LiteSpeed Web Server Plugin installed.
 Usage: ./lscmctl [-php path/to/php] command [flag/parameter]
 Possible Commands:
-scan [-n] [-e]
+setcacheroot [-svr <cache root>] [-vh <cache root>]
-        Scan for all WordPress installations. This command will create an lsc_manager_data file under the '.../lsws/admin/lscdata' directory.
+    List/Set server and/or virtual host cache roots. This command will list the
-        Add the -n flag to only discover new installations.
+current server and virtual host cache roots when no additional input is given.
-        By adding the -e flag, LSC-WP will be enabled on all installations after scanning is complete.
+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] | [$VERSION]
+setversion [--list] | [--latest] | <version>
-        List/Set active LSCWP version. This command will list the currently active version when no additional input it given.
+    List/Set active LSCWP version. This command will list the currently active
-        Use --list to show available versions. Provide a valid version number to switch to that version.
+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.
-enable -m | $WP_PATH
+scan [-n] [-e]
-        Enables LSWCP for all discovered WordPress installations with the -m parameter or a single installtion by providing the path to the WordPress
+    Scan for all WordPress installations. This command will create an lscm.data
-        installation directory.
+file under the "lsws/admin/lscdata" directory. Add the -n flag to only discover
+new installations. By adding the -e flag, LSC-WP will be enabled on all
+installations after scanning is complete.
-disable -m | $WP_PATH
+enable -m | <wp path>
-        Disables LSWCP for all discovered WordPress installations with the -m parameter or a single installtion by providing the path to the WordPress
+    Enables LSWCP for all discovered WordPress installations with the -m
-        installation directory.
+parameter or a single installtion by providing the path to the WordPress
+installation directory.
-upgrade -m | $WP_PATH
+disable -m | <wp path>
-        Upgrade LSWCP for all discovered WordPress installations to the current active version with the -m parameter or a single installation by
+    Disables LSWCP for all discovered WordPress installations with the -m
-        providing the path to the WordPress installation directory.
+parameter or a single installtion by providing the path to the WordPress
+installation directory.
-flag $WP_PATH
+upgrade -m | <wp path>
-        Flag a single WordPress installation. Flagged installations will be skipped during mass operations.
+    Upgrade LSWCP for all discovered WordPress installations to the current
+active version with the -m parameter or a single installtion by providing the
+path to the WordPress installation directory.
-unflag $WP_PATH
+flag <wp path>
-        Unflag a single WordPress installation. Flagged installations will be skipped during mass operations.
+    Flag a single WordPress installation. Flagged installations will be skipped
+during mass operations.
-status $WP_PATH
+unflag <wp path>
-        Get the most up to date LSCWP status for the provided WordPress installation.
+    Unflag a single WordPress installation. Flagged installations will be
+skipped during mass operations.
+status <wp path>
+    Get the most up to date LSC-WP status for the provided WordPress
+installation.
 Example Usage:
-Discover all installations:
+  List server and virtual host cache roots:
-./lscmctl scan
+  ./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
-Discover new installations only, passing in path to php binary:
+  Set active LSCWP version to v1.5:
-./lscmctl -php /path/to/php/ scan -n
+  ./lscmctl setversion 1.5
-Display currently active LSCWP version:
+  Discover all installations:
-./lscmctl setversion
+  ./lscmctl scan
-Set new active LSCWP version:
+  Discover new installations only, passing in path to php binary:
-./lscmctl setversion 1.5
+  ./lscmctl -php /path/to/php/ scan -n
-Enable LSCWP on all discovered installations:
+  Enable LSC-WP on all discovered installations:
-./lscmctl enable -m
+  ./lscmctl enable -m
-Disable LSCWP for a single installation:
+  Disable LSC-WP for a single installation:
-./lscmctl disable /home/user/public_html/wp
+  ./lscmctl disable /home/user/public_html/wp
-Get LSCWP status for a single installation:
+  Get LSC-WP status for a single installation:
-./lscmctl status /home/user/public_html/wp
+  ./lscmctl status /home/user/public_html/wp
 </code>