Automattic

Donncha O Caoimh (a11n)

Mike Stott

Nauris

Mark (a11n)

Pete (a11n)

Adnan Haque (a11n)

Peter Petrov

<p>This plugin generates static html files from your dynamic WordPress blog.  After a html file is generated your webserver will serve that file instead of processing the comparatively heavier and more expensive WordPress PHP scripts.</p>
<p>The static html files will be served to the vast majority of your users:</p>
<ul>
<li>Users who are not logged in.</li>
<li>Users who have not left a comment on your blog.</li>
<li>Or users who have not viewed a password protected post.</li>
</ul>
<p>99% of your visitors will be served static html files. One cached file can be served thousands of times. Other visitors will be served custom cached files tailored to their visit. If they are logged in, or have left comments those details will be displayed and cached for them.</p>
<p>The plugin serves cached files in 3 ways (ranked by speed):</p>
<ol>
<li>Expert. The fastest method is by using Apache mod_rewrite (or whatever similar module your web server supports) to serve “supercached” static html files. This completely bypasses PHP and is extremely quick. If your server is hit by a deluge of traffic it is more likely to cope as the requests are “lighter”. This does require the Apache mod_rewrite module (which is probably installed if you have custom permalinks) and a modification of your .htaccess file which is risky and may take down your site if modified incorrectly.</li>
<li>Simple. Supercached static files can be served by PHP and this is the recommended way of using the plugin. The plugin will serve a “supercached” file if it exists and it’s almost as fast as the mod_rewrite method. It’s easier to configure as the .htaccess file doesn’t need to be changed. You still need a custom permalink. You can keep portions of your page dynamic in this caching mode.</li>
<li>WP-Cache caching. This is mainly used to cache pages for known users, URLs with parameters and feeds. Known users are logged in users, visitors who leave comments or those who should be shown custom per-user data. It’s the most flexible caching method and slightly slower. WP-Cache caching will also cache visits by unknown users if supercaching is disabled. You can have dynamic parts to your page in this mode too. This mode is always enabled but you can disable caching for known users, URLs with parameters, or feeds separately. Set the constant “DISABLE_SUPERCACHE” to 1 in your wp-config.php if you want to only use WP-Cache caching.</li>
</ol>
<p>If you’re not comfortable with editing PHP files then use simple mode. It’s easy to set up and very fast.</p>
<h3>Recommended Settings</h3>
<ol>
<li>Simple caching.</li>
<li>Compress pages.</li>
<li>Don’t cache pages for known users.</li>
<li>Cache rebuild.</li>
<li>CDN support.</li>
<li>Extra homepage checks.</li>
</ol>
<p>Garbage collection is the act of cleaning up cache files that are out of date and stale. There’s no correct value for the expiry time but a good starting point is 1800 seconds.</p>
<p>Consider deleting the contents of the “Rejected User Agents” text box and allow search engines to cache files for you.</p>
<p>Preload as many posts as you can and enable “Preload Mode”. Garbage collection of old cached files will be disabled. If you don’t care about sidebar widgets updating often set the preload interval to 2880 minutes (2 days) so all your posts aren’t recached very often. When the preload occurs the cache files for the post being refreshed is deleted and then regenerated. Afterwards a garbage collection of all old files is performed to clean out stale cache files.<br />
Even with preload mode enabled cached files will still be deleted when posts are modified or comments made.</p>
<h3>Development</h3>
<ul>
<li>Active development of this plugin is handled <a href="https://github.com/Automattic/wp-super-cache" rel="nofollow ugc">on GitHub</a>.</li>
<li>Translation of the plugin into different languages is on the <a href="https://translate.wordpress.org/projects/wp-plugins/wp-super-cache" rel="nofollow ugc">translation page</a>.</li>
</ul>
<h3>Documentation</h3>
<p>If you need more information than the following, you can have a look at <a href="https://github.com/Automattic/wp-super-cache/wiki" rel="nofollow ugc">the wiki</a> or the <a href="https://odd.blog/wp-super-cache-developers/" rel="nofollow ugc">Developer documentation</a>.</p>
<h4>Preloading</h4>
<p>You can generate cached files for the posts, categories and tags of your site by preloading. Preloading will visit each page of your site generating a cached page as it goes along, just like any other visitor to the site. Due to the sequential nature of this function, it can take some time to preload a complete site if there are many posts.<br />
To make preloading more effective it can be useful to disable garbage collection so that older cache files are not deleted. This is done by enabling “Preload Mode” in the settings. Be aware however, that pages will go out of date eventually but that updates by submitting comments or editing posts will clear portions of the cache.</p>
<h4>Garbage Collection</h4>
<p>Your cache directory fills up over time, which takes up space on your server. If space is limited or billed by capacity, or if you worry that the cached pages of your site will go stale then garbage collection has to be done. Garbage collection happens on a regular basis and deletes old files in the cache directory. On the advanced settings page you can specify:<br />
1. Cache timeout. How long cache files are considered fresh for. After this time they are stale and can be deleted.<br />
2. Scheduler. Setup how often garbage collection should be done.<br />
3. Notification emails. You can be informed on garbage collection job progress.<br />
There’s no right or wrong settings for garbage collection. It depends on your own site.<br />
If your site gets regular updates, or comments then set the timeout to 1800 seconds, and set the timer to 600 seconds.<br />
If your site is mostly static you can disable garbage collection by entering 0 as the timeout, or use a really large timeout value.</p>
<p>The cache directory, usually wp-content/cache/ is only for temporary files. Do not ever put important files or symlinks to important files or directories in that directory. They will be deleted if the plugin has write access to them.</p>
<h4>CDN</h4>
<p>A Content Delivery Network (CDN) is usually a network of computers situated around the world that will serve the content of your website faster by using servers close to you. Static files like images, Javascript and CSS files can be served through these networks to speed up how fast your site loads. You can also create a “poor man’s CDN” by using a sub domain of your domain to serve static files too.</p>
<p><a href="https://wordpress.org/plugins/ossdl-cdn-off-linker/" rel="ugc">OSSDL CDN off-linker</a> has been integrated into WP Super Cache to provide basic CDN support. It works by rewriting the URLs of files (excluding .php files) in wp-content and wp-includes on your server so they point at a different hostname. Many CDNs support <a href="https://www.google.com/search?hl=en&q=%22origin+pull%22" rel="nofollow ugc">origin pull</a>. This means the CDN will download the file automatically from your server when it’s first requested, and will continue to serve it for a configurable length of time before downloading it again from your server.</p>
<p>Configure this on the “CDN” tab of the plugin settings page. This is an advanced technique and requires a basic understanding of how your webserver or CDNs work. Please be sure to clear the file cache after you configure the CDN.</p>
<h4>REST API</h4>
<p>There are now REST API endpoints for accessing the settings of this plugin. You’ll need to be authenticated as an admin user with permission to view the settings page to use it. This has not been documented yet but you can find all the code that deals with this in the “rest” directory.</p>
<h4>Custom Caching</h4>
<p>It is now possible to hook into the caching process using the add_cacheaction() function.</p>
<p>Three hooks are available:</p>
<ol>
<li>‘wp_cache_get_cookies_values’ – modify the key used by WP Cache.</li>
<li>‘add_cacheaction’ – runs in phase2. Allows a plugin to add WordPress hooks.</li>
<li>‘cache_admin_page’ – runs in the admin page. Use it to modify that page, perhaps by adding new configuration options.</li>
</ol>
<p>There is one regular WordPress filter too. Use the “do_createsupercache” filter<br />
to customize the checks made before caching. The filter accepts one parameter.<br />
The output of WP-Cache’s wp_cache_get_cookies_values() function.</p>
<p>WP Super Cache has its own plugin system. This code is loaded when WP Super Cache loads and can be used to change how caching is done. This is before most of WordPress loads so some functionality will not be available. Plugins can be located anywhere that PHP can load them. Add your own plugin either:</p>
<ul>
<li>by putting your plugin in the wp-content/plugins/wp-super-cache-plugins directory, or</li>
<li>by calling wpsc_add_plugin( $name ) where $name is the full filename and path to the plugin. You only need to call that function once to add it. Use wpsc_delete_plugin( $name ) to remove it from the list of loaded plugins.</li>
</ul>
<p>The cookies WP Super Cache uses to identify “known users” can be modified now by adding the names of those cookies to a list in the plugin configuration. Use wpsc_add_cookie( $name ) to add a new cookie, and wpsc_delete_cookie( $name ) to remove it. The cookie names also modify the mod_rewrite rules used by the plugin but I recommend using Simple mode caching to avoid complications with updating the .htaccess file.<br />
The cookie name and value are used to differenciate users so you can have one cookie, but different values for each type of user on your site for example. They’ll be served different cache files.</p>
<p>See <a href="https://github.com/Automattic/wp-super-cache/blob/4cda5c0f2218e40e118232b5bf22d227fb3206b7/plugins/searchengine.php" rel="nofollow ugc">plugins/searchengine.php</a> as an example I use for my <a href="https://odd.blog/no-adverts-for-friends/" rel="nofollow ugc">No Adverts for Friends</a> plugin.</p>
<h3>Troubleshooting</h3>
<p>If things don’t work when you installed the plugin here are a few things to check:</p>
<ol>
<li>Is wp-content writable by the web server?</li>
<li>Is there a wp-content/wp-cache-config.php ? If not, copy the file wp-super-cache/wp-cache-config-sample.php to wp-content/wp-cache-config.php and make sure WPCACHEHOME points at the right place.</li>
<li>Is there a wp-content/advanced-cache.php ? If not, then you must copy wp-super-cache/advanced-cache.php into wp-content/. You must edit the file and change the path so it points at the wp-super-cache folder.</li>
<li>If pages are not cached at all, remove wp-content/advanced-cache.php and recreate it, following the advice above.</li>
<li>
<p>Make sure the following line is in wp-config.php and it is ABOVE the “require_once(ABSPATH.’wp-settings.php’);” line:</p>
<pre><code>define( 'WP_CACHE', true );
</code></pre>
</li>
<li>Try the Settings->WP Super Cache page again and enable cache.</li>
<li>Look in wp-content/cache/supercache/. Are there directories and files there?</li>
<li>Anything in your php error_log?</li>
<li>If your browser keeps asking you to save the file after the super cache is installed you must disable Super Cache compression. Go to the Settings->WP Super Cache page and disable it there.</li>
<li>The plugin does not work very well when PHP’s safe mode is active. This must be disabled by your administrator.</li>
<li>If pages are randomly super cached and sometimes not, your blog can probably be viewed with and without the “www” prefix on the URL. You should choose one way and install the <a href="http://txfx.net/code/wordpress/enforce-www-preference/" rel="nofollow ugc">Enforce www preference</a> plugin if you are using an old WordPress install. The latest versions redirect themselves (you should always be running the latest version of WordPress anyway!)</li>
<li>Private Server users at Dreamhost should edit wp-content/wp-cache-config.php and set the cache dir to “/tmp/” if they are getting errors about increasing CPU usage. See this <a href="https://wordpress.org/support/topic/145895?replies=42" rel="ugc">discussion</a> for more.</li>
<li>File locking errors such as “failed to acquire key 0x152b: Permission denied in…” or “Page not cached by WP Super Cache. Could not get mutex lock.” are a sign that you may have to use file locking. Edit wp-content/wp-cache-config.php and uncomment “$use_flock = true” or set $sem_id to a different value. You can also disable file locking from the Admin screen as a last resort.</li>
<li>Make sure cache/wp_cache_mutex.lock is writable by the web server if using coarse file locking.</li>
<li>The cache folder cannot be put on an NFS or Samba or NAS share. It has to be on a local disk. File locking and deleting expired files will not work properly unless the cache folder is on the local machine.</li>
<li>
<p>Garbage collection of old cache files won’t work if WordPress can’t find wp-cron.php. If your hostname resolves to 127.0.0.1 it could be preventing the garbage collection from working. Check your access_logs for wp-cron.php entries. Do they return a 404 (file not found) or 200 code? If it’s 404 or you don’t see wp-cron.php anywhere WordPress may be looking for that script in the wrong place. You should speak to your server administator to correct this or edit /etc/hosts on Unix servers and remove the following line. Your hostname must resolve to the external IP address other servers on the network/Internet use. See http://yoast.com/wp-cron-issues/ for more. A line like “127.0.0.1 localhost localhost.localdomain” is ok.</p>
<pre><code>127.0.0.1 example.com
</code></pre>
</li>
<li>If old pages are being served to your visitors via the supercache, you may be missing Apache modules (or their equivalents if you don’t use Apache). 3 modules are required: mod_mime, mod_headers and mod_expires. The last two are especially important for making sure browsers load new versions of existing pages on your site.</li>
<li>The error message, “WP Super Cache is installed but broken. The path to wp-cache-phase1.php in wp-content/advanced-cache.php must be fixed!” appears at the end of every page. Open the file wp-content/advanced-cache.php in your favourite editor. Is the path to wp-cache-phase1.php correct? This file will normally be in wp-content/plugins/wp-super-cache/. If it is not correct the caching engine will not load.</li>
<li>Caching doesn’t work. The timestamp on my blog keeps changing when I reload. Check that the path in your .htaccess rules matches where the supercache directory is. You may have to hardcode it. Try disabling supercache mode.</li>
<li>
<p>If supercache cache files are generated but not served, check the permissions on all your wp-content/cache/supercache folders (and each of wp-content cache and supercache folders) and wp-content/cache/.htaccess. If your PHP runs as a different user to Apache and permissions are strict Apache may not be able to read the PHP generated cache files. To fix you must add the following line to your wp-config.php (Add it above the WP_CACHE define.) Then clear your cache.</p>
<pre><code>umask( 0022 );
</code></pre>
</li>
<li>
<p>If you see garbage in your browser after enabling compression in the plugin, compression may already be enabled in your web server. In Apache you must disable mod_deflate, or in PHP zlib compression may be enabled. You can disable that in three ways. If you have root access, edit your php.ini and find the zlib.output_compression setting and make sure it’s “Off” or add this line to your .htaccess:</p>
<pre><code>php_flag zlib.output_compression off
</code></pre>
<p>If that doesn’t work, add this line to your wp-config.php:</p>
<pre><code>ini_set('zlib.output_compression', 0);
</code></pre>
</li>
<li>The “white screen of death” or a blank page  when you visit your site is almost always caused by a PHP error but <a href="http://www.johnberns.com/2010/03/19/wp-super-cache-blank-page-problem-fixed/" rel="nofollow ugc">it may also be caused by APC</a>. Disable that PHP extension if you have trouble and replace with eAccelerator or Xcache.</li>
<li>After uninstalling, your permalinks may break if you remove the WordPress mod_rewrite rules too. Regenerate those rules by visiting the Settings->Permalink page and saving that form again.</li>
<li>If your blog refuses to load make sure your wp-config.php is correct. Are you missing an opening or closing PHP tag?</li>
<li>Your front  …</li>
</ol>


