Aller au contenu principal

BookStack sur Google Cloud Run

BookStack sur Google Cloud Run

BookStack est une plateforme wiki et de documentation gratuite, open source, sous licence MIT, construite sur Laravel (PHP), organisant le contenu en étagères (Shelves) → livres (Books) → chapitres (Chapters) → pages (Pages) avec édition WYSIWYG et Markdown, recherche en texte intégral, révisions de pages et permissions granulaires. Ce module déploie BookStack sur Cloud Run v2 sur la fondation App_CloudRun, qui provisionne et gère l'infrastructure Google Cloud partagée.

Ce guide se concentre sur les services cloud utilisés par BookStack et sur la manière de les explorer et de les exploiter depuis la console Google Cloud et la ligne de commande. Pour les mécanismes communs à chaque application Cloud Run — identité de service, entrée et équilibrage de charge, mise à l'échelle et concurrence, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls, sauvegardes et cycle de vie du déploiement — reportez-vous au guide de la fondation App_CloudRun plutôt que de les répéter ici.


Ce que coûte BookStack sur RAD et comment cela se compare​

BookStack sur le module Cloud Run de RAD coûte environ 84 US$ par mois dans votre propre projet Google Cloud, sans frais de licence supplémentaires — BookStack est open source. Dans un projet géré par RAD pour vous, le même déploiement est facturé à 67 crédits par jour (environ 2 010 par mois, soit environ 201 US$ au prix de la recharge). Ou consultez le guide GKE pour une capacité toujours active sur les pods. Si vous n'avez besoin de BookStack qu'occasionnellement — pour des études, une démo, un projet de courte durée — un projet géré par RAD peut être supprimé et restauré dans les 30 jours sans frais supplémentaires, de sorte que ce chiffre mensuel ne représente que quelques dollars. Voir Mettre en pause gratuitement, ci-dessous.

Ce que vous payez sur RAD​

BookStack est open source, il n'y a donc pas de frais de licence. Vous payez pour trois choses :

Dans un projet Google Cloud que vous possédezDans un projet géré par RAD pour vous
Frais de module, une fois par déploiement75 crédits (7,50 US$ au prix de la recharge)67,5 crédits (10 % de moins)
BuildsInclus dans le prix : pas de frais de build pour la création, 5 mises à jour par mois (mois calendaire UTC) gratuites, puis 2 crédits chacune, et rien pour la suppression ou pour un build échoué, dans la limite de 10 builds échoués par jour (UTC). Les sessions de lab et les projets clients sont l'exception : ils sont toujours facturés au temps de build à la minuteIdem
Coût d'exécution Google CloudFacturé par Google à votre propre compte de facturation, environ 84 US$ par mois pour la configuration par défaut (tableau ci-dessous)Facturé à l'heure en crédits ; RAD publie 67 crédits par jour, environ 2 010 par mois (environ 201 US$ au prix de la recharge)
Qui possède quoiVous possédez le projet et sa facturation ; RAD le déploie et le met à jourRAD possède le projet, avec des garde-fous, des quotas et des alertes budgétaires ; vous avez accès à la console, et un solde minimum acheté est conservé en réserve

