forked from cloudflare/Cloudflare-WordPress
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
365 lines (218 loc) · 11.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
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
=== Cloudflare ===
Contributors: icyapril, manatarms, thillcf, deuill, epatryk, jacobbednarz
Tags: cloudflare, seo, ssl, ddos, speed, security, cdn, performance, free
Requires at least: 3.4
Tested up to: 5.5.1
Stable tag: 4.0.0
Requires PHP: 7.2
License: BSD-3-Clause
All of Cloudflare’s performance and security benefits in a simple one-click install.
== Description ==
= What this plugin can do for you =
**Automatic Platform Optimization (APO)**
Take your WordPress site's performance to the next level with Automatic Platform Optimizations (APO). APO allows Cloudflare to serve your entire WordPress site from its edge network ensuring consistent, fast performance for visitors no matter where they are. Find out more in our [announcement blog](https://blog.cloudflare.com/automatic-platform-optimizations-starting-with-wordpress/).
**One-click WordPress-optimized settings**
The easiest way to setup Cloudflare for your WordPress site. Let us configure Cloudflare with the tried and true settings for an optimal experience.
**Web application firewall (WAF) rulesets**
Available on all of Cloudflare’s [paid plans](https://www.cloudflare.com/plans/), the WAF has built-in rulesets, including rules specifically tailored to mitigate WordPress threats and vulnerabilities. These security rules are always kept up-to-date, once the WAF is enabled, you can rest easy knowing your site is protected from even the latest threats.
**Automatic cache purge on website updates**
If you don't take advantage of the performance benefits of Automatic Platform Optimization for WordPress, using the Cloudflare plugin still ensures that changes to the appearance of your website purge the cache. This means that you can focus on your website, while we ensure that the latest static content is always available to your visitors.
Additionally, Cloudflare’s plugin for WordPress automatically refreshes the Cloudflare cache of static content for each post/page/custom post type when you update the content.
= Additional features =
* Header rewrite to prevent a redirect loop when Cloudflare’s Universal SSL is enabled
* Change Cloudflare settings from within the plugin itself without needing to navigate to the cloudflare.com dashboard. You can change settings for cache purge, security level, Always Online, and image optimization
* View analytics such as total visitors, bandwidth saved, and threats blocked
* Support for [HTTP2/Server Push](https://blog.cloudflare.com/announcing-support-for-http-2-server-push-2/)
== Installation ==
= Prerequisite =
Make sure your PHP version is 7.2 or higher.
= From your WordPress Dashboard =
1. Visit “Plugins” → Add New
2. Search for Cloudflare
3. Activate Cloudflare from your Plugins page.
= From WordPress.org =
1. Download Cloudflare
2. Upload the “cloudflare” directory to your “/wp-content/plugins/” directory, using ftp, sftp, scp etc.
3. Activate Cloudflare from your Plugins page.
= Once Activated =
1. Go to https://dash.cloudflare.com
2. Login with your cloudflare account. If you don’t have a Cloudflare account, first sign up for Cloudflare.
3. Navigate to the [API Tokens section](https://dash.cloudflare.com/profile/api-tokens) of the user profile (found in the top right corner of the dashboard).
4. Select 'Create Token'
5. Select the 'WordPress' Template
6. Select the Account and Zone to grant the plugin access to
7. Then select "Continue to Summary" and "Create Token"
8. Copy your API Token
9. Return back to WordPress Cloudflare Plugin page
10. Enter your email address and paste your API Token
11. Press Login.
== Frequently Asked Questions ==
= Do I need a Cloudflare account to use the plugin? =
Yes, on install and activation of the plugin, first time users will be asked to enter their email address (used to sign-up for an account at cloudflare.com) and either an API Token or their API key. This is needed to support all the features offered by the plugin.
= What settings are applied when I click "Apply Default Settings" in Cloudflare's WordPress plugin? =
You can review the recommended settings that are applied [here](https://support.cloudflare.com/hc/en-us/articles/227342487).
= Does the plugin work if I have Varnish enabled? =
Yes, Cloudflare works with, and helps speed up your site even more, if you have Varnish enabled.
== Screenshots ==
== Changelog ==
= 4.0.0 - 2021-02-09 =
* Drop support for PHP 5.6, 7.0 and 7.1
= 3.8.10 - 2021-01-29 =
* Add Jacob to maintainers list
= 3.8.9 - 2021-01-14 =
* Revert Add pagination purging
= 3.8.8 - 2021-01-13 =
* Add pagination purging
= 3.8.7 - 2020-12-07 =
* Purge taxonomy feed URLs
* Fix changing APO settings (cf, wordpress, plugin) when running on subdomain
* Fix setting hostname override
= 3.8.6 - 2020-11-19 =
* Add subdomain support for APO card
= 3.8.5 - 2020-10-15 =
* Added automatic purge cache on new comment
= 3.8.4 - 2020-10-13 =
* Added composer's type=wordpress-plugin for Bedrock users
* Fixed typo in readme.txt
* Fix modify header exception thrown during wp-cron
1. Cloudflare Plugin
== Changelog ==
= 3.8.3 - 2020-10-05 =
* Fixed setting all APO values properly for correct dashboard rendering
= 3.8.2 - 2020-10-02 =
* re-relase broken version, no changes
= 3.8.1 - 2020-10-02 =
* Fixed typo in config.js(on) that resulted in warning [#292](https://github.com/cloudflare/Cloudflare-WordPress/pull/292)
* Check for array indicies are set before using [#278](https://github.com/cloudflare/Cloudflare-WordPress/pull/278)
= 3.8.0 - 2020-10-01 =
* Added APO support
* Renamed Automatic Cache Management card to Auto Purge Content On Update
= 3.7.0 - 2020-09-25 =
* Bump cloudflare-plugin-backend v2.3.0 and cloudflare-plugin-frontend v3.1.0 [#283](https://github.com/cloudflare/Cloudflare-WordPress/pull/283)
= 3.6.0 - 2020-09-17 =
* Bump cloudflare-plugin-backend [#276](https://github.com/cloudflare/Cloudflare-WordPress/pull/276)
= 3.5.1 - 2020-07-02 =
*Fixed*
* Fixed Cache Purges failing [#266](https://github.com/cloudflare/Cloudflare-WordPress/issues/266)
= 3.5.0 - 2020-06-26 =
*Fixed*
* Disable HTTP/2 Push on wp-admin pages [#214](https://github.com/cloudflare/Cloudflare-WordPress/pull/214)
* Fix PHP 7.4 notice [#256](https://github.com/cloudflare/Cloudflare-WordPress/pull/256)
*Added*
* Purge attachment URLs [#208](https://github.com/cloudflare/Cloudflare-WordPress/pull/208)
* Purge URLs on page/post update [#206](https://github.com/cloudflare/Cloudflare-WordPress/pull/206)
* Turn on IPv6 by default [#229](https://github.com/cloudflare/Cloudflare-WordPress/pull/229)
* Add constants for better control HTTP/2 Server Push [#213](https://github.com/cloudflare/Cloudflare-WordPress/pull/213)
* Allow custom actions for purge url and purge everything actions [#212](https://github.com/cloudflare/Cloudflare-WordPress/pull/212)
= 3.4.1 - 2019-08-29 =
*Fixed*
* Updated list of contributors.
* Updated tested WordPress version to latest (5.2.2).
= 3.4.0 - 2019-08-29 =
*Added*
* Added support for API Token authentication.
= 3.3.2 - 2017-12-12 =
*Fixed*
* Bug in cf-ip-rewrite
*Added*
* Added a new filter cloudflare_purge_by_url allowing users to have better control on automatically purged urls.
= 3.3.1 - 2017-6-29 =
*Fixed*
* Potential bug by using $_GET.
= 3.3.0 - 2017-6-29 =
*Added*
* Added a new Splash Screen
* Added userConfig.js file allowing custom configurations.
* Added logs in debug mode for Automatic Cache Purge.
* Added logs for oversized Server Push HTTP headers.
*Changed*
* Automatic Cache Purge now purges Autoptimize by everything rather than by URL.
* Updated IP Ranges
*Fixed*
* Bug where domains which had capital letters not working.
* Bug where Automatic Cache Purge couldn't purge front page.
* Bug related to work with IWP.
* Bug where if PHP is compiled with ipv6-disable flag, it crashed the site.
= 3.2.1 - 2017-3-14 =
*Fixed*
* Bug where accounts which had more than 20 zones would not show up correctly.
= 3.2.0 - 2017-3-1 =
*Added*
* Bypass Cache By Cookie functionality.
* HTTP/2 Server Push functionality (disabled by default).
*Changed*
* Lowered the plugin size.
* Automatic Cache Management feature includes purging taxonomies.
* Automatic Cache Management feature supports sites which use both HTTP and HTTPS.
*Fixed*
* Admin bar disappearing from the plugin.
* Bug where spinner was loading forever.
* Bug where the backend errors where not being shown in the frontend.
* Issues where IE11 was not working properly.
= 3.1.1 - 2016-11-17 =
*Changed*
* Moved Admin Bar behind Automatic Cache Purge toggle.
= 3.1.0 - 2016-11-17 =
*Added*
* Added ability to automatically purge cache when a post is published, edited or deleted. (Thanks to brandomeniconi and mike503)
* Added ability to work with WordPress MU Domain Mapping plugin. (Thanks to brandomeniconi)
*Changed*
* Changed the UI to look more like cloudflare.com dashboard.
* Changed plugin description.
* Disabled showing WordPress Admin Bar and Edit Post Link to avoid caching problems for users using HTML Caching.
*Fixed*
* Fixed bug where require vendor folders was not working.
* Fixed bug where static files were cached which caused issues updating the plugin.
* Fixed dependencies which caused issues with PHP Compatibility Checker plugin.
= 3.0.6 - 2016-10-6 =
*Added*
* Added ability to toggle Development Mode.
*Fixed*
* Fixed bug where active zone dropdown was not working properly.
*Changed*
* Compressed resources to lower plugin size.
* Updated Cloudflare logo.
= 3.0.5 - 2016-09-28 =
*Fixed*
* Fixed bug where refactored Flexible SSL fix was causing the settings page hook not to load.
= 3.0.4 - 2016-09-27 =
*Added*
* Ability for users to toggle Automatic HTTPS Rewrites (enabled by default, solves for most mixed content errors).
*Fixed*
* Fixed an issue where low PHP version where getting syntax error.
* Fixed issue where some users using Flexible SSL where not able to login to wp-admin .
* Fixed a bug where the active zone selector was not paginating through the whole zone list.
* Fixed an issue where the setting for Image Optimization was being displayed incorrectly.
* Fixed a bug in Analytics where the Uniques Visitors data was not displaying accurately.
*Changed*
* Compressed assets to lower plugin size.
* Hooks loading logic refactored to make it more simple and readable.
= 3.0.3 - 2016-09-21 =
*Fixed*
* Fixed an issue where some domains were being incorrectly propagated to the domain selector dropdown
* Fixed an issue where the Web Application Firewall was accidentally triggering RFI Attack Rules
* Fixed an issue where image optimization was not being enabled for Pro and higher Cloudflare plans
= 3.0.2 - 2016-09-16 =
*Fixed*
* Disabled HTTP/2 Server Push which was leading to 520 and 502 errors for some websites.
= 3.0.1 - 2016-09-16 =
*Fixed*
* Fixed HTTP/2 Server Push exceeding the header limit Cloudflare has which caused 520 errors.
* Fixed warning message in HTTP/2 Server Push.
= 3.0.0 - 2016-09-15 =
*Added*
* Added one-click application oft WordPress specific recommended settings
* Added ability to purge the Cloudflare cache
* Integrated with WordPress cache management to automatically clear the Cloudflare cache on updating site appearance
* Added ability to change Cloudflare settings (Always Online mode, I’m Under Attack, Image Optimization, Security Level, Web Application Firewall)
* Added Analytics showing Cached Requests, bandwidth used, unique visitors, threats blocked
* Added Header rewrite to prevent a redirect loop when Cloudflare’s Universal SSL is enabled
* Added HTTP/2 Server Push support
* Added Support for PHP 5.3+
*Removed*
* Removed HTTPS Protocol Rewriting
* Removed submission of spam comments
* Removed ability to toggle Development Mode On/Off
*Changed*
* Updated user interface
* Started to support WordPress 3.4+ instead of 2.8+ because we depend on the [WordPress Options API](https://codex.wordpress.org/Options_API)