Ibexa DXP with Fastly

Contents:


Ibexa DXP is a “commercial extended” version of Ibexa OSS that includes, among other things, support for push-based purging on the Fastly CDN.

Remove Varnish configuration 

In Ibexa DXP, Varnish is enabled by default when deploying on Platform.sh. In order to use Fastly, Varnish must be disabled:

 "https://{default}/":
     type: upstream
-     upstream: "varnish:http"
+     upstream: "app:http"

Setting up Ibexa DXP to use Fastly 

Ibexa DXP’s documentation includes instructions on how to configure Ibexa DXP for Fastly. Follow the steps there to prepare Ibexa DXP for Fastly.

Set credentials on Platform.sh 

The best way to provide the Fastly credentials and configuration to Ibexa DXP on Platform.sh is via environment variables. That way private credentials are never stored in Git.

Using the CLI, run the following commands to set the configuration on your production environment (assumed to be main below, but change it to fit your setup). (Note that they inherit to all other environments by default unless overridden.)

platform variable:create -e main --level environment env:HTTPCACHE_PURGE_TYPE --value 'fastly'
platform variable:create -e main --level environment env:FASTLY_SERVICE_ID --value 'YOUR_ID_HERE'
platform variable:create -e main --level environment env:FASTLY_KEY --value 'YOUR_ID_HERE'

Replacing YOUR_ID_HERE with the Fastly Service ID and Key obtained from Fastly.

Note: On a Platform.sh Dedicated Cluster, set those values on the production branch:

platform variable:set -e production env:HTTPCACHE_PURGE_TYPE fastly
platform variable:set -e production env:FASTLY_SERVICE_ID YOUR_ID_HERE
platform variable:set -e production env:FASTLY_KEY YOUR_ID_HERE

Setup the correct VCL files 

There are two VCL files provided as starting points for using Fastly with Ibexa DXP; you can find them in vendor/ezsystems/ezplatform-http-cache-fastly/fastly/*.vcl. They handle varying cache by user context hash (permissions) as well as several other needs by Ibexa DXP and it’s underlying HttpCache system.

Configure Fastly and Platform.sh 

See the alternate Go-live process for Fastly on Platform.sh. This process is the same for any application.