Aller au contenu principal

Trilium sur Google Cloud Run

Trilium sur Google Cloud Run

Trilium Notes (le fork TriliumNext, activement maintenu — et non le dépôt archivé zadam/trilium) est une application open source de prise de notes hiérarchique, auto-hébergée, dotée d'une base de données SQLite intégrée. Ce module déploie Trilium sur Cloud Run v2 en s'appuyant sur le socle App_CloudRun, qui provisionne et gère l'infrastructure Google Cloud partagée.

Ce guide se concentre sur les services cloud utilisés par Trilium 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 à toutes les applications Cloud Run — identité du 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 du socle App_CloudRun plutôt que de les répéter ici.


1. Vue d'ensemble​

Trilium s'exécute sous forme d'un unique conteneur Node.js/Express sur Cloud Run v2. Le déploiement assemble un ensemble volontairement restreint de services Google Cloud :

FonctionnalitéService Google CloudRemarques
CalculCloud Run v2Service Node.js, 1 vCPU / 1 GiB par défaut, mise à l'échelle automatique serverless — mais voir les remarques sur la mise à l'échelle ci-dessous
Base de donnéesAucune (SQLite intégré)L'intégralité du magasin de documents de Trilium est un unique fichier SQLite, document.db, sur le volume persistant
Stockage d'objetsCloud StorageUn bucket de données dédié, monté via GCS FUSE sur /home/node/trilium-data
SecretsSecret ManagerAucun secret généré — Trilium n'a aucun identifiant défini par variable d'environnement
EntréeURL Cloud RunURL run.app par défaut ; équilibreur de charge HTTPS externe + domaine personnalisé en option

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

  • Aucun moteur de base de données à gérer. database_type = "NONE" — il n'y a ni instance Cloud SQL, ni chaîne de connexion, ni rien à sauvegarder séparément du bucket de données.
  • Une seule instance. min_instance_count = max_instance_count = 1. La base de données SQLite intégrée de Trilium ne prend pas en charge plusieurs rédacteurs — exécuter plus d'une instance expose à une corruption de la base de données par des écritures concurrentes.
  • Aucun identifiant pré-créé. Contrairement aux applications dont le mot de passe est stocké dans Secret Manager, Trilium n'a aucun amorçage d'authentification piloté par variable d'environnement. À la première visite, l'application affiche elle-même un écran « Set Password » ; terminez-le avant de partager l'URL.
  • La sonde de santé est /api/health-check, et non /. Le chemin racine (/) renvoie une redirection 302 vers l'écran de configuration/connexion. Seul /api/health-check renvoie un 200 {"status":"ok"} non authentifié — confirmé en conditions réelles par des tests de conteneur en local.
  • Le répertoire de données est essentiel. /home/node/trilium-data contient la base de données SQLite, toutes les pièces jointes, l'historique des révisions et les paramètres. Perdre ce volume revient à tout perdre ; il est persisté par défaut via un bucket monté par GCS FUSE.
  • mount_options définit uid=1000,gid=1000. Le conteneur de Trilium s'exécute en tant qu'utilisateur node (confirmé via docker run ... id node) ; sans options de montage correspondantes, GCS FUSE monte le répertoire avec root comme propriétaire et l'application ne parvient pas à démarrer.

2. Services Google Cloud et comment les explorer​

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

A. Cloud Run — le service Trilium​

Trilium s'exécute en tant que service Cloud Run v2 unique. Comme il doit rester à exactement une instance, il n'y a pas de mise à l'échelle automatique significative à observer — le signal intéressant est l'état des révisions et le comportement au démarrage à froid.

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

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

B. Cloud Storage — le répertoire de données de Trilium​

L'intégralité de l'état de l'application (le fichier SQLite document.db, les pièces jointes, l'historique des révisions, les paramètres) réside dans un bucket Cloud Storage dédié, monté via GCS FUSE sur /home/node/trilium-data.

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

Consultez App_CloudRun pour les options de montage GCS Fuse et CMEK.

C. Réseau et entrée​

Le service est accessible par défaut à son URL run.app. Un équilibreur de charge HTTPS externe avec domaine personnalisé, Cloud CDN et Cloud Armor peut être ajouté.

  • Console : Cloud Run (URL du service) ; Network services → Load balancing.
  • CLI :
    gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'

Consultez App_CloudRun.

D. Cloud Logging et Monitoring​

Les journaux des conteneurs sont envoyés vers Cloud Logging ; les métriques de Cloud Run sont envoyées vers Cloud Monitoring, avec des tests de disponibilité et des règles d'alerte en option.

  • Console : Logging → Logs Explorer ; Monitoring → Dashboards / Alerting.
  • CLI :
    gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50

3. Comportement de l'application Trilium​

  • Aucun job de configuration de base de données au premier déploiement. Trilium crée et migre son propre schéma SQLite lors de la première visite web, via son propre assistant de configuration — il n'existe aucun job db-init géré par Terraform à inspecter.
  • Écran « Set Password » au premier lancement. La première visite de l'URL racine affiche un formulaire de définition du mot de passe (aucun administrateur ni nom d'utilisateur par défaut — Trilium est une application mono-utilisateur). Aucun identifiant pré-créé n'est à rechercher dans Secret Manager.
  • Chemin de santé. Les sondes de démarrage et d'activité ciblent /api/health-check, qui renvoie 200 {"status":"ok"} dès que le serveur HTTP est à l'écoute — que la base de données SQLite ait déjà été initialisée ou non (cela n'a lieu qu'une fois que l'opérateur a terminé l'étape Set Password).
  • Contrainte d'un rédacteur unique. N'augmentez jamais max_instance_count au-delà de 1 — la base de données SQLite intégrée ne supporte pas sans risque des rédacteurs concurrents provenant de plusieurs instances.
  • Inspecter la révision en cours d'exécution :
    gcloud run services describe <service-name> \
    --region "$REGION" --project "$PROJECT" \
    --format='value(status.url)'

4. Variables de configuration​

Les variables sont regroupées exactement comme elles apparaissent sur la plateforme de déploiement. Seuls les paramètres propres à Trilium ou notables pour lui sont listés ; toutes les autres entrées sont héritées d'App_CloudRun avec leur comportement standard.

Groupe 1 — Projet et identité​

VariableValeur par défautDescription
project_id(obligatoire)Projet Google Cloud cible.
regionus-central1Région du service et des ressources régionales.

Groupe 2 — Environnement de déploiement​

VariableValeur par défautDescription
tenant_iddemoCourt suffixe qui rend les noms de ressources uniques par environnement.
support_users[]Adresses e-mail bénéficiant d'un accès au projet et des alertes de surveillance.
resource_labels{}Libellés appliqués à toutes les ressources.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_nametriliumNom de base des ressources. Ne pas modifier après le premier déploiement.
application_display_nameTrilium NotesNom lisible affiché dans la console.
application_versionlatestTag de version de l'image Docker ; associé en interne à un ARG de build épinglé (TRILIUM_VERSION), et non transmis tel quel sous la forme latest au Dockerfile.
enable_passwordfalseRéservé par souci de cohérence avec les autres modules d'éditeurs mono-utilisateur. Sans effet — Trilium n'a aucun amorçage de mot de passe piloté par variable d'environnement.

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

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour ne provisionner que l'infrastructure.
cpu_limit1000mCPU par instance.
memory_limit1GiMémoire par instance ; Trilium est léger, n'augmentez cette valeur que pour de très grandes collections de notes.
min_instance_count / max_instance_count1 / 1Gardez les deux à 1 — la base de données SQLite intégrée ne prend pas en charge plusieurs rédacteurs.
container_port8080Port HTTP par défaut de Trilium.
execution_environmentgen2Gen2 est requis pour les montages GCS Fuse.
enable_image_mirroringtrueMet en miroir l'image Trilium dans Artifact Registry.

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

VariableValeur par défautDescription
ingress_settingsallPublic par défaut ; restreignez à internal pour un déploiement privé.
vpc_egress_settingPRIVATE_RANGES_ONLYN'achemine via le VPC que le trafic RFC 1918.
enable_iapfalseExige une connexion Google devant Trilium.

Groupe 11 — Stockage et système de fichiers​

VariableValeur par défautDescription
create_cloud_storagetrueCrée le bucket de données de Trilium.
gcs_volumes[]Volumes GCS Fuse supplémentaires en plus du bucket de données monté automatiquement.

Groupe 12 — Backend de base de données​

VariableValeur par défautDescription
database_typeNONENon utilisé — Trilium n'a pas de base de données SQL (SQLite intégré uniquement).

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probeHTTP /api/health-check, délai de 15sSonde de démarrage.
liveness_probeHTTP /api/health-check, délai de 30sSonde de vivacité.
uptime_check_configdésactivéTest de disponibilité Cloud Monitoring facultatif sur /api/health-check.

5. Sorties​

SortieDescription
service_nameNom du service Cloud Run.
trilium_urlURL run.app par défaut du service.
service_locationRégion dans laquelle le service s'exécute.
load_balancer_ip / load_balancer_urlIP / URL de l'équilibreur de charge HTTPS externe (lorsqu'il est activé).
storage_bucketsBuckets Cloud Storage créés.
container_image / container_registryImage déployée et dépôt Artifact Registry.
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants du projet.

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).

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
max_instance_count1CritiqueL'augmenter expose à une corruption de la base de données SQLite intégrée par des rédacteurs concurrents — aucune protection n'existe contre cela au niveau de la couche de requêtes.
mount_options du bucket de données / de gcs_volumesuid=1000,gid=1000CritiqueUn uid/gid incorrect monte le répertoire de données avec root comme propriétaire ; le processus Trilium non root ne parvient pas à démarrer et renvoie une erreur de permission.
Étape « Set Password » de la première visiteÀ terminer immédiatementCritiqueUne instance Trilium sans mot de passe défini, laissée sur une URL publique, est accessible à tous jusqu'à ce que le mot de passe soit défini.
Chemin de startup_probe / liveness_probe/api/health-checkÉlevéFaire pointer les sondes sur / renvoie une redirection 302, que la plupart des contrôles de santé HTTP considèrent comme un échec, ce qui empêche la révision de devenir Ready.
ingress_settingsinternal pour un usage privéMoyenall (valeur par défaut) rend l'instance (initialement non authentifiée, avant l'étape Set Password) accessible depuis l'internet public.
memory_limit1GiFaibleTrilium est léger ; n'augmentez cette valeur que pour de très grandes collections de notes ou de pièces jointes.

Pour le comportement du socle évoqué tout au long de cette page — identité du 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 des images — consultez App_CloudRun. La configuration applicative propre à Trilium partagée avec la variante GKE est décrite dans Trilium_Common.

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