Skip to main content

Memos on Google Cloud Run

Memos on Google Cloud Run

Memos is an open-source, MIT-licensed, self-hosted note-taking service built for quick markdown capture — a single ~20MB Go binary with a React frontend. This module deploys Memos 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 Memos 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

Memos runs as a single Go container on Cloud Run v2. The deployment wires together a deliberately small set of Google Cloud services — Memos has no queue, no cache, and no background workers:

CapabilityGoogle Cloud serviceNotes
ComputeCloud Run v2Go service, 1 vCPU / 512 MiB by default, serverless autoscaling, scale-to-zero by default
DatabaseCloud SQL for PostgreSQL 15Required — this module standardizes on Postgres via a single MEMOS_DSN connection URL
Object storagenoneNot provisioned by this module — see the attachments note below
Cache & queuenoneMemos has no queue or cache dependency
SecretsSecret ManagerOnly the database password (managed by the Foundation); Memos itself has no app-level secret
IngressCloud Run URLDefault run.app URL; optional external HTTPS load balancer + custom domain

Sensible defaults worth knowing up front:

  • PostgreSQL 15 is the standardized engine. Memos_Common fixes database_type = "POSTGRES_15". Memos itself also supports MySQL and SQLite upstream, but this module does not wire those paths.
  • No admin-bootstrap secret exists. The first account created through the web UI becomes the host/admin — there is no DEFAULTUSER-style env var and nothing to retrieve from Secret Manager for first login.
  • Scale-to-zero is enabled by default (min_instance_count = 0, cpu_always_allocated = false). Memos does no work without an inbound request, so request-based billing is the correct default — unlike apps with background schedulers or WebSocket push, there is no reason to force always-on CPU here.
  • The database DSN is computed at container start, not baked into the image. memos-entrypoint.sh reads the platform-injected DB_* variables and builds the single MEMOS_DSN connection URL Memos expects, branching on whether Cloud Run handed it a Unix-socket directory or a TCP host, and URL-encoding the password.
  • No object storage is provisioned. This module does not declare a GCS bucket or volume for uploaded file attachments. Text notes persist fully in PostgreSQL, but binary attachments would live on Cloud Run's ephemeral container filesystem and would not survive a revision restart. Fine for text-only note-taking; add a gcs_volumes entry if attachment persistence is required.
  • Public sign-up is open by default, same as any fresh Memos install. Disable self-registration from within the Memos UI after creating the first (admin) account, if the deployment should not accept further public sign-ups.

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 Memos service

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

  • Console: Cloud Run → select the service for revisions, traffic, logs, and metrics.
  • 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"

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

B. Cloud SQL for PostgreSQL 15

Memos stores all application data (notes, tags, users, resources metadata) in a managed Cloud SQL for PostgreSQL 15 instance. The service connects privately through the Cloud SQL Auth Proxy over a Unix socket; 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"
    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. Secret Manager

Only the database password secret exists for this module — managed entirely by the Foundation, not by Memos_Common. Memos generates its own internal session-signing key and stores it in its own database on first boot; there is no corresponding Secret Manager entry to inspect.

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

D. Networking & ingress

The service is reachable at its run.app URL by default. 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.

E. 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. Memos Application Behaviour

  • First-deploy database setup. An initialization Job runs create-db-and-user.sh using postgres:15-alpine. It connects through the Cloud SQL Auth Proxy and idempotently creates the application role and database. The job is safe to re-run.
  • Schema migrations on start. Memos applies its own internal GORM auto-migrate schema setup on every startup — no separate migration job is needed, and upgrading application_version applies schema changes automatically.
  • No admin-bootstrap credential to retrieve. The first account created through the web UI's sign-up form becomes the host/admin. There is nothing in Secret Manager to fetch before first login — this differs from most apps in this catalogue.
  • Database DSN is computed, not static. memos-entrypoint.sh builds MEMOS_DSN from DB_HOST/DB_PORT/DB_USER/DB_NAME/DB_PASSWORD at container start (see Memos_Common for the exact branching logic), then chains into the upstream image's own entrypoint, which drops privileges to a non-root user before launching the compiled binary.
  • Health path. Startup and liveness probes target / — Memos's public login/landing page, reachable without authentication. No dedicated /health or /healthz endpoint is documented upstream.
  • 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 Memos 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.

