dorsetdigital/silverstripe-url-rewriter

Rewrites the URLs of a SilverStripe site

v1.0.1 2021-03-01 22:27 UTC

Requires

• silverstripe/cms: ^4.0
• silverstripe/vendor-plugin: ^1.0

BSD-3-Clause

• Tim Burt

• cdn
• silverstripe

README

Provides a simple method of rewriting the URLs of assets. This was developed primarily for use with the SilverStripe S3 assets module, allowing a quick method of using a CloudFront distribution to serve assets instead of linking directly to the S3 bucket.

Requirements

*Silverstripe 4.x

Installation

• Install the code with composer require dorsetdigital/silverstripe-url-rewriter
• Run a dev/build?flush to update your project

Usage

The module won't make any changes to your site unless you do a bit of configuration. There are a few options you can set, done in a yml file:

---
Name: rewriteconfig
---

DorsetDigital\URLRewriter\Middleware:
  rewrite_enabled: true
  old_url: 'https://old.example.com'
  new_url: 'https://cdn-distribution.example.com'  
  enable_in_dev: true

The options are hopefully fairly self explanatory:

• rewrite_enabled - globally enables and disables the module (default false - disabled)
• old_url - the full URL you wish to rewrite (eg. https://somebucket.s3.aws.com)
• new_url - the new URL you wish to use (eg. https://somedistribution.cloudfront.net)
• enable_in_dev - enable the CDN in dev mode (default false)

Notes

• The module is disabled in the CMS / admin system, so rewrites do not currently happen here
• When enabled, the module will always add an HTTP header of X-Rewrites: Enabled to show that it's working, even if none of the other rewrite operations are carried out. If this is not present and you think it should be, ensure that you have set cdn_rewrite to true, that you have specified the cdn_domain in your config file and that you have enable_in_dev set to true if you are testing in dev mode.