Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
litespeed_wiki:cpanel:cli-lscwp-management [2018/06/12 21:24] Michael Alegre |
litespeed_wiki:cpanel:cli-lscwp-management [2019/04/19 20:05] Michael Alegre [Command-Line Interface - LiteSpeed Cache For WordPress Management] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Command-Line Interface - LiteSpeed Cache For WordPress Management ====== | ====== Command-Line Interface - LiteSpeed Cache For WordPress Management ====== | ||
- | As of LiteSpeed Enterprise 5.1.14, in addition to the plugin features above, a command-line interface script also exists under ''/usr/local/lsws/admin/misc/lscmctl'' for executing basic cache management actions through the terminal or in a cron job. The help page for this script is included below. | + | This page covers the various cache management options available through our lsmctl cli script. Most of these options are also available through our [[litespeed_wiki:cpanel:whm-plugin-lscwp-management|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. 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.]] | [[https://blog.litespeedtech.com/2017/06/28/wpw-autodiscovery-lscache-and-the-command-line/|Learn more about the CLI script on our blog.]] | ||
Line 7: | Line 9: | ||
<code> | <code> | ||
- | LiteSpeed Cache Manager Script Help Page | + | LiteSpeed Cache Manager CLI Tool v1.4 |
+ | |||
+ | |||
+ | 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, LSC-WP will be enabled on all | ||
+ | installations after scanning is complete. | ||
- | This script requires that you have cPanel with LiteSpeed Web Server Plugin installed. | + | 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. | ||
- | Usage: ./lscmctl [-php path/to/php] command [flag/parameter] | + | 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. | ||
- | Possible Commands: | + | flag <wp path> |
+ | Flag a single WordPress installation. Flagged installations will be skipped | ||
+ | during mass operations. | ||
- | scan [-n] [-e] | + | unflag <wp path> |
- | Scan for all WordPress installations. This command will create an lsc_manager_data file under the '.../lsws/admin/lscdata' directory. | + | Unflag a single WordPress installation. Flagged installations will be |
- | Add the -n flag to only discover new installations. | + | skipped during mass operations. |
- | By adding the -e flag, LSC-WP will be enabled on all installations after scanning is complete. | + | |
- | setversion [--list] | [$VERSION] | + | status <wp path> |
- | List/Set active LSCWP version. This command will list the currently active version when no additional input it given. | + | Get the most up to date LSC-WP status for the provided WordPress |
- | Use --list to show available versions. Provide a valid version number to switch to that version. | + | installation. |
- | enable -m | $WP_PATH | + | dashnotify {-m | -wppath <wp path>} [-plugin <plugin slug>] {-msgfile <message file path> | -msg <message>} |
- | Enables LSWCP for all discovered WordPress installations with the -m parameter or a single installtion by providing the path to the WordPress | + | Notify all discovered WordPress installations with the provided message |
- | installation directory. | + | (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 notfiied. | ||
- | disable -m | $WP_PATH | + | dashnotifyremove {-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 | + | Remove Dash Notifier plugin (and notification messages) from all discovered |
- | installation directory. | + | 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 | + | Example Usage: |
- | Flag a single WordPress installation. Flagged installations will be skipped during mass operations. | + | |
- | unflag $WP_PATH | + | List server and virtual host cache roots: |
- | Unflag a single WordPress installation. Flagged installations will be skipped during mass operations. | + | ./lscmctl setcacheroot |
- | status $WP_PATH | + | Set virtual host cache root: |
- | Get the most up to date LSCWP status for the provided WordPress installation. | + | ./lscmctl setcacheroot -vh /path/to/ssd/lscache |
+ | Display currently active LSCWP version: | ||
+ | ./lscmctl setversion | ||
- | Example Usage: | + | Display selectable LSCWP versions: |
+ | ./lscmctl setversion --list | ||
- | Discover all installations: | + | Set active LSCWP version to latest available: |
- | ./lscmctl scan | + | ./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> | + | |
- | ====== Scan And Enable Using A CronJob ====== | + | 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 | ||
+ | </code> | ||
+ | ===== Scan And Enable Using A CronJob ===== | ||
If you do not want to continue manually running the CLI script you can setup a cronjob to run the script at fixed intervals instead. | If you do not want to continue manually running the CLI script you can setup a cronjob to run the script at fixed intervals instead. | ||
Line 83: | Line 135: | ||
<code> 00 03 * * * /usr/local/lsws/admin/misc/lscmctl scan -e </code> | <code> 00 03 * * * /usr/local/lsws/admin/misc/lscmctl scan -e </code> | ||
- | This command will run the CLI script daily at 3am, re-discovering all WordPress installations and mass enabling LSCWP on any unflagged installations. | + | This command will run the CLI script daily at 3am, re-discovering all current and new WordPress installations and mass enabling LSCWP on any unflagged installations. |