Differences

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

--- litespeed_wiki:cpanel:cpanel-plugin-lscwp-management [2018/07/02 21:24]
Michael Alegre
+++ litespeed_wiki:cpanel:cpanel-plugin-lscwp-management [2018/07/09 17:51] (current)
Lisa Clarke Proofreading
@@ Line 12: / Line 12: @@
-===== Manage LSCWP Installations =====
+===== Plugin Not Available For cPanel Users? =====
-The manage view is where most of the magic happens.  Here you can manage LSCWP for your WordPress installations individually or in groups.
+If the LiteSpeed Web Cache Manager plugin is not appearing for cPanel users after installing through the LiteSpeed WHM plugin, please try the following:
-{{:litespeed_wiki:cpanel:cpanel-plugin-manage.png?direct&800|}}
+  - Log in to WHM and navigate to the **Feature List** screen by selecting **Packages > Feature Manager**.
+  - From here you can add or remove user access to plugins by creating or editing feature lists.
+  - Create or edit the feature list you wish to modify.
+  - Click the checkbox labelled **LS Web Cache Manager** and then press the **Save** button. This will add or remove this plugin in your current feature list, which can then be assigned to a package if it has not been already.
-Starting from the actual table we have the following fields:
+This plugin should now appear in the **Advanced** section of the cPanel home screen for all users assigned this package.
-  * **Discovered WordPress Installations -**  This field will contain the path of each WordPress installation discovered during the last scan operation.
+{{ :litespeed_wiki:cpanel:cpanel-v1.0.0-advanced-icon.png?nolink |}}
-  * **LSCWP Status -** Displays the last known status of LSCWP for the listed WordPress installation.
+If you do not see the **LiteSpeed Web Cache Manager** item in the advanced section of your cPanel home screen, please upgrade LiteSpeed Web Server to 5.1.x at the minimum.
-  * **Flag -** This field can either be blank or display a flag icon. While an installation is flagged, displaying the flag icon, it will be excluded from all future Mass Enable/Disable operations.
+You must have a license with LSCache enabled to use these features. **[[litespeed_wiki:licenses:add-lscache|How To Get LSCache]]**
-  * **Actions -** This field contains action buttons that perform a specific action only for the related WordPress installation. These actions include Enable/Disable LSCWP, Flag/Unflag this installation, and Flush which flushes the cache for this installation only.
+//**Note:** If you would like to install the LiteSpeed Web Cache Manager plugin but do not have WHM access, please contact your server administrator or hosting provider.//
-Looking at the top row of buttons, we have **Scan/Re-scan** as well as **Refresh Status**.
+===== Plugin Breakdown =====
-  * **Scan/Re-scan -** Discovers all WordPress installations under each cPanel users ''public_html'' folder. These discovered installations will then be saved to a data file and displayed in the manager screen. If this data file is removed or corrupted, simply scan again to repopulate the list.
+==== Main Page ====
-  * **Refresh Status -** Each listed WordPress installation will have an LSCWP Status of either "Enabled" or "Disabled" reflecting the status of LSCWP for that installation. The **Refresh Status** button will update this value to the most current status for all listed WordPress installations.
+This is the first page shown when visiting the plugin page. Here you will be presented with 3 sections and a link to the settings page.
-Moving on we have the the bottom row of buttons which are used to perform group operations. These buttons work in tandem with the check-boxes found next to each discovered installation to allow you to perform some basic operations for only the selected group.
+{{ :litespeed_wiki:cpanel:cpanel-v1.0.0-main-page.png?nolink |}}
-  * **Enable Selected & Disable Selected -** These buttons allow you to enable and disable LSCWP for the selected WordPress installations.
+  * **Why Use LSCache?** - Contains some information on LSCache and the various available LSCache plugins through the [[https://litespeedtech.com/products/cache-plugins|Available LSCache Plugins]] link.
+  * **Flush LSCache** - This section contains a button for flushing the contents of your LSCache folder. This will clear the cache for all owned sites with LSCache enabled.
+  * **LiteSpeed Cache Management** - This section contains a link to the LiteSpeed Cache Management page for owned WordPress sites where LSCWP can be selectively enabled and disabled on a per site basis.
+  * **Settings** - This link will take you to the plugin settings page.
-  * **Flag Selected & Unflag Selected -** These buttons allow you to set or unset the flag field for the selected WordPress Installations. Flagged installations will be excluded from **Mass Enable LSCWP** and **Mass Disable LSCWP** operations.
+The **LiteSpeed Cache Management** and **Settings** pages will be covered in more detail below.
-  * **Flush Selected -** This button allows you to flush the cache for the selected WordPress Installations.
+==== LiteSpeed Cache Management - WordPress Cache ====
+The manage view is where most of the magic happens.  Here you can manage LSCWP for your WordPress installations individually or in groups.
-===== Plugin Not Available To cPanel Users =====
+{{ :litespeed_wiki:cpanel:cpanel-v1.0.0-manage-wordpress.png?nolink |}}
-If the LiteSpeed Web Cache Manager plugin is not appearing for cPanel users after installing through the LiteSpeed WHM plugin, please try the following:
+Starting from the actual table we have the following fields:
-  - Log in to WHM and navigate to the Feature List screen by selecting Packages >> Feature Manager.
+  * **Discovered WordPress Installations**:  This field contains the path of each WordPress installation discovered during the last scan operation.
-  - From here you can add or remove user access to plugins by creating or editing feature lists.
-  - Create or edit the feature list you wish to modify.
-  - Click the checkbox labelled "LS Web Cache Manager" and then the save button. This will add or remove this plugin in your current feature list, which can then be assigned to a package if it has not been already.
-This plugin should now appear in the **Advanced** section of the cPanel home screen for all users assigned this package.
+  * **Cache Status**: Displays the last known status of LSCWP for the listed WordPress installation.
-{{ :litespeed_wiki:cpanel:cpanel-v1.0.0-advanced-icon.png?nolink |}}
+  * **Flag**: This field can either be blank or display a flag icon. While an installation is flagged (in other words, displaying the flag icon), it will be excluded from all future Mass Enable/Disable LSCWP operations in the WHM plugin.
-If you do not see the **LS Web Cache Manager** item in the advanced section of your cPanel home screen, please upgrade LiteSpeed Web Server to 5.1.x at the minimum.
+  * **Actions**: This field contains action buttons that perform a specific action only for the related WordPress installation. These actions include Enable/Disable LSCWP and Flag/Unflag this installation.
-You must have a license with LSCache enabled to use these features. **[[litespeed_wiki:licenses:add-lscache|How To Get LSCache]]**
+Looking at the top row of buttons, we have **Scan/Re-scan**, **Refresh Status**, and to the right, **Flush All**.
-//**Note:** If you would like to install the LiteSpeed Web Cache Manager plugin but do not have WHM access, please contact your server administrator or hosting provider.//
+  * **Scan/Re-scan**: Discovers all WordPress installations under each cPanel user's known document root. These discovered installations will then be saved to a data file and displayed on the manager screen. If this data file is removed or corrupted, simply scan again to repopulate the list.
+  * **Refresh Status**: Each listed WordPress installation will have an LSCWP Status reflecting the status of LSCWP for that installation. The **Refresh Status** button will update this value to the most current status for all listed WordPress installations.
+  * **Flush All**: Like the button of the same name on the main page, this button will flush the contents of your LSCache folder. This will clear the cache for all owned sites with LSCache enabled.
+Moving on we have the the bottom row of buttons which are used to perform group operations. These buttons work in tandem with the check-boxes found next to each discovered installation to allow you to perform some basic operations for only the selected group.
+  * **Enable Selected & Disable Selected**: These buttons allow you to enable and disable LSCWP for the selected WordPress installations.
+  * **Flag Selected & Unflag Selected**: These buttons allow you to set or unset the flag field for the selected WordPress Installations. Flagged installations will be excluded from **Mass Enable/Disable LSCWP** operations in the WHM plugin.
+==== Settings ====
+The Settings page allows you to control various plugin related settings (one at the moment).
+{{ :litespeed_wiki:cpanel:cpanel-v1.0.0-settings.png?nolink |}}
+  * **Log File Level**: This setting controls the highest level of log messages that will be written to the log file located at ''/home/$user/lscmData/ls_webcachemgr.log''. The default value is ''INFO''.
 ===== Uninstallation =====