Votre premier déploiement réussi sur RAD est exempt de frais de module, quel que soit le montant des frais : une fois par compte, pour un module que vous déployez et payez vous-même (dans une solution, les frais d'une application : la première à réussir ; jamais une session de lab ou un projet client).

10 crédits coûtent 1 US$ en recharge unique, et moins sur un forfait mensuel. Dans un projet géré par RAD, la base de données, le serveur de fichiers et le réseau sont partagés par chaque application du projet, de sorte qu'une deuxième application n'ajoute pas une deuxième base de données.

Coût d'exécution par défaut dans votre propre projet (us-central1, prix catalogue Google) :

Ressource (module par défaut)Par mois
Cloud Run, 1 vCPU / 2 Gio (scaleToZero)13,16 US$
Cloud SQL pour MySQL, 1 vCPU / 3,75 Go, zonal, 10 Go SSD51,02 US$
Serveur de fichiers NFS/cache (petite VM)13,43 US$
Cloud NAT et réseau5 US$
Cloud Storage (modules complémentaires, sauvegardes)1 US$
Totalenviron 84 US$

Le prix de Cloud SQL et des pods Cloud Run/GKE est le même en africa-south1 (Johannesburg) ; la petite VM coûte environ 10 % de plus là-bas.

  • La mise à l'échelle à zéro est la valeur par défaut sur Cloud Run. Le chiffre ci-dessus suppose une utilisation quotidienne modeste ; définissez min_instance_count ≥ 1 pour le maintenir toujours actif (et éviter les démarrages à froid), ce qui augmente la ligne Cloud Run mais pas le reste du tableau.

Comment cela se compare, pour le wiki d'une petite équipe​

Le projet BookStack lui-même ne vend pas d'hébergement ; une poignée de fournisseurs tiers répertorient l'hébergement BookStack sur la page des sponsors de bookstackapp.com, mais RAD n'a pas obtenu de prix actuel de leur part, donc aucun n'est cité ici. La comparaison qui peut être vérifiée est un serveur nu :

  • Un droplet Hetzner CPX22 ou DigitalOcean (2 vCPU/4 Go, environ 24 US$/mois) ou un GCP e2-standard-2 (2 vCPU/8 Go, environ 49 US$/mois) ferait fonctionner BookStack et sa base de données MySQL.
  • Sur un VPS nu, vous gérez vous-même MySQL, les sauvegardes, les correctifs de sécurité et les mises à niveau. Le module de RAD vous offre Cloud SQL géré, Secret Manager et Cloud Monitoring pour les frais de module plus l'utilisation de Google Cloud ci-dessus.

Mettre en pause gratuitement : supprimer un projet géré par RAD, le restaurer lorsque vous en avez besoin​

Si BookStack s'exécute dans un projet géré par RAD pour vous, la suppression de l'ensemble du projet — plutôt que la suppression de ce seul module — délie d'abord sa facturation, puis demande à Google de supprimer le projet purement et simplement. Google le conserve, récupérable, pendant 30 jours, et comme la facturation est déjà déliée, rien n'est facturé pendant cette période. Contrairement à la suppression d'un seul module, cela ne supprime pas Cloud SQL, aucune VM ou la ressource de calcul une par une : l'ensemble du projet s'arrête simplement.

Une restauration n'est pas garantie — conservez vos propres sauvegardes. Les conditions de Google Cloud ne garantissent pas qu'un projet restauré, ou les ressources qu'il contient, seront utilisables après sa restauration, de sorte que la restauration ne peut pas être considérée comme un moyen de récupérer un projet supprimé. Avant de supprimer, assurez-vous d'avoir effectué des sauvegardes appropriées des données et de la configuration de l'application et de les avoir stockées en dehors du projet. Si une restauration échoue, ou si le projet restauré ne fonctionne pas, la solution de repli consiste à redéployer l'application (voir la section suivante) et à restaurer sa configuration et ses données à partir de ces sauvegardes.

  • La restauration est une vérification, pas une reconstruction. Dans les 30 jours, le propriétaire du projet peut demander à Google de récupérer le projet et de rattacher son compte de facturation, puis d'exécuter Mettre à jour sur chaque déploiement pour confirmer que tout est revenu. Comme rien n'a été détruit individuellement, cette mise à jour trouve les mêmes ressources déjà présentes, et une mise à jour ne facture jamais les frais de module à nouveau. Les mises à jour sont incluses dans le prix (5 par mois pour chaque déploiement), donc une restauration ne coûte normalement aucun crédit.
  • Ce que cela nécessite. Vous devez posséder le projet (pas un projet dont RAD ne gère que la facturation), le restaurer vous-même dans les 30 jours — après quoi Google le supprime définitivement — et effacer à nouveau le seuil d'admission du niveau (100 crédits pour le niveau sandbox que la plupart des utilisations d'étude/démo conviennent). Google indique que la plupart des services fonctionnent à nouveau pleinement dans les 36 heures suivant une restauration.
  • Un véritable manque : les sauvegardes nocturnes ne survivent pas. Les sauvegardes sont écrites dans un bucket à l'intérieur du projet, et ce bucket a la suppression logicielle de Cloud Storage désactivée, il est donc très probable qu'il disparaisse dès que le projet est supprimé — même si le projet lui-même est récupérable pendant 30 jours. Copiez une sauvegarde (vers Google Drive, ou un bucket en dehors du projet) avant de supprimer s'il y a quelque chose d'irremplaçable ; pour une installation par défaut sans rien d'irremplaçable, cela n'a pas d'importance.

