Aller au contenu principal

Chatwoot sur Google Cloud Run

Chatwoot sur Google Cloud Run

Chatwoot est une plateforme open source de service client et d'engagement client multicanal (e-mail, chat en direct, réseaux sociaux et boîtes de réception de messagerie, suivi des SLA et rapports) qui constitue une alternative conforme au RGPD à Zendesk ou Intercom. Ce module déploie Chatwoot sur Cloud Run v2 au-dessus de 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 Chatwoot et sur la manière de les explorer et de les exploiter à partir de la console Google Cloud et de 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 Chatwoot sur RAD, et comparaison​

Chatwoot sur le module Cloud Run de RAD coûte environ 102 $ US par mois dans votre propre projet Google Cloud, sans frais de licence supplémentaires — Chatwoot 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 Chatwoot 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 Mettez-le en pause gratuitement, ci-dessous.

Ce que vous payez sur RAD​

Chatwoot 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éploiement110 crédits (11 $ US au prix de la recharge)99 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 à la minute pour le temps de buildIdentique
Coût d'exécution Google CloudFacturé par Google à votre propre compte de facturation, environ 102 $ 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 : une fois par compte, pour un module que vous déployez et payez vous-même (dans une solution, les frais d'une application : le premier à réussir ; jamais une session de lab ou un projet client).

10 crédits coûtent 1 $ US pour une recharge unique, et moins avec un plan 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 toutes les applications du projet, de sorte qu'une deuxième application n'ajoute pas de 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, 2x vCPU / 4 Gio (scaleToZero)31,53 $ US
Cloud SQL pour PostgreSQL, 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 102 $ US

Les prix de Cloud SQL et de Cloud Run/pod GKE sont les mêmes 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.

Comparaison pour une équipe de dix agents​

L'équipe de Chatwoot vend Chatwoot Cloud hébergé par agent :

OptionPar mois (10 agents)Notes
Chatwoot Cloud, Hacker0 $ USNiveau gratuit, limité
Chatwoot Cloud, Startups190 $ US (19 $ US/agent)Hébergé par Chatwoot
Chatwoot Cloud, Business390 $ US (39 $ US/agent)Hébergé par Chatwoot, le plus populaire
Chatwoot Cloud, Enterprise990 $ US (99 $ US/agent)Hébergé par Chatwoot
RAD, Cloud Run, votre propre projetEnviron 102 $ US, plus 11 $ US une fois par déploiementL'automatisation de RAD, dans votre projet
RAD, Cloud Run, un projet géré par RADEnviron 960 crédits (96 $ US)RAD
  • Le prix de Chatwoot Cloud augmente avec chaque siège d'agent ; le coût de RAD est celui de l'infrastructure. Pour dix agents, le coût d'exécution du projet propre à RAD est déjà inférieur même au niveau payant le moins cher de Chatwoot Cloud.
  • Un serveur bon marché est bon marché jusqu'à ce que quelque chose tombe en panne. Sur RAD, la base de données est Cloud SQL avec des sauvegardes automatisées, et les secrets vivent dans Secret Manager. Sur votre propre serveur, chacun de ces éléments est un travail que quelqu'un doit faire.

Mettez-le en pause gratuitement : supprimez un projet géré par RAD, restaurez-le lorsque vous en avez besoin​

Si Chatwoot 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 purement et simplement le projet. 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 attente. Contrairement à la suppression d'un module, cela ne démantèle 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 Update 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 dont cela a besoin. 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 cela, 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 affirme 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 à conserver ; pour une installation par défaut sans rien d'irremplaçable, cela n'a pas d'importance.

Source : Supprimer et restaurer des projets.

Payez 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) : 110 crédits (11,00 $ US) au prix de la recharge. La suppression ne permet d'économiser de l'argent que si Chatwoot reste inutilisé pendant environ 3 jours ou plus — dans votre propre projet, cela représente environ 3,40 $ 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 lorsque rien d'autre dans le projet ne les utilise, donc la suppression de Chatwoot pendant qu'une autre application partage le projet n'économise que la partie calcul de Chatwoot.
  • Conservez d'abord les données. 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 cabinets 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 ; Prix de Chatwoot Cloud ; les prix changent, vérifiez chaque source avant de vous fier à un chiffre.

1. Vue d'ensemble​

