Skip to content

Commit 374a6b5

Browse files
Docs for Imunify Security WordPress plugin.
1 parent 6c6542a commit 374a6b5

File tree

6 files changed

+69
-0
lines changed

6 files changed

+69
-0
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,5 +98,10 @@ export default [
9898
title: "Patchman",
9999
description: "Automated vulnerability patching and malware removal.",
100100
link: "/patchman/",
101+
},
102+
{
103+
title: "WordPress Plugin",
104+
description: "Documentation for Imunify Security plugin for WordPress available in Imunify360.",
105+
link: "/wordpress_plugin/",
101106
}
102107
]
7.51 KB
Loading
298 KB
Loading
275 KB
Loading

docs/dashboard/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1057,6 +1057,7 @@ Go to <span class="notranslate">_Imunify360 → Settings → General_</span>. Th
10571057
* <span class="notranslate">[OSSEC](/dashboard/#ossec)</span>
10581058
* <span class="notranslate">[PAM](/dashboard/#pam)</span>
10591059
* <span class="notranslate">[Error Reporting](/dashboard/#error-reporting)</span>
1060+
* <span class="notranslate">[WordPress plugin](/dashboard/#wordpress-plugin)</span>
10601061
* <span class="notranslate">[Contact Details](/dashboard/#contact-details)</span>
10611062

10621063
#### Installation
@@ -1498,6 +1499,25 @@ imunify360-agent config update '{"PAM": {"ftp_protection": true}}'
14981499

14991500
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.
15001501

1502+
#### WordPress plugin
1503+
1504+
:::warning
1505+
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.
1506+
:::
1507+
1508+
Tick the <span class="notranslate">_Install WordPress plugin_</span> checkbox to install the Imunify Security WP plugin on all WordPress sites.
1509+
1510+
![](/images/wordpress-plugin/panel-settings.png)
1511+
1512+
You can also enable it via CLI with the following command:
1513+
1514+
<div class="notranslate">
1515+
1516+
```
1517+
imunify360-agent config update '{"WORDPRESS":{"security_plugin_enabled": true}}'
1518+
```
1519+
</div>
1520+
15011521
#### Error Reporting
15021522

15031523
Tick <span class="notranslate">_Enable Sentry error reporting_</span> checkbox to send reports to the Imunify360 error reports server.

docs/wordpress_plugin/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Imunify Security WordPress Plugin
2+
3+
## Overview
4+
5+
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.
6+
7+
## Prerequisites
8+
9+
* **WordPress Version**: 5.0.0 or higher
10+
* **PHP Version**: 5.6 or higher
11+
* **Imunify360**: 8.2.0 or higher
12+
13+
## Installation
14+
15+
Currently the plugin is not available in the WordPress plugin repository. You can install it manually by following the steps below:
16+
17+
1. Navigate to Imunify360 settings in the cPanel
18+
2. Scroll down to the `WordPress Plugin` section
19+
3. Tick the `Install WordPress plugin` checkbox and click the `Save changes` button
20+
4. Plugin will be installed in the background to all WordPress installations on the server
21+
22+
![](/images/wordpress-plugin/panel-settings.png)
23+
24+
## Features
25+
26+
### Dashboard Widget
27+
28+
Plugin adds a dashboard widget that helps administrators keep track of their site's real-time security status including:
29+
30+
- the timestamps for the last and next scheduled scans
31+
- detailed list of malware items that have been detected and cleaned, including the file path, signature, and the clean-up time
32+
33+
### Notice
34+
35+
Plugin adds a notice to the WordPress admin dashboard visible to non-administrator users. The notice informs users about the security status of the website and provides a link to the Imunify360 dashboard for more information.
36+
37+
## Screenshots
38+
39+
### Admin widget - no malware found
40+
41+
![](/images/wordpress-plugin/widget-no-malware.png)
42+
43+
### Admin widget - site not protected
44+
![](/images/wordpress-plugin/widget-not-protected.png)

0 commit comments

Comments
 (0)