Source : Supprimer et restaurer des projets.

Payer uniquement pendant que vous l'utilisez, l'autre méthode : supprimer et redéployer​

Dans votre propre projet, ou une fois que la fenêtre de restauration de 30 jours ci-dessus est passée, la façon d'arrêter de payer est de supprimer le déploiement et de le redéployer lorsque vous en avez besoin.

  • Ce que coûte un redéploiement. Les frais de module à nouveau (les builds sont inclus) : 75 crédits (7,50 US$) au prix de la recharge. La suppression ne permet d'économiser de l'argent que si BookStack reste inutilisé pendant environ 3 jours ou plus — dans votre propre projet, cela représente environ 2,79 US$ par jour, et dans un projet géré par RAD, c'est 67 crédits par jour.
  • La majeure partie du coût d'exécution ici est généralement la base de données et/ou la VM ou le cluster de fichiers/cache partagé. Ils ne s'arrêtent que si rien d'autre dans le projet ne les utilise, donc la suppression de BookStack alors qu'une autre application partage le projet n'économise que la partie calcul de BookStack.
  • Conserver les données en premier. Les sauvegardes nocturnes vont dans un bucket à l'intérieur du déploiement et sont supprimées avec lui, alors copiez la dernière sauvegarde avant de supprimer si vous voulez la conserver.

Sessions de lab et environnements gérés​

  • Sessions de lab, pour la formation. Un formateur anime une session pour une classe. Chaque participant reçoit l'application dans son propre projet Google Cloud pendant 15 minutes à 24 heures, dans la limite d'une allocation définie par le formateur. Le formateur peut aussi créer un seul environnement partagé pour toute la classe, et chacun utilise alors la même application et ses données. Soit le formateur finance toutes les places, soit chaque participant paie la sienne. Tout est supprimé à la fin de la session et les crédits inutilisés sont reversés au formateur.
  • Environnements gérés, pour les sociétés de conseil. Un partenaire exécute l'application pour un client à partir d'un portefeuille cloisonné qu'il finance, et règle directement avec le client. Si le portefeuille est faible, la facturation est suspendue et les données sont conservées, de sorte que personne ne reçoit de frais inattendus. À la fin, le partenaire transfère le projet et les déploiements deviennent la propriété du client.

Les crédits peuvent être achetés dans plus de 20 devises, y compris XAF, XOF, NGN, GHS, KES et ZAR, par carte, virement bancaire ou argent mobile.

Sources (8 octobre 2026) : Prix catalogue Google Cloud de l'API Cloud Billing Catalog ; frais RAD et estimation des crédits quotidiens de radmodules.dev/pricing ; Supprimer et restaurer des projets pour la fenêtre de pause/restauration et la mise en garde sur le bucket de sauvegarde ; les prix changent, vérifiez chaque source avant de vous fier à un chiffre.

1. Vue d'ensemble​

BookStack s'exécute comme un conteneur PHP sur Cloud Run v2. Le déploiement relie un ensemble ciblé de services Google Cloud :

CapacitéService Google CloudNotes
CalculCloud Run v2Conteneur PHP (LinuxServer), 1 vCPU / 2 Gio par défaut, autoscaling sans serveur ; mise à l'échelle à zéro prise en charge
Base de donnéesCloud SQL pour MySQL 8.0Requis — BookStack ne prend pas en charge PostgreSQL ou d'autres moteurs
Stockage d'objetsCloud StorageUn bucket data dédié (gcs-bookstack<tenant>-data) provisionné automatiquement
Fichiers persistantsFilestore / NFSImages et pièces jointes téléchargées persistantes à /var/lib/bookstack
Cache et sessionsRedis (facultatif)Désactivé par défaut ; BookStack utilise le pilote de cache/session local
SecretsSecret ManagerAPP_KEY Laravel auto-généré ; mot de passe de la base de données
EntréeURL Cloud Run / Équilibrage de charge CloudURL run.app par défaut ; équilibreur de charge HTTPS externe facultatif + domaine personnalisé