Chatwoot s'exécute comme un conteneur Ruby on Rails unique qui combine le serveur web et un worker Sidekiq en arrière-plan dans une seule arborescence de processus. Le déploiement relie un ensemble ciblé de services Google Cloud :

CapacitéService Google CloudNotes
CalculCloud Run v2Rails + worker Sidekiq colocalisé sur le port 3000, 2 vCPU / 4 Gio par défaut
Base de donnéesCloud SQL pour PostgreSQL 15Requis — database_type est fixé à POSTGRES_15 ; l'extension vector (pgvector) est activée pour les fonctionnalités d'IA/recherche de Chatwoot
Cache et file d'attenteRedis (hébergé sur NFS ou externe)Prend en charge la file d'attente de jobs de Sidekiq et le pub/sub d'ActionCable ; activé par défaut
Persistance des fichiersCloud Filestore (NFS)Les pièces jointes persistent sous /opt/chatwoot/storage, partagées entre les révisions
Stockage d'objetsCloud StorageUn bucket suffixé storage provisionné automatiquement par le module Common, plus un bucket data par défaut déclaré dans storage_buckets
SecretsSecret ManagerSECRET_KEY_BASE Rails 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 :

  • PostgreSQL 15 est obligatoire. database_type est codé en dur à POSTGRES_15 par la sortie config du module Common ; le schéma de Chatwoot et les fonctionnalités de recherche basées sur pgvector l'exigent.
  • Image personnalisée. container_image_source = "custom" — le module Common construit FROM chatwoot/chatwoot:${APP_VERSION} et superpose un cloud-entrypoint.sh qui mappe les variables d'environnement DB_*/REDIS_* de la Fondation sur la convention POSTGRES_*/REDIS_URL de Chatwoot et lance Sidekiq en arrière-plan avant d'exécuter le serveur Rails. L'image s'exécute en tant que root — correspondant à l'image amont, dont les /app//app/tmp sont détenus par root et non inscriptibles par le groupe, de sorte que l'étape create_tmp_directories de Rails a besoin de root pour réussir.
  • Cloud SQL est atteint via un socket Unix, pas un bouclage TCP. Avec enable_cloudsql_volume = true, Cloud Run monte le socket du proxy d'authentification Cloud SQL à /cloudsql/<instance> ; le point d'entrée transmet le DB_HOST injecté directement en tant que POSTGRES_HOST (le pilote Ruby pg accepte un chemin de répertoire comme hôte de socket Unix). Cela diffère de la variante GKE, où un proxy sidecar écoute sur 127.0.0.1:5432.
  • Deux jobs d'initialisation s'exécutent en séquence. db-init (crée la base de données, le rôle et les autorisations — y compris une autorisation cloudsqlsuperuser afin que Chatwoot puisse créer lui-même des extensions Postgres) s'exécute en premier, puis chatwoot-prepare (bundle exec rails db:chatwoot_prepare) crée/met à niveau le schéma et initialise les valeurs par défaut, en utilisant l'image d'application Chatwoot construite. Il n'y a pas d'étape de migration intra-conteneur ; la configuration du schéma se fait entièrement dans ces deux jobs avant que le conteneur d'application n'ait besoin de servir le trafic.
  • Redis est activé par défaut (enable_redis = true). Laissez redis_host vide pour utiliser l'adresse IP Redis partagée hébergée sur le serveur NFS que la Fondation injecte automatiquement.
  • SECRET_KEY_BASE est généré une fois et partagé entre le processus web Rails et le worker Sidekiq (colocalisés dans le même conteneur) — il doit rester stable lors des redémarrages/redéploiements, car Rails l'utilise pour signer les sessions et chiffrer les colonnes chiffrées d'ActiveRecord.
  • NFS est activé par défaut (enable_nfs = true) afin que les pièces jointes téléchargées persistent et soient partagées entre les révisions à /opt/chatwoot/storage.
  • cpu_always_allocated est par défaut false (facturation basée sur les requêtes, démarrage à froid). Sidekiq (notifications, webhooks, attribution automatique) et les mises à jour de l'interface utilisateur en temps réel d'ActionCable ne s'exécutent que pendant qu'une requête est servie ou pendant la fenêtre de maintien au chaud après la requête ; définissez cpu_always_allocated = true avec min_instance_count >= 1 pour maintenir la livraison en arrière-plan continue.
  • ENABLE_ACCOUNT_SIGNUP est par défaut "false" — l'inscription libre-service administrateur/agent est désactivée sur un helpdesk fraîchement déployé ; activez-la via environment_variables si vous souhaitez une inscription publique.

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 signalés dans les Sorties du déploiement.

