Skip to main content

Castopod on Google Cloud Run

Castopod on Google Cloud Run

Castopod is an open-source, ActivityPub-native podcast hosting platform built on CodeIgniter 4 (PHP 8) and served by FrankenPHP/Caddy. This module deploys Castopod on Cloud Run v2 on top of the App_CloudRun foundation, which provisions and manages the shared Google Cloud infrastructure.

This guide focuses on the cloud services Castopod uses and how to explore and operate them from the Google Cloud Console and the command line. For the mechanics common to every Cloud Run application — service identity, ingress and load balancing, scaling and concurrency, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls, backups, and the deployment lifecycle — refer to the App_CloudRun foundation guide rather than repeating them here.


1. Overview

Castopod runs as a PHP/FrankenPHP container on Cloud Run v2, listening on port 8080. The deployment wires together a focused set of Google Cloud services:

CapabilityGoogle Cloud serviceNotes
ComputeCloud Run v2FrankenPHP/Caddy service, 1 vCPU / 2 GiB by default, serverless autoscaling; scale-to-zero supported
DatabaseCloud SQL for MySQL 8.0Required — Castopod does not support PostgreSQL or other engines
Media storageCloud Storage + Cloud Filestore (NFS)A media bucket is provisioned; NFS is enabled by default to persist uploads across restarts
CacheRedis (optional)File cache (CP_CACHE_HANDLER = file) is the default; Redis is opt-in
SecretsSecret ManagerAuto-generated CP_ANALYTICS_SALT; database password
IngressCloud Run URL / Cloud Load BalancingDefault run.app URL; optional external HTTPS load balancer + custom domain

Sensible defaults worth knowing up front:

  • MySQL 8.0 is mandatory. The database engine is fixed (database_type = "MYSQL_8_0") by the module; selecting PostgreSQL or any other engine breaks startup.
  • The database config is written into Castopod's .env, not env vars. Castopod (CodeIgniter 4) reads dot-notated keys (database.default.hostname …) that cannot be Cloud Run env var names. The container entrypoint materialises them into .env from the injected DB_* variables, and resolves a TCP host (DB_IP) because CI4's mysqli driver cannot use the Cloud SQL socket directory.
  • CP_ANALYTICS_SALT is generated automatically and stored in Secret Manager. Keep it stable — it anonymises listener analytics, and changing it breaks de-duplication continuity for previously recorded listeners.
  • Scale-to-zero is enabled by default (min_instance_count = 0). Cold starts add a few seconds of latency to the first request after idle. Set min_instance_count = 1 to keep Castopod always warm.
  • max_instance_count = 1 by default. Do not scale beyond one instance unless the shared media filesystem (NFS/GCS) and a shared cache are confirmed multi-instance-safe.
  • NFS is enabled by default (enable_nfs = true) to persist uploaded media across container restarts. Castopod stores episode audio and artwork on the filesystem, not in the database.
  • The base URL is derived automatically. The entrypoint sets CP_BASEURL from the runtime CLOUDRUN_SERVICE_URL, so podcast feed and media URLs reflect the real service address.
  • CodeIgniter migrations run on container start — there is no separate migrate job; the schema is created on first boot after the db-init job provisions the DB and user.

2. Google Cloud Services & How to Explore Them

All commands assume PROJECT and REGION are set. Service and resource names are reported in the deployment Outputs.

A. Cloud Run — the Castopod service

Castopod runs as a Cloud Run v2 service that autoscales by request load between the minimum and maximum instance counts. Each deployment creates an immutable revision; traffic can be split across revisions for safe rollouts.

  • Console: Cloud Run → select the service for revisions, traffic, logs, and metrics.
  • CLI:
    gcloud run services list --project "$PROJECT" --region "$REGION" \
    --filter="metadata.name~castopod"
    gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
    gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"

See App_CloudRun for scaling, concurrency, execution environment, and traffic splitting.

B. Cloud SQL for MySQL 8.0

