nitropack
Last commit date
nitropack-sdk
5 years ago
view
5 years ago
advanced-cache.php
5 years ago
cf-helper.php
5 years ago
constants.php
5 years ago
diagnostics.php
5 years ago
functions.php
5 years ago
integrations.php
5 years ago
main.php
5 years ago
readme.txt
5 years ago
uninstall.php
6 years ago
wp-cli.php
5 years ago
readme.txt
359 lines
| 1 | === NitroPack === |
| 2 | Contributors: nitropack |
| 3 | Tags: cache,perfomance,optimize,pagespeed,lazy load,cdn,critical css,compression,defer css javascript,minify css,minify,webp |
| 4 | Requires at least: 4.7 |
| 5 | Tested up to: 5.7 |
| 6 | Requires PHP: 5.3 |
| 7 | Stable tag: 1.5.3 |
| 8 | License: GNU General Public License, version 2 |
| 9 | License URI: https://www.gnu.org/licenses/gpl-2.0.html |
| 10 | |
| 11 | Everything you need for a fast website. Simple set up, easy to use, awesome support. Caching, Lazy Loading, Minification, Defer CSS/JS, CDN and more! |
| 12 | |
| 13 | == Description == |
| 14 | NitroPack is the all-in-one performance optimization service. It combines **everything** you need for a lightning-fast website. Image optimization, code minification, caching, CDN, lazy loading - you name it, NitroPack has it. |
| 15 | |
| 16 | [youtube https://www.youtube.com/watch?v=IKbHcOZ3Plw] |
| 17 | |
| 18 | NitroPack performs all optimizations in the cloud. This makes it a **very lightweight** solution with a **lower CPU overhead** compared to standard caching plugins. |
| 19 | |
| 20 | Our service provides you with the following (typically paid extra) functionalities **included without the need for additional configuration**: |
| 21 | |
| 22 | * **Amazon CloudFront CDN** – we automatically serve your static assets from a CDN based on Amazon’s CloudFront service |
| 23 | * **Image Optimization** – we optimize all of your images automatically and convert them to WebP |
| 24 | * **Cache Warmup** – we keep your most important pages optimized at all times |
| 25 | |
| 26 | Apart from these, NitroPack offers other unique features and benefits like: |
| 27 | |
| 28 | * **Incredibly Simple Setup** – getting started with NitroPack is a breeze. There’s no technical configuration or a 15-step installation process. And you don’t need to be a developer to set it up. Simply follow [these 4 steps](https://wordpress.org/plugins/nitropack/#installation "Installation Instructions") and you’ll be done in no time |
| 29 | * **No risk of damaging your original site files** – NitroPack works on copies of your site files. You don’t like the results from an optimization? No problem. Purge your cache and start over. Even if you decide to disable NitroPack your site will go back to the state it was in before activating our plugin |
| 30 | * **Cache Invalidation** – you can invalidate cache files instead of purging them. This allows NitroPack to keep serving your visitors from cache while a fresh copy of the cache is being generated in the background. Cache invalidation is awesome for **high traffic situations** like campaigns. It allows you to keep updating your site while still serving cache to your clients. And with NitroPack, **cache invalidation happens automatically**. (For more info on this, scroll down to the “NitroPack and Campaigns” section) |
| 31 | * **Critical CSS tailored to each of your unique layouts** – most plugins that provide critical CSS functionality prepare a single critical CSS file per post type. Even when you have multiple pages with the same post type but different layouts. NitroPack detects this and generates **unique critical CSS for each unique layout**. Oh, and because desktop and mobile devices have different viewports, NitroPack also uses different critical CSS for each device type ;) |
| 32 | * **Optimize resources linked statically into your theme files** – NitroPack will discover and optimize all resources linked into your theme, even ones that come hardcoded into your CSS files (even if they are multiple levels down an @import chain) |
| 33 | |
| 34 | **The configuration requires no technical knowledge.** All you need to do is select your desired optimization level: Standard, Medium, Strong or Ludicrous. Besides that, NitroPack does all the work. |
| 35 | |
| 36 | ## Other Key Features |
| 37 | |
| 38 | * Minify HTML |
| 39 | * Minify CSS files and inline CSS defined in style tags and attributes |
| 40 | * Minify JavaScript files and inline script tags |
| 41 | * HTML, CSS and JavaScript compression |
| 42 | * Gzip and Brotli compression |
| 43 | * Optimize images |
| 44 | * Convert to WebP |
| 45 | * Lazy load images (including CSS background images) |
| 46 | * Lazy load iframes |
| 47 | * Amazon CDN |
| 48 | * Image previews for YouTube and Vimeo embeds |
| 49 | * Defer CSS |
| 50 | * Defer JavaScript |
| 51 | * Font rendering optimization |
| 52 | * DNS prefetch |
| 53 | * Compatible with mobile, tablet and desktop devices out of the box |
| 54 | * Multisite ready |
| 55 | * Support for scheduled posts |
| 56 | * eCommerce compatibility |
| 57 | * Multilingual support |
| 58 | * Advanced resource loading mechanism |
| 59 | * Resource preloading using web workers |
| 60 | * Automatic cache management – NitroPack will automatically update its cache files when you update content on your site |
| 61 | * Option to exclude certain pages from being cached |
| 62 | * Option to exclude any resource from being optimized |
| 63 | * Option to ignore URL parameters that do not modify the content of your pages (e.g. campaign parameters like utm_source, utm_campaign, etc.) |
| 64 | * Cloudflare integration |
| 65 | * Sucuri integration |
| 66 | * Generic reverse proxy integration (NGINX, Varnish, etc.) |
| 67 | * No database connection needed |
| 68 | |
| 69 | ## Running Marketing Campaigns with NitroPack |
| 70 | |
| 71 | Two major issues often come up when running a campaign. First, each visitor hits your server with a **unique URL** request. Second, you lose your **cache** if you update content on your site. |
| 72 | Most optimization plugins come up short when it comes to both issues. |
| 73 | At the same time, NitroPack has two powerful features that help you thrive in these high traffic situations: |
| 74 | |
| 75 | 1. NitroPack recognizes **campaign parameters in the URL** and ignores them when looking up a cache file for the campaign request. |
| 76 | 2. **Cache invalidation** - typically, when you update content on your site, caching plugins have to purge their cache and start rebuilding it. When a purge occurs during a high traffic period your visitors will no longer be served from cache. And your server will have to work extra hard to generate new cache files. As a result, the user experience on your website takes a hit. NitroPack solves this problem by **invalidating the cache, instead of purging it**. This method allows NitroPack to refresh the cache files in the background. At the same time, you still serve your clients from the slightly outdated cache files. As we already said, this happens **automatically**. You don’t need to worry about caching during an important campaign. |
| 77 | |
| 78 | Whether you’re running a big campaign or your site suddenly becomes trending, both features are crucial for keeping your visitors happy. |
| 79 | So, if you want a fast website right now, **go over to the [Installation](https://wordpress.org/plugins/nitropack/#installation "Installation Instructions") section and download NitroPack**. |
| 80 | |
| 81 | ## Incompatible Plugins |
| 82 | |
| 83 | WordPress is designed to have only a single active page cache solution at a time, otherwise conflicts can arise. We do not recommend using NitroPack together with another caching plugin, like: |
| 84 | |
| 85 | * WP Rocket |
| 86 | * Autoptimize |
| 87 | * Swift Performance |
| 88 | * WP Fastest Cache |
| 89 | * WP Fastest Cache Premium |
| 90 | * Powerpack (WPTouchPro) |
| 91 | * W3 Total Cache |
| 92 | * Breeze |
| 93 | * PhastPress |
| 94 | * WP Super Cache |
| 95 | * Litespeed Cache |
| 96 | * Swift Performance |
| 97 | * PageSpeed Ninja |
| 98 | * Comet Cache by WP Sharks |
| 99 | * Hummingbird |
| 100 | * SG Optimizer |
| 101 | * WP-Optimize - only the page caching must be disabled, not the entire plugin |
| 102 | * Smush - only the lazy load option must be disabled, not the entire plugin |
| 103 | * JetPack - only the lazy load option must be disabled, not the entire plugin |
| 104 | * ShortPixel - only the WebP conversion option must be disabled, not the entire plugin |
| 105 | |
| 106 | ## 3rd Party Services Used By The NitroPack Plugin |
| 107 | |
| 108 | The NitroPack plugin acts as a service. It calls/sends data to our API servers, which perform all of the optimizations. |
| 109 | As a result, our infrastructure does all the heavy lifting. That’s how NitroPack ensures low CPU overhead for your servers. |
| 110 | To learn more about what NitroPack provides as a service as well as what data it collects and uses, please visit: |
| 111 | |
| 112 | * Our website - [https://nitropack.io/](https://nitropack.io/) |
| 113 | * Terms of Use - [https://nitropack.io/page/terms](https://nitropack.io/page/terms) |
| 114 | * Privacy Policy - [https://nitropack.io/page/privacy](https://nitropack.io/page/privacy) |
| 115 | |
| 116 | NitroPack also uses Amazon CloudFront and Bunny CDN to accelerate content delivery across the globe. |
| 117 | For more information about these services, please visit: |
| 118 | |
| 119 | * The official CloudFront page - [https://aws.amazon.com/cloudfront/](https://aws.amazon.com/cloudfront/) |
| 120 | * The AWS Service Terms page - [https://aws.amazon.com/service-terms/](https://aws.amazon.com/service-terms/) |
| 121 | * BunnyCDN’s website - [https://bunnycdn.com/](https://bunnycdn.com/) |
| 122 | * BunnyCDN’s Terms of Service - [https://bunnycdn.com/tos](https://bunnycdn.com/tos) |
| 123 | * Bunny CDN’s Privacy & Data Policy - [https://bunnycdn.com/privacy](https://bunnycdn.com/privacy) |
| 124 | |
| 125 | == Installation == |
| 126 | |
| 127 | 1. Click the “Download” button on this page. You’ll get a .zip file, which you can save on your computer. |
| 128 | 2. Go to your website’s dashboard, open the “Plugins” menu and click “Add new”. After that, choose the nitropack.zip file and click “Install Now” |
| 129 | 3. You now need to **connect your website to NitroPack**. Simply go to [https://nitropack.io/](https://nitropack.io/) and create an account. After you log in, you’ll see a “Connect Your Website” menu on the left. There, you’ll find a Site ID and Site Secret. |
| 130 | 4. Go back to your website’s dashboard. Click “Settings” and find the NitroPack option. Finally, enter your Site ID and Site Secret and click “Connect to NitroPack”. |
| 131 | |
| 132 | That’s all there is to it! |
| 133 | |
| 134 | |
| 135 | |
| 136 | == Frequently Asked Questions == |
| 137 | |
| 138 | = Does NitroPack modify site files? = |
| 139 | |
| 140 | No. NitroPack works on copies of your site files. However, it does modify your wp-config.php file if WP_CACHE is not enabled yet. |
| 141 | |
| 142 | = I installed NitroPack but my pages are still slow. Why? = |
| 143 | |
| 144 | After installing and activating NitroPack, you must log into your account, go to “Connect Your Website” and use the provided Site ID and Site Secret to connect the plugin to our cloud service. |
| 145 | |
| 146 | = Why my scores are still low after connecting NitroPack? = |
| 147 | |
| 148 | After connecting NitroPack you need to select your desired optimization mode - Standard, Medium, Strong or Ludicrous. Once you do that, please visit your home page and allow NitroPack a minute to prepare an optimized version of your page. You can then run the tests again. |
| 149 | |
| 150 | = How long does it take for pages to get optimized? = |
| 151 | |
| 152 | It usually takes NitroPack a few seconds to optimize your pages. |
| 153 | |
| 154 | = Can I use another page caching plugin and NitroPack at the same time? = |
| 155 | |
| 156 | WordPress’s design allows you to use only one page cache solution at a time. Other page cache solutions are designed this way too. However, you can use other non-page cache optimization solutions perfectly well with NitroPack.io (e.g. database optimization plugins, object caching, etc.). |
| 157 | |
| 158 | = What if I have a question? = |
| 159 | |
| 160 | You can contact us anytime at https://m.me/getnitropack |
| 161 | |
| 162 | = Will NitroPack slow down my server? = |
| 163 | |
| 164 | No. We’ve designed NitroPack to be a very lightweight solution that adds no CPU overhead to your server. |
| 165 | |
| 166 | == Screenshots == |
| 167 | 1. Connect your store |
| 168 | 2. Dashboard - see and manage the data in your Nitropack.io |
| 169 | |
| 170 | == Changelog == |
| 171 | |
| 172 | = 1.5.4 = |
| 173 | * Change: Bump up the tested-up-to version for WP 5.7 |
| 174 | * Bug fix: Resolve a constant already defined error |
| 175 | * Bug fix: Resolve an issue with the positioning of the status dot in the admin bar |
| 176 | |
| 177 | = 1.5.3 = |
| 178 | * New Feature: Safe Mode toggle within the plugin's dashboard |
| 179 | * Improvement: Add support for an upcoming improvement in the compatibility with reverse proxies like Cloudflare and Sucuri |
| 180 | * Improvement: Add a filter to allow the list of cacheable post types to be extended - `nitropack_cacheable_post_types` |
| 181 | * Improvement: Better handling of WooCommerce price updates |
| 182 | * Bug fix: Cache warmup was not being triggerd when posting a new article. This is resolved now. |
| 183 | |
| 184 | = 1.5.2 = |
| 185 | * Improvement: Faster cache purge via the webhook |
| 186 | * Improvement: Purging/Invalidating cache via WP-CLI is now direct and provides better feedback of the result |
| 187 | * Bug fix: Any cache purge was triggering full cache purge on the local server. This is now resolved. |
| 188 | |
| 189 | = 1.5.1 = |
| 190 | * Bug fix: Resolve an issue causing a fatal error related to undefined class name |
| 191 | |
| 192 | = 1.5.0 = |
| 193 | * New Feature: Compatibility with Cloudflare APO |
| 194 | * Improvement: Better resilience to network related issues |
| 195 | * Improvement: Faster cache purge |
| 196 | * Improvement: Overall stability improvements |
| 197 | * Deprecation: Removed the Invalidate All Cache option. The invalidate action is much better suited for single page invalidations. |
| 198 | |
| 199 | = 1.4.1 = |
| 200 | * Improvement: Performance improvements in content updates |
| 201 | * Improvement: Better compatibility with Download Monitor |
| 202 | |
| 203 | = 1.4.0 = |
| 204 | * New feature: Extended WP-CLI compatibility with ability to purge/invalidate by URL or tag |
| 205 | * New feature: Add a method for dynamically preventing automated purge/invalidate |
| 206 | * Improvement: Compatibility with jQuery 3 |
| 207 | * Improvement: Better compatibility with SiteGround's dynamic cache layer |
| 208 | * Improvement: Overall stability improvements |
| 209 | * Bug fix: Resolve an issue with undefined HTTP_HOST key |
| 210 | |
| 211 | = 1.3.20 = |
| 212 | * Bug fix: Resolve an issue with reverse proxy cache purge through the webhook |
| 213 | |
| 214 | = 1.3.19 = |
| 215 | * Improvement: Stability improvements |
| 216 | |
| 217 | = 1.3.18 = |
| 218 | * New Feature: Pagely compatibility |
| 219 | * Improvement: Even better compatibility with WooCommerce's Geolocate option |
| 220 | * Improvement: More accurate sync with Avada's date based containers |
| 221 | * Improvement: Better compatibility with reverse proxies |
| 222 | * Improvement: Stability improvements |
| 223 | |
| 224 | = 1.3.17 = |
| 225 | * New Feature: Much simpler and easier connect method |
| 226 | * New Feature: Support a new "nitropack_meta_box" capability which allows you to grant access to cache purge on different user roles |
| 227 | * Improvement: Better status notices |
| 228 | * Improvement: Stability improvements |
| 229 | |
| 230 | = 1.3.16 = |
| 231 | * Improvement: Better compatibility with ShortPixel Adaptive Images 2.x |
| 232 | * Improvement: Overall stability and performance improvements |
| 233 | |
| 234 | = 1.3.15 = |
| 235 | * Improvement: Handling of stock quantity changes in WooCommerce via the REST API |
| 236 | * Improvement: Overall stability and performance improvements |
| 237 | |
| 238 | = 1.3.14 = |
| 239 | * Improvement: Better handling of stock quantity changes in WooCommerce |
| 240 | * Improvement: Better handling of updates to non-public post types |
| 241 | * Improvement: More efficient use of our API |
| 242 | * Bug fix: Fix an issue with slow cache propagation after full purge |
| 243 | |
| 244 | = 1.3.13 = |
| 245 | * New feature: Add admin bar entry with quick links to useful actions like purge cache |
| 246 | * New feature: Add WP-CLI methods for invalidating/purging cache |
| 247 | * New feature: Add WP-CLI method for running cache warmup |
| 248 | * Improvement: Automatically detect outdated cache files restored from a backup and do not serve them to clients |
| 249 | * Improvement: Automatically detect connection issues and suggest steps to resolve these |
| 250 | * Improvement: Automatically start optimizing after the plugin is connected successfully |
| 251 | * Improvement: Performance improvements |
| 252 | |
| 253 | = 1.3.12 = |
| 254 | * Bug fix: Resolve a fatal error in the SDK on certain PHP versions |
| 255 | |
| 256 | = 1.3.11 = |
| 257 | * Improvement: Workaround for issue with communicating to our servers in LiteSpeed environments |
| 258 | |
| 259 | = 1.3.10 = |
| 260 | * Bug fix: Resolve an issue with domains starting with "www." which was introduced in v1.3.9 |
| 261 | |
| 262 | = 1.3.9 = |
| 263 | * New feature: Ability to connect/disconnect using WP-CLI |
| 264 | * Improvement: Recognize updates to WooCommerce Cart Reports post types to reduce cache purges |
| 265 | * Improvement: Better Ezoic compatibility |
| 266 | * Bug fix: Resolve an issue with saving the compression status when configured manually |
| 267 | * Overall stability improvements |
| 268 | |
| 269 | = 1.3.8 = |
| 270 | * New feature: Add support for local AJAX caching |
| 271 | * Improvement: Better SiteGround compatibility |
| 272 | * Improvement: Ezoic compatibility |
| 273 | * Improvement: NGINX Helper compatibility |
| 274 | * Bug fix: Resolve an issue which caused problems in WP CLI |
| 275 | * Improvements in the automated cache purge |
| 276 | * Overall stability improvements |
| 277 | |
| 278 | = 1.3.7 = |
| 279 | * Bug fix: Resolve an issue causing insufficient permissions error |
| 280 | |
| 281 | = 1.3.6 = |
| 282 | * Bug fix: Resolve an issue with nonces in REST requests |
| 283 | |
| 284 | = 1.3.5 = |
| 285 | * Improvement: Show instructions for configuring recommended hosting settings if needed |
| 286 | * Improvement: Better detection of taxonomies and archive pages |
| 287 | * Improvement: Better compatibility with ShortPixel |
| 288 | * Improvement: Better WP Engine compatibility |
| 289 | * Improvement: Updated nonce handling |
| 290 | * Bug fix: Category pages were not being optimized if archive optimization was disabled. This is now fixed. |
| 291 | * Bug fix: Fix an issue with custom cache expiration for The Events Calendar |
| 292 | |
| 293 | = 1.3.4 = |
| 294 | * Improvement: Better compatibility with Kinsta |
| 295 | * Improvement: Improved handling of post status transiotions |
| 296 | * Improvement: Allow optimizations for archive pages |
| 297 | |
| 298 | = 1.3.3 = |
| 299 | * Improvement: Optimize all post/page types by default ot avoid confusion why a certain URL is not optimized. |
| 300 | * Improvement: Automatically refresh cache based on comment actions (posting, approving, unapproving, etc.) |
| 301 | |
| 302 | = 1.3.2 = |
| 303 | * Improvement: Workaround for an issue in the WP Engine environment which causes timeouts in certain network communication scenarios. This resolves slow post/page updates in the admin area. |
| 304 | |
| 305 | = 1.3.1 = |
| 306 | * Improvement: Nicer cache purge reason messages |
| 307 | * Bug fix: Resolve an issue where the home page was not always updated after publishing new posts/pages |
| 308 | |
| 309 | = 1.3 = |
| 310 | * New feature: Option select which post types and taxonomies get optimized |
| 311 | * New feature: Option to enable/disable the automated cache purges |
| 312 | * New feature: Automatically warmup new posts/pages |
| 313 | * New feature: Add meta box to allow cache purge/invalidate from the post/page edit screens |
| 314 | * New feature: New and improved way of tracking relationships between pages allowing for smarter automated cache purges, which affect less cache files |
| 315 | * Resolve layout issues in the admin panel on mobile |
| 316 | * Add compatibility with GoDaddy's managed WordPress hosting |
| 317 | |
| 318 | = 1.2.3 = |
| 319 | * Stability improvements |
| 320 | |
| 321 | = 1.2.2 = |
| 322 | * Synchronize the nonce and page cache life times |
| 323 | * Improve cache synchronization when updating menu entries |
| 324 | * Improve cache synchronization when making appearance customizations |
| 325 | * Fix false "plugin conflict" error with WP Optimize |
| 326 | * Stability improvements |
| 327 | |
| 328 | = 1.2.1 = |
| 329 | * Added support for Fusion Builder's container expiration |
| 330 | * Added compatibility with the Post Expirator plugin |
| 331 | * Added compatibility with the Portfolio Sorting plugin |
| 332 | * Stability improvements |
| 333 | |
| 334 | = 1.2 = |
| 335 | * Stability improvements |
| 336 | |
| 337 | = 1.1.5 = |
| 338 | * Improved cache management for scheduled posts |
| 339 | * Fix cache expiration for posts scheduled for dates in the past |
| 340 | * Better update handling |
| 341 | |
| 342 | = 1.1.4 = |
| 343 | * Stability improvements |
| 344 | |
| 345 | = 1.1.3 = |
| 346 | * Prevent crashes originating from missing functions.php file |
| 347 | |
| 348 | = 1.1.2 = |
| 349 | * Better handling of automated updates |
| 350 | |
| 351 | = 1.1.1 = |
| 352 | * Automatically update the advanced-cache.php file after plugin update |
| 353 | |
| 354 | = 1.1 = |
| 355 | * Performance and stability improvements |
| 356 | |
| 357 | = 1.0 = |
| 358 | * Initial release |
| 359 |