A. Cloud Run — le service Chatwoot​

Chatwoot s'exécute en tant que service Cloud Run v2 qui s'adapte automatiquement en fonction de la charge de requêtes entre le nombre minimal et maximal d'instances. Chaque révision équivalente à un pod exécute à la fois le serveur web Rails et un processus worker Sidekiq en arrière-plan dans le même conteneur, de sorte que le service ne devrait pas passer de longues périodes à zéro instance si la livraison rapide des messages/notifications est importante.

  • 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 PostgreSQL 15​

Chatwoot stocke toutes les données d'application (conversations, contacts, boîtes de réception, agents, rapports) dans une instance Cloud SQL pour PostgreSQL 15 gérée, y compris l'extension vector utilisée par ses fonctionnalités d'IA/recherche. Le service se connecte privatement via le proxy d'authentification Cloud SQL sur un socket Unix à /cloudsql/<instance> ; aucune IP publique n'est exposée. Lors du premier déploiement, le job db-init crée la base de données de l'application, le rôle et les autorisations (y compris une autorisation cloudsqlsuperuser pour que les appels de création d'extension de Chatwoot réussissent), puis le job chatwoot-prepare exécute rails db:chatwoot_prepare pour construire le schéma.

  • Console : SQL → sélectionnez l'instance pour les connexions, les sauvegardes, les indicateurs, les métriques.
  • CLI :
    gcloud sql instances list --project "$PROJECT"
    gcloud sql instances describe <instance-name> --project "$PROJECT"
    gcloud sql connect <instance-name> --user=<db-user> --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é suffixé storage est provisionné automatiquement par le module Common, en plus du bucket data par défaut déclaré dans storage_buckets. Des buckets supplémentaires peuvent être déclarés de la même manière.

  • Console : Cloud Storage → Buckets.
  • CLI :
    gcloud storage buckets list --project "$PROJECT" --filter="name~chatwoot"
    gcloud storage ls gs://<bucket-name>/

Voir App_CloudRun pour les options GCS Fuse et CMEK.

D. Redis (file d'attente, cache et pub/sub)​

Sidekiq (la file d'attente de jobs en arrière-plan de Chatwoot) et ActionCable (mises à jour de l'interface utilisateur en temps réel) nécessitent tous deux Redis. enable_redis = true par défaut ; lorsque redis_host est laissé vide, la Fondation injecte l'adresse IP Redis partagée hébergée sur le serveur NFS, et le point d'entrée du conteneur construit REDIS_URL à partir de REDIS_HOST/REDIS_PORT/REDIS_AUTH au démarrage — ceci est auto-réparateur, que redis_host ait été défini explicitement ou laissé vide.

Sidekiq nécessite Redis 6.2 ou plus récent, et le Redis hébergé sur NFS est 6.0. Le Redis partagé sur la VM NFS exécute la version 6.0.16, et Sidekiq 7 refuse de démarrer avec elle. L'interface web continue de fonctionner (le point d'entrée met Sidekiq en arrière-plan), de sorte que le déploiement semble sain alors qu'aucun job en arrière-plan ne s'exécute. Pointez redis_host vers une instance Redis 6.2+ — par exemple Memorystore, via create_redis = true dans Services_GCP, qui provisionne Redis 7.2.

  • Console : Memorystore → Redis (si vous utilisez une instance dédiée).
  • CLI :
    redis-cli -h <redis-host> ping
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.containers[0].env)'

E. Secret Manager​

