Merge pull request #110 from martinkrcho/mkrcho-wp-plugin-v1

Author: annkots

docs/.vuepress/config-client/documents.ts

@@ -98,5 +98,10 @@ export default [
         title: "Patchman",
         description: "Automated vulnerability patching and malware removal.",
         link: "/patchman/",
+    },
+    {
+        title: "WordPress Plugin",
+        description: "Documentation for Imunify Security plugin for WordPress available in Imunify360.",
+        link: "/wordpress_plugin/",
     }
 ]

docs/.vuepress/public/images/wordpress-plugin/malware-found-details.png

@@ -1070,6 +1070,7 @@ Go to <span class="notranslate">_Imunify360 → Settings → General_</span>. Th
 * <span class="notranslate">[OSSEC](/dashboard/#ossec)</span>
 * <span class="notranslate">[PAM](/dashboard/#pam)</span>
 * <span class="notranslate">[Error Reporting](/dashboard/#error-reporting)</span>
+* <span class="notranslate">[WordPress plugin](/dashboard/#wordpress-plugin)</span>
 * <span class="notranslate">[Contact Details](/dashboard/#contact-details)</span>
 
 #### Installation
@@ -1511,6 +1512,25 @@ imunify360-agent config update '{"PAM": {"ftp_protection": true}}'
 
 Click <span class="notranslate">_Save changes_</span> button on the bottom of the section to save changes. This will enable protection for SSH/FTP protocols.
 
+#### WordPress plugin
+
+:::warning
+The WordPress plugin installation is currently allowed only if _Settings > Malware > General > Default action on detect_ is set to _Cleanup_. Other installation options will be introduced in the future release.
+:::
+
+Tick the <span class="notranslate">_Install WordPress plugin_</span> checkbox to install the Imunify Security WP plugin on all WordPress sites.
+
+![](/images/wordpress-plugin/panel-settings.png)
+
+You can also enable it via CLI with the following command:
+
+<div class="notranslate">
+
+```
+imunify360-agent config update '{"WORDPRESS":{"security_plugin_enabled": true}}'
+```
+</div>
+
 #### Error Reporting
 
 Tick <span class="notranslate">_Enable Sentry error reporting_</span> checkbox to send reports to the Imunify360 error reports server.

docs/.vuepress/public/images/wordpress-plugin/panel-settings.png

@@ -0,0 +1,48 @@
+# Imunify Security WordPress Plugin
+
+## Overview
+
+The **Imunify Security WordPress plugin** is designed exclusively for Imunify360 users, providing WordPress administrators with a comprehensive overview of malware that has been cleaned from their site. It integrates seamlessly with the Imunify360 platform to enhance your website's security.
+
+## Prerequisites
+
+* **WordPress Version**: 5.0.0 or higher
+* **PHP Version**: 5.6 or higher
+* **Imunify360**: 8.2.0 or higher
+
+## Installation
+
+Currently the plugin is not available in the WordPress plugin repository. You can install it manually by following the steps below:
+
+1. Navigate to Imunify360 settings in the cPanel
+2. Scroll down to the `WordPress Plugin` section
+3. Tick the `Install WordPress plugin` checkbox and click the `Save changes` button
+4. Plugin will be installed in the background to all WordPress installations on the server
+
+![](/images/wordpress-plugin/panel-settings.png)
+
+## Features
+
+### Dashboard Widget
+
+Plugin adds a dashboard widget that helps administrators keep track of their site's real-time security status including:
+
+- the timestamps for the last and next scheduled scans
+- detailed list of malware items that have been detected and cleaned, including the file path, signature, and the clean-up time
+
+## Screenshots
+
+### Admin widget - malware cleaned
+
+![](/images/wordpress-plugin/widget-malware-cleaned.png)
+
+### Malware details
+
+![](/images/wordpress-plugin/malware-found-details.png)
+
+### Admin widget - no malware found
+
+![](/images/wordpress-plugin/widget-no-malware.png)
+
+### Admin widget - site not protected
+![](/images/wordpress-plugin/widget-not-protected.png)