How to setup Concrete CMS behind CDN (Amazon CloudFront)

This is a community-contributed tutorial. This tutorial is over a year old and may not apply to your version of Concrete CMS.
Jul 16, 2016
By hissy for Developers

Issues

The main issue of using Concrete CMS behind CDN is host names.

  • www.example.com
    • CDN (Amazon CloudFront)
    • When guest users access to your site, visit to this host.
  • origin.example.com
    • Origin Web server (concrete5)
    • When you login to concrete5, access to this host. |

When this case, concrete5's canonical URL is origin.example.com, but actual host name for gust users is www.example.com .

The sub issue is cache life time.

CDN stores cache only when the full page cache is enabled, because of Cache-Control header. However, full page cache should be disabled when editing content with concrete because of host name.

How can we solve the issues?

  1. When editing content on origin.example.com, turn off caching.
  2. When viewing content on www.example.com, turn on caching and set www.example.com to canonical URL.

Code

1. Change environment to cdn when HTTP User Agent is 'Amazon CloudFront'.

application/bootstrap/start.php

<?php
use Concrete\Core\Application\Application;

/**
 * -----------------------------------------------------------------
 * Instantiate concrete5
 * -----------------------------------------------------------------
 */
$app = new Application();

/**
 * -----------------------------------------------------------------
 * Detect the environment based on the use agent
 * -----------------------------------------------------------------
 */
$app->detectEnvironment(function(){
    $request = \Concrete\Core\Http\Request::getInstance();
    if ($request->server->get('HTTP_USER_AGENT') == 'Amazon CloudFront') {
        return 'cdn';
    }
});

return $app;

2. Turn off caching on default environment

application/config/concrete.php

<?php

return array(
    'cache' => array(
        'blocks' => false, // turn off block cache
        'pages' => 0, // turn off page cache
    ),
);

3. Turn on caching on cdn environment, and set canonical URLs

application/config/cdn.concrete.php

<?php

return array(
    'cache' => array(
        'blocks' => true, // turn on block cache
        'pages' => 'blocks', // cache page if all blocks support it.
    ),
    'seo' => array(
        'canonical_url' => 'http://www.example.com/',
        'canonical_ssl_url' => 'https://www.example.com/',
    ),
);
Recent Tutorials
Create custom Site Health tasks
Apr 19, 2024
By myq.

This tutorial will guide you through the creation of a new Site Health task

Reusing the same Express entity in multiple associations
Apr 11, 2024
By myq.

How to create and manage multiple associations in Express

Express Form Styling
Apr 11, 2024
By myq.

Different ways to style Express forms

Setting addon/theme version compatibility in the marketplace
Jan 9, 2024

For developers worn out with setting the latest addon or theme version manually across too many core versions, here is a JavaScript bookmarklet to do it for you.

How to get the locale of a page
Jan 8, 2024
By wtfdesign.

Now, why don't we just have a getLocale() method on Page objects beats me, but here's how you work around it

Using a Redis Server
Jun 16, 2023
By mlocati.

How to configure Concrete to use one or more Redis servers to persist the cache.

Improvements?

Let us know by posting here.