Skip to content

Commit fd0792b

Browse files
authored
Merge pull request #122 from annkots/master
TCR-678: update documentation about generic control panel integration
2 parents 9b42d93 + 376cbec commit fd0792b

File tree

1 file changed

+41
-4
lines changed

1 file changed

+41
-4
lines changed

docs/control_panel_integration/README.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ After the successful installation, **you can reach the Imunify360 UI at the URL
266266

267267
## 4. Set up modules and integrations and change other Imunify360 settings to reflect your needs
268268

269-
#### 4.1 Define list of administrators for Imunify360
269+
### 4.1 Define list of administrators for Imunify360
270270

271271
The administrators have full access to Imunify360 UI and its settings. To grant non-root users full access add more administrators by listing them in the them in the <span class="notranslate">`/etc/sysconfig/imunify360/auth.admin`</span> file or specify the [integration scripts](https://cloudlinux.zendesk.com/hc/en-us/articles/4840433434524-How-to-filter-the-number-of-users-by-using-integration-scripts?_gl=1*1dtmkmt*_up*MQ..*_ga*ODUwMjA5NDYyLjE2OTkyMTAwOTI.*_ga_1RCQ134PYC*MTY5OTIxMDA4OS4xLjAuMTY5OTIxMDA4OS4wLjAuMA..*_ga_V4QHJSZM47*MTY5OTIxMDA4OS4xLjAuMTY5OTIxMDA4OS4wLjAuMA..*_ga_8LBSSX7VQX*MTY5OTIxMDA4OS4xLjAuMTY5OTIxMDA4OS4wLjAuMA..) admin scetion.
272272

@@ -317,7 +317,7 @@ It should point to an executable file that generates a JSON file similar to the
317317
</div>
318318
</details>
319319

320-
#### 4.2 FTP uploads scan
320+
### 4.2 FTP uploads scan
321321
To scan files uploaded via FTP, configure [PureFTPd](https://www.pureftpd.org/project/pure-ftpd/). Write in the <span class="notranslate">`pure-ftp.conf`</span>:
322322

323323
<div class="notranslate">
@@ -327,7 +327,7 @@ CallUploadScript yes
327327
```
328328
</div>
329329

330-
#### 4.3 Per-domain rules constrol
330+
### 4.3 Per-domain rules constrol
331331
To enable domain-specific ModSecurity configuration, specify the <span class="notranslate">`modsec_domain_config_script`</span> in the <span class="notranslate">`integration.conf`</span>.
332332

333333
<div class="notranslate">
@@ -354,7 +354,7 @@ The script should also restart the web server to apply the configuration. This s
354354
If configuration change failed, the script should return 1, and in the standard error stream (stderr) it should return the reason for failure. On success, the script should return 0.
355355
In a single run of the script, we might update a single domain/user, as well as multiple users (all users) on the system.
356356

357-
#### 4.4 Integration with WebShield
357+
### 4.4 Integration with WebShield
358358

359359
WebShield consists of four services:
360360

@@ -782,3 +782,40 @@ It should point to an executable file that generates a JSON file similar to the
782782
</div>
783783

784784
<span class="notranslate">`web_server_config_path`</span> should point to a path that is added as <span class="notranslate">`IncludeOptional`</span> in this domain's virtual host e.g., <span class="notranslate">`/path/to/example.com/specific/config/to/include`</span> path should be added for the <span class="notranslate">`example.com`</span> domain.
785+
786+
### WordPress Plugin with non-CloudLinux generic panel environment
787+
788+
This section explains how install the [**Imunify Security WordPress Plugin**](https://docs.imunify360.com/wordpress_plugin/) on servers that **do not run CloudLinux OS** and use a **home-grown** or **“generic” hosting panel**.
789+
790+
1. Ensure the PHP-handler discovery script is present. Add (or reuse) the PHP discovery script described in the [CloudLinux OS integration guide](https://docs.cloudlinux.com/cloudlinuxos/control_panel_integration/#php).
791+
792+
2. Extend your [domain](https://docs.imunify360.com/control_panel_integration/#data-description) API response. Your `domain` script must now return PHP-handler details for **every** hosted domain.
793+
794+
```
795+
{
796+
"data": {
797+
"example.com": {
798+
"document_root": "/home/example/public_html",
799+
"php": { // <========== NB: lines 5-11 — required in full
800+
"php_version_id": "alt-php56",
801+
"version": "56",
802+
"ini_path": "/opt/alt/php56/link/conf",
803+
"is_native": true,
804+
"handler": "lsapi"
805+
}
806+
}
807+
},
808+
"metadata": {
809+
"result": "ok"
810+
}
811+
}
812+
```
813+
814+
3. Provide Imunify Security integration settings – create the vendor-specific configuration directory and symlink the standard Imunify Security integration file into it:
815+
816+
```
817+
mkdir -p /opt/cpvendor/etc/
818+
```
819+
```
820+
ln -s /etc/sysconfig/imunify360/integration.conf /opt/cpvendor/etc/integration.ini
821+
```

0 commit comments

Comments
 (0)