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:whm-plugin-lscwp-management [2019/04/22 20:40] Michael Alegre [Getting Started] |
litespeed_wiki:cpanel:whm-plugin-lscwp-management [2019/04/24 16:16] Michael Alegre [Cache Root Setup] Added equivalent CLI commands mention. |
||
---|---|---|---|
Line 11: | Line 11: | ||
===== Cache Root Setup ===== | ===== Cache Root Setup ===== | ||
+ | |||
+ | Equivalent CLI commands: ''setcacheroot'' | ||
+ | |||
+ | Example: ''./lscmctl setcacheroot'' <nowiki>[</nowiki>[[litespeed_wiki:cpanel:cli-lscwp-management|Go to CLI page]]<nowiki>]</nowiki> | ||
+ | |||
+ | <html><br /></html> | ||
+ | |||
Click **WHM Plugin > LiteSpeed Configuration > Cache Root Setup** | Click **WHM Plugin > LiteSpeed Configuration > Cache Root Setup** | ||
{{ :litespeed_wiki:cpanel:whm-plugin-main-config_cacheroot.png?nolink |}} | {{ :litespeed_wiki:cpanel:whm-plugin-main-config_cacheroot.png?nolink |}} | ||
Line 58: | Line 65: | ||
The first time, a user may see only a **Scan** button available \\ | The first time, a user may see only a **Scan** button available \\ | ||
{{ :litespeed_wiki:cpanel:whm-plugin-main-managelscwp_prescan.png?nolink |}} \\ | {{ :litespeed_wiki:cpanel:whm-plugin-main-managelscwp_prescan.png?nolink |}} \\ | ||
- | After a scan and cache is enabled, it will look like this \\ | + | After a scan and cache is enabled, it will look like this \\ \\ |
{{ :litespeed_wiki:cpanel:whm-plugin-main-managelscwp_postscan.png?nolink |}} \\ | {{ :litespeed_wiki:cpanel:whm-plugin-main-managelscwp_postscan.png?nolink |}} \\ | ||
Line 107: | Line 114: | ||
* **Force Version Change For All Existing Installations -** Allows you to change the version of existing LiteSpeed Cache for WordPress installations, allowing you to select which to change based on current cache version. | * **Force Version Change For All Existing Installations -** Allows you to change the version of existing LiteSpeed Cache for WordPress installations, allowing you to select which to change based on current cache version. | ||
- | ===== Testing ===== | + | ===== WordPress Dash Notifier ===== |
+ | 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 LiteSpeed Cache for WordPress to their clients, rather than installing it directly for them via Mass Enable. | ||
+ | ==== Recommend A Plugin ==== | ||
+ | {{ :litespeed_wiki:cpanel:whm-plugin-main-dashnotifier_rap.png?nolink |}} | ||
+ | |||
+ | **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 on [[https://wordpress.org/plugins/]] 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. | ||
+ | |||
+ | <html><br /></html> | ||
+ | |||
+ | === End Result === | ||
+ | - User does not have the plugin ('litespeed-cache') installed: \\ {{ :litespeed_wiki:cpanel:whm-plugin-main-dashnotifier_rap_install.png?nolink |}} \\ | ||
+ | - User has plugin ('litespeed-cache') installed, but deactivated: \\ {{ :litespeed_wiki:cpanel:whm-plugin-main-dashnotifier_rap_activate.png?nolink |}} \\ | ||
+ | - User has 'litespeed-cache' plugin installed and active: \\ * No message will be displayed | ||
+ | |||
+ | ==== Broadcast A Message ==== | ||
+ | {{ :litespeed_wiki:cpanel:whm-plugin-main-dashnotifier_bam.png?nolink |}} | ||
+ | |||
+ | **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. | ||
+ | |||
+ | <html><br /></html> | ||
+ | |||
+ | === End Result === | ||
+ | {{ :litespeed_wiki:cpanel:whm-plugin-main-dashnotifier_bam_simple.png?nolink |}} | ||
+ | |||
+ | ==== 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. | ||
+ | |||
+ | ===== Testing Caching ===== | ||
To test your domains, you should see ''X-LiteSpeed-Cache: hit'' in the response header. Check [[litespeed_wiki:cache:lscwp:installation#testing|here]] for detailed verification steps. | To test your domains, you should see ''X-LiteSpeed-Cache: hit'' in the response header. Check [[litespeed_wiki:cache:lscwp:installation#testing|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. | 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. |