forked from elementor/wp2static
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
464 lines (282 loc) · 17.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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
=== WP Static HTML Output ===
Contributors: leonstafford
Donate link: https://www.paypal.me/leonjstafford
Tags: static,html,export,performance,security,cache,s3,dropbox,github,netlify,bunnycdn
Requires at least: 3.2
Tested up to: 4.9.6
Stable tag: 2.7
The optimum solution to speed up and secure your WordPress site - export to static HTML and hide all traces of WordPress from your site!
== Description ==
The optimum solution to speed up and secure your WordPress site - export to static HTML and hide all traces of WordPress from your site!
= Features =
* generates a standalone, static html copy of your whole WordPress website
* removes all traces of WordPress from your exported site
* protects you from malicious attacks/malware
* auto-deploy to a local folder, ZIP file, FTP, S3, Dropbox, GitHub, Netlify or BunnyCDN
* one site to unlimited export targets
* specify extra files to include in the output (ie, dynamically loaded assets)
* desktop notifications alert you to when exports are complete
* multi-language support (English/Japanese currently, Spanish and Chinese in progress)
* schedule unattended exports via the WP Crontrol plugin or by hitting the custom hook
* realtime logs visible during / saved after export
* asynchronous exports for some methods overcomes hosting limitations for large site exports
This plugin produces a static HTML version of your wordpress install, incredibly useful for anyone who would like the publishing power of wordpress but whose webhost doesn't allow dynamic PHP driven sites - such as Dropbox. You can run your development site on a different domain or offline, and the plugin will change all relevant URLs when you publish your site. It's a simple but powerful plugin, and after hitting the publish button, the plugin will output a ZIP file of your entire site, ready to upload straight to it's new home.
= Limitations =
* The nature of a static site implies that any dynamic elements of your wordpress install that reply upon Wordpress plugins or internal functions to operate dynamically will no longer work. Significantly, this means comments. You can workaround this by including a non-Wordpress version of an external comments provider into your theme code, such as the Disqus comment system. Any page elements that rely upon Javascript will function normally.
* inability to correctly capture some relative links in posts
* inability to detect assets dynamically loaded via javascript after page load, these will need to specified separately (but will work)
= Similar plugins =
Having issues with this plugin? I try to support any issues via the official support forum or email, but if you want to try some other plugins for static export, give these a go:
* [Simply Static](https://wordpress.org/plugins/simply-static/)
= Planned upgrades =
* re-write export to relative URLs
* progress meter to show % of .ZIP creation
* selectively export only changed pages since last output
* increase 1-click deployment options
Developed by [**Leon Stafford**](http://leonstafford.github.io). If you have any questions about this plugin's usage, installation or development, please email me at: [[email protected]](mailto:[email protected])
== Installation ==
= via WP Admin panel =
1. Go to Plugins > Add New
2. Search for "WP Static HTML Output"
3. Click on the Install Now button
4. Activate the plugin and find it under the Tools menu
= manual installation =
1. Upload the static-html-output directory to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Access the plugin settings from the "Tools" menu
= via WP CLI =
1. `wp --allow-root plugin install static-html-output-plugin --activate`
== Frequently Asked Questions ==
= Where can I publish my static site to? =
Anywhere that allows HTML files to be uploaded, ie:
* GitHub/GitLab/BitBucket Pages (GitHub API integration now included)
* S3 / CloudFront
* Dropbox
* Any FTP server
* Netlify
= My comments don't work anymore! =
See the readme. In brief: you can't use dynamic WordPress functions such as comments on a static site. Use an external comments provider such as Disqus, or live without them.
== Screenshots ==
1. The main interface
2. The main interface (Japanese)
== Changelog ==
= 2.7 =
* Bugfix: Fixes major issue where a failed first export blocked subsequent ones unless page was refreshed
* Bugfix: Plugin was not respecting the Output Directory Override
= 2.6.4 =
* Improvement: Reduced plugin download size from 4+ MB to about 0.8MB
* Improvement: Streamlined S3 and CloudFront export codes not to require massive AWS SDK
* Improvement: Add check for cURL extension and add more help to system requirements page
* Improvement: Make UI cleaner; place export button above Export Log;call to action on n exports
* Bugfix: Remove message about deleting ZIP when none has been created
= 2.6.3 =
* Bugfix: Reduced plugin download size and fix missing libraries needed for export
= 2.6.2 =
* Improvement: Reduced plugin total ZIP size to allow installation for limited hosts
= 2.6.1 =
* Bugfix: Fix CloudFront Cache Invalidation and update to latest AWS SDK V3.6.13
* Bugfix: allow crawling sites served via SSL / HTTPS
* Bugfix: prevent PHP warnings in error_log for unlink and renaming files - check they exist first
* Bugfix: correctly determine WP root in filesystem
* Improvement: allow FTP active mode, not just passive
* Improvement: add Osaka endpoint for S3
* Improvement: include more information in Export Log to help debug
= 2.6 =
* Feature: Remove all traces of WordPress from your site - improve your SEO/SEM
* Feature: Include all of your uploads folder by default - ensures all files are exported
* Improvement: Streamlined interface for less clutter
* Improvement: Cleanup export folder upon completion - no more filling up your uploads dir
* Improvement: Make ZIP creation an optional step - not everyone needs to create ZIPs!
* Bugfix: Respect custom output folder setting
* Bugfix: Strip query strings from extracted URLs
* Bugfix: Use base uploads dir for export folder - no more digging around for your export folder
= 2.5 =
* Under the hood improvements, increasing stability and performance of the plugin.
= 2.4 =
* Feature: Export to BunnyCDN - a very cheap and quick static site hosting option
* Bugfix: Extracts relative URLs like fonts, background images, etc linked from your theme's CSS files
= 2.3 =
* Feature: Scheduled exports via WP Crontrol
* Bugfix: FTP export now works on shared/limited hosting
* Bugfix: Extracts all URLs when crawling your website's HTML files
* Bugfix: Subsequent exports correctly show realtime progress in log
= 2.2 =
* Bugfix: GitHub export now works on shared/limited hosting
* Feature: Realtime export progress logs
= 2.1 =
* Bugfix: don't hang on failures
* Bugfix: fix option to retain files on server after export
* Feature: 1-click publishing to a Netlify static site
* Feature: view server log on failure
= 2.0 =
Critical bug fixes and a shiny new feature!
* Bugfix: Dropbox export once again working after they killed version 1 of their API
* Bugfix: Amazon S3 publishing fixed after bug introduced in 1.9
* Feature: 1-click publishing to a GitHub Pages static site
Thanks to a user donation for funding the development work to get GitHub Pages exporting added as a new feature. I was also able to merge some recently contributed code from @patrickdk77, fixing the recent issues with AWS S3 and CloudFront. Finally, I couldn't make a new release without fixing the Dropbox export functionality - unbeknowst to me, they had killed version 1 of their API in September, breaking the functionality in this plugin, along with many other apps.
= 1.9 =
* Bugfix: Plugin now works on PHP 5.3
Though this is no longer an officially supported PHP version, many of this plugin's users are running PHP 5.3 or earlier. This fix should once again allow them to use the plugin, which has not been possible for them since about version 1.2. If you are one of these affected users, please now upgrade and enjoy all the new useful features!
= 1.8 =
* Bugfix: improved URL rewriting
Plugin now ensures that formatted versions of your site's URL, ie //mydomain.com or http:\/\/mydomain.com\/ or the https/http equivalent are detected and rewritten to your target Base URL. The rewriting should now also work within CSS and JavaScript files.
= 1.7 =
* Bugfix: index.html contents empty for some users' themes/setups
* Bugfix: remove PHP short open tags for better compatibility
= 1.6 =
* Additional URLs now work again! Much needed bugfix.
= 1.5 =
* bugfix for Dropbox export function not exporting all files
= 1.4 =
* add Dropbox export option
* fix bug some users encountered with 1.3 release
= 1.3 =
* reduce plugin download size
= 1.2.2 =
* supports Amazon Web Service's S3 as an export option
= 1.2.1 =
* unlimited export targets
* desktop notifications alert you when all exports are completed (no more staring at the screen)
= 1.2.0 =
* 1-click generation and exporting to an FTP server
* improved user experience when saving and exporting sites (no more white screen of boredom!)
= 1.1.3 =
* Now able to choose whether to strip unneeded meta tags from generated source code.
* Improved layout for config/export screen.
* Better feedback to user when system requirements are not met
= 1.1.2 =
* Version bump for supporting latest WP (4.7)
= 1.1.1 =
Added Features
* Updated author URL
Removed Features
* Premium options for One-Click publishing to provided hosting and domain
= 1.1.0 =
Added Features
* Premium options for One-Click publishing to provided hosting and domain
= 1.0.9 =
Added Features
* Japanese localization added (ja_UTF)
= 1.0.8 =
Added Features
* long-awaited FTP transfer option integrated with basic functionality
* option to save generated static HTML files on server
= 1.0.7 =
Fixed bug introduced with previous version. Applied following modifications contributed by Brian Coca (https://github.com/bcoca):
Added Features
* zip is now written atomically (write tmp file first, then rename to zip) which now allows polling scripts to only deal with completed zip file.
* username and blog id are now part of the file name. For auditing and handling
multi site exports.
Bug fixes
* . and .. special directory entries are now ignored
* dirname is checked before access avoiding uninitialized warning
= 1.0.6 =
Added shortcut to Settings page with Plugin Action Links
= 1.0.5 =
Added link to relevant Settings page when permalinks structure is not set.
= 1.0.4 =
Added a timeout value to URL request which was breaking for slow sites
= 1.0.3 =
Altered main codebase to fix recursion bug and endless loop. Essential upgrade.
= 1.0.2 =
Initial release to Wordpress community
== Upgrade Notice ==
Critical upgrade - recommended for all users. If you have troubles upgrading, please contact the developer at [email protected] for assistance.
= 2.7 =
* Bugfix: Fixes major issue where a failed first export blocked subsequent ones unless page was refreshed
* Bugfix: Plugin was not respecting the Output Directory Override
= 2.6.4 =
Non-critical update - get some UI and exporting improvements and a minor bug fix
* Improvement: Reduced plugin download size from 4+ MB to about 0.8MB
* Improvement: Streamlined S3 and CloudFront export codes not to require massive AWS SDK
* Improvement: Add check for cURL extension and add more help to system requirements page
* Improvement: Make UI cleaner; place export button above Export Log;call to action on n exports
* Bugfix: Remove message about deleting ZIP when none has been created
= 2.6.3 =
Critical update - fixes issues blocking installation/export for some users.
* Bugfix: Reduced plugin download size and fix missing libraries needed for export
= 2.6.2 =
Important fix for those users trying to upgrade to a recent version of the plugin. The reduced filesize of this version should allow installs where others where failing.
* Improvement: Reduced plugin total ZIP size to allow installation for limited hosts
= 2.6.1 =
Minor release - fixes some minor issues discovered in V2.6, brings some improvements. Recommeneded to upgrade for increased stability with your exports and an easier time troubleshooting when something goes wrong.
* Bugfix: Fix CloudFront Cache Invalidation and update to latest AWS SDK V3.6.13
* Bugfix: allow crawling sites served via SSL / HTTPS
* Bugfix: prevent PHP warnings in error_log for unlink and renaming files - check they exist first
* Bugfix: correctly determine WP root in filesystem
* Improvement: allow FTP active mode, not just passive
* Improvement: add Osaka endpoint for S3
* Improvement: include more information in Export Log to help debug
= 2.6 =
Important upgrade, bringing a killer new feature, nice improvements and important bugfixes:
* Feature: Remove all traces of WordPress from your site - improve your SEO/SEM
* Feature: Include all of your uploads folder by default - ensures all files are exported
* Improvement: Streamlined interface for less clutter
* Improvement: Cleanup export folder upon completion - no more filling up your uploads dir
* Improvement: Make ZIP creation an optional step - not everyone needs to create ZIPs!
* Bugfix: Respect custom output folder setting
* Bugfix: Strip query strings from extracted URLs
* Bugfix: Use base uploads dir for export folder - no more digging around for your export folder
= 2.5 =
* Under the hood improvements, increasing stability and performance of the plugin.
= 2.4 =
All the important bits from the 2.3 release, plus:
* Feature: Export to BunnyCDN - a very cheap and quick static site hosting option
* Bugfix: Extracts relative URLs like fonts, background images, etc linked from your theme's CSS files
= 2.3 =
Important upgrade - critical bugfixes and new features. As we hit the 100,000 alltime downloads mark, there are big things in the pipeline coming in the major 3.0 release. Get the latest 2.3 version for a marked improvement to the plugin!
* Feature: Scheduled exports via WP Crontrol
* Bugfix: FTP export now works on shared/limited hosting
* Bugfix: Extracts all URLs when crawling your website's HTML files
* Bugfix: Subsequent exports correctly show realtime progress in log
= 2.2 =
Important upgrade - bug fix and better error reporting. Recommended for all users.
* Bugfix: GitHub export now works on shared/limited hosting
* Feature: Realtime export progress logs
Recommended upgrade for all users. Exporting from shared hosting has been improved. Better ability to debug issues and get help when an export is failing.
= 2.1 =
* Bugfix: don't hang on failures
* Bugfix: fix option to retain files on server after export
* Feature: 1-click publishing to a Netlify static site
* Feature: view server log on failure
= 2.0 =
Critical bug fixes and a shiny new feature!
* Bugfix: Dropbox export once again working after they killed version 1 of their API
* Bugfix: Amazon S3 publishing fixed after bug introduced in 1.9
* Feature: 1-click publishing to a GitHub Pages static site
Thanks to a user donation for funding the development work to get GitHub Pages exporting added as a new feature. I was also able to merge some recently contributed code from @patrickdk77, fixing the recent issues with AWS S3 and CloudFront. Finally, I couldn't make a new release without fixing the Dropbox export functionality - unbeknowst to me, they had killed version 1 of their API in September, breaking the functionality in this plugin, along with many other apps.
Please contact me to report any bugs or request new features. Thanks again for your support of this plugin!
= 1.9 =
Critical update for many users~!
* Bugfix: Plugin now works on PHP 5.3
Though this is no longer an officially supported PHP version, many of this plugin's users are running PHP 5.3 or earlier. This fix should once again allow them to use the plugin, which has not been possible for them since about version 1.2. If you are one of these affected users, please now upgrade and enjoy all the new useful features!
= 1.8 =
* Bugfix: improved URL rewriting
Plugin now ensures that formatted versions of your site's URL, ie //mydomain.com or http:\/\/mydomain.com\/ or the https/http equivalent are detected and rewritten to your target Base URL. The rewriting should now also work within CSS and JavaScript files.
= 1.7 =
* Bugfix: index.html contents empty for some users' themes/setups
* Bugfix: remove PHP short open tags for better compatibility
= 1.6 =
* Additional URLs now work again! Much needed bugfix. Recommended upgrade.
= 1.5 =
* bugfix for Dropbox export function not exporting all files
= 1.4 =
* add Dropbox export option
* fix bug some users encountered with 1.3 release
= 1.3 =
From this update on, will only do major point increases, ie 1.3, 1.4, vs 1.3.1, 1.3.2. This is due to way WP plugin directory only reports usage stats across major version numbers.
* reduce plugin download size
= 1.2.2 =
* supports Amazon Web Service's S3 as an export option
= 1.2.1 =
This update brings much desired multiple export targets. Please note, it will need you to enter your settings again as the guts of the plugin changed quite a bit and a settings migration didn't make the cut.
* unlimited export targets
* desktop notifications alert you when all exports are completed (no more staring at the screen)
= 1.2.0 =
Good to be back into developing the plugin again. This release brings some good functionality, though may be some bugs.
* 1-click generation and exporting to an FTP server
* improved user experience when saving and exporting sites (no more white screen of boredom!)
= 1.1.2 =
Minor version bump after compatibility checking with latest WordPress (4.7).
= 1.1.0 =
Premium VIP subscription option added, providing static optimized hosting and a domain for your website.