Group 2 — Deployment Environment

VariableDefaultDescription
tenant_deployment_iddemoShort suffix that makes resource names unique per environment.
support_users[]Emails granted project access and monitoring alerts.
resource_labels{}Labels applied to all resources.

Group 3 — Application Identity

VariableDefaultDescription
application_namememosBase name for resources. Do not change after first deploy.
application_display_nameMemosHuman-readable name shown in the Console.
application_descriptionMemos note-taking service on Cloud RunService description.
application_versionlatestDeployment-tracking tag. Memos_Common maps "latest" to the pinned MEMOS_VERSION = "0.28.0" Dockerfile build arg, so a fresh build never resolves a non-existent latest upstream tag.

Group 4 — Runtime & Scaling

VariableDefaultDescription
deploy_applicationtrueSet false to provision infrastructure only.
container_image_sourcecustomBuilds the wrapper image with the computed-DSN entrypoint. "prebuilt" deploys the official image directly but then requires manually wiring MEMOS_DRIVER/MEMOS_DSN via environment_variables.
container_imageghcr.io/usememos/memosBase image reference used by the custom build.
cpu_limit1000mCPU per instance.
memory_limit512MiMemory per instance — sufficient for Memos's small footprint.
min_instance_count0Scale-to-zero — Memos has no background work to keep warm for.
max_instance_count1Single-instance default; raise for higher concurrent load.
container_port5230Memos's native default port — no remapping performed.
execution_environmentgen2Gen2 required for NFS/GCS Fuse mounts (not used by this module, but the platform default).
timeout_seconds300Maximum request duration (0–3600 seconds).
cpu_always_allocatedfalseRequest-based billing — Memos does no work between requests.
enable_cloudsql_volumetrueCloud SQL Auth Proxy for socket connections.
enable_image_mirroringtrueMirror the Memos image into Artifact Registry.

Group 5 — Access & Ingress Control

VariableDefaultDescription
ingress_settingsallPublic ingress; Memos has no separate unauthenticated ingest path to protect.
vpc_egress_settingPRIVATE_RANGES_ONLYRoute only RFC 1918 traffic via VPC.
enable_iapfalseRequire Google sign-in in front of the whole service.
iap_authorized_users / iap_authorized_groups[]Who may access through IAP.

Group 6 — Environment Variables & Secrets

VariableDefaultDescription
environment_variables{}Extra non-secret settings. Any MEMOS_* value Memos documents can be set here (e.g. MEMOS_INSTANCE_URL). The database connection (MEMOS_DSN, MEMOS_DRIVER) is computed automatically — do not set them here.
secret_environment_variables{}Map of env var → Secret Manager secret name.
secret_propagation_delay30Seconds to wait after secret creation before proceeding.
secret_rotation_period2592000sSecret Manager rotation notification frequency.

Group 7 — Backup & Restore

VariableDefaultDescription
backup_schedule0 2 * * *Automated backup cron (UTC).
backup_retention_days7Retention; raise for production.
enable_backup_import / backup_source / backup_file / backup_formatrestore optionsRestore from a backup on deploy.

Group 8 — CI/CD & Binary Authorization

Standard App_CloudRun Cloud Build / Cloud Deploy integration — see App_CloudRun. Key inputs: enable_cicd_trigger, github_repository_url, github_token, enable_cloud_deploy, enable_binary_authorization.

Group 9 — Custom SQL & NFS

enable_custom_sql_scripts, custom_sql_scripts_bucket, custom_sql_scripts_path run SQL from a GCS bucket after provisioning. nfs_instance_name / nfs_instance_base_name are declared for convention parity but not exercised — Memos does not use NFS. See App_CloudRun.

