Guides

Cette section rassemble des guides pratiques : des recettes pas-à-pas pour résoudre un problème précis, qui supposent que vous connaissez déjà les bases de Kirexo.

Guides disponibles

• Activer l'autocomplétion Castor sur l'hôte — bash, zsh, fish ; dans le devcontainer c'est déjà actif.
• Exécuter les tests — lancer la suite de tests unitaires, d'intégration et E2E.
• Whitelister un domaine — autoriser une URL bloquée par le pare-feu du devcontainer.
• Debugger le pare-feu du Dev Container — inspecter iptables, ipset, dnsmasq quand une commande échoue suspectement.
• Pousser depuis le Dev Container — git push en HTTPS via le credential helper glab (SSH absent du conteneur par design).
• Bootstrapper la pipeline CI — séquence d'actions one-shot sur une nouvelle instance GitLab (DNS, PAT, variable CI/CD, custom domain Pages, schedule, premier build des images CI). À jouer avant les autres guides CI.
• Créer un tag de release — déclencher une release (build Docker, doc, release GitLab) via la pipeline CREATE_TAG=true.
• Déployer Kirexo en production — pull d'une image immuable taggée et rollback via KIREXO_VERSION.
• Configurer la cleanup policy du registry — empêcher le Container Registry du projet d'accumuler les tags kirexo-prod:<YYYYMMDDHHMM> au fil des releases.
• Configurer le domaine GitLab Pages — associer doc.kirexo.app et provisionner le certificat Let's Encrypt.
• Configurer l'audit de sécurité quotidien — créer la schedule GitLab qui lance composer audit chaque matin et tente d'ouvrir une MR de patch (fallback issue), et qui déclenche en même temps Renovate, le contrôle des outils et le scan CVE des images (kirexo-prod, kirexo-base, kirexo-dev).
• Configurer le rebuild hebdomadaire de la doc — schedule dédiée (REBUILD_DOCS=true) qui réveille pages chaque lundi pour rafraîchir le rendu de la doc figée sur le dernier tag.
• Configurer les montées de version automatiques (Renovate) — activer le bot qui ouvre des MRs de montée de version et de sécurité (réutilise le GITLAB_TOKEN).

Guides à venir

Voici les guides qui seront publiés au fur et à mesure de l'avancement du projet :

• Connecter son compte Mastodon à Kirexo.
• Configurer un plugin de diffusion.
• Écrire son propre plugin (implémenter DiffusionPluginInterface).
• Migrer ses articles depuis WriteFreely.

Si vous cherchez un guide qui n'est pas dans cette liste, ouvrez une issue sur le dépôt.