petermolnar/wp-ffpc
1
0
Fork 0
Code Issues 22 Pull requests 4 Projects Releases Packages Wiki Activity Actions
wp-ffpc/README.md
Glaydston Veloso 5d9530e3ae Add readme update
2016-11-09 13:18:09 +01:00

602 lines
21 KiB
Markdown
Raw Permalink Blame History

=== WP-FFPC ===
Contributors: cadeyrn, ameir, haroldkyle, plescheff, dkcwd, IgorCode
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=XU3DG7LLA76WC
Tags: cache, page cache, full page cache, nginx, memcached, apc, speed
Requires at least: 3.0
Tested up to: 4.5
Stable tag: 1.11.2
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl-3.0.html
The fastest way to cache: use the memory!
== Description ==
WP-FFPC ( WordPress Fast Full Page Cache ) is a cache plugin for [WordPress](http://wordpress.org/ "WordPress"). It works with any webserver, including apache2, lighttpd, nginx.
It can be configured to join forces with [NGiNX](http://NGiNX.org "NGiNX")'s built-in [memcached plugin](http://nginx.org/en/docs/http/ngx_http_memcached_module.html "memcached plugin").
= **IMPORTANT NOTES, PLEASE READ THIS LIST** =
* Requirements:
* WordPress >= 3.0
* **at least one** of the following for storage backend:
* memcached with [PHP Memcached](http://php.net/manual/en/book.memcached.php "Memcached") > 0.1.0
* memcached with [PHP Memcache](http://php.net/manual/en/book.memcache.php "Memcache") > 2.1.0
* [APC](http://php.net/manual/en/book.apc.php "APC")
* [APCu](http://pecl.php.net/package/APCu "APC User Cache")
* PHP 5.3+ is really highly recommended, see "Known issues"
* This plugin does **not** kick in right after activation. You have to adjust the setting in Settings -> WP-FFPC and save the settings.*
= Known issues =
* errors will not be displayed on the admin section if PHP < 5.3, only in the logs. This is due to the limitations of displaying the errors ( admin_notices is a hook, not a filter ) and due to the lack of proper anonymus functions in older PHP. PHP 5.3 is 5 years old, so it's time to upgrade.
* APC with PHP 5.4 is buggy; the plugin with that setup can even make your site slower. Please use APCu or memcached if you're using PHP >= 5.4
= Features: =
* Wordpress Network support
* fully supported domain/subdomain based WordPress Networks on per site setup as well
* will work in Network Enabled mode only for subdirectory based Multisites ( per site settings will not work in this case )
* supports various backends
* memcached with [PHP Memcached](http://php.net/manual/en/book.memcached.php "Memcached")
* memcached with [PHP Memcache](http://php.net/manual/en/book.memcache.php "Memcache")
* [APC](http://php.net/manual/en/book.apc.php "APC")
* [APCu](http://pecl.php.net/package/APCu "APC User Cache")
* [Xcache](http://xcache.lighttpd.net/ "Xcache") - not stable yet, volunteer testers required!
* cache exclude options ( home, feeds, archieves, pages, singles; regex based url exclusion )
* (optional) cache for logged-in users
* 404 caching
* canonical redirects caching
* Last Modified HTTP header support ( for 304 responses )
* shortlink HTTP header preservation
* pingback HTTP header preservation
* talkative log for [WP_DEBUG](http://codex.wordpress.org/WP_DEBUG "WP_DEBUG")
* multiple memcached upstream support
* precache ( manually or by timed by wp-cron )
* varying expiration time for posts, taxonomies and home
Many thanks for donations, contributors, supporters, testers & bug reporters:
* [Harold Kyle](https://github.com/haroldkyle)
* [Eric Gilette](http://www.ericgillette.com/)
* [doconeill](http://wordpress.org/support/profile/doconeill)
* Mark Costlow
* Jason Miller
* [Dave Clark](https://github.com/dkcwd)
* Miguel Clara
* [Anton Pelešev](https://github.com/plescheff)
* Firas Dib
* [CotswoldPhoto](http://wordpress.org/support/profile/cotswoldphoto)
* [tamagokun](https://github.com/tamagokun)
* Many Ayromlou
* mailgarant.nl
* Christian Rößner
* [Ameir Abdeldayem](https://github.com/ameir)
* [Alvaro Gonzalez](https://github.com/andor-pierdelacabeza)
* Meint Post
* Knut Sparhell
* Christian Kernbeis
* Gausden Barry
* Maksim Bukreyeu
* Lissome Hong Kong Limited
* [Gabriele Lauricella](https://github.com/gablau)
* 7th Veil, LLC
* Julia Harsch
* Grant Berntsen
* [Glaydston Veloso](https://github.com/glaydston)
== Installation ==
1. Upload contents of `wp-ffpc.zip` to the `/wp-content/plugins/` directory
2. Enable WordPress cache by adding `define('WP_CACHE',true);` in wp-config.php
3. Activate the plugin through the `Plugins` menu in WordPress ( site or Network wide )
4. Check the settings in `Settings` ( site or Network Admin, depending on activation wideness ) -> `WP-FFPC` menu in WordPress.
5. Save the settings. THIS STEP IS MANDATORY: without saving the settings, there will be no activated caching!
= Using the plugin with NGiNX =
If the storage engine is either PHP Memcache or PHP Memcached extension, the created entries can be read and served directly from NGiNX ( if it has memcache or memc extension )
A short configuration example is generated on the plugin settings page, under `NGiNX` tab according to the saved settings.
**NOTE:** Some features ( most of additional HTTP headers for example, like pingback, shortlink, etc. ) will not be available with this solution.
== Frequently Asked Questions ==
= How to use the plugin on Amazon Linux? =
You have to remove the default yum package, named `php-pecl-memcache` and install `Memcached` through PECL.
= How to use the plugin in a WordPress Network =
From version 1.0, the plugin supports subdomain based WordPress Network with possible different per site cache settings. If the plugin is network active, obviously the network wide settings will be used for all of the sites. If it's activated only on some of the sites, the other will not be affected and even the cache storage backend can be different from site to site.
= How logging works in the plugin? =
Log levels by default ( if logging enabled ) includes warning and error level standard PHP messages.
Additional info level log is available when [WP_DEBUG](http://codex.wordpress.org/WP_DEBUG "WP_DEBUG") is enabled.
= How can I contribute? =
In order to make contributions a lot easier, I've moved the plugin development to [GitHub](https://github.com/petermolnar/wp-ffpc "GitHub"), feel free to fork and put shiny, new things in it and get in touch with me [hello@petermolnar.eu](mailto:hello@petermolnar.eu "hello@petermolnar.eu") when you have it ready.
= Where can I turn for support? =
I provide support for the plugin as best as I can, but it comes without guarantee.
Please post feature requests to [WP-FFPC feature request topic](http://wordpress.org/support/topic/feature-requests-14 "WP-FFPC feature request topic") and any questions on the forum.
== Screenshots ==
1. settings screen, cache type and basic settings
2. debug and in depth-options
3. cache exceptions
4. memcached servers settings
5. NGiNX example
== Changelog ==
Version numbering logic:
* every A. indicates BIG changes.
* every .B version indicates new features.
* every ..C indicates bugfixes for A.B version.
= 1.12.0 =
*2016-11-09*
* Add new class to detect mobile devices
* Create a cache to mobile and desktop version
= 1.11.1 =
*2016-04-21*
* exclude cache for WooCommerce
* fix load textdomain
* add Italian (it_IT) translation
= 1.11.0 =
*2016-01-15*
* merged filter for HTML before it hits the cache
* refactored logging
= 1.10.1 =
*2015-10-30*
* fixed nginx configuration sample snippets
* nginx configuration moved from Settings tab to Help tab, so if you're looking for the "nginx" tab, you need to look under "Help" on the WP-FFPC Settings page.
= 1.10.0 =
*2015-10-23*
*IMPORTANT, READ THIS*
* Proper browser cache support:
* new options to set real browser cache expiry for singles, taxonomy and home
* added Etag support based on browser cache expiry
* added proper Expires header according to cache entry generation time + browser cache expiry
* added support for Last Modified header for home & taxonomy ( singles already had it) based on the last post modified date within the taxonomy
= 1.9.1 =
*2015-10-18*
* bugfix for is_writable check failures ( see: https://wordpress.org/support/topic/settings-saved-but-getting-not-saved-error-message)
* bugfix for memcached.protocol notice
* typo fixes
* replace variable with string constant in translatable messages
= 1.9.0 =
*2015-10-14*
* adding exclude option based on text entry matching ( regex )
= 1.8.4 =
*2015-10-13*
* changes in HTML debug comment: instead of the former, single comment, now 2 comments are added. The first is added when the cache entry is generated; the second only appears if the page was served from the cached entry. Please note that this last bit will - should - change with every single refresh.
* backend code is now split into separate files
* more debug code
= 1.8.3 =
*2015-05-07*
* small change in key creation: prefix is kept in front of sha1 hashes for debugging purposes
= 1.8.2 =
*2015-04-30*
* sha1 key hashing made to be optional
* added additional debug condition of WP_FFPC__DEBUG_MODE constant to be `true`
= 1.8.1 =
*2015-04-29*
* fixing the wrong release of 1.8.0
= 1.8.0 =
*2015-04-29*
What's new:
* backend keys are now sha1 hashes instead of full url; this is to prevent too long key error with memcached
Under the hood:
* wp-common is removed; no more git submodules
* logging method changed
= 1.7.9 =
*2015-02-02*
What's new:
* detailed log messages for other log message clarification
* added auto-upgrade for advanced-cache.php on plugin upgrade
= 1.7.8 =
*2015-01-30*
What's new:
* merged pull request for [wp-ffpc-purge](https://github.com/zeroturnaround/wp-ffpc-purge)
= 1.7.7 =
*2015-01-14*
What's fixed:
* fixed alert backwards compatibility for PHP < 5.3
= 1.7.6 =
*2015-01-09*
What's fixed:
* anonymus function call only for PHP 5.3
= 1.7.5 =
*2014-12-29*
What's fixed:
* wp-ffpc was not actually alerting when it had issues; this should be fixed now
This was a really bad bug and it could have cause a lot of issues since the plugin was probably not working in some cases when the alerts went unnoticed. Due to WordPress restrictions on admin_notices hook I had to use PHP features only present since 5.3. Please keep this in mind.
= 1.7.4 =
*2014-12-17*
What's changed:
* localhost cache forced exclude removed; instead please use `define('WP_CACHE', $_SERVER['REMOTE_ADDR'] !== '127.0.0.1');` instead as pointed out by [plescheff](https://github.com/petermolnar/wp-ffpc/commit/eb4942005273822aec8c2da09f0e763807f94f9c#commitcomment-9006031) if required
* compatibility tested up to WordPress 4.1
= 1.7.3 =
*2014-12-17*
What's fixed:
* expiration time set to '0' resulted instant expiration instead of infinite keep; fixed now
= 1.7.2 =
*2014-12-08*
What's changed:
* merged pull request for memcached proxy compatibility; memcached binary mode if off by default from now on
= 1.7.1 =
*2014-12-04*
What's fixed:
* [Unable to determine path from Post Permalink](https://wordpress.org/support/topic/unable-to-determine-path-from-post-permalink) noise fixed
* potential Multisite precache bug fixed ( database prefixes were not set according to original prefix )
What's new:
* added permanent cache exception of localhost
What's changed:
* pingback header preservation is now off by default and can manually be turned on
= 1.7.0 =
*2014-09-19*
What's new:
* added varying expiration time options
What's changed:
* **dropped Xcache support**: the reasons behind this is the outstandingly terrible documentation of Xcache
* **dropped persistent memcache mode**: no one was using it and even if the were only caused trouble
* **removed '/wp-' hardcoded cache exception**; this is now the default in the regex exceptions field as ^/wp-; please add this manually in case you've already been using the regex field
= 1.6.4 =
*2014-09-12*
What's fixed:
* downgraded log level from halting-level fatal to warning ( thank you PHP for the consistent naming... ) in case the selected extension is missing
* leftover code parts cleanup
= 1.6.3 =
*2014-09-12*
What's fixed:
* there were still some alway-on log messages
= 1.6.2 =
*2014-09-05*
What's fixed:
* merge pulled from [plescheff](https://github.com/petermolnar/wp-ffpc/pull/25)
* fixed bug of alway-on log messages ( warning was set to default where notice should have been )
= 1.6.1 =
*2014-09-04*
What's fixed:
1.6 release, correcting SVN madness with non-recursive copies.
= 1.6.0 =
*2014-05-30*
What's new:
* added functionality to exclude regex urls, contribution from [plescheff](https://github.com/plescheff/wp-ffpc/commit/3c875ad4fe1e083d3968421dd83b9c179c686649)
* added functionality to include "?" containing URL
What's fixed:
* some warning messages removed in case there's not a single backend installed when the plugin is activated
* fixed issue of resetting settings when new version of defaults was released
Under the hood:
* major changes to the abstract wp-common class for better interoperability between my plugins
= 1.5.0 =
*2014-05-30*
What's new:
* APCu backend added ( APCu is a stripped version of APC with only user object cache functionality what can be used with PHP 5.4 & 5.5 besides [Opcache](http://php.net/manual/en/book.opcache.php "PHP Opcache") )
= 1.4.0 =
*2014-05-12*
What's new:
* Xcache backend added ( theoretical, partially tested, volunteer testers required )
What's fixed:
* invalidation for comment actions added
= 1.3.3 =
*2014-04-29*
What's changed:
* removed broadcast message
* better logs ( additional logs and adding translation compatibility )
= 1.3.2 =
*2014-04-09*
What's fixed:
* 1.3.1 was a quickfix for an uncommitted change required for 1.3 to work.
* removed PHP warning in case WP_CACHE was off ( see https://github.com/petermolnar/wp-ffpc/issues/14 )
* PHP notices in log from [Harold Kyle](https://github.com/haroldkyle "Harold Kyle")
* ms is really second
= 1.3 =
*2014-04-04*
What's fixed:
* uninstall will not fail anymore ( and I hate PHP for it's retarted language restrictions )
* typo fix for memcache functions from [Dave Clark](https://github.com/dkcwd "Dave Clark")
* uninstall security lines from [Dave Clark](https://github.com/dkcwd "Dave Clark")
* modification to nginx sample file from [Harold Kyle](https://github.com/haroldkyle "Harold Kyle") to skip all urls with query string present
What's new:
* added unix socket memcache module support ( ONLY for memcache backend for now )
= 1.2.2 =
*2013-11-07*
What's fixed:
* 404 for first hit of 404 pages; bug report from [phoenix13](wordpress.org/support/profile/phoenix13 phoenix13)
= 1.2.1 =
*2013-07-23*
What's fixed:
* call to undefined function get_blog_option error fixed
= 1.2 =
*2013-07-17*
What's new:
* additional cookie patterns to exclude visitors from cache, contribution from [Harold Kyle](https://github.com/haroldkyle "Harold Kyle")
* syslog dropped; using "regular" PHP log instead
* pre-cache from wp-cron
* changeable key scheme ( was fixed previously ); possibility to add user-specific cache if PHPESSID cookie is present
What's fixed:
* logged in cookie check fixed ( was not checking all WordPress cookies )
* global error messages to show if settings are not saved
**Dropped functionalities**
* there's no info log on/off anymore, it's triggered when WP_DEBUG is active
* sync protocols has been removed for two reasons: this has to be done by other systems and causes issues in special cases
**For Devs**
* the abstract class have been moved into a separate Github repository, [wp-common](https://github.com/petermolnar/wp-common "wp-common"). Because PHP is not capable of replacing/redefining classes, there's a versioning with the abstract and the utilities class, please be aware of this.
= 1.1.1 =
*2013-04-25*
* bugfix: Memcache plugin was diplaying server status incorrectly ( although the plugin was working )
* bugfix: typo prevented log to work correctly
= 1.1 =
*2013-04-24*
What's new:
* HTML comment option for displaying cache info before closing "body" tag ( a.k.a make sure it works "noob" method )
* pre-cache function ( only manual pre-cache is enabled for now; uses permalinks structure )
* new, additional invalidation method: clear post & all taxonomy cache, including feeds
* full virtual server example to use the plugin with nginx ( originally it was only a snippet required to use the plugin )
What's fixed:
* contributed fixes from [Harold Kyle](https://github.com/haroldkyle "Harold Kyle") to surpress PHP notices and warnings; better CSS & JS enqueue; corrected admin panel descriptions
* bugfix for status check ( there were situations where the status was not updated correctly )
* manual flush cache bug fixed ( was only flushing if the settings were on "flush all" )
* bugfix on data & meta prefixes ( some places used hardcoded prefixes )
* feed caching fixed ( due to a security check it turned out feeds were excluded for a long time )
= 1.0 =
*2013-03-22*
* plugin development using [GitHub repository](https://github.com/petermolnar/wp-ffpc "GitHub repository") from this version
* Software licence change from GPLv2 to GPLv3
* backend code completely replaced ( object-based backend, improved readability & better structure, lot less global vars, etc. )
* added proper uninstall ( uninstall hook was not removing options from DB, uninstall.php will )
* revisited multisite support ( eliminated overwriting-problems )
* preparations for localization support ( all strings are now go through WordPress translate if available )
* more detailed log & error messages
* retouched Memcache initialization ( faster connect, cleaner persistent connections )
* proper settings migration from previous versions
**Bugfixes**
* faulty expiration times fixed
* eliminated warning message for memcache when no memcache extension is present
* fixed multisite settings overwriting issue
**Dropped functions**
* APC entry compression support
= 0.6.1 =
*2013-03-08*
* refactored & corrected backend status check for memcached driver
= 0.6 =
*2013-03-08*
* true WordPress Network support:
* if enabled network-wide, settings will be the same for every site
* if enabled only per site settings could vary from site to site and cache could be active or disabled on a per site basis without interfering other sites
* delete options button to help solving problems
= 0.5.1 =
*2013-03-07*
* settings link for plugins page
* readme cleanup
* setting link URL repair & cleanup
= 0.5 =
*2013-03-06*
WARNING, MAJOR CHANGES!
* default values bug ( causing %3C bug ) really fixed by the help of Mark Costlow <cheeks@swcp.com>
* UI cleanup, new tabbed layout
* WP-FFPC options moved from global menu to under Settings in both Site and Network Admin interfaces
* added 'persistent' checkbox for memcached connections
* added support for multiple memcached servers, feature request from ivan.buttinoni ( ivanbuttinoni @ WordPress.org forum )
* case-sensitive string checks replaced with case-insensitives, contribution of Mark Costlow <cheeks@swcp.com>
* refactored settings saving mechanism
* additional syslog informations
* additional comments on the code
* lots of minor fixes and code cleanup
* donation link on the top
= 0.4.3 =
*2013-03-03*
* long-running %3C bug fixed by the help of Mark Costlow <cheeks@swcp.com>, many thanks for it. It was cause by a bad check in the default values set-up: is_numeric applies for string numbers as well, which was unknown to me, and cause some of the values to be 0 where they should have been something different.
= 0.4.2 =
*2012-12-07*
* added optional sync protocoll option: replace all http->https or https->http depending on request protocol
* binary mode is working correctly with memcached extension
* added warning message for memcache extension in binary mode
**KNOWN ISSUES**
There are major problems with the "memcache" driver, the source is yet unkown. The situation is that there's no response from the memcached server using this driver; please avoid using it!
= 0.4.1 =
*2012-08-16*
* storage key extended with scheme ( http; https; etc. ), the miss caused problems when https request server CSS and JS files via http.
= 0.4 =
*2012-08-06*
* tested against new WordPress versions
* added lines to "memcached" storage to be able to work with NGiNX as well
* added lines to "memcached" to use binary protocol ( tested with PHP Memcached version 2.0.1 )
**KNOWN ISSUES**
* "memcache" extension fails in binary mode; the reason is under investigation
= 0.3.2 =
*2012-02-27*
* apc_cache_info replaced with apc_sma_info, makes plugin faster
= 0.3 =
*2012-02-21*
* added syslog debug messages possibility
* bugfix: removed (accidently used) short_open_tags
= 0.2.3 =
*2012-02-21*
* NGiNX-sample.conf file added, NGiNX config is created from here
= 0.2.2 =
*2012-02-21*
* memcache types bugfix, reported in forum, thanks!
= 0.2.1 =
*2012-02-21*
* bugfix, duplicated inclusion could emerge, fix added, thanks for Géza Kuti for reporting!
= 0.2 =
*2012-02-19*
* added APC compression option ( requires PHP ZLIB ). Useful is output pages are large. Compression is on lowest level, therefore size/CPU load is more or less optimal.
= 0.1 =
*2012-02-16*
* first public release
Reference in a new issue View git blame Copy permalink