WP Super Cache


I've been using this caching plugin since before Automattic took over management. Since I don't get very much in the way of comments on my site, the vast majority of hits are anonymous and don't change what should be on the page next time, so a static cache helps a *lot*.


Major speedup for the typical use case


It is very easy to use and optimally accelerates the website(s). Many thanks for the free version, it's simply brilliant.


Very helpful tool

A very fast caching engine for WordPress that produces static html files.

manojtd

<p>Once you use a Content Delivery Network (CDN) such as Amazon Cloudfront to speed up your blog, you will come across instances when you update a static file (a style or image file, for instance), but your readers keep getting the stale file from the CDN. No amount of cache clearing on your blog server is going to help refresh the cached file because it is on the CDN. The only way would be to “invalidate” the file, which will signal the CDN to pull a fresh copy from the origin location. But this necessitates you to log on to the CDN server, locate the file, generate a proper invalidation request, and wait for it to percolate to all the mirrors. And it often costs money.</p>
<p>CDN Buster offers a much easier alternative. You enter a Version String in the plugin admin page, and append the same string where you define the CDN address in your caching plugins, such as WP Super Cache or W3 Total Cache. This way, when your reader loads a page, he is looking for a different file, and your CDN server will query your blog server for it, where this plugin will intercept the query and serve the modified file from the <em>original</em> location. Thus, the modified file will get loaded on your CDN and all will be well.</p>
<h4>Pro Version</h4>
<p>In addition to the fully functional Lite version, <em>CDN Buster</em>  also has a <a href="http://buy.thulasidas.com/cdn-buster" title="CDN Buster -- easy invalidation of your CDN cache, $5.95" rel="nofollow ugc">Pro version</a> with many more features.</p>
<ol>
<li>Automatically update the CDN settings in your WP Super Cache or W3 Total Cache plugin.</li>
<li>Change the origin pull location on your CDN server to a generic string (e.g. <code>cdn-bustor-*</code> where <code>*</code> can be anything) without touching your blog settings to invalidate the cache.</li>
<li>Invalidate by file type, so that only certain types of files are invalidated.</li>
<li>Invalidate single files from a list that you specify.</li>
</ol>
<h4>Why use a CDN</h4>
<p>Content Delivery Network (CDN) is a collection of geographically distributed servers that mirror and serve you static contents (images, JavaScrip/CSS files, movies etc.) to your readers much faster than your own blog server can. It speeds up your blog tremendously:</p>
<ol>
<li>It serves a large part of your website payload from servers that are close to the readers. CDN servers are specifically optimized for such contents.</li>
<li>Since your resources on the CDN have different address (URL), the reader’s browser loads the statc content and the dynamic content (from your blog server) in parallel, enhancing the user experience.</li>
<li>The load on your blog server goes down becuase it is no longer serving a large part of the page content, which improves its performance.</li>
</ol>
<p>In short, if you are not using a CDN yet, you should. It is very easy to set it up if you use any popular cacching plugins (such as WP Super Cache or W3 Total Cache). Most CNDs are of the so-called Origin Pull kind, where the CDN server automatically pulls a file from a location (typically your blog itself) whenever it is asked to serve a file it doesn’t have in its cache. This is usually a one-time operation, which is slow. The CDN then proceeds to mirror the file on its servers all over the world. Thereafter, whenever the file is requested, the file is served instantly from a server closest to the reader.</p>


CDN Buster

Wrote this plugin because I could not find anything similar in the directory. Hope you find it useful.



Author Review

CDN Buster is a tool to invalidate the files cached on your CDN server en masse. It helps you update the stale files on your CDN server easily.

WP Super Cache vs CDN Buster