Aller au contenu principal

FreshRSS sur Google Cloud Run

FreshRSS sur Google Cloud Run

FreshRSS est un agrégateur de flux RSS et Atom gratuit, auto-hébergé et sous licence GPL-3.0 — un « lecteur d'actualités » léger et multi-utilisateur écrit en PHP, qui s'exécute derrière Apache et expose les API Google Reader et Fever pour les clients mobiles. Ce module déploie FreshRSS 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 FreshRSS 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​

FreshRSS s'exécute comme un conteneur PHP/Apache sur Cloud Run v2. Le déploiement assemble un ensemble ciblé de services Google Cloud :

FonctionnalitéService Google CloudRemarques
CalculCloud Run v2Service PHP/Apache sur le port 80, 1 vCPU / 2 GiB par défaut, mise à l'échelle automatique serverless ; mise à l'échelle à zéro activée
Base de donnéesCloud SQL for PostgreSQL 15Obligatoire — le point d'entrée effectue l'installation avec --db-type pgsql
Stockage persistantNFS (Filestore / autogéré)Monté sur /var/www/FreshRSS/data ; contient la configuration, l'état par utilisateur et le cache des flux. Aucun bucket GCS
CacheRedis (facultatif)Désactivé par défaut ; FreshRSS n'en a pas besoin
SecretsSecret ManagerFRESHRSS_ADMIN_PASSWORD généré automatiquement ; mot de passe de la base de données
EntréeURL Cloud Run / Cloud Load BalancingURL run.app par défaut ; équilibreur de charge HTTPS externe et domaine personnalisé facultatifs

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

  • PostgreSQL 15 est le moteur pris en charge. Le point d'entrée du conteneur code en dur --db-type pgsql et le job db-init ne prend en charge que Postgres ; le schéma est créé par l'installateur de FreshRSS lui-même au premier démarrage.
  • NFS est activé par défaut (enable_nfs = true) et monté sur /var/www/FreshRSS/data. FreshRSS y écrit sa configuration générée (data/config.php), l'état par utilisateur, les articles mis en cache et les favicons — sans volume persistant, cet état est perdu à chaque démarrage à froid ou redéploiement.
  • FRESHRSS_ADMIN_PASSWORD est généré automatiquement et stocké dans Secret Manager. Il initialise le compte admin par défaut (ainsi que son mot de passe d'API pour les clients mobiles) lors de la première installation.
  • 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 une période d'inactivité.
  • L'actualisation des flux s'exécute via un cron dans le conteneur (CRON_MIN = */15). Tant que le service est mis à l'échelle à zéro, ce cron ne se déclenche pas — consultez le tableau des pièges.
  • max_instance_count = 1. Une seule instance détient le cron d'actualisation du conteneur et l'état de session/cache stocké sur fichiers ; exécuter plusieurs instances sans précaution duplique les actualisations de flux.
  • Le conteneur écoute sur le port 80 (Apache), et non 8080.
  • BASE_URL est défini à partir de l'URL de service prévue au moment du plan et corrigé à l'exécution à partir de CLOUDRUN_SERVICE_URL, afin que les liens autoréférents de FreshRSS et la redirection / → configuration pointent vers le véritable hôte Cloud Run.

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

FreshRSS s'exécute comme un service Cloud Run v2 qui se met automatiquement à l'échelle selon la charge des requêtes, entre le nombre minimal et le nombre maximal 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 progressifs sûrs.

  • Console : Cloud Run → sélectionnez le service pour consulter les révisions, le trafic, les journaux et les métriques.
  • CLI :
    gcloud run services list --project "$PROJECT" --region "$REGION" \
    --filter="metadata.name~freshrss"
    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 SQL for PostgreSQL 15​

FreshRSS stocke toutes les données de l'application (flux, abonnements, articles, catégories, utilisateurs) dans une instance gérée Cloud SQL for PostgreSQL 15. Le service s'y connecte de manière privée via le Cloud SQL Auth Proxy sur un socket Unix ; aucune adresse IP publique n'est exposée. Lors du premier déploiement, le Job db-init crée la base de données et l'utilisateur de l'application, et l'installateur de FreshRSS crée le schéma.

  • Console : SQL → sélectionnez l'instance pour consulter les connexions, les sauvegardes, les flags et 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 figurent dans les sorties. Consultez App_CloudRun pour le modèle de connexion, les sauvegardes et la rotation du mot de passe.

C. Stockage persistant (NFS)​

Le répertoire de données de FreshRSS (/var/www/FreshRSS/data) repose sur un volume NFS (enable_nfs = true), qui contient la configuration générée, l'état par utilisateur, les articles mis en cache et les favicons. Ce module ne déclare aucun bucket GCS — le contenu des flux est conservé dans PostgreSQL et dans le répertoire de données NFS.

  • Console : Filestore → Instances (NFS géré), ou Compute Engine → Instances de VM (serveur NFS autogéré).
  • CLI :
    gcloud filestore instances list --project "$PROJECT"
    # Confirm the mount inside the running revision:
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.volumes)'

Consultez App_CloudRun pour le modèle de serveur NFS et les options GCS Fuse.

D. Redis (cache facultatif)​

Redis est désactivé par défaut (enable_redis = false) et FreshRSS n'en a pas besoin. Il est exposé comme option transmise par souci de cohérence avec les modules PHP apparentés ; laissez-le désactivé sauf raison précise de l'activer.

  • Console : Memorystore → Redis (si vous utilisez une instance gérée).
  • CLI :
    redis-cli -h <redis-host> ping

E. Secret Manager​

Un secret d'application est généré automatiquement : FRESHRSS_ADMIN_PASSWORD, qui initialise le compte admin par défaut et son mot de passe d'API lors de la première installation. Le mot de passe de la base de données est géré séparément par le socle.

  • Console : Security → Secret Manager.
  • CLI :
    gcloud secrets list --project "$PROJECT" --filter="name~freshrss"
    gcloud secrets versions access latest --secret=<secret-name> --project "$PROJECT"

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

F. Réseau et entrée​

Le service est accessible par défaut à son URL run.app (entrée publique). Un équilibreur de charge HTTPS externe avec domaine personnalisé, Cloud CDN et Cloud Armor peut être ajouté ; les paramètres d'entrée et la sortie VPC contrôlent la connectivité.

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

Consultez App_CloudRun.

G. Cloud Logging et Monitoring​

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

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

  • Configuration de la base de données au premier déploiement. Le Job db-init s'exécute avec postgres:15-alpine. Il se connecte via le Cloud SQL Auth Proxy et crée de manière idempotente la base de données et l'utilisateur de l'application, puis accorde les privilèges. Le job peut être réexécuté sans risque.
  • Installation au premier démarrage. Le script platform-entrypoint.sh du conteneur résout l'hôte de la base de données, puis pilote les scripts de FreshRSS cli/do-install.php (qui crée data/config.php et le schéma) et cli/create-user.php (qui crée le compte admin à partir de FRESHRSS_ADMIN_PASSWORD), avant d'enchaîner sur le point d'entrée d'origine. L'installation est idempotente — elle est ignorée dès que data/config.php existe sur le volume NFS.
  • Cron d'actualisation des flux. L'image d'origine démarre un cron dans le conteneur (CRON_MIN = */15) qui actualise les flux suivis toutes les 15 minutes. Il ne s'exécute que tant qu'une instance est active — avec la mise à l'échelle à zéro (min_instance_count = 0), les actualisations sont suspendues jusqu'à ce que la requête suivante réveille le service.
  • Identifiant administrateur. L'identifiant par défaut est admin avec le FRESHRSS_ADMIN_PASSWORD généré ; la même valeur est définie comme mot de passe d'API utilisé par les clients mobiles des API Google Reader / Fever. Modifiez-le dans l'interface de FreshRSS après la première connexion — la seule rotation de la valeur dans Secret Manager ne réinitialise pas un compte déjà installé.
  • Chemin de santé. La sonde de démarrage est une vérification TCP sur le port 80 ; la sonde de vivacité est un HTTP GET sur / (200). FreshRSS sert également un point de terminaison JSON /status non authentifié, adapté aux tests de disponibilité. Prévoyez une fenêtre généreuse au premier démarrage, le temps que l'installateur crée le schéma.
  • URL de base. BASE_URL est défini sur l'URL Cloud Run prévue au moment du plan et corrigé à l'exécution à partir de CLOUDRUN_SERVICE_URL. Vérifiez la révision en cours d'exécution :
    gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'
  • Inspecter l'exécution des jobs :
    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 propres à FreshRSS ou notables pour celui-ci sont listés ; toutes les autres entrées sont héritées d'App_CloudRun avec leur comportement standard.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_namefreshrssNom de base des ressources. Ne le modifiez pas après le premier déploiement.
display_nameFreshRSSNom lisible affiché dans la console.
application_versionlatestTag de l'image FreshRSS ; latest est épinglé sur un tag éprouvé (1.26.3) au moment du build. Épinglez-le explicitement en production.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

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

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour provisionner uniquement l'infrastructure.
container_image_sourcecustomFreshRSS est livré avec un build personnalisé léger ; n'utilisez prebuilt qu'avec une container_image externe.
cpu_limit1000mCPU par instance (1 vCPU).
memory_limit2GiMémoire par instance ; conservez au moins 512Mi.
min_instance_count00 active la mise à l'échelle à zéro ; définissez 1 pour que le cron d'actualisation des flux continue de s'exécuter.
max_instance_count1Conservez 1 — une seule instance détient le cron d'actualisation et l'état stocké sur fichiers.
container_port80FreshRSS/Apache écoute sur le port 80.
execution_environmentgen2Gen2 est requis pour les montages NFS.
enable_cloudsql_volumetrueSocket du Cloud SQL Auth Proxy pour les connexions Postgres.
timeout_seconds300Durée maximale d'une requête (0 à 3600 secondes).

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

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

VariableValeur par défautDescription
ingress_settingsallall autorise l'accès public.
enable_iapfalseExige une connexion Google devant FreshRSS.
iap_authorized_users / iap_authorized_groups[]Qui peut accéder via IAP.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 11 — Stockage et système de fichiers​

VariableValeur par défautDescription
enable_nfstrueMonte un volume NFS persistant pour le répertoire de données de FreshRSS. Laissez-le activé — indispensable pour conserver la configuration et l'état par utilisateur.
nfs_mount_path/var/www/FreshRSS/dataEmplacement de montage du volume NFS dans le conteneur.
create_cloud_storage / storage_bucketstrue / []FreshRSS ne déclare aucun bucket propre ; ajoutez-en ici si nécessaire.
gcs_volumes[]Montages de volumes GCS Fuse facultatifs (nécessite gen2).

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 12 — Backend de base de données​

VariableValeur par défautDescription
database_typePOSTGRES_15Version du moteur PostgreSQL. FreshRSS s'installe avec --db-type pgsql.
db_namefreshrssNom de la base de données PostgreSQL. Immuable après le premier déploiement.
db_userfreshrssUtilisateur de la base de données de l'application. Mot de passe généré automatiquement dans Secret Manager.
database_password_length32Longueur du mot de passe généré (16 à 64).

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probeTCP / 30s delay, threshold 20Sonde de démarrage ; le seuil élevé laisse le temps à l'installation du premier démarrage.
liveness_probeHTTP / 300s delaySonde de vivacité ; /status est un point de terminaison JSON non authentifié alternatif.
uptime_check_configdisabled, path /Test de disponibilité Cloud Monitoring ; désactivé par défaut.
alert_policies[]Règles d'alerte sur les métriques.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 21 — Cache Redis​

VariableValeur par défautDescription
enable_redisfalseDésactivé par défaut ; FreshRSS n'a pas besoin de Redis.
redis_host / redis_port"" / 6379Point de terminaison Redis, s'il est activé.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.


5. Sorties​

Renvoyés lorsqu'un déploiement réussit — 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 des services propres à chaque é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 Secret Manager contenant le mot de passe de la base de données.
database_host / database_portPoint de terminaison / port de la base de données.
storage_bucketsBuckets Cloud Storage créés (FreshRSS n'en déclare aucun).
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, tests de disponibilité.
initialization_jobsNoms des jobs de configuration (db-init).
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants du projet.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationÉtat et détails du 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 de VPC-SC.
audit_logging_enabled / artifact_registry_cmek_enabledÉtat de la journalisation d'audit et de 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 au moteur du socle App_CloudRun, qui valide les valeurs et leurs combinaisons au moment du plan — un runtime gen1 avec des montages NFS, IAP sans identité autorisée, un redis_port/backup_retention_days hors limites, un database_type qui ne correspond pas à une extension activé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'apply ou à l'exécution.

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
enable_nfstrueCritiqueLe désactiver place le répertoire de données de FreshRSS sur un disque éphémère — config.php, l'état par utilisateur et le cache sont effacés à chaque démarrage à froid ou redéploiement, ce qui impose une réinstallation.
nfs_mount_path/var/www/FreshRSS/dataCritiqueUn montage ailleurs laisse le répertoire de données éphémère (même effet qu'une absence de NFS).
db_name / db_userÀ définir une seule foisCritiqueImmuables après le premier déploiement ; les renommer recrée la base de données et l'utilisateur, et rend orphelines toutes les données des flux.
database_typePOSTGRES_15CritiqueFreshRSS s'installe avec --db-type pgsql ; un moteur autre que Postgres casse l'installateur et db-init.
enable_backup_importfalse sauf en cas de restaurationCritiqueL'activer sans backup_uri valide fait échouer le job d'importation.
container_port80ÉlevéFreshRSS/Apache écoute sur le port 80 ; un port erroné fait échouer la sonde de démarrage et le service ne devient jamais prêt.
enable_cloudsql_volumetrueÉlevéLe socket de l'Auth Proxy évite l'exigence SSL d'une connexion TCP directe par IP privée vers Cloud SQL Postgres ; le désactiver peut rompre la connectivité.
min_instance_count1 pour une actualisation fiableÉlevéAvec 0 (mise à l'échelle à zéro), le cron d'actualisation des flux du conteneur est suspendu pendant l'inactivité ; les flux ne sont mis à jour que lorsqu'une requête réveille le service.
max_instance_count1ÉlevéExécuter plusieurs instances duplique le cron d'actualisation du conteneur et fragmente l'état de session/cache stocké sur fichiers.
enable_iapuniquement pour les déploiements privésÉlevéIAP bloque toutes les requêtes non authentifiées, y compris celles des clients mobiles utilisant les API Google Reader / Fever.
FRESHRSS_ADMIN_PASSWORD (généré automatiquement)À modifier dans l'interface après la première connexionMoyenLa seule rotation du secret ne réinitialise pas un compte déjà installé ; le premier mot de passe reste valide jusqu'à sa modification dans l'application.
memory_limit2GiMoyenLes valeurs inférieures à 512Mi exposent à un OOM lors d'actualisations de flux intensives.
application_versionÀ épingler en productionMoyenlatest est résolu en un tag épinglé au moment du build, mais un épinglage explicite rend les mises à niveau délibérées.

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 à FreshRSS, partagée avec la variante GKE, est décrite dans FreshRSS_Common.

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