Un secret spécifique à Chatwoot est généré automatiquement et stocké dans Secret Manager : SECRET_KEY_BASE (clé de signature de session / de chiffrement ActiveRecord de Rails, partagée de manière identique entre les processus web et Sidekiq, et également injectée dans le job d'initialisation chatwoot-prepare). 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" --filter="name~chatwoot"
    gcloud secrets versions access latest --secret=secret-<resource-prefix>-chatwoot-secret-key-base --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 aux intégrations de canaux externes (webhooks, intégrations de widgets de chat en direct) de l'atteindre. Un équilibreur de charge HTTPS externe avec un domaine personnalisé, Cloud CDN et Cloud Armor peuvent être superposés.

  • 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​

La sortie standard/erreur du conteneur (les processus Rails et Sidekiq, puisqu'ils partagent un conteneur) est acheminée vers Cloud Logging ; les métriques Cloud Run et Cloud SQL sont acheminées vers 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 Chatwoot​

  • La configuration de la base de données au premier déploiement s'exécute en deux jobs chaînés. db-init (image postgres:15-alpine) se connecte via le socket Cloud SQL, crée de manière idempotente le rôle et la base de données, accorde les privilèges, accorde cloudsqlsuperuser au rôle de l'application (nécessaire car l'utilisateur de l'application de Cloud SQL n'est pas un véritable superutilisateur Postgres et les appels db:chatwoot_prepare de schema.rb enable_extension pour plusieurs extensions), et pré-crée vector, pg_stat_statements, pg_trgm et pgcrypto de manière défensive. chatwoot-prepare dépend de db-init (depends_on_jobs = ["db-init"]) et exécute bundle exec rails db:chatwoot_prepare en utilisant l'image d'application Chatwoot construite, et non une image client générique. Les deux jobs ont execute_on_apply = true.
  • Pas de migrations intra-conteneur. La création/mise à niveau du schéma est entièrement gérée par le job d'initialisation chatwoot-prepare avant que le conteneur d'application ne soit censé servir le trafic — le point d'entrée d'exécution n'exécute pas rails db:migrate.
  • chatwoot-prepare préfère TCP au socket lorsque les deux sont disponibles. Son script vérifie explicitement si DB_HOST est un chemin de socket (débutant par /) ; si c'est le cas et si DB_IP (l'IP privée de l'instance) est également présent, il se connecte via DB_IP avec PGSSLMODE=require à la place, car le socket Unix Cloud SQL ne se matérialise pas toujours à temps dans un job Cloud Run. Il ne revient au chemin de socket littéral que lorsque DB_IP n'est pas défini. Le point d'entrée du conteneur d'application de longue durée n'a pas de tel mécanisme de repli — il transmet DB_HOST directement en tant que POSTGRES_HOST, en s'appuyant sur la présence du socket pour le service lui-même.
  • Alias des variables d'environnement de la base de données. La plateforme injecte DB_HOST (le répertoire du socket Cloud SQL sur Cloud Run), DB_PORT, DB_NAME, DB_USER, DB_PASSWORD ; cloud-entrypoint.sh (intégré à l'image) mappe ces valeurs sur la convention POSTGRES_HOST/POSTGRES_PORT/POSTGRES_DATABASE/ POSTGRES_USERNAME/POSTGRES_PASSWORD de Chatwoot.
  • L'URL Redis est auto-réparatrice. Si REDIS_URL n'est pas déjà défini, le point d'entrée le construit à partir des REDIS_HOST/REDIS_PORT/ REDIS_AUTH injectés — couvrant à la fois le cas explicite redis_host et le cas de repli NFS par défaut.
  • Sidekiq s'exécute en colocation, en arrière-plan. cloud-entrypoint.sh démarre bundle exec sidekiq -C config/sidekiq.yml & avant d'exécuter le serveur Rails ; un trap sur TERM/INT arrête Sidekiq en même temps que le conteneur. Étant donné que Sidekiq traite les jobs en arrière-plan (livraison de canaux, notifications, rapports) uniquement pendant que le conteneur est en cours d'exécution, conservez min_instance_count >= 1 (et envisagez cpu_always_allocated = true) si la livraison rapide est plus importante que le coût d'inactivité.
  • ENABLE_ACCOUNT_SIGNUP est désactivé par défaut. Le module Common injecte ENABLE_ACCOUNT_SIGNUP = "false" en même temps que RAILS_ENV=production, RAILS_LOG_TO_STDOUT=true et RAILS_MAX_THREADS=5 (dimensionnés au-dessus de la concurrence par défaut de Cloud Run pour éviter "could not obtain a connection from the pool"). L'interface utilisateur d'intégration de Chatwoot crée le premier compte administrateur de manière interactive lors de la première visite — il n'y a pas de secret d'identifiant administrateur auto-généré pour ce module.
  • Chemin de santé. Les sondes de démarrage et de vivacité sont HTTP GET / — la page de connexion/intégration renvoie 200 sans authentification. Le startup_probe par défaut permet un délai initial de 60 secondes plus jusqu'à 30 tentatives à une période de 15 secondes (environ 8 minutes) avant d'échouer, pour absorber chatwoot-prepare s'exécutant avant le conteneur d'application.
  • Signal d'arrêt du proxy Cloud SQL. Les jobs d'initialisation signalent au sidecar du proxy d'authentification Cloud SQL de se terminer à la fin afin que le pod du job se termine au lieu de rester bloqué sur un sidecar actif.
  • Inspecter l'exécution du job et la configuration en cours :
    gcloud run jobs list --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <db-init-job-name> --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <chatwoot-prepare-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 Chatwoot sont listés ; toutes les autres entrées sont héritées de App_CloudRun avec son comportement standard.

Groupe 1 — Projet, identité et intégration de recherche​

VariableValeur par défautDescription
project_id(requis)Projet Google Cloud cible.
regionus-central1Région pour le service et les ressources régionales.
elasticsearch_url""Point de terminaison Elasticsearch facultatif (par exemple, de Elasticsearch_GKE) pour la recherche en texte intégral de Chatwoot. Laissez vide pour désactiver.
elasticsearch_username""Nom d'utilisateur Elasticsearch ; laissez vide lorsque xpack.security.enabled est faux.
elasticsearch_password_secret""ID du secret Secret Manager contenant le mot de passe Elasticsearch ; lorsqu'il est défini, injecté en tant que ELASTICSEARCH_PASSWORD et le compte de service de la charge de travail se voit accorder secretAccessor.

Groupe 2 — Environnement de déploiement​

VariableValeur par défautDescription
tenant_iddemoCourt suffixe qui rend les noms de ressources uniques par environnement.
support_users[]E-mails ayant accès au projet et aux alertes de surveillance.
resource_labels{}Étiquettes appliquées à toutes les ressources.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_namechatwootNom de base des ressources. Ne pas modifier après le premier déploiement.
display_nameChatwoot HelpdeskNom lisible par l'homme affiché dans la console.
descriptionChatwoot - Open-source helpdesk and customer support platformDescription du service.
application_versionv4.15.1Balise d'image chatwoot/chatwoot utilisée comme base de build personnalisé. Incrémenter pour déclencher une reconstruction.

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

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour provisionner uniquement l'infrastructure.
container_image_sourcecustomConstruit sur mesure à partir de chatwoot/chatwoot ; ne pas définir à prebuilt — cela ignore le wrapper cloud-entrypoint.sh.
cpu_limit2000m2 vCPU — Rails + worker Sidekiq colocalisé.
memory_limit4Gi4 Gio recommandés ; les deux processus partagent le conteneur.
cpu_always_allocatedfalseCoût-premier démarrage à froid par défaut ; le travail de Sidekiq/ActionCable est mis en pause entre les requêtes. Définissez true (avec min_instance_count >= 1) pour restaurer la livraison continue en arrière-plan.
min_instance_count00 active la mise à l'échelle à zéro ; définissez 1 pour maintenir le worker Sidekiq actif.
max_instance_count5Plafond de mise à l'échelle horizontale standard.
container_port3000Port du serveur Rails de Chatwoot.
execution_environmentgen2Gen2 requis pour les montages NFS et GCS Fuse.
enable_cloudsql_volumetrueSocket Unix du proxy d'authentification Cloud SQL pour les connexions Postgres.
enable_image_mirroringtrueMettre en miroir l'image Chatwoot dans Artifact Registry.
traffic_split[]Répartir le trafic entre les révisions pour les déploiements progressifs.

Groupe 5 — Contrôle d'accès et d'entrée​

VariableValeur par défautDescription
ingress_settingsallall est la valeur par défaut afin que les intégrations de canaux externes et le widget de chat en direct puissent atteindre le service.
vpc_egress_settingPRIVATE_RANGES_ONLYAcheminer uniquement le trafic RFC 1918 via VPC.
enable_iapfalseExiger la connexion Google. Bloque les webhooks de canaux publics et le widget de chat en direct.
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 { ENABLE_ACCOUNT_SIGNUP = "true" } pour ouvrir l'inscription en libre-service. Les valeurs de base RAILS_*/POSTGRES_*/REDIS_* sont définies automatiquement.
secret_environment_variables{}Mappe de variable 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 restauration​

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_file / backup_formatoptions de restaurationRestaurer à partir d'une sauvegarde lors du déploiement.

Groupe 8 — CI/CD et autorisation binaire​

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

Groupe 9 — Initialisation personnalisée et scripts SQL​

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 — Équilibreur de charge, CDN et rétention d'images​

VariableValeur par défautDescription
enable_cloud_armorfalseProvisionner l'é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_days(défini)Politique de nettoyage d'Artifact Registry.

Groupe 11 — Stockage et système de fichiers​

VariableValeur par défautDescription
create_cloud_storagetrueCréer des buckets GCS définis dans storage_buckets.
storage_buckets[{ name_suffix = "data" }]Buckets GCS supplémentaires au-delà du bucket suffixé storage auto-provisionné du module Common.
enable_nfstrueNFS est activé par défaut afin que les pièces jointes persistent et soient partagées entre les révisions.
nfs_mount_path/opt/chatwoot/storageOù Chatwoot stocke les pièces jointes téléchargées.
gcs_volumes[]Montages de volume GCS Fuse (nécessite gen2).
manage_storage_kms_iam / enable_artifact_registry_cmekfalseOptions CMEK.

Groupe 12 — Backend de base de données​

VariableValeur par défautDescription
database_typePOSTGRES_15Remplacé par une valeur fixe par la sortie config du module Common, quelle que soit la valeur définie ici ; Chatwoot nécessite Postgres 15+ avec pgvector.
db_namechatwootNom de la base de données PostgreSQL. Immuable après le premier déploiement.
db_userchatwootUtilisateur de la base de données de l'application. Mot de passe auto-généré dans Secret Manager.
database_password_length32Longueur du mot de passe généré (16-64).
application_database_name / application_database_usercrappdb / crappuserDéclarations de miroir de fondation inertes (satisfont uniquement la convention de miroir) — le chatwoot.tf de Chatwoot connecte db_name/db_user à la place, donc celles-ci ne sont jamais transmises à main.tf.
enable_auto_password_rotation / rotation_propagation_delay_secdésactivéRotation du mot de passe de la base de données.

Groupe 13 — Jobs et tâches planifiées​

VariableValeur par défautDescription
initialization_jobs[]Laissez vide pour utiliser la chaîne de jobs db-init → chatwoot-prepare intégrée du module Common.
cron_jobs[]Non utilisé — Chatwoot n'a pas de tâches récurrentes planifiées par la plateforme ; Sidekiq gère sa propre planification en cours de processus.

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probeHTTP / , délai initial de 60s, période de 15s, 30 tentativesSonde de démarrage ; dimensionnée pour absorber chatwoot-prepare se terminant avant le conteneur de l'application.
liveness_probeHTTP / , délai initial de 60s, période de 30s, 3 tentativesSonde de vivacité.
startup_probe_config / health_check_configHTTP /Sondes structurées alternatives (au niveau du service) ; startup_probe/liveness_probe prennent effet par défaut.
uptime_check_config{ enabled=false, path="/" }Vérification de disponibilité Cloud Monitoring ; désactivée par défaut.
alert_policies[]Politiques d'alerte métrique.

Groupe 21 — Cache et file d'attente Redis​

VariableValeur par défautDescription
enable_redistrueRequis pour la mise en file d'attente Sidekiq et le pub/sub ActionCable ; transmis à la fondation sans condition.
redis_host""Vide utilise l'adresse IP Redis partagée hébergée sur le serveur NFS que la Fondation injecte.
redis_port6379Port Redis.
redis_auth""Mot de passe d'authentification Redis facultatif (sensible).

Groupe 22 — Contrôles de service VPC 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 de simulation.
enable_audit_loggingfalseJournaux d'audit Cloud détaillés.

Toutes les autres entrées (y compris les application_display_name, application_description, container_build_config, additional_services, additional_containers, et les remplacements de réseau/instance SQL) suivent le comportement standard de App_CloudRun et sont inertes à moins d'être explicitement câblées — le chatwoot.tf de Chatwoot ne les transmet pas.


5. Sorties​

Retournées 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 par défaut run.app 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'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 contenant le mot de passe de la base de données.
database_host / database_portPoint de terminaison de la base de données (répertoire de socket Cloud SQL) / port.
storage_bucketsBuckets Cloud Storage créés.
network_name / network_exists / regionsRéseau VPC, présence, régions disponibles.
container_image / container_registryImage déployée et dépôt Artifact Registry.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesStatut de surveillance, canaux, tests de disponibilité.
initialization_jobsNoms des jobs de configuration (db-init, chatwoot-prepare).
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_configurationStatut 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_modeStatut VPC-SC.
audit_logging_enabled / artifact_registry_cmek_enabledJournalisation d'audit et statut 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 du plan. Ce module transmet sa configuration via le moteur de socle App_CloudRun, qui valide les valeurs et les combinaisons au moment du plan — un runtime gen1 avec des montages NFS/GCS, un redis_port/backup_retention_days hors plage, un database_type invalide. 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'au moment de l'apply ou de l'exécution.

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
database_typePOSTGRES_15 (fixé par Common)CritiqueLe schéma de Chatwoot et la recherche basée sur pgvector nécessitent Postgres 15+ ; tout autre moteur casse chatwoot-prepare.
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 orpheline toutes les données.
SECRET_KEY_BASE (auto-généré)Ne jamais changerCritiqueSa rotation invalide chaque session/cookie signé et rend les colonnes chiffrées par ActiveRecord définitivement illisibles ; Sidekiq échouera également à déchiffrer les jobs en cours.
enable_redistrue (transmis inconditionnellement)CritiqueSidekiq (jobs en arrière-plan, livraison de canaux) et ActionCable (interface utilisateur en temps réel) nécessitent tous deux Redis ; le désactiver interrompt silencieusement la livraison des messages même si l'interface web se charge.
container_image_sourcecustomÉlevéChatwoot est une image pré-construite de Docker Hub enveloppée dans un point d'entrée personnalisé (mappage d'environnement + lancement de Sidekiq) ; passer à prebuilt ignore ce wrapper et le conteneur ne mappera pas correctement DB_*/REDIS_*.
Ordre des jobs chatwoot-prepareS'exécute après db-init (depends_on_jobs = ["db-init"])ÉlevéL'exécution de la préparation du schéma avant l'existence des octrois de base de données/rôle/extension fait échouer le Job (must be superuser sur CREATE EXTENSION, ou la base de données/le rôle manquant entièrement).
enable_cloudsql_volumetrueÉlevéLe socket Unix du proxy d'authentification Cloud SQL est requis pour la connectivité de la base de données du conteneur d'application à longue durée de vie sur Cloud Run.
enable_nfstrueÉlevéLe désactiver rend les pièces jointes téléchargées éphémères — perdues lors de la prochaine révision.
min_instance_count1 pour la productionÉlevéEn dessous de 1, le worker Sidekiq co-localisé ne s'exécute pas entre les requêtes, de sorte que les jobs en arrière-plan (interrogation des canaux, notifications, rapports) stagnent.
cpu_always_allocatedtrue pour la production (avec min_instance_count >= 1)Moyen/ÉlevéLa valeur par défaut false, axée sur les coûts, n'alloue du CPU que lors du traitement d'une requête ; le travail de Sidekiq et d'ActionCable est mis en pause en dehors de cette fenêtre et de la queue de maintien au chaud.
ingress_settingsallÉlevéLe réglage sur internal bloque les webhooks de canaux externes et le widget de chat en direct public.
enable_iapuniquement lorsque les canaux publics ne sont pas nécessairesÉlevéIAP bloque toutes les requêtes non authentifiées, y compris les webhooks de canaux et le widget de chat en direct.
ENABLE_ACCOUNT_SIGNUP (par défaut "false")Laisser false, activer brièvement pour le premier administrateur si nécessaireMoyenLaisser l'inscription en libre-service publique activée sur un centre d'aide accessible par Internet permet à quiconque d'enregistrer un compte d'agent/administrateur.
backup_retention_days7 (augmenter pour la production)MoyenTrop court pour la rétention de conformité des données de conversation/client.
enable_cloud_armoractiver pour la productionMoyenLa console de l'agent et les points de terminaison des canaux publics sont accessibles sans protection WAF.

Pour le comportement du socle référencé partout — identité de service, mise à l'échelle et concurrence, ingress 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 à Chatwoot partagée avec la variante GKE se trouve dans le module Chatwoot_Common (modules/Chatwoot_Common) ; voir Chatwoot_Common pour les secrets, le bootstrap de la base de données, l'image/point d'entrée du conteneur, les sondes de santé et le stockage d'objets, et Chatwoot_GKE pour les notes de câblage côté GKE parallèles.

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