silverstripe/redirectedurls

Provides a system for users to configure arbitrary redirections in the CMS

Installs: 382 880

Dependents: 12

Suggesters: 0

Security: 0

Stars: 32

Watchers: 6

Forks: 49

Open Issues: 15

Type:silverstripe-vendormodule

3.0.0 2023-02-28 17:13 UTC

This package is auto-updated.

Last update: 2024-02-09 02:18:19 UTC


README

Latest Stable Version License Monthly Downloads

Authors:

  • Sam Minnée
  • Stig Lindqvist
  • Russ Michell

This module provides a system for users to configure arbitrary redirections in the CMS. These can be used for legacy redirections, friendly URLs, and anything else that involves redirecting one URL to another.

The URLs may include query-strings, and can be imported from a CSV using the "Redirects" model admin included.

The redirection is implemented as a plug-in to the 404 handler, which means that you can't create a redirection for a page that already exists on the site.

Requirements

  • PHP ^8.1
  • Silverstripe CMS ^5

Legacy:

  • Silverstripe CMS ^4: ^2 tags
  • Silverstripe CMS ^3: ^1 tags

Installation

  • Use composer to run the following in the command line:
  composer require silverstripe/redirectedurls

Usage

  1. Click 'Redirects' in the main menu of the CMS.
  2. Click 'Add Redirected URL' to create a mapping of an old URL to a new URL on your Silverstripe website.
  3. Enter a 'From Base' which is the URL from your old website (not including the domain name). For example, "/about-us.html".
  4. Alternatively, depending on your old websites URL structure you can redirect based on a query string using the combination of 'From Base' and 'From Querystring' fields. For exmaple, "index.html" as the base and "page=about-us" as the query string.
  5. As a further alternative, you can include a trailing '/*' for a wildcard match to any file with the same stem. For example, "/about/*".
  6. Complete the 'To' field which is the URL you wish to redirect traffic to if any traffic from. For example, "/about-us".
  7. Alternatively you can terminate the 'To' field with '/*' to redirect to the specific file requested by the user. For example, "/new-about/*". Note that if this specific file is not in the target directory tree, the 404 error will be handled by the target site.
  8. Create a new Redirection for each URL mapping you need to redirect.

For example, to redirect "/about-us/index.html?item=1" to "/about-us/item/1", set:

From Base:  /about-us/index.html
From Querystring:  item=1
To:  /about-us/item/1

Importing

  1. Create a CSV file with the columns headings 'FromBase', 'FromQuerystring' and 'To' and enter your URL mappings.
  2. Click 'Redirects' in the main menu of the CMS.
  3. In the 'Import' section click 'Choose file', select your CSV file and then click 'Import from CSV'.
  4. Optionally select the 'Replace data' option if you want to replace the RedirectedURL database table contents with the imported data.

CSV Importer, example file format:

FromBase, FromQuerystring, To
/about-us/index.html, item=1, /about/item/1
/example/no-querystring.html, ,/example/no-querystring/
/example/two-queryparams.html, foo=1&bar=2, /example/foo/1/bar/2
/about/*, ,/about-us

Allowing redirects from Asset URLs

This assumes that your project as silverstripe/assets.

Please note: By default, many web services will route assets (and other resources) directly through Nginx. If this is the case for you, then please be aware that adding the following extension will not be enough to enable this functionality.

---
Name: app-redirectedurls
---
SilverStripe\Assets\Flysystem\FlysystemAssetStore:
  extensions:
    - SilverStripe\RedirectedURLs\Extension\AssetStoreURLHandler

Routing assets through Apache

This might differ for your web service, but you can use the following for any service that respect the .platform.yml configuration, and you can use this if you are using the latest Silverstripe dev-boxes.

Performance considerations

Be very aware that Apache is slower than Nginx for serving static resources. Making this change could mean a significant impact to your application's performance.

Implementation

URL rules allow you to customise default behaviour:

url_rules:
  mysite:
    - '<regex>': '<rule>'

The regex must be in a format accepted by nginx. This will be used as a case-insensitive location matcher and is compared against the full URL.

  • ^/assets/ - match all URLs pointing to the assets directory
  • \.(gif|jpg|jpeg)$ - match extensions at the end of the URL

For example, if you wanted to route all assets through Apache.

platform.yml:

url_rules:
  mysite:
    - '^/assets/': 'apache'

Some thoughts on limiting what assets are served from Apache

Instead of serving all assets, is there are specific extension (or extensions) that you could call out? EG, is it only PDFs that you want to support redirect for?

url_rules:
  mysite:
    - '^/assets/.+\.(pdf)$': 'apache'

Or what about only serving a specific asset directory that you've specified with your content authors?

url_rules:
    mysite:
        - '^/assets/Documents/': 'apache'