-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
337 lines (231 loc) · 11.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
=== WebFacing - Disk, resource usage and errors from cPanel® on your Dashboard & in Site Health ===
Contributors: knutsp, proisp
Donate link: https://paypal.me/knutsp
Tags: disk-space, security, server, cpanel
Requires at least: 5.3
Tested up to: 5.8.1
Stable tag: 2.7
Requires PHP: 7.3
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
Shows disk usage information, recommendations and alerts in your dashboard At a Glance widget and on Site Health panel tabs.
Resource gauges in custom dasboard widget.
Includes Server Error log test in Site Health.
Also includes a Site Health test for HTTPS only, and an Email routing test,
both with information about the possible issue, recommendation and actions.
Worth noting is that the disk space used/available are the figures for your hosting account, not for the entire (shared) server.
== Description ==
🕸️ By [WebFacing](https://webfacing.eu/). Shows disk usage, memory, cpu and processes resource usage information, recommendations and alerts, plus number of created email accounts, in your admin Dashboard At a Glance widget, a special Dashboard Gauges widget, plus error logs and extensive info on Tools - Site Health panels.
Includes an email routing test (when server is not authority, routing must be remote).
Also includes a Site Health test for HTTPS only (http should not be allowed, but forwarded to https) with information about the issue, recommendation and actions.
Made with a little help from [cPanel, L.L.C., USA](http://www.cpanel.net/) and [PRO ISP AS, Norway](https://proisp.eu/) - many thanks.
This plugin is a candidate to be recommended to all customers by [PRO ISP AS, Norway](https://proisp.eu/).
See also [WebFacing – Email Accounts in cPanel®](https://wordpress.org/plugins/wf-cpanel-email-accounts/)
## This plugin adds the following:
### Dashboard
#### At a Glance (core widget)
- One item showing used disk space
- One item showing number of email accounts (site domain only)
- One line widget footer line mentioning the name of your web hosting provider, and maximum disk space for current plan/account (on PRO ISP only)
#### cPanel Resource Usage (custom widget)
- Memory usage (gauge)
- CPU usage (gauge)
- Number of active Entry Processes (gauge)
- Disk in/out usage (gauge)
- cPanel® Server Errors last 24 hours
### Tools - Site Health panel
#### Status (tab)
- A disk space test with explaining text and possible actions (cPanel® only) with following result types and actions
* Good (less than 90%)
* Recommended (over 90%, but less than 95%)
* Critical (over 95%)
- A HTTPS only test with explaining text (with HTTPS enabled only), actions with link to a relevant guide (special guide in case PRO ISP), and with the following result types and actions
* Good (http loopback requests are rejected)
* Recommended fix (http loopback requests successful)
- An Email Routing test for the site domain with explaining text and possible actions (cPanel® only) with following result types and actions
- Good (local server is authoritative or Email routing is Remote)
- Critical (local server is not authoritative and Email routing is Local)
- A Sever Error test with error log
- Good (no errors last 24 hours)
- Recommended (less than 25 errors)
- Critical (more than 24 errors)
#### Info (tab)
- A disk space section containing (cPanel® only)
- cPanel® user name (private)
- cPanel® user created (private)
- cPanel® user updated (private)
- cPanel® user subaccounts and assigned services (private)
- Two Factor Authentication enabled in cPanel®?
- Max disk space available
- Total disk space used
- Disk used by media files
- Disk space used by mail
- Is Local DNS authoritative?
- MX server is self
- Email Routing is local?
- Main domain in cPanel®
- Addon domains
- Parked domains
- Dead domains
- MySQL® Disk Usage
- CPU Usage
- Entry Processes
- Physical Memory Usage
- In/Out Operations Per Second (IOPS)
- In/Out Usage
- Number of Processes
- Number of cPanel® Server Errors
- Email accounts disk space used (all under the site domain)
- Email forwarding destinations (all under the site domain)
- Contact email addresses in cPanel®
- Adds one line to the WordPress Server values section
- Number of cPanel® Server Errors
- Adds some lines to the WordPress Constant values section
- `WP_CONTENT_URL`
- `FORCE_SSL_ADMIN`
- `WP_DISABLE_FATAL_ERROR_HANDLER`
- `ALLOW_UNFILTERED_UPLOADS`
- `AUTOMATIC_UPDATER_DISABLED`
- `WP_AUTO_UPDATE_CORE`
- `ALLOW_UNFILTERED_UPLOADS`
- `CORE_UPGRADE_SKIP_NEW_BUNDLED`
- `DISALLOW_FILE_MODS`
- `DISALLOW_FILE_EDIT`
- `SAVEQUERIES`
- `WP_POST_REVISIONS`
- `CUSTOM_USER_TABLE`
- `CUSTOM_USER_META_TABLE`
- `WF_DEV_LOGIN`
- `WF_DEV_EMAIL`
- `WF_DEBUG`
## Translation ready, ready translations are
- Norwegian (Bokmål)
## Filter interval for fetching data for Dashboard Gauges widget
`wf_cpanel_gauges_interval` (default: 10 seconds)
## Filter capability for showing resource gauges widget
`wf_cpanel_widget_capability` (default: `manage_options`)
## Debug setting
For extra debug information, add this line to your `wp-config.php` or in another plugin:
`const WF_DEBUG = true;`
## Known limitations
- Links to documentation to resolve reported issues are shown to PRO ISP AS customers only.
- This plugin will probably not report much if the site is not on a cPanel® managed server, but will do the test for HTTPS only.
- Resource gauges in dashboard widget suffers interference from [Site Kit](https://wordpress.org/plugins/google-site-kit/) plugin by Google. Gauges not shown.
== Frequently Asked Questions ==
= Does this plugin add database tables, store options or adding lines to `wp-config.php`? =
No, not, none.
= Does it require my login information to cPanel®? =
No.
= What if I don't want the (new) cPanel® Resource Usage widget (gauges)?
Close it with the up arrow icon, or hide it using Screen Options (the top right hidden panel) - as usual. No data will be fetched from cPanel® while widget is closed or hidden.
= Does it work on other web hosts than PRO ISP? =
Yes, at least on some, but not tested much. Please report your experience. Use Reviews, Support or GitHub.
= Does it work without cPanel®? =
Very, very limited. The 'HTTPS only' security test should work, and disk used info, but max space test will not be performed and the result will just show 'N/A'.
= Can I contribute to this plugin? =
Yes, visit it's [Github repo](https://github.com/Nettvendt/wf-cpanel-right-now-site-health) and create an issue, clone it and/or file a pull request.
== Screenshots ==
1. Dashboard - At a Glance widget
2. Site Health Disk Space Test
3. Site Health Email Routing Test
4. Site Health HTTPS only test
5. Dashboard - Resource usage & errors widget
== Changelog ==
= 2.8 =
- Add PHP Fatal errors count to gauges widget and in Site Health Info
= 2.7 =
- Oct 19, 2021
- Add PHP Error/Debug Log File Size to Site Health Info
- Expired transients cleanup
- Add <code>WP_CONTENT_URL</code> to Site Health Info WordPress Constants
- Add <code>FORCE_SSL_ADMIN</code> to Site Health Info WordPress Constants
- Restructured code with simpler translations
- Integrated with Query Monitor plugin
- Files & classes renaming
= 2.6 =
- Add subaccounts info to Site Health Info tab
- Add disk i/o gauge in Dashboard Resources widget
= 2.5.1 =
- Typos fix
= 2.5 =
- Translatable gauge labels
- Server errors count in Dashboard Resource Usage & Server Errors widget
- Two new constants i Site Health Info WordPress Constants section
- Server errors in Site Health Info Server section
= 2.4.6 =
- Make sure no errors from gethostbyaddr() when no <code>SERVER_ADDR</code> (cron, CLI)
= 2.4.4 =
- Make resource gauges responsive to current widget width
= 2.4.1 =
- Added cPanel® user last modified to Site Health Info
= 2.4 =
- Added Server error test and log
- Better security for getting resources from JavaScript (generated token as a secret)
= 2.3.5 =
- Detect interference with Google Site Kit plugin
= 2.3.3 =
- Fix for some sites not showing gauges due to referrer policy
= 2.3.1 =
- Fix for PHP 8
= 2.3 =
* Added gauges in new widget on dashboard to show resource usage (Memory, CPU and Processes)
= 2.2.1 =
- Translation fixes
= 2.2 =
- Less strict cPanel® features check on load
- Add dead domains to Site Health Info tab
- Count addon, parked and dead domains as label suffix
- Include main email account in email account count in Dashboard - At a Glance widget
- More translation contexts
= 2.1 =
- Add Site Health cPanel® Info tab main account disk usage
- Add Site Health cPanel® Info tab maximum emails sending frequency per hour
- Add cPanel® version info in Site Health Info tab
- Tidy up Site Health for cPanel® entries in Info tab
- Reorder, and make more logically hierarchical, Site Health for cPanel® Info tab
- Remove Site Health cPanel® forwarders in Info tab (install my other plugin 'WebFacing – Email Accounts in cPanel®' to list them)
- Better handling of IDN domains where overlooked
- A few extra, useful WordPress constants in Site Health Info tab, but removed WP_ENVIRONMENT_TYPE as redundant
- Recommending my other plugin 'WebFacing – Email Accounts in cPanel®' in Dashboard - At a glance widget
= 2.0.1 =
- Fixed a bug (oversight) in 2.0 that alerted about email routing in the case that the MX-record points to self. In that case, no worry.
= 2.0 =
- Email accounts number (and size as tooltip) in Dashboard Right Now widget
- New test for Email Routing under Site Health Status tab
- More constants under WordPress Constants in Site Health Info tab
- A lot more information in cPanel® & Disk Usage in Site Health Info tab
= 1.6.2 =
- Fix for fatal error when undefined constant in PHP 7.4
= 1.6.1 =
- Urgent: Safeguard against PHP fatal errors when installed on a site not using cPanel®
= 1.6 =
- March 11, 2021
- In case on PRO ISP AS: Added link to PRO ISP's support article for enabling HTTPS in cPanel® in Site Health - Status - Security
- Database disk space shown in Dashboard widget tooltip
- A few more useful constants in Site Health - Info - WordPress Constants
- Correct language neutral values in Site Health - Info for debug copy results
- Some minor translation fixes
= 1.5.3 =
- Bugfix: Database disk space was counted twice, leading to too high value for total disk space used
= 1.5.2 =
- Added Database disk usage to Site Health Info tab
= 1.5 =
- Partly rewritten to use more cPanel® <code>uapi</code> calls
- Removed cPanel® <code>Quota</code> calls
- Introducing some cPanel® Usage Statistics parametres, like CPU Usage and number of Entry Processes, in Site Health Info tab
- Better caching of values in short lived transients
- Added <code>DISALLOW_FILE_EDIT</code> to Site Health Info WordPress Constants
= 1.4.1 =
- Added detection for Enterprise hosting packages at PRO ISP.
- Spelling error for Pro Premium package.
- Tested for WP 5.6
- Some minor text changes in ´readme.txt´.
- Some old code cleanup.
= 1.3 =
- Get disk used also when not on cPanel®.
= 1.2 =
Switched to new `quota` command on cPanel® for disk space max & used. Thanks to [@proisp](https://profiles.wordpress.org/proisp/) for implementing it.
= 1.1 =
- Cap check for showing cPanel® username in At a Glance.
= 1.0 =
- Initial release, Sep 2020.