Valeurs par défaut judicieuses à connaître d'emblée :

  • MySQL 8.0 est obligatoire. Le moteur de base de données est fixé par la couche d'application partagée (database_type = "MYSQL_8_0") ; PostgreSQL n'est pas pris en charge et la sélection d'un autre moteur entraîne un échec au démarrage.
  • L'image linuxserver/bookstack pré-construite est utilisée directement. Il n'y a pas de Cloud Build personnalisé pour le déploiement par défaut ; l'image officielle LinuxServer.io est mise en miroir dans Artifact Registry (enable_image_mirroring = true) et déployée telle quelle.
  • Le conteneur écoute sur le port 80 (container_port = 80, container_protocol = "http1").
  • La persistance NFS des téléchargements est activée par défaut. enable_nfs = true monte NFS à /var/lib/bookstack afin que les images et pièces jointes téléchargées survivent aux redémarrages, redéploiements et événements de mise à l'échelle. La désactivation entraîne la perte des fichiers téléchargés.
  • La mise à l'échelle à zéro est activée par défaut (min_instance_count = 0, max_instance_count = 1). Les démarrages à froid ajoutent quelques secondes de latence à la première requête après l'inactivité ; BookStack est un wiki purement requête/réponse sans workers en arrière-plan, donc la facturation basée sur les requêtes (cpu_always_allocated = false) est correcte.
  • APP_KEY est immuable après le premier démarrage. La clé d'application Laravel est générée une fois et stockée dans Secret Manager ; sa rotation rend toutes les valeurs chiffrées de la base de données (secrets à deux facteurs, certains paramètres) indéchiffrables.
  • L'image exécute php artisan migrate --force automatiquement au démarrage, de sorte que le schéma est créé au premier démarrage après que db-init ait provisionné la base de données et l'utilisateur — il n'y a pas de job de migration séparé.
  • Un administrateur par défaut est initialisé par l'image LinuxServer : admin@admin.com avec le mot de passe password. Changez-le immédiatement après la première connexion.
  • Cloud Run se connecte à Cloud SQL via TCP IP privée. enable_cloudsql_volume = false par défaut, donc DB_HOST est l'IP privée de l'instance ; MySQL via TCP IP privée n'a pas besoin de SSL.

2. Services Google Cloud et comment les explorer​

Toutes les commandes supposent que PROJECT et REGION sont définis. Les noms de services et de ressources sont indiqués dans les Sorties du déploiement.

A. Cloud Run — le service BookStack​

BookStack s'exécute comme un service Cloud Run v2 qui s'adapte automatiquement en fonction de la charge de requêtes entre le nombre minimum et maximum d'instances. Chaque déploiement crée une révision immuable ; le trafic peut être réparti entre les révisions pour des déploiements sûrs.

  • Console : Cloud Run → sélectionnez le service pour les révisions, le trafic, les journaux et les métriques.
  • CLI :
    gcloud run services list --project "$PROJECT" --region "$REGION"
    gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
    gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"

Voir App_CloudRun pour la mise à l'échelle, la concurrence, l'environnement d'exécution et la répartition du trafic.

B. Cloud SQL pour MySQL 8.0​

BookStack stocke toutes les données de l'application (livres, pages, utilisateurs, révisions, permissions) dans une instance Cloud SQL pour MySQL 8.0 gérée. Le service se connecte via l'IP privée de Cloud SQL via l'égresse VPC (enable_cloudsql_volume = false) ; DB_HOST est défini sur l'IP privée de l'instance et aucune IP publique n'est exposée. Lors du premier déploiement, un job d'initialisation crée la base de données et l'utilisateur de l'application.

  • Console : SQL → sélectionnez l'instance pour les connexions, les sauvegardes, les drapeaux, les métriques.
  • CLI :
    gcloud sql instances list --project "$PROJECT"
    gcloud sql instances describe <instance-name> --project "$PROJECT"
    gcloud sql connect <instance-name> --user=bookstack --database=<db-name> --project "$PROJECT"

Le nom de l'instance, la base de données, l'utilisateur et le secret du mot de passe se trouvent dans les Sorties. Voir App_CloudRun pour le modèle de connexion, les sauvegardes et la rotation des mots de passe.

C. Cloud Storage​

Un bucket Cloud Storage dédié (storage_buckets par défaut : name_suffix = "data", résultant en gcs-bookstack<tenant>-data) est provisionné automatiquement. Des buckets supplémentaires peuvent être déclarés via storage_buckets.

  • Console : Cloud Storage → Buckets.
  • CLI :
    gcloud storage buckets list --project "$PROJECT"
    gcloud storage ls gs://<uploads-bucket>/ # bucket name is in the Outputs

