distantnative/retour-for-kirby

Advanced redirection management and error tracking for Kirby 3

2.0.0 2019-08-06 09:48 UTC

README

Version Dependency License Donate

Add a Panel view where you can manage advanced redirections and error tracking based on rules supporting wildcards and HTTP status codes. Make sure to take your visitors where they are heading.

Screenshot

This plugin is completely free and published under the MIT license. However, if you are using it in a commercial project and want to help me keep up with maintenance, please consider making a donation of your choice or purchasing your Kirby license(s) through my affiliate link.

Installation

Download, unzip and copy this repository to /site/plugins/retour.

Alternatively, you can install it with composer:

composer require distantnative/retour-for-kirby

What is it about?

Redirects

URL pattern
Path to catch via the plugin and redirect. Can use routing patterns, e.g. (:any) or (:all), learn more.

Please notice that you can only create redirects for paths where no actual page exists. Existing pages or routes will always overrule redirects set up in Retour.

Redirect to
Four options:

  • Relative path inside your own site (e.g. blog/2018/a-nice-story)
  • URL of external website (e.g. https://getkirby.com)
  • error to return your site's error page
  • empty to let the browser request fail (for status codes not in the 3xx range)

If you use routing patterns, the matched parts can be used via numbered variables ($1, $2...): e.g. project/(:any)/photos => project/$1/gallery.

Status
HTTP status codes in the 3xx range will actually redirect the request to the new location (URL changes). All other HTTP status codes have the option to return a specified page with the selected HTTP status code (while the URL stays the same) or let the browser request fail with the selected HTTP status code (if you leave the Redirect to field empty).

  • #7ea328 Redirects (300-399)
  • #f0c674 Other HTTP status codes
  • #c82829 disabled

Options

Option Default Description
distantnative.retour.deleteAfter false Number of months after which all the tracking log entries should be deleted automatically. Turned off by default

Permissions

Access

title: Editor

permissions:
  access:
    retour: false

Update

title: Editor

permissions:
  site:
    update: false

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you encounter any problem, please create an issue.