diff --git a/docs/.vuepress/config-client/documents.ts b/docs/.vuepress/config-client/documents.ts index 7778e15d..a0070e9f 100644 --- a/docs/.vuepress/config-client/documents.ts +++ b/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/", } ] \ No newline at end of file diff --git a/docs/.vuepress/public/images/wordpress-plugin/malware-found-details.png b/docs/.vuepress/public/images/wordpress-plugin/malware-found-details.png new file mode 100644 index 00000000..efdabc84 Binary files /dev/null and b/docs/.vuepress/public/images/wordpress-plugin/malware-found-details.png differ diff --git a/docs/.vuepress/public/images/wordpress-plugin/panel-settings.png b/docs/.vuepress/public/images/wordpress-plugin/panel-settings.png new file mode 100644 index 00000000..31b42c9a Binary files /dev/null and b/docs/.vuepress/public/images/wordpress-plugin/panel-settings.png differ diff --git a/docs/.vuepress/public/images/wordpress-plugin/widget-malware-cleaned.png b/docs/.vuepress/public/images/wordpress-plugin/widget-malware-cleaned.png new file mode 100644 index 00000000..b46eb5d8 Binary files /dev/null and b/docs/.vuepress/public/images/wordpress-plugin/widget-malware-cleaned.png differ diff --git a/docs/.vuepress/public/images/wordpress-plugin/widget-no-malware.png b/docs/.vuepress/public/images/wordpress-plugin/widget-no-malware.png new file mode 100644 index 00000000..fdb59c3c Binary files /dev/null and b/docs/.vuepress/public/images/wordpress-plugin/widget-no-malware.png differ diff --git a/docs/.vuepress/public/images/wordpress-plugin/widget-not-protected.png b/docs/.vuepress/public/images/wordpress-plugin/widget-not-protected.png new file mode 100644 index 00000000..e40e5732 Binary files /dev/null and b/docs/.vuepress/public/images/wordpress-plugin/widget-not-protected.png differ diff --git a/docs/dashboard/README.md b/docs/dashboard/README.md index 084b845e..6187ab62 100644 --- a/docs/dashboard/README.md +++ b/docs/dashboard/README.md @@ -1070,6 +1070,7 @@ Go to _Imunify360 → Settings → General_. Th * [OSSEC](/dashboard/#ossec) * [PAM](/dashboard/#pam) * [Error Reporting](/dashboard/#error-reporting) +* [WordPress plugin](/dashboard/#wordpress-plugin) * [Contact Details](/dashboard/#contact-details) #### Installation @@ -1511,6 +1512,25 @@ imunify360-agent config update '{"PAM": {"ftp_protection": true}}' Click _Save changes_ 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 _Install WordPress plugin_ 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: + +
+ +``` +imunify360-agent config update '{"WORDPRESS":{"security_plugin_enabled": true}}' +``` +
+ #### Error Reporting   Tick _Enable Sentry error reporting_ checkbox to send reports to the Imunify360 error reports server. diff --git a/docs/wordpress_plugin/README.md b/docs/wordpress_plugin/README.md new file mode 100644 index 00000000..fbfc4027 --- /dev/null +++ b/docs/wordpress_plugin/README.md @@ -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)