Files
supabase/docker/upgrades.json
T

49 lines
3.4 KiB
JSON

{
"_schema": {
"description": "Manual-action manifest for self-hosted upgrades, read by update.sh with jq. Hand-edit this file directly; it is the source of truth (no generation step). Keys are self-hosted release versions as bare semver (e.g. \"0.7.0\"), matching the self-hosted/vX.Y.Z tag and the \"## [0.7.0]\" CHANGELOG heading. Only add an entry for a release that needs an action a file diff cannot encode: a data migration, a run-this-first script, or a breaking default. Routine config changes are applied automatically by update.sh's 3-way merge and must NOT be listed here. update.sh gates on entries in (your version, target version], ordered with sort -V.",
"fields": {
"breaking": "bool - requires explicit user confirmation before applying",
"gate": "string|null - script to run before upgrading past this release (e.g. utils/upgrade-pg17.sh)",
"migration_guide_url": "string|null - link to the per-release migration guide",
"requires": "string[] - free-text manual steps shown to the user"
}
},
"0.6.0": {
"breaking": true,
"gate": "utils/upgrade-pg17.sh",
"migration_guide_url": "https://supabase.com/docs/guides/self-hosting/postgres-upgrade-17",
"requires": [
"Postgres 17 is now the default. Do NOT start Postgres 17 against an existing Postgres 15 data directory - back up your database first.",
"Run 'sudo bash utils/upgrade-pg17.sh' (needs bash + root) to migrate Postgres 15 -> 17, then recreate containers. To defer, pin Postgres 15 with the docker-compose.pg15.yml override.",
"Includes a security fix for the API gateway (Realtime /api/tenants and /api/openapi routes) - strongly recommended for any instance running Realtime."
]
},
"0.7.0": {
"breaking": true,
"gate": null,
"migration_guide_url": "https://github.com/orgs/supabase/discussions/47093",
"requires": [
"API_EXTERNAL_URL now includes the /auth/v1 path prefix, and SAML SSO endpoints moved to /auth/v1/sso/saml/*. Update custom OAuth provider callback URLs and any SAML configuration accordingly.",
"Anon (publishable) key access to the OpenAPI spec at /rest/v1/ has been removed. Use the service role or secret API key if you relied on it; normal data access via /rest/v1/<table> is unaffected."
]
},
"0.8.0": {
"breaking": true,
"gate": null,
"migration_guide_url": "https://github.com/orgs/supabase/discussions/48048",
"requires": [
"Envoy is now the default API gateway, replacing Kong. The gateway service is renamed from 'kong' to 'api-gw' (container 'supabase-envoy'); the 'kong' network alias still resolves, so internal service references keep working.",
"If you customized volumes/api/kong.yml or the gateway service, enable the Kong override with 'sh run.sh config add kong' to keep running Kong; otherwise the merge switches you to Envoy."
]
},
"0.8.3": {
"breaking": false,
"gate": null,
"migration_guide_url": null,
"requires": [
"Storage database migrations in this release are one-way: once Storage v1.81.0 has started, going back to an older Storage image makes every file upload fail. Back up your database before running 'docker compose up'.",
"If this instance ever ran Storage v1.72.0-v1.72.3 (only possible with a manually pinned image), apply the SQL fix from https://github.com/supabase/storage/issues/1394 first, or uploads will fail after the update."
]
}
}