Skip to content

Getting started

Requirements

Retour 5 requires Kirby 4.

For Kirby 3, you can use v4.4.2 (although without further support or development).

Install

There are two main ways to install this plugin:

  1. Download & unzip
  2. Copy this repository to /site/plugins/retour.
  3. Visit the Panel view: https://yourwebsite.com/panel/retour

With composer

Alternatively, you can install it with composer:

bash
composer require distantnative/retour-for-kirby

Panel menu

coming soon...

Updates

Make sure to read the release notes for breaking changes before you start the update.

  1. Download & unzip the new version
  2. Replace the /site/plugins/retour folder

Or, if you installed the plugin via composer, run:

bash
composer update distantnative/retour-for-kirby

Create a backup

When updating, always make sure to first create backups of the redirects config (/site/config/retour.yml) and database (/site/logs/retour/log.sqlite).