-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
readme.txt
137 lines (92 loc) · 4.7 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
=== Hestia Nginx Cache ===
Contributors: jakobbouchard, jaapmarcus
Donate link: https://github.com/sponsors/jakobbouchard
Tags: cache, flush, purge, hestia, nginx
Requires at least: 4.8
Tested up to: 6.6
Requires PHP: 5.4
Stable tag: 2.4.0
License: GPL v3
License URI: http://www.gnu.org/licenses/gpl-3.0.txt
Purged the Nginx cache automatically after making website changes. Uses the *new* HestiaCP API, released in 1.6.0.
== Description ==
**Important**: Hestia 1.6.12 fixes an issue where purging the cache could make the website unavailable, resulting in a 502 error. If you aren't using this version, please upgrade!
This plugin automatically purges the Nginx cache after you make a website change such as updating a post or changing your theme.
You also have the ability to manually purge the cache using a button in the WordPress admin bar.
== Installation ==
Manage your Hestia cache in a better way by using these steps to install the plugin.
= Installing and activating the plugin =
1. Install Hestia Nginx Cache automatically or by uploading the ZIP file.
2. Activate the plugin through the *Plugins* menu in WordPress.
= Getting API access =
If you are not the server administrator, you can skip this step.
1. Login as the system administrator account and navigate to the server configuration page.
2. Enable API access for all users in the Security > System section.
3. In the "Allowed IP addresses for API" box, enter both `127.0.0.1` and your server's public IP.
= Generating an Access key =
1. Log in as your regular user in the Hestia Control Panel and navigate to your user settings.
2. Click on the "Access Key" button, and create a new access key with the `purge-nginx-cache` permission. *Make sure to save the Secret key, as you will only see it once.*
If you do not see the "Access Key" button, it means that the feature is disabled on the server. If you are the administrator, refer to the previous section to enable it. If not, contact your server administrator so that they can enable the API access.
= Configuring the plugin =
1. Navigate to the plugin's settings in the Settings submenu in the sidebar.
2. Enter the Access key and Secret key from the previous section in the appropriate boxes.
3. For the hostname, use the HestiaCP same hostname you use to connect to the control panel. Same thing for the port.
4. For the username, enter the username that is owner of the domain name you are trying to clear.
== Frequently Asked Questions ==
= How do I generate an Access key? =
Refer to the Installation tab for information on how to configure the plugin.
= Can I manually purge the cache using the plugin? =
Yes, you can. Once the plugin is installed and activated, you will see a "Purge Nginx Cache" button in the admin bar.
= I am experiencing issues with the plugin. What do I do? =
You can try to resolve the problem by purging the cache, deactivating the plugin, or disabling Nginx caching in Hestia.
If you are using Cloudflare and get an error when purging the cache, enter the hostname of the Hestia install in the settings, not the site URL.
If your issues persist, do not hesitate to contact me via email!
== Changelog ==
= 2.4.0 =
* Add WP CLI support.
= 2.3.0 =
* Add an option to disable automatic purging.
= 2.2.5 =
* Fix a dumb issue with the new JavaScript.
= 2.2.4 =
* Fix the purge button not working in the frontend.
* Add notice when purging in the frontend.
* Add translations for "pt_BR" and "fr_CA".
= 2.2.3 =
* Fix some PHP warnings.
= 2.2.2 =
* Fix issue where a warning could exist if an option wasn't defined.
= 2.2.1 =
* Make sure the nonce is always hidden.
= 2.2.0 =
* Show button on the frontend when logged in.
= 2.1.4 =
* Fix domain field in admin
* Increase response timeout, in case the server is slow
* Remove SSL verification, in case your HestiaCP serves a self-signed certificate
= 2.1.3 =
* Fixed PHP 8.1 compatibility
= 2.1.2 =
* Fixed require at least "Can edit posts" permission to reset cache
= 2.1.0 =
* Add a setting to disable the admin bar button.
* Add a setting to change the admin bar button's text.
* Add a purge cache button in the settings page.
* Add a section to site health with the plugin's info.
= 2.0.0 =
* Add support for the new Hestia API, released in 1.6.0.
* Add settings link in the plugins list.
* Remove jQuery usage in the admin JS.
* Remove support for the legacy API, as it was quite unsecure for many reasons.
= 1.2.2 =
* Fix automatic purging.
= 1.2.1 =
* Fix error notice not appearing when the cache failed to clear.
= 1.2.0 =
* Fix the admin bar button not working.
* Fix the notice not appearing.
= 1.1.0 =
* Changed the way purges are done, so that they are done only once per post instead of 10+ times.
* Hide password in frontend.
= 1.0.0 =
* Initial release.