Voir App_CloudRun pour les options GCS Fuse et CMEK.

D. Redis (cache et sessions facultatifs)​

Redis est désactivé par défaut (enable_redis = false) ; BookStack utilise ses pilotes de cache et de session locaux. Lorsque enable_redis = true est défini, la couche partagée injecte REDIS_HOST et REDIS_PORT afin que BookStack puisse utiliser Redis pour le cache et les sessions. Lorsque redis_host est laissé vide et enable_nfs est vrai, l'IP Redis co-hébergée de la VM du serveur NFS est utilisée.

  • Console : Memorystore → Redis (si vous utilisez une instance gérée).
  • CLI :
    redis-cli -h <redis-host> ping
    redis-cli -h <redis-host> info keyspace
    # Confirm the DB wiring in the running revision:
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.containers[0].env)' | tr ',' '\n' | grep -E 'DB_|REDIS_'

E. Secret Manager​

Un secret cryptographique est généré automatiquement et stocké dans Secret Manager : la APP_KEY Laravel (base64:<44-char base64>), utilisée pour chiffrer toutes les données d'application que BookStack stocke chiffrées. Le mot de passe de la base de données est géré séparément par la fondation.

  • Console : Sécurité → Secret Manager.
  • CLI :
    gcloud secrets list --project "$PROJECT"
    gcloud secrets versions access latest --secret=<secret-name> --project "$PROJECT"

Voir App_CloudRun pour les détails d'injection et de rotation.

F. Réseau et entrée​

Le service est accessible par son URL run.app par défaut (ingress_settings = "all"), ce qui permet l'accès public attendu d'un wiki partagé. Un équilibreur de charge HTTPS externe avec un domaine personnalisé, Cloud CDN et Cloud Armor peuvent être superposés ; les paramètres d'entrée et l'égresse VPC contrôlent la connectivité.

  • Console : Cloud Run (URL du service) ; Services réseau → Équilibrage de charge.
  • CLI :
    gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'
    gcloud compute addresses list --project "$PROJECT"

Voir App_CloudRun.

G. Cloud Logging et Monitoring​

Les journaux de conteneurs sont envoyés à Cloud Logging ; les métriques Cloud Run et Cloud SQL sont envoyées à Cloud Monitoring, avec des vérifications de disponibilité et des politiques d'alerte facultatives.

  • Console : Logging → Explorateur de journaux ; Monitoring → Tableaux de bord / Alertes.
  • CLI :
    gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50

3. Comportement de l'application BookStack​

  • Configuration de la base de données au premier déploiement. Un job d'initialisation exécute db-init.sh en utilisant mysql:8.0-debian. Il détecte le socket Cloud SQL ou le point de terminaison TCP, attend que MySQL soit accessible, crée la base de données et l'utilisateur de l'application, accorde les privilèges, vérifie que l'utilisateur de l'application peut se connecter et arrête gracieusement le sidecar Cloud SQL Auth Proxy. Le job est idempotent et peut être réexécuté en toute sécurité (max_retries = 3).
  • Auto-migration du schéma au démarrage. L'image LinuxServer BookStack exécute php artisan migrate --force automatiquement à chaque démarrage de conteneur, de sorte que le schéma est créé au premier démarrage et mis à niveau lors des démarrages ultérieurs — il n'y a pas de job de migration séparé.
  • APP_KEY est immuable après le premier démarrage. La clé d'application Laravel est générée une fois et écrite dans Secret Manager. La faire pivoter rend toutes les valeurs chiffrées de la base de données (secrets à deux facteurs, certains paramètres) indéchiffrables de manière permanente. Ne la faites pivoter que pendant une fenêtre de maintenance planifiée avec un plan de rechiffrement.
  • Administrateur de première exécution. L'image initialise un compte administrateur par défaut, admin@admin.com / password. Changez le mot de passe (et idéalement l'e-mail) immédiatement après la première connexion.
  • Les fichiers téléchargés résident sur NFS. Les images, les pièces jointes et autres téléchargements sont stockés sur le système de fichiers sous /var/lib/bookstack, qui est sauvegardé par NFS par défaut afin qu'ils survivent aux redémarrages, aux redéploiements et à la mise à l'échelle à zéro.
  • Chemin de santé. La sonde de vivacité cible /status — le point de terminaison de santé JSON non authentifié de BookStack qui signale l'état de l'application/base de données/cache/session. La sonde de démarrage est une vérification TCP sur le port 80. Prévoyez une fenêtre généreuse pour le premier démarrage : la sonde de vivacité a un délai initial de 300 secondes pour s'adapter aux migrations automatiques.
  • Inspecter l'exécution du job :
    gcloud run jobs list --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <job-name> --project "$PROJECT" --region "$REGION"