Group 10 — Load Balancer, CDN & Image Retention

VariableDefaultDescription
enable_cloud_armorfalseProvision Global HTTPS LB + Cloud Armor WAF.
admin_ip_ranges[]CIDR ranges exempted from WAF rules.
application_domains[]Custom domain names for the HTTPS LB.
enable_cdnfalseEnable Cloud CDN on the HTTPS LB backend.
max_images_to_retain / delete_untagged_images / image_retention_days(set)Artifact Registry cleanup policy.

Group 11 — Storage & Filesystem

VariableDefaultDescription
create_cloud_storagetrueCreate GCS buckets defined in storage_buckets — empty by default, since Memos attachments are not GCS-backed in this module.
storage_buckets[]No bucket provisioned by default.
enable_nfsfalseNot used — Memos keeps no state outside PostgreSQL in this module's wiring.
gcs_volumes[]Add an entry here (mounted at Memos's data directory) if attachment persistence across revisions is required.

Group 12 — Database Backend

VariableDefaultDescription
database_typePOSTGRES_15Fixed by Memos_Common.
application_database_namememosPostgreSQL database name. Immutable after first deploy.
application_database_usermemosApplication database user. Password auto-generated in Secret Manager.
database_password_length32Generated password length (16–64).
enable_auto_password_rotation / rotation_propagation_delay_secoffDB password rotation.

Group 13 — Jobs & Scheduled Tasks

VariableDefaultDescription
initialization_jobs[]Leave empty to use the built-in db-init job.
cron_jobs[]Not used — Memos has no platform-scheduled recurring tasks.

Group 14 — Observability & Health

VariableDefaultDescription
startup_probeHTTP / 30s delayStartup probe — targets the public login page.
liveness_probeHTTP / 30s delayLiveness probe.
uptime_check_config{ enabled=false }Cloud Monitoring uptime check; enable explicitly to activate.
alert_policies[]Metric alert policies.

Group 16 — Redis

VariableDefaultDescription
enable_redisfalseMemos has no cache/queue dependency; leave false unless integrating an external Redis instance for a custom purpose.

Group 22 — VPC Service Controls & Audit Logging

VariableDefaultDescription
enable_vpc_scfalseEnforce a VPC-SC perimeter (requires organization_id).
vpc_cidr_ranges / vpc_sc_dry_run(set)Access level CIDRs / dry-run mode.
enable_audit_loggingfalseDetailed Cloud Audit Logs.

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 — empty by default.
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 (includes 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. 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
application_database_name / application_database_userSet onceCriticalImmutable after first deploy; renaming recreates the DB/user and destroys all data.
First account created via sign-upCreate it immediately after deployCriticalThe first account to register becomes host/admin — if left open, any visitor who reaches the URL first claims that role.
Public self-registrationDisable after first adminHighMemos ships with open sign-up by default; leaving it enabled lets anyone with the URL create an account.
container_image_sourcecustom (default)High"prebuilt" deploys the official image directly, but that image has no logic to compute MEMOS_DSN from the platform's DB_* vars — it must be wired manually via environment_variables or the app fails to connect to the database.
enable_backup_importfalse unless restoringCriticalEnabling without a valid backup_file fails the import job.
memory_limit512Mi (default is sufficient)MediumMemos's footprint is small; raising this mainly affects cost, not correctness.
min_instance_count0 (default)LowScale-to-zero adds a brief cold start (Go binary, fast boot) to the first request after idle — much shorter than JVM/Node.js apps in this catalogue.
gcs_volumes for attachmentsAdd explicitly if neededMediumWithout it, uploaded binary attachments live on Cloud Run's ephemeral filesystem and do not survive a revision restart — text notes in PostgreSQL are unaffected.
enable_cloud_armorenable for productionMediumThe login/sign-up form is publicly reachable without WAF protection by default.

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. Memos-specific application configuration shared with the GKE variant is described in Memos_Common.