Skip to content

Console self-host

La console self-host vérifie que l’image Docker autonome contient tout ce qui est nécessaire pour exécuter l’application Nuxt/NFZ et reconstruire la documentation VitePress depuis l’interface d’administration.

Elle est accessible depuis :

txt
/admin/selfhost

Pourquoi cette page existe

En mode self-host, l’application ne se contente pas de servir le build Nuxt. Elle doit aussi pouvoir lancer un build VitePress à chaud lorsque l’administrateur clique sur Build docs.

Le conteneur runtime doit donc embarquer :

  • .output pour l’application Nuxt/Nitro ;
  • docs/ pour les sources VitePress commerciales ;
  • user-guide/ pour le guide utilisateur public ;
  • scripts/prepare-docs-build.ts et scripts/finalize-docs-build.ts ;
  • services/_shared/docs-inline-images.ts et services/_shared/docs-media.ts ;
  • node_modules/.bin/vitepress ;
  • uncrypto sous .output/server/node_modules/uncrypto pour Bun/Nitro/h3.

Contrôles affichés

L’onglet Readiness liste les fichiers et dossiers critiques présents dans le runtime Docker. Un élément manquant indique que le Dockerfile ne copie pas encore une dépendance nécessaire au build documentaire.

L’onglet Commandes rappelle les commandes de reconstruction sans cache, de logs et de diagnostics.

L’onglet Flux self-host résume le chemin complet : authentification locale, édition Markdown, build à chaud et diffusion sous /docs.

Commandes recommandées

Après modification du Dockerfile self-host ou d’une dépendance de build documentaire :

bash
docker compose -f docker-compose.selfhost.yml down
docker compose -f docker-compose.selfhost.yml build --no-cache nfz-docs-builder
docker compose -f docker-compose.selfhost.yml up -d

Pour suivre le runtime :

bash
docker logs -f vpb-selfhosting-nfz-docs-builder-1

Pour valider localement l’archive avant build Docker :

bash
bun run diagnose:selfhost-runtime-build
bun run doctor:docs

Bonnes pratiques

Ne supprime pas les copies runtime de scripts/, services/, node_modules/, docs/ et user-guide/ dans les Dockerfile. Elles sont nécessaires au build VitePress lancé depuis l’application déjà démarrée.

Ne remplace pas le mode self-host par une vérification distante NFZ License Server : la version self-host offline doit rester utilisable sans appel réseau de licence, avec contrôle local par clé publique/privée.

Guide utilisateur public généré avec VitePress.