4. Variables de configuration​

Les variables sont regroupées exactement comme elles apparaissent sur la plateforme de déploiement. Seuls les paramètres spécifiques ou notables pour BookStack sont listés ; toute autre entrée est héritée de App_CloudRun avec son comportement standard.

Groupe 1 — Projet et identité​

VariableValeur par défautDescription
project_id(requis)Projet Google Cloud cible.
regionus-central1Région pour le service et les ressources régionales.

Groupe 2 — Environnement de déploiement​

VariableValeur par défautDescription
tenant_iddemoSuffixe court qui rend les noms de ressources uniques par environnement.
support_users[]E-mails auxquels sont accordés l'accès au projet et les alertes de surveillance.
resource_labels{}Étiquettes appliquées à toutes les ressources.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_namebookstackNom de base des ressources. Ne pas modifier après le premier déploiement.
display_nameBookStackNom lisible par l'homme affiché dans la console.
descriptionBookStack wiki on Cloud RunDescription du service.
application_versionlatestTag d'image linuxserver/bookstack ; épingler (par exemple version-v24.10) en production.
php_memory_limit / upload_max_filesize / post_max_size512M / 64M / 64MIndices de réglage PHP ; inertes pour l'image LinuxServer par défaut.

Groupe 4 — Exécution et mise à l'échelle​

VariableValeur par défautDescription
deploy_applicationtrueDéfinir false pour provisionner uniquement l'infrastructure.
container_image_sourceprebuiltDéployer directement l'image LinuxServer mise en miroir — pas de build personnalisé.
container_image""Remplacer la référence de l'image ; laisser vide pour utiliser la valeur par défaut mise en miroir.
cpu_limit1000mCPU par instance ; 1 vCPU par défaut.
memory_limit2GiMémoire par instance.
min_instance_count00 active la mise à l'échelle à zéro.
max_instance_count1Garder à 1 — BookStack n'a pas de coordination de file d'attente multi-instances.
container_port80BookStack écoute sur le port 80.
container_protocolhttp1HTTP/1.1.
execution_environmentgen2Gen2 requis pour les montages NFS et GCS Fuse.
timeout_seconds300Durée maximale de la requête (0–3600 secondes).
enable_cloudsql_volumefalseSe connecter via TCP IP privée Cloud SQL (correct pour MySQL sur Cloud Run).
enable_image_mirroringtrueMettre en miroir l'image LinuxServer dans Artifact Registry.
max_revisions_to_retain7Combien d'anciennes révisions conserver.

Groupe 5 — Entrée et VPC​

VariableValeur par défautDescription
ingress_settingsallall permet l'accès public pour le wiki.
vpc_egress_settingPRIVATE_RANGES_ONLYAcheminer uniquement le trafic RFC 1918 via VPC.
enable_iapfalseExiger la connexion Google. Bloque les lecteurs anonymes.
iap_authorized_users / iap_authorized_groups[]Qui peut accéder via IAP.

Groupe 6 — Variables d'environnement et secrets​

VariableValeur par défautDescription
environment_variables{}Paramètres supplémentaires non secrets (par exemple APP_URL, configuration de la messagerie). Ne pas définir APP_KEY ou DB_* ici.
secret_environment_variables{}Mappage de var d'environnement → nom de secret Secret Manager.
secret_propagation_delay30Secondes à attendre après la création du secret avant de continuer.
secret_rotation_period2592000sFréquence de notification de rotation de Secret Manager.

Groupe 7 — Sauvegarde et maintenance​

VariableValeur par défautDescription
backup_schedule0 2 * * *Cron de sauvegarde automatisée (UTC).
backup_retention_days7Rétention ; augmenter pour la production/conformité.
enable_backup_import / backup_source / backup_uri / backup_formatoptions de restaurationRestaurer à partir d'une sauvegarde lors du déploiement.

Groupe 8 — CI/CD et autorisation binaire​

