forked from rtCamp/nginx-helper
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
374 lines (245 loc) · 15 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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
=== Nginx Helper ===
Contributors: rtcamp, rahul286, saurabhshukla, manishsongirkar36, faishal, desaiuditd, darren-slatten, jk3us, daankortenbach, telofy, pjv, llonchj, jinnko, weskoop, bcole808, gungeekatx, rohanveer, chandrapatel, gagan0123, ravanh, michaelbeil, samedwards, niwreg, entr, nuvoPoint, iam404, rittesh.patel, vishalkakadiya, BhargavBhandari90, vincent-lu, murrayjbrown, bryant1410, 1gor, matt-h, pySilver, johan-chassaing, dotsam, sanketio, petenelson, nathanielks, rigagoogoo, dslatten, jinschoi, kelin1003, vaishuagola27, rahulsprajapati, Joel-James, utkarshpatel
Donate Link: http://rtcamp.com/donate/
Tags: nginx, cache, purge, nginx map, nginx cache, maps, fastcgi, proxy, redis, redis-cache, rewrite, permalinks
License: GPLv2 or later (of-course)
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Requires at least: 3.0
Tested up to: 4.9.8
Stable tag: 2.0.1
Cleans nginx's fastcgi/proxy cache or redis-cache whenever a post is edited/published. Also does a few more things.
== Description ==
1. Removes `index.php` from permalinks when using WordPress with nginx.
1. Adds support for purging redis-cache when used as full-page cache created using [nginx-srcache-module](https://github.com/openresty/srcache-nginx-module#caching-with-redis)
1. Adds support for nginx fastcgi_cache_purge & proxy_cache_purge directive from [module](https://github.com/FRiCKLE/ngx_cache_purge "ngx_cache_purge module"). Provides settings so you can customize purging rules.
1. Adds support for nginx `map{..}` on a WordPress-multisite network installation. Using it, Nginx can serve PHP file uploads even if PHP/MySQL crashes. Please check the tutorial list below for related Nginx configurations.
= Tutorials =
You will need to follow one or more tutorials below to get desired functionality:
* [Nginx Map + WordPress-Multisite + Static Files Handling](https://easyengine.io/wordpress-nginx/tutorials/multisite/static-files-handling/)
* [Nginx + WordPress + fastcgi_purge_cache](https://easyengine.io/wordpress-nginx/tutorials/single-site/fastcgi-cache-with-purging/)
* [Nginx + WordPress-Multisite (Subdirectories) + fastcgi_purge_cache](https://easyengine.io/wordpress-nginx/tutorials/multisite/subdirectories/fastcgi-cache-with-purging/)
* [Nginx + WordPress-Multisite (Subdomains/domain-mapping) + fastcgi_purge_cache](https://easyengine.io/wordpress-nginx/tutorials/multisite/subdomains/fastcgi-cache-with-purging/)
* [Other WordPress-Nginx Tutorials](https://easyengine.io/wordpress-nginx/tutorials/)
== Installation ==
Automatic Installation
1. Log in to your WordPress admin panel, navigate to the Plugins menu and click Add New.
1. In the search field type “Nginx Helper” and click Search Plugins. From the search results, pick Nginx Helper and click Install Now. Wordpress will ask you to confirm to complete the installation.
Manual Installation
1. Extract the zip file.
1. Upload them to `/wp-content/plugins/` directory on your WordPress installation.
1. Then activate the Plugin from Plugins page.
For proper configuration, check out our **tutorial list** in the [Description tab](http://wordpress.org/extend/plugins/nginx-helper).
== Frequently Asked Questions ==
**Important** - Please refer to [https://easyengine.io/nginx-helper/faq](https://easyengine.io/nginx-helper/faq) for up-to-date FAQs.
= FAQ - Installation/Comptability =
**Q. Will this work out of the box?**
No. You need to make some changes at the Nginx end. Please check our [tutorial list](https://easyengine.io/wordpress-nginx/tutorials/).
= FAQ - Nginx Fastcgi Cache Purge =
**Q. There's a 'purge all' button? Does it purge the whole site?**
Yes, it does. It physically empties the cache directory. It is set by default to `/var/run/nginx-cache/`.
If your cache directory is different, you can override this in your wp-config.php by adding
`define('RT_WP_NGINX_HELPER_CACHE_PATH','/var/run/nginx-cache/');`
Replace the path with your own.
**Q. Does it work for custom posts and taxonomies?**
Yes. It handles all post-types the same way.
**Q. How do I know my Nginx config is correct for fastcgi purging?**
Manually purging any page from the cache, by following instructions in the previous answer.
Version 1.3.4 onwards, Nginx Helper adds a comment at the end of the HTML source ('view source' in your favourite browser):
`<!--Cached using Nginx-Helper on 2012-10-08 07:01:45. It took 42 queries executed in 0.280 seconds.-->`. This shows the time when the page was last cached. This date/time will be reset whenever this page is purged and refreshed in the cache. Just check this comment before and after a manual purge.
As long as you don't purge the page (or make changes that purge it from the cache), the timestamp will remain as is, even if you keep refreshing the page. This means the page was served from the cache and it's working!
The rest shows you the database queries and time saved on loading this page. (This would have been the additional resource load, if you weren't using fast-cgi-cache.)
**Q. I need to flush a cached page immediately! How do I do that?**
Nginx helper plugin handles usual scenarios, when a page in the cache will need purging. For example, when a post is edited or a comment is approved on a post.
To purge a page immediately, follow these instructions:
* Let's say we have a page at the following domain: http://yoursite.com/about.
* Between the domain name and the rest of the URL, insert '/purge/'.
* So, in the above example, the purge URL will be http://yoursite.com/purge/about.
* Just open this in a browser and the page will be purged instantly.
* Needless to say, this won't work, if you have a page or taxonomy called 'purge'.
= FAQ - Nginx Redis Cache =
**Q. Can I override the redis hostname, port and prefix?**
Yes, you can force override the redis hostname, port or prefix by defining constant in wp-config.php. For example:
```
define('RT_WP_NGINX_HELPER_REDIS_HOSTNAME', '10.0.0.1');
define('RT_WP_NGINX_HELPER_REDIS_PORT', '6000');
define('RT_WP_NGINX_HELPER_REDIS_PREFIX', 'page-cache:');
```
= FAQ - Nginx Map =
**Q. My multisite already uses `WPMU_ACCEL_REDIRECT`. Do I still need Nginx Map?**
Definitely. `WPMU_ACCEL_REDIRECT` reduces the load on PHP, but it still ask WordPress i.e. PHP/MySQL to do some work for static files e.g. images in your post. Nginx map lets nginx handle files on its own bypassing wordpress which gives you much better performance without using a CDN.
**Q. I am using X plugin. Will it work on Nginx?**
Most likely yes. A wordpress plugin, if not using explicitly any Apache-only mod, should work on Nginx. Some plugin may need some extra work.
= Still need help! =
Please post your problem in [our free support forum](http://community.rtcamp.com/c/wordpress-nginx).
== Screenshots ==
1. Nginx plugin settings
2. Remaining settings
== Changelog ==
= 2.0.1 =
* Fix settings url for multisite: use network_admin_url to get network correct settings url. [#163](https://github.com/rtCamp/nginx-helper/pull/163) - by [Joel-James](https://github.com/Joel-James)
* Fix php error with arbitrary statement in empty - Prior to PHP 5.5. [#165](https://github.com/rtCamp/nginx-helper/pull/165) - by [PatelUtkarsh](https://github.com/PatelUtkarsh)
= 2.0.0 =
* Fix typo causing failure to purge on trashed comment. [#159](https://github.com/rtCamp/nginx-helper/pull/159) - by [jinschoi](https://github.com/jinschoi)
* Refactor Plugin structure and remove unused code. Initial code by [chandrapatel](https://github.com/chandrapatel), [#153](https://github.com/rtCamp/nginx-helper/pull/153) - by [jinschoi](https://github.com/kelin1003),
* Run phpcs and fix warning. [#158](https://github.com/rtCamp/nginx-helper/pull/158)
* Make compatible with EasyEngine v4.
= 1.9.12 =
* Allow override Redis host/port/prefix by defining constant in wp-config.php [#152](https://github.com/rtCamp/nginx-helper/pull/152) - by [vincent-lu](https://github.com/vincent-lu)
= 1.9.11 =
* Fixed issue where permalinks without trailing slash does not purging [#124](https://github.com/rtCamp/nginx-helper/issues/124) - by Patrick
* Check whether role exist or not before removing capability. [#134](https://github.com/rtCamp/nginx-helper/pull/134) - by [1gor](https://github.com/1gor)
= 1.9.10 =
* Fixed issue where Nginx cache folders deleted on purge. [#123](https://github.com/rtCamp/nginx-helper/pull/123) - by [johan-chassaing](https://github.com/johan-chassaing)
* Fixed Redis purge all feature for installation where WordPress lives in a separate folder. [#130](https://github.com/rtCamp/nginx-helper/pull/130) - by [pySilver](https://github.com/pySilver)
= 1.9.9 =
* Fix wp_redirect issue. [#131](https://github.com/rtCamp/nginx-helper/pull/131) - by [matt-h](https://github.com/matt-h)
= 1.9.8 =
* Fixed homepage cache cleared when WPML plugin used [#116](https://github.com/rtCamp/nginx-helper/pull/116) - by [Niwreg](https://profiles.wordpress.org/niwreg/)
* Fixed Purge Cache clears the whole Redis cache [#113](https://github.com/rtCamp/nginx-helper/issues/113) - by HansVanEijsden
* One log file for all site in WPMU.
* Single site Redis cache purge when click on Purge Cache button in WPMU [#122](https://github.com/rtCamp/nginx-helper/pull/122) - by Lars Støttrup Nielsen
* Fixed notices and warnings.
= 1.9.7 =
* Remove timestamp if cron or wp-cli [#114](https://github.com/rtCamp/nginx-helper/pull/114) - by [samedwards](https://profiles.wordpress.org/samedwards/)
* Fixed notices and warnings.
= 1.9.6 =
* Fixed cache purging on post publish.
* Error fixed when redis server not installed.
= 1.9.5 =
Added custom purge URL option.
= 1.9.4 =
* Added redis server connection timeout.
* Added RedisException handling.
= 1.9.3 =
* Added PhpRedis API support.
* Added redis-lua script support to purge complete cache very fast.
* Added composer.json support
* Fixed cache purging link in admin bar.
* Updated the initial settings to include the 'purge_method' [#99](https://github.com/rtCamp/nginx-helper/pull/99) - by
[gagan0123](https://github.com/gagan0123)
= 1.9.2 =
Fix purging for Redis cache and FastCGI cache
= 1.9.1 =
Fix purging for custom post types
= 1.9 =
Added Redis cache purge support.
= 1.8.13 =
Fixed PHP notice for an undefined index when "Enable Logging" is not set.
= 1.8.12 =
Updated readme and changelog
= 1.8.11 =
Fix url escaping [#82](https://github.com/rtCamp/nginx-helper/pull/82) - by
[javisperez](https://github.com/javisperez)
= 1.8.10 =
* Security bug fix
= 1.8.9 =
* Default setting fix and wp-cli example correction - by [bcole808](https://profiles.wordpress.org/bcole808/)
= 1.8.8 =
* Added option to purge cache without nginx purge module - by [bcole808](https://profiles.wordpress.org/bcole808/)
= 1.8.7 =
* Added action `rt_nginx_helper_purge_all` to purge cache from other plugins - by [gungeekatx](https://profiles.wordpress.org/gungeekatx/)
= 1.8.6 =
* Removed wercker.yml from plugin zip/svn.
* Updated readme
= 1.8.5 =
* Added WP_CLI support - by [Udit Desai](https://profiles.wordpress.org/desaiuditd/)
= 1.8.4 =
* Fix undefined index issue and correct "purge_archive_on_del" key
= 1.8.3 =
* Tested with WordPress 4.0
* Fix issue #69
= 1.8.1 =
* Tested with wordpress 3.9.1
* Fix confilct with Mailchimp's Social plugin
= 1.8 =
* New admin UI
* Fix missing wp_sanitize_redirect function call
= 1.7.6 =
* Update Backend UI
* Added Language Support
= 1.7.5 =
* Fixed option name mismatch issue to purge homepage on delete.
= 1.7.4 =
* Disable purge and stamp by default.
= 1.7.3 =
* Suppressed `unlink` related error-messages which can be safely ignored.
* Fixed a bug in purge-all option.
= 1.7.2 =
* [pjv](http://profiles.wordpress.org/pjv/) fixed bug in logging file.
= 1.7.1 =
* Fixes bug in true purge and admin screen.
= 1.7 =
* True full cache purge added.
* Map file location changed to uploads' directory to fix http://rtcamp.com/support/topic/plugin-update-removes-map-file/
* Log file location also changed to uploads' directory.
= 1.6.13 =
* [pjv](http://profiles.wordpress.org/pjv/) changed the way home URL is accessed. Instead of site option, the plugin now uses home_URL() function.
= 1.6.12 =
* [telofy](http://wordpress.org/support/profile/telofy) added purging of atom and RDF feeds.
= 1.6.11 =
* Removed comments from Admin screens since, it was interfering with media uploads in 3.5 up.
= 1.6.10 =
* Cleaned up code.
* Added credits for code.
* Improved attachment purging.
= 1.6.9 =
* Added Faux to Purge all buttons, to avoid misleading users.
= 1.6.8 =
* [daankortenbach](http://profiles.wordpress.org/daankortenbach) added Purge Cache link to wp-admin bar
= 1.6.7 =
* [jk3us](http://profiles.wordpress.org/jk3us) added better content-type detection for cache verification comments
= 1.6.6 =
* [darren-slatten](http://profiles.wordpress.org/darren-slatten/) added Manual 'Purge all URLs' functionality
= 1.6.5 =
* Fixed typo that interfered with archive purge settings. Thanks to [Daan Kortenbach](http://profiles.wordpress.org/daankortenbach/) for pointing this out.
= 1.6.4 =
* Improved code for map generation to better conventions since the nesting confused some servers.
* Added map update process to admin_init for frequent refreshes.
= 1.6.3 =
* Fixed duplicate entries.
= 1.6.2 =
* Another bug fix in the revised code for improved multisite and multidomain mapping.
= 1.6.1 =
* Fixed bug in the revised code for improved multisite and multidomain mapping.
= 1.6 =
* Revised code for improved multisite and multidomain mapping.
= 1.5 =
* Timestamp now only gets added to content-type text/html
* Added option to toggle timestamp creation
= 1.4 =
* Fixed bug related to nomenclature of comment status that caused purge to fail.
= 1.3.9 =
* Removed extraneous headers.
= 1.3.8 =
* Fixed bug in single post/page/post-type purging code. Thanks to Greg for pointing this out here: http://rtcamp.com/support/topic/updating-post-nginx-helper-purge-cache-post/.
= 1.3.7 =
* Changed the action hook, back to 'shutdown' from 'wp_footer' to add verification comments.
* Added a check to prevent adding comments to ajax requests,
= 1.3.6 =
* Changed the action hook, from 'shutdown' to 'wp_footer' to add verification comments. This was interfering with other plugins.
= 1.3.5 =
* Improved Readme.
* Improved cache verification comments.
= 1.3.4 =
* Fixed duplicate entries generated for maps (Harmless, but doesn't look good!)
* Added timestamp html comments for cache verification, as described here: http://rtcamp.com/wordpress-nginx/tutorials/checklist/
= 1.3.3 =
* Fixed map generation for multi domain installs using domain mapping plugin, where blog ids were not displayed.
= 1.3.2 =
* Fixed map generation for multi domain installs with domain mapping plugin.
= 1.3.1 =
* Minor fixes for directory structure and file names.
= 1.3 =
* Improved Readme.
= 1.2 =
* Fixed map generation error.
* Fixed purging logic.
* Fixed UI where purge settings were lost on disabling and re-enabling purge.
* Minor Ui rearrangement.
= 1.1 =
* Improved readme.txt. Added Screenshots.
= 1.0 =
* First release
== Upgrade Notice ==
= 1.9.12 =
* Allow override Redis host/port/prefix by defining constant in wp-config.php [#152](https://github.com/rtCamp/nginx-helper/pull/152) - by [vincent-lu](https://github.com/vincent-lu)