Aller au contenu

Héberger cette documentation

Cette documentation est livrée avec KiwiDesk sous forme d’une image Docker ghcr.io/kaipicpic/kiwidesk-docs : un site statique servi par nginx, sans base de données ni compte. Elle s’installe à côté de l’application, dans la même stack, pour que l’équipe y accède depuis le lien Documentation de KiwiDesk.

Le fichier docker-compose.yml contient un service docs, publié sur le port 3080 du serveur (variable DOCS_PORT). Il démarre avec le reste de la stack et suit la même version (KIWIDESK_VERSION).

  1. Choisissez l’adresse de la documentation : http://<serveur>:3080 sur le réseau local, ou un sous-domaine derrière votre reverse proxy, par exemple https://docs.kiwidesk.ma-boutique.fr relayé vers 127.0.0.1:3080 (même configuration que pour l’application, voir Reverse proxy et HTTPS).

  2. Indiquez cette adresse dans .env :

    DOCS_URL=https://docs.kiwidesk.ma-boutique.fr
  3. Appliquez : docker compose -f docker-compose.yml up -d.

Le lien Documentation apparaît dans le menu du compte (en bas de la barre latérale) et dans la fenêtre des raccourcis clavier (touche ?). Il ouvre l’adresse DOCS_URL dans un nouvel onglet. La variable est lue au démarrage du service web : pas besoin de reconstruire l’image. Quand DOCS_URL est vide, le lien ouvre une page qui indique que la documentation n’est pas configurée.

Si vous ne voulez pas de la documentation sur le serveur, supprimez le service docs de votre copie du fichier compose et videz DOCS_URL (ou faites-la pointer vers une autre copie de la documentation).

La recherche du site (en haut de chaque page) fonctionne sans service externe : son index est construit avec le site et chargé par le navigateur.