Intégration standard App_CloudRun Cloud Build / Cloud Deploy — voir App_CloudRun. Entrées clés : enable_cicd_trigger, github_repository_url, github_token, enable_cloud_deploy, enable_binary_authorization.

Groupe 9 — Scripts SQL personnalisés​

enable_custom_sql_scripts, custom_sql_scripts_bucket, custom_sql_scripts_path, custom_sql_scripts_use_root — exécuter du SQL à partir d'un bucket GCS après le provisionnement. Voir App_CloudRun.

Groupe 10 — Cloud Armor, CDN et domaine personnalisé​

VariableValeur par défautDescription
enable_cloud_armorfalseProvisionner un équilibreur de charge HTTPS global + WAF Cloud Armor.
admin_ip_ranges[]Plages CIDR exemptées des règles WAF.
application_domains[]Noms de domaine personnalisés pour l'équilibreur de charge HTTPS.
enable_cdnfalseActiver Cloud CDN sur le backend de l'équilibreur de charge HTTPS.
max_images_to_retain / delete_untagged_images / image_retention_days7 / true / 30Politique de nettoyage d'Artifact Registry.

Groupe 11 — Cloud Storage et NFS​

VariableValeur par défautDescription
create_cloud_storagetrueCréer le bucket data par défaut et tous ceux de storage_buckets.
storage_buckets[{ name_suffix="data" }]Buckets GCS à provisionner.
enable_nfstruePersister les images/pièces jointes téléchargées sur NFS.
nfs_mount_path/var/lib/bookstackChemin de montage où BookStack stocke les téléchargements.
gcs_volumes[]Montages de volume GCS Fuse (nécessite gen2).
manage_storage_kms_iam / enable_artifact_registry_cmekfalseOptions CMEK.

Groupe 12 — Base de données​

VariableValeur par défautDescription
database_typeMYSQL_8_0Fixe — BookStack nécessite MySQL 8.0.
db_namebookstackNom de la base de données MySQL (préfixé par le locataire). Immuable après le premier déploiement.
db_userbookstackUtilisateur de la base de données de l'application (préfixé par le locataire). Mot de passe auto-généré dans Secret Manager.
database_password_length32Longueur du mot de passe généré.
enable_auto_password_rotation / rotation_propagation_delay_secfalse / 90Rotation du mot de passe de la base de données.

Groupe 13 — Automatisation des charges de travail​

VariableValeur par défautDescription
initialization_jobs[]Laisser vide pour utiliser le job db-init intégré.
cron_jobs[]BookStack n'a pas de tâches récurrentes planifiées par la plateforme.

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probePort TCP 80, délai 30sSonde de démarrage (vérification d'écoute de port).
liveness_probeHTTP /status, délai 300sSonde de vivacité contre le point de terminaison de santé non authentifié.
uptime_check_config{ enabled=false, path="/status" }Vérification de disponibilité Cloud Monitoring facultative.
alert_policies[]Politiques d'alerte métriques.

Groupe 21 — Cache et sessions Redis​

VariableValeur par défautDescription
enable_redisfalseInjecter REDIS_HOST/REDIS_PORT afin que BookStack puisse utiliser Redis pour le cache/les sessions.
redis_host""Point de terminaison Redis. Laisser vide pour utiliser l'IP du serveur NFS (nécessite enable_nfs = true).
redis_port6379Port Redis.
redis_auth""Mot de passe d'authentification Redis facultatif (sensible).

Groupe 22 — VPC Service Controls et journalisation d'audit​

VariableValeur par défautDescription
enable_vpc_scfalseAppliquer un périmètre VPC-SC (nécessite organization_id).
vpc_cidr_ranges / vpc_sc_dry_run(défini)CIDR de niveau d'accès / mode simulation.
enable_audit_loggingfalseJournaux d'audit Cloud détaillés.

5. Sorties​

Retourné lors d'un déploiement réussi — le moyen le plus rapide de localiser et d'explorer les ressources en cours d'exécution.

SortieDescription
service_nameNom du service Cloud Run.
service_urlURL run.app par défaut du service.
service_locationRégion dans laquelle le service s'exécute.
stage_servicesURL de service spécifiques à l'étape (Cloud Deploy).
load_balancer_ip / load_balancer_urlIP / URL de l'équilibreur de charge HTTPS externe (lorsqu'il est activé).
database_instance_nameNom de l'instance Cloud SQL.
database_name / database_userNom / utilisateur de la base de données de l'application.
database_password_secretSecret Manager secret contenant le mot de passe de la base de données.
database_host / database_portPoint de terminaison de la base de données (IP privée, sensible) / port.
storage_bucketsBuckets Cloud Storage créés.
network_name / network_exists / regionsRéseau VPC, présence, régions.
container_image / container_registryImage déployée et dépôt Artifact Registry.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesÉtat de la surveillance, canaux, vérifications de disponibilité.
initialization_jobsNoms des jobs de configuration.
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants de projet.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationÉtat et détails CI/CD.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistre et déclencheur de build.
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_modeÉtat VPC-SC.
audit_logging_enabled / artifact_registry_cmek_enabledJournalisation d'audit et état CMEK.

6. Pièges de configuration et valeurs par défaut judicieuses​

Risque : Critique (perte de données / panne / sécurité) — Élevé (service dégradé) — Moyen (coût ou dégradation partielle) — Faible (mineur).

Validation héritée au moment de la planification. Ce module transmet sa configuration au moteur de fondation App_CloudRun, qui valide les valeurs et les combinaisons au moment de la planification — un réplica en lecture sans son primaire, IAP sans identités autorisées, un runtime gen1 avec des montages NFS/GCS, un database_type qui ne correspond pas au moteur requis par BookStack, un redis_port/backup_retention_days hors de portée. Une configuration invalide fait échouer le plan avec une erreur claire et nommée avant la création de toute ressource, de sorte que la plupart des erreurs ci-dessous sont détectées en amont plutôt qu'à l'application ou à l'exécution.

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
APP_KEY (auto-généré)Ne jamais faire pivoter après le premier démarrageCritiqueLe faire pivoter rend toutes les valeurs chiffrées de la base de données (secrets à deux facteurs, certains paramètres) indéchiffrables de manière permanente.
db_name / db_userDéfinir une foisCritiqueImmuable après le premier déploiement ; le renommage recrée la base de données/l'utilisateur et détruit toutes les données.
enable_backup_importfalse sauf restaurationCritiqueL'activation sans un backup_uri valide fait échouer le job d'importation.
database_typeMYSQL_8_0CritiqueBookStack nécessite MySQL ; tout autre moteur entraîne un échec au démarrage.
APP_URL (via environment_variables)URL réelle du serviceÉlevéUne URL de base erronée interrompt le chargement des ressources, les liens et les redirections de connexion.
enable_nfstrueÉlevéLa désactivation entraîne la perte de toutes les images et pièces jointes téléchargées lors d'un redéploiement ou d'une mise à l'échelle à zéro.
memory_limit2GiÉlevéDes valeurs inférieures risquent des arrêts OOM en cas d'édition concurrente et d'indexation en texte intégral.
enable_cloudsql_volumefalse (TCP IP privée)ÉlevéSur Cloud Run, BookStack se connecte via TCP IP privée ; forcer le chemin du socket est inutile et peut interrompre la connectivité de la base de données.
ingress_settingsallÉlevéLa définition à internal bloque tous les lecteurs externes du wiki.
enable_iapuniquement lorsque les lecteurs doivent s'authentifierÉlevéIAP bloque tout accès anonyme, y compris les lecteurs de documentation publique.
max_instance_count1MoyenBookStack n'a pas de coordination multi-instances ; la mise à l'échelle risque une incohérence du cache/des sessions.
min_instance_count0 (CR)MoyenLa mise à l'échelle à zéro ajoute un délai de démarrage à froid à la première requête après l'inactivité.
admin@admin.com mot de passe par défautChanger lors de la première connexionMoyenLaisser le password par défaut permet à quiconque ayant l'URL de se connecter en tant qu'administrateur.
backup_retention_days7 (augmenter pour la production)MoyenTrop court pour la rétention de conformité.

Pour le comportement de la fondation référencé tout au long — identité de service, mise à l'échelle et concurrence, entrée et équilibrage de charge, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC-SC, sauvegardes et mise en miroir d'images — voir App_CloudRun. La configuration d'application spécifique à BookStack partagée avec la variante GKE est décrite dans BookStack_Common.

Need RAD to do something it does not do yet? Request it on the roadmap, or vote on what is already there.