https://github.com/modxcms/maxcdn
MODX integration for speeding up sites via MaxCDN: http://www.maxcdn.com/
https://github.com/modxcms/maxcdn
Last synced: about 1 month ago
JSON representation
MODX integration for speeding up sites via MaxCDN: http://www.maxcdn.com/
- Host: GitHub
- URL: https://github.com/modxcms/maxcdn
- Owner: modxcms
- Created: 2014-05-15T17:57:40.000Z (about 11 years ago)
- Default Branch: develop
- Last Pushed: 2015-07-15T19:38:56.000Z (almost 10 years ago)
- Last Synced: 2025-04-19T19:32:11.569Z (about 2 months ago)
- Language: PHP
- Size: 504 KB
- Stars: 4
- Watchers: 10
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# MODX MaxCDN Toolkit
## Introduction
The MODX MaxCDN Toolkit provides the necessary elements to dynamically integrate MaxCDN with MODX. There are five elements to the toolkit:
* __Rules Manager__: The Rules Manager allows for frontend rules to be specified via a regular expression syntax. These rules will allow the targetted link structures (such as src or href attributes) to be rewritten to point to your CDN URL.
* __MaxCDN Linker Plugin__: The MaxCDN Linker plugin accesses the rules specified in the Rules Manager and dynamically rewrites the link structures on the frontend. See the Selective Caching section below.
* __MaxCDN Purge on Clear Cache Plugin__: The Purge Cache plugin will send a 'purge all' request to MaxCDN when using the Clear Cache menu option in the MODX Manager. This plugin can be enabled or disabled via the _mcdn.purge_on_clear_cache_ system setting.
* __MaxCDN Manager Plugin__: The MaxCDN Manager plugin provides advanced manager integration. It is only applicable if you are using a MaxCDN Enterprise plan and are utilising the full-page caching implementation (covered below in the Full-Page Caching section). By default, this is disabled on install due to it's specific usage requirements.
* __Purge Tool__: A simple form-based Purge tool allowing either a full purge of the MaxCDN pull zone or selective purging of individual files.
## Pre-Requisites
The following pre-requisites are required prior to installation:
* You have signed up for MaxCDN and configured your pull zone
* Signup [here](http://tracking.maxcdn.com/c/90953/3982/378?u=http%3A%2F%2Fwww.maxcdn.com%2Fmodx%2F) for the MODXers 25% discount
* Configure a pull zone: https://www.maxcdn.com/one/tutorial/how-to-create-a-pull-zone/
* Implement the SEO options on your pull zone: https://www.maxcdn.com/one/tutorial/use-seo-with-cdn/
* You have created an API application within MaxCDN's control panel
* Get an API Key/Secret pair: https://www.maxcdn.com/one/tutorial/create-api-idkey-pair/
* PHP 5.3 or above
## Installation
On installation of the MaxCDN component, have the following pieces of information available to expedite the setup:
* Your Pull Zone ID
* Your Company Alias
* Your Consumer Key/Secret pair
* Your default CDN URL (the MaxCDN generated CDN URL, xxx.yyy.netdna.com)
__Note: It is recommended that you initially select the _disabled_ option on install otherwise the MaxCDN Linker plugin will be immediately active which may not be desired. Once the component is installed, you can check settings, make any configuration or rule changes and then enable the MaxCDN integration.__
## Difference between CDN Strategies
### Selective CDN Caching
Selective caching is where you specifically target certain frontend static assets normally served from your site's domain to be served from the CDN domain instead. The MODX MaxCDN Toolkit supports this approach via a combination of the Rules Manager and the MaxCDN Linker plugin.
With the Rules Manager, you can either use the default rules (which should satisfy most use cases) or you can be more specific with custom rules, for example, only CDN cache assets in a certain folder or with a certain extension. These rules are applied against content types and can be applied to specific contexts for even granular targeting of assets.
See the section on Basic CDN Sharding to see how custom rules can be used to improve your site's frontend loading performance beyond the advantages already given by caching through MaxCDN.
#### Default Rules
For the purpose of documentation or if you do not select the 'Install Default Rules' option on install and later decide you want to use them, here are the default rules shipped with the MODX MaxCDN Toolkit:
__1. Site URL src and href links__
Replace src and href links that start with the site URL.
* Input Rule: ``((?:<(?:a|link|img|script)\b)(?:[^>]+)(?:href|src)=")(?:{site_url})([^>]+\.(?:jpe?g|png|gif|svg|xml|js|css)")``
* Output Format: ``{match1}{cdn_url}{match2}``
__2. Base URL src and href links__
Replace src and href links that start with the base URL.
* Input Rule: ``((?:<(?:a|link|img|script)\b)(?:[^>]+)(?:href|src)=")(?:{base_url})([^/][^>]+\.(?:jpe?g|png|gif|svg|xml|js|css)")``
* Output Format: ``{match1}{cdn_url}{match2}``
__3. Relative URL src and href links__
Replace relative src and href links.
* Input Rule: ``((?:<(?:a|link|img|script)\b)(?:[^>]+)(?:href|src)=")(?!(?:https?|/))([^>]+\.(?:jpe?g|png|gif|svg|xml|js|css)")``
* Output Format: ``{match1}{cdn_url}{match2}``
### Web fonts
If you want to cache web fonts via MaxCDN, you can add the extensions to the default rules above but please read this [MaxCDN support article](http://support.maxcdn.com/howto/use-cdn-with-webfonts/) first as the article outlines some important webserver configuration changes required to avoid security issues with some browsers.
### Full-Page Caching
Full-page caching is a different configuration and requires a MaxCDN Enteprise plan. In a full-page caching scenario, you would configure your pull zone as such:
1. Create an A Record, origin.example.com that points to the IP of your site.
2. Configure your web server, if needed, to route the domain to your MODX install.
3. Create your pull zone, add origin.example.com as your Origin URL and add your site's domain as a custom CDN domain.
4. Change your site's domain to a CNAME record that points to the default CDN URL provided by MaxCDN, xxx.yyy.netdna.com.
5. Allow time for the DNS changes to propagate but then your site should be getting served via MaxCDN.
6. Install [microcache](https://github.com/opengeek/microcache/) to allow cache headers be set for your MODX resources.
7. Disable the MaxCDN Linker plugin and enable the MaxCDN Manager plugin, this will provide an additional button when saving resources that will you to save and then send a purge request to MaxCDN for that particular MODX resource.
## CDN Sharding
CDN sharding is a method whereby assets are served from several different CDN URLs to allow more concurrent requests to be handled by the browser thus resulting in quicker page load times.
First, you will need to make sure you have several alternative CDN URLs specified in the MaxCDN Control Panel. For each rule you create or update, you can assign multiple CDN URLs that will be used. The assigned CDN URLs will utilize a round-robin assignment on a per-rule basis when matches are found via the MaxCDN Linker plugin. This method means you can have different groups of CDN URLs assigned to different rules.
While this method will also work with SSL domains, you will need to have the Wildcard SSL addon from MaxCDN with a wildcard SSL certificate installed in the MaxCDN dashboard (please note the Wildcard SSL addon is an expensive option so, unfortunately, may not be suitable in a majority of deployments).
__Note: If you are using the full-page caching strategy, you can still use the Rules Manager to do CDN sharding, just make sure you have the MaxCDN Linker plugin enabled.__
## SSL Support
When adding a rule, you can select the scheme to use for the CDN URL from one of the following: HTTP, HTTPS, or Schemeless.
Custom SSL domains can only be added in the MaxCDN Control Panel if you have the EdgeSSL add-on however all MaxCDN accounts can make use of the Shared SSL domain if you enable it in the MaxCDN Control Panel. Details on the Shared SSL can be found here: http://support.maxcdn.com/howto/setup-shared-ssl/
__Note: Do not specify HTTPS on any domains that you haven't set up either via the Shared SSL option or the EdgeSSL add-on in the MaxCDN Control Panel. You will insecure content loading errors if you do.__