Castopod stores all application data (podcasts, episodes, users, analytics) in a managed Cloud SQL for MySQL 8.0 instance. The service connects privately — the entrypoint dials the Cloud SQL private IP over TCP (CodeIgniter's mysqli driver cannot use the Auth Proxy socket directory); no public IP is exposed. On first deploy an initialization Job creates the application database and user.

  • Console: SQL → select the instance for connections, backups, flags, metrics.
  • CLI:
    gcloud sql instances list --project "$PROJECT" --filter="name~castopod"
    gcloud sql instances describe <instance-name> --project "$PROJECT"
    gcloud sql connect <instance-name> --user=<db-user> --database=<db-name> --project "$PROJECT"

The instance name, database, user, and password secret are in the Outputs. See App_CloudRun for the connection model, backups, and password rotation.

C. Cloud Storage & media persistence

A dedicated Cloud Storage media bucket is provisioned automatically. Because Castopod writes uploaded audio and artwork to the container filesystem under /var/www/castopod/public/media, Cloud Filestore (NFS) is enabled by default (enable_nfs = true, mounted at nfs_mount_path) so those files survive restarts.

  • Console: Cloud Storage → Buckets; Filestore → Instances.
  • CLI:
    gcloud storage buckets list --project "$PROJECT" --filter="name~media"
    gcloud filestore instances list --project "$PROJECT"

See App_CloudRun for GCS Fuse, NFS, and CMEK options.

D. Redis (object cache)

Redis is disabled by default — Castopod uses a filesystem cache (CP_CACHE_HANDLER = file). When enable_redis = true, the module injects REDIS_HOST and REDIS_PORT for Castopod's object cache. When redis_host is left empty and enable_nfs is true, the NFS server VM's IP is used as the Redis endpoint.

  • Console: Memorystore → Redis (if using a managed instance).
  • CLI:
    redis-cli -h <redis-host> ping
    # Confirm the injected cache/redis env in the running revision:
    gcloud run services describe <service-name> --region "$REGION" \
    --format='value(spec.template.spec.containers[0].env)'

E. Secret Manager

One cryptographic secret is generated automatically and stored in Secret Manager: CP_ANALYTICS_SALT (used to anonymise podcast listener analytics). The database password is managed separately by the foundation.

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

See App_CloudRun for injection and rotation details.

F. Networking & ingress

The service is reachable at its run.app URL by default, which allows public access required for public podcast feeds and media downloads. An external HTTPS load balancer with a custom domain, Cloud CDN, and Cloud Armor can be layered on; ingress settings and VPC egress control connectivity.

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

See App_CloudRun.

G. Cloud Logging & Monitoring

Container logs flow to Cloud Logging; Cloud Run and Cloud SQL metrics flow to Cloud Monitoring, with optional uptime checks and alert policies.

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

3. Castopod Application Behaviour

  • First-deploy database setup. An initialization Job runs db-init.sh using mysql:8.0-debian. It connects through the Cloud SQL Auth Proxy socket (or private-IP TCP fallback) and idempotently creates the application database and user, grants privileges, and verifies the app user can connect. The job is safe to re-run.
  • Migrations run on container start. The castopod/castopod image runs the CodeIgniter 4 schema migrations automatically on every startup, so the schema is created on first boot and upgrading the application version applies schema changes without a separate migration job.
  • Database config lives in .env, injected at runtime. The entrypoint writes database.default.hostname|database|username|password|port and app.baseURL into Castopod's .env from the foundation-injected DB_* and CLOUDRUN_SERVICE_URL values. It resolves the DB host to the private-IP TCP address because CI4's mysqli driver cannot use the Cloud SQL socket directory.
  • CP_ANALYTICS_SALT should be stable after first boot. It is generated once and written to Secret Manager; changing it breaks de-duplication continuity for previously recorded listeners. Only rotate deliberately.
  • Health path. The startup probe is TCP on the container port and the liveness probe is HTTP GET / — Castopod's unauthenticated homepage returns 200 once booted and connected to MySQL. Allow several minutes on first boot for the CodeIgniter migrations to complete (the startup probe provides a 30-second initial delay plus a 20-retry window).
  • First-run setup. After deploy, open the service URL and complete Castopod's web install wizard to create the first super-admin account and set the instance name and podcast defaults. Media uploads then persist to the NFS-backed media directory.
  • Inspect job execution:
    gcloud run jobs list --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <job-name> --project "$PROJECT" --region "$REGION"

4. Configuration Variables

Variables are grouped exactly as they appear on the deployment platform. Only settings specific to or notable for Castopod are listed; every other input is inherited from App_CloudRun with its standard behaviour.

Group 1 — Project & Identity

VariableDefaultDescription
project_id(required)Target Google Cloud project.
regionus-central1Region for the service and regional resources.

All other inputs follow standard App_CloudRun behaviour.

Group 2 — Deployment Environment

VariableDefaultDescription
tenant_deployment_iddemoShort suffix that makes resource names unique per environment.

All other inputs follow standard App_CloudRun behaviour.

Group 3 — Application Identity

VariableDefaultDescription
application_namecastopodBase name for resources. Do not change after first deploy.
display_nameCastopodHuman-readable name shown in the Console.
application_versionlatestCastopod image tag; latest is pinned to the current stable release (1.15.5). Pin explicitly in production.

All other inputs follow standard App_CloudRun behaviour.

Group 4 — Runtime & Scaling

VariableDefaultDescription
deploy_applicationtrueSet false to provision infrastructure only.
cpu_limit1000mCPU per instance; Castopod needs a minimum of 1 vCPU.
memory_limit2GiMemory per instance; minimum 512Mi, 2Gi recommended for large media libraries.
min_instance_count00 enables scale-to-zero; set 1 to keep Castopod always warm.
max_instance_count1Keep at 1 unless shared media/cache is confirmed multi-instance-safe.
container_port8080FrankenPHP/Caddy listens on port 8080.
enable_cloudsql_volumefalseLeave disabled — the entrypoint connects over private-IP TCP for MySQL, not the Cloud SQL Auth Proxy socket.

All other inputs follow standard App_CloudRun behaviour.

Group 5 — Access & Ingress Control

VariableDefaultDescription
ingress_settingsallall is required for public podcast feeds and media downloads.

All other inputs follow standard App_CloudRun behaviour.

Group 11 — Storage & Filesystem

VariableDefaultDescription
enable_nfstrueProvisions Cloud Filestore to persist uploaded media across restarts; required for durable media.
nfs_mount_path/var/lib/castopodContainer mount path for the NFS volume.
gcs_volumes[]Optional GCS Fuse volume mounts (requires gen2).

All other inputs follow standard App_CloudRun behaviour.

Group 12 — Database Backend

VariableDefaultDescription
database_typeMYSQL_8_0Fixed MySQL 8.0 engine. Do not change — Castopod does not support PostgreSQL.
db_namecastopodMySQL database name. Immutable after first deploy.
db_usercastopodApplication database user. Password auto-generated in Secret Manager.

All other inputs follow standard App_CloudRun behaviour.

Group 14 — Observability & Health

VariableDefaultDescription
startup_probeTCP, 30s delayTCP startup probe on the container port; 20-retry window covers first-boot migrations.
liveness_probeHTTP / 300s delayLiveness probe against Castopod's unauthenticated homepage (returns 200 when booted).

All other inputs follow standard App_CloudRun behaviour.

Group 21 — Redis Cache

VariableDefaultDescription
enable_redisfalseSwitch Castopod's object cache to Redis; injects REDIS_HOST/REDIS_PORT.
redis_host""Redis endpoint. Leave empty to use the NFS server IP (requires enable_nfs = true).
redis_port6379Redis port.

All other inputs follow standard App_CloudRun behaviour.


5. Outputs

Returned on a successful deployment — the quickest way to locate and explore the running resources.

OutputDescription
service_nameCloud Run service name.
service_urlDefault run.app URL of the service.
service_locationRegion the service runs in.
stage_servicesStage-specific service URLs (Cloud Deploy).
load_balancer_ip / load_balancer_urlExternal HTTPS load balancer IP / URL (when enabled).
database_instance_nameCloud SQL instance name.
database_name / database_userApplication database name / user.
database_password_secretSecret Manager secret holding the DB password.
database_host / database_portDB endpoint / port.
storage_bucketsCreated Cloud Storage buckets (includes the media bucket).
network_name / network_exists / regionsVPC network, presence, regions.
container_image / container_registryDeployed image and Artifact Registry repo.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesMonitoring status, channels, uptime checks.
initialization_jobsNames of the setup jobs (db-init).
deployment_id / tenant_id / resource_prefixNaming identifiers.
project_id / project_numberProject identifiers.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationCI/CD status and details.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistry and build trigger.
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_modeVPC-SC status.
audit_logging_enabled / artifact_registry_cmek_enabledAudit logging and CMEK status.

6. Configuration Pitfalls & Sensible Defaults

Risk: Critical (data loss / outage / security) — High (service degraded) — Medium (cost or partial degradation) — Low (minor).

Inherited plan-time validation. This module passes its configuration through the App_CloudRun foundation engine, which validates values and combinations at plan time — a read replica without its primary, IAP with no authorized identities, a gen1 runtime with NFS/GCS mounts, a database_type that does not match the engine, an out-of-range redis_port/backup_retention_days. Invalid configuration fails the plan with a clear, named error before any resource is created, so most mistakes below are caught up front rather than at apply or runtime.

SettingSensible valueRiskConsequence if wrong
database_typeMYSQL_8_0CriticalCastopod is MySQL-only; any other engine breaks startup and migrations.
db_name / db_userSet onceCriticalImmutable after first deploy; renaming recreates the DB/user and destroys all podcast data.
enable_nfstrueCriticalWith NFS off, uploaded episode audio and artwork live on ephemeral disk and are lost on every restart/redeploy.
CP_ANALYTICS_SALT (auto-generated)Do not change after first bootHighChanging it breaks listener de-duplication continuity for previously recorded analytics.
max_instance_count1 unless shared state confirmedHighScaling beyond 1 without a shared media filesystem and cache causes inconsistent media and cache across instances.
memory_limit2GiHighBelow 512Mi Castopod (PHP 8) fails to boot; large media libraries need more headroom.
ingress_settingsallHighinternal blocks public podcast feed and media access.
enable_iaponly for private instancesHighIAP blocks all unauthenticated access, including public RSS feeds and media downloads.
CP_BASEURL (auto-derived)Actual service URLHighA wrong base URL produces broken feed/media links; the entrypoint derives it from CLOUDRUN_SERVICE_URL.
min_instance_count1 for productionMediumScale-to-zero (0) adds cold-start latency to the first request after idle.
enable_cloud_armorenable for productionMediumThe public UI and admin are reachable without WAF protection.

For the foundation behaviour referenced throughout — service identity, scaling and concurrency, ingress and load balancing, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC-SC, backups, and image mirroring — see App_CloudRun. Castopod-specific application configuration shared with the GKE variant is described in Castopod_Common.