Retour : Le plugin qui simplifie la gestion des redirections dans Kirby

Il y a des plugins qu'on découvre et qu'on oublie aussitôt. Et puis il y a Retour pour Kirby, qui tombe clairement dans la catégorie des indispensables. Ce petit module fait quelque chose de très simple mais terriblement utile. Il vous donne une vue d'ensemble sur toutes les erreurs 404 qui surviennent sur votre site et vous laisse créer des redirections quand c'est nécessaire.

Pour ceux qui ont suivi mon dernier tuto sur la personnalisation des pages d'erreur dans Kirby, ça s'inscrit dans la même démarche. Une suite naturelle, pourrait-on dire.

Bon, si vous faites partie de ces rares développeurs qui ne génèrent jamais d'erreurs 404, cette présentation ne vous concerne probablement pas... Pour le reste d'entre nous, mortels du web confrontés régulièrement à ces petits soucis de redirection, la suite devrait vous intéresser.

Présentation du plugin

L'image ci-dessus illustre assez bien ce que le plugin a dans le ventre. En pratique, il vous offre la possibilité de créer des redirections basées sur des règles que vous définissez vous-même, avec le support des wildcards pour gérer plusieurs URLs en une seule fois. Les codes de statut HTTP sont également personnalisables selon vos besoins.

L'autre fonctionnalité intéressante, c'est le monitoring des requêtes perdues. Toutes ces tentatives d'accès à des pages qui n'existent plus ou jamais existé, Retour les enregistre. C'est loin d'être anecdotique quand on sait l'impact que peuvent avoir ces erreurs 404 sur le référencement d'un site. Mais le vrai point fort reste probablement la simplicité d'utilisation. Tout passe par le Panel de Kirby, cette interface familière qu'on utilise déjà au quotidien. Aucune manipulation de code n'est requise, pas de fichiers de config à éditer manuellement non plus.

Installation

Pour information, le CMS Kirby ne vous impose pas l'utilisation de composer.

Toutefois si vous l'utilisez, vous avez juste à faire :

composer require distantnative/retour-for-kirby

Si vous n'utilisez pas composer, vous pouvez l'installer manuellement :

1. Télécharger le plugin et le décompresser
2. Copier le répertoire du plugin au niveau de votre projet Kirby dans /site/plugins/retour
3. Naviguer sur l'interface d'administration de votre site, vous devriez voir le lien Redirections

La documentation explique également pour mettre à jour le plugin : https://distantnative.com/retour-for-kirby/quickstart

Fonctionnement

Visualisation et ajout des redirections

La création d'une nouvelle redirection commence par un clic sur le bouton "Ajouter" placé au-dessus du tableau. Cette action fait apparaître un panneau où vous pouvez entrer l'ensemble des informations requises. Pour modifier ou supprimer une route déjà existante, il suffit de cliquer sur la ligne correspondante dans le tableau ou d'utiliser l'option du menu déroulant.

Dans le champ "Chemin", vous indiquez le segment d'URL qui suit le domaine de votre site et que vous voulez intercepter. Un chemin statique comme "url-en-erreur" fonctionne très bien, mais les redirections dynamiques sont aussi possibles grâce aux espaces réservés, comme dans "blog/(:all)". Ces derniers utilisent les patterns de route propres à Kirby.

La destination de la redirection se configure dans "Rediriger vers", et là les possibilités sont multiples. Une URL externe complète comme "https://getkirby.com" peut être spécifiée. Vous pouvez aussi sélectionner une page de votre site via le sélecteur de liens, ou indiquer un chemin relatif du type "blog/2018/a-nice-story". Pour afficher la page d'erreur du site, il suffit d'entrer "error". En laissant ce champ vide, vous provoquerez l'échec de la requête du navigateur, ce qui est utile pour certains codes de statut HTTP hors de la plage 3xx.

Si votre chemin contient des placeholders, vous pouvez les réutiliser dans la destination avec la syntaxe "$1", "$2", etc. Ainsi "project/(:any)/photos" devient "project/$1/gallery", et "blog/(:any)/(:all)" se transforme en "notes/$1/entries/$2".

Le code de statut HTTP que vous choisissez détermine comment la redirection se comporte. Les codes 3xx redirigent effectivement la requête et changent l'URL visible dans le navigateur. Pour les autres codes, la page cible s'affiche au chemin d'origine sans modification d'URL, ou bien la requête échoue avec le code sélectionné si vous n'avez rien mis dans "Rediriger vers".

L'activation du flag de priorité fait en sorte que la route de redirection écrase même les pages existantes. Sans cette activation, seuls les chemins qui n'existent pas déjà peuvent être redirigés.

Vous disposez d'un champ "Commentaire" pour noter ce qui vous semble important, comme la raison d'être de cette redirection. C'est particulièrement utile en équipe, d'autant que Retour enregistre automatiquement l'utilisateur à l'origine de la modification.

Le tri du tableau des routes se modifie en cliquant sur les en-têtes de colonnes, ce qui facilite la vue d'ensemble. Un bouton près du bouton "Ajouter" active un champ de recherche qui filtre les lignes selon le terme que vous entrez.

Surveiller les requêtes échouées avec l'onglet "Echecs"

Le plugin Retour vous offre la possibilité de suivre les requêtes vers votre site que Kirby n'a pas pu traiter, notamment lorsque la page demandée n'existe tout simplement pas. Ces informations sont précieuses car elles vous permettent d'identifier où quelque chose ne fonctionne pas correctement. En d'autres termes, vous pouvez voir exactement où vos utilisateurs rencontrent des problèmes.

Lorsque vous ouvrez Retour pour la première fois, les données affichées correspondent au mois en cours. Cette période sélectionnée s'applique non seulement aux graphiques statistiques, mais aussi à toutes les données des tableaux. C'est particulièrement important pour les échecs puisque seuls ceux survenus pendant la période choisie apparaissent à l'écran. Le même principe vaut pour la colonne de comptage dans l'onglet des redirections ou les chiffres globaux de l'onglet système.

La barre de navigation vous permet de modifier facilement cette période. Vous pouvez naviguer entre le mois précédent et le suivant, ou même changer l'échelle pour afficher une année complète, un jour spécifique ou n'importe quel intervalle personnalisé selon vos besoins.

Chaque ligne du tableau propose une option accessible via les trois points situés à droite pour créer une nouvelle redirection basée sur la requête échouée. Le chemin sera automatiquement pré-rempli pour éviter que ces échecs ne se reproduisent à l'avenir. Une fois que vous enregistrez cette nouvelle route, toutes les entrées d'échec pour ce chemin seront également marquées comme résolues dans les statistiques.

Le nettoyage des logs peut s'avérer nécessaire selon votre utilisation. Vous avez deux possibilités pour cela. La première consiste à effectuer cette opération manuellement en cliquant sur le bouton situé au-dessus du tableau des échecs. La seconde option est automatique et s'active via le paramètre "distantnative.retour.deleteAfter" qui efface les anciennes données selon l'intervalle que vous définissez.

Pour conclure

Au final, Retour s'impose comme un plugin indispensable pour qui veut garder son site Kirby en bonne santé.

L'approche est pragmatique : plutôt que de vous laisser découvrir vos erreurs 404 par hasard, le plugin vous les présente sur un plateau et vous permet d'y répondre rapidement. La gestion des redirections via le Panel évite les manipulations hasardeuses dans les fichiers de configuration.

C'est exactement le type d'outil qui se fait oublier une fois installé, mais qui travaille discrètement pour vous.

Si vous utilisez Kirby professionnellement, difficile de passer à côté.

Plus d'informations

Recommandations