dorsetdigital/silverstripe-smart-redirect

Allows CMS users to build redirection URLs based on browser language, user location and time periods

v1.0.0 2021-12-14 19:13 UTC

Requires

• endroid/qr-code: ^3.9
• geoip2/geoip2: ^2.11
• guzzlehttp/guzzle: ^7.0
• league/iso3166: ^3.0
• silverstripe/cms: ^4.0
• silverstripe/vendor-plugin: ^1.0
• undefinedoffset/sortablegridfield: ^2@stable
• zonuexe/http-accept-language: ^0.4.1

BSD-3-Clause

• Tim Burt

• url
• redirect
• qr code
• silverstripe
• redirection

README

This module provides an interface to create and manage URL redirects based on a number of criteria.

Initially designed to work as an easy method for generating and deploying QR codes, the module can find applications anywhere that conditional redirection may be required (such as URl shorteners, etc.)

Tools are included for redirection based on the browser language, the user's geolocation (IP based using Maxmind) and time / date. A default redirection rule is also included.

Requirements & Dependencies

• Silverstripe 4.x

(See composer.json for additional dependencies)

Installation

Install with composer:

composer require dorsetdigital/silverstripe-smart-redirect

Usage

A set of supported languages and countries is included with the module. If you wish to use the geolocation functionality, you will need a Maxmind licence key for the free Geolite 2 countries database. The module expects this to be set in the environment in: MAXMIND_LICENCE_KEY Once configured, a build task is included to download and extract the most recent Maxmind database. It is expected that this would be run via cron or using the QueuedJobs module periodically to keep the database current.

Screenshots of the QR preview, redirect editing and rule editing screens can be found in the docs directory.

ToDo

• Add internationalisation to all fields / content
• Add ability to enable / disable specific rule types using the configuration API
• Finish docs