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
Customize locale icons
Oct 29, 2024
By myq.

How to customize locale (language region) flags

Concrete CMS Caching Guide
Oct 16, 2024

An overview of types of caching in Concrete and considerations when using them.

Redirect all requests to HTTPS
Oct 9, 2024
By myq.

How to follow best practices for a secure web

Upgrade Concrete versions 9.3.1 and 9.3.2
Sep 10, 2024
By myq.

How to get past a bug in versions 9.3.1 and 9.3.2 that prevents upgrading the Concrete core through the Dashboard

How to use Composer with Marketplace extensions
Aug 22, 2024

Composer can be used to manage third-party extensions from the marketplace

Controlling Google Tag Manager Tags Based on Concrete CMS Edit Toolbar Visibility
Aug 13, 2024

This document provides a step-by-step guide on how to control the firing of Google Tag Manager (GTM) tags based on the visibility of the Concrete CMS edit toolbar. It explains how to create a custom JavaScript variable in GTM to detect whether the edit toolbar is present on a page and how to set up a trigger that ensures GTM tags only fire when the toolbar is not visible. This setup is particularly useful for developers and marketers who want to ensure that tracking and analytics tags are not activated during content editing sessions, thereby preserving the accuracy of data collected.

Improvements?

Let us know by posting here.