Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

docs(self-hosted): update nav and minor corrections (#48499)

Andrey A.6a99952af5ff
diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
index 70effd01a41..196a9cb40e8 100644
--- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
+++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
@@ -3073,34 +3073,34 @@ export const self_hosting: NavMenuConstant = {
url: '/guides/self-hosting',
items: [
{ name: 'Overview', url: '/guides/self-hosting' },
- { name: 'Self-Hosting with Docker', url: '/guides/self-hosting/docker' },
+ { name: 'Deploy with Docker', url: '/guides/self-hosting/docker' },
+ { name: 'Configure new API keys', url: '/guides/self-hosting/self-hosted-auth-keys' },
+ { name: 'Enable Envoy API Gateway', url: '/guides/self-hosting/self-hosted-envoy' },
+ {
+ name: 'Add Reverse Proxy with HTTPS',
+ url: '/guides/self-hosting/self-hosted-proxy-https',
+ },
{
name: 'How-to Guides',
items: [
- { name: 'Configure new API keys', url: '/guides/self-hosting/self-hosted-auth-keys' },
- { name: 'Self-Hosted Functions', url: '/guides/self-hosting/self-hosted-functions' },
- {
- name: 'Add Reverse Proxy with HTTPS',
- url: '/guides/self-hosting/self-hosted-proxy-https',
- },
- { name: 'Envoy API Gateway', url: '/guides/self-hosting/self-hosted-envoy' },
{ name: 'Upgrade to Postgres 17', url: '/guides/self-hosting/postgres-upgrade-17' },
- {
- name: 'Restore Project from Platform',
- url: '/guides/self-hosting/restore-from-platform',
- },
+ { name: 'Remove superuser access', url: '/guides/self-hosting/remove-superuser-access' },
+ { name: 'Run Self-Hosted Functions', url: '/guides/self-hosting/self-hosted-functions' },
{ name: 'Configure S3 Storage', url: '/guides/self-hosting/self-hosted-s3' },
- { name: 'Copy Storage from Platform', url: '/guides/self-hosting/copy-from-platform-s3' },
- { name: 'Custom Email Templates', url: '/guides/self-hosting/custom-email-templates' },
+ { name: 'Add Custom Email Templates', url: '/guides/self-hosting/custom-email-templates' },
{ name: 'Configure Social Login (OAuth)', url: '/guides/self-hosting/self-hosted-oauth' },
{ name: 'Configure Phone Login & MFA', url: '/guides/self-hosting/self-hosted-phone-mfa' },
{ name: 'Configure SAML 2.0 SSO', url: '/guides/self-hosting/self-hosted-saml-sso' },
{ name: 'Enable MCP server', url: '/guides/self-hosting/enable-mcp' },
- { name: 'Remove superuser access', url: '/guides/self-hosting/remove-superuser-access' },
{
name: 'Custom Postgres Extensions',
url: '/guides/self-hosting/custom-postgres-extensions',
},
+ {
+ name: 'Restore Project from Platform',
+ url: '/guides/self-hosting/restore-from-platform',
+ },
+ { name: 'Copy Storage from Platform', url: '/guides/self-hosting/copy-from-platform-s3' },
],
},
{
diff --git a/apps/docs/content/guides/self-hosting/custom-email-templates.mdx b/apps/docs/content/guides/self-hosting/custom-email-templates.mdx
index f130534b30f..a0182284675 100644
--- a/apps/docs/content/guides/self-hosting/custom-email-templates.mdx
+++ b/apps/docs/content/guides/self-hosting/custom-email-templates.mdx
@@ -1,7 +1,7 @@
---
title: 'Custom Email Templates'
-description: 'Configure custom email templates with self-hosted Supabase instance'
-subtitle: 'Configure custom email templates with self-hosted Supabase instance'
+description: 'Configure custom email templates with self-hosted Supabase instance.'
+subtitle: 'Configure custom email templates with self-hosted Supabase instance.'
---
When running a self-hosted Supabase instance, you can fully customize emails sent by Supabase Auth.
diff --git a/apps/docs/content/guides/self-hosting/docker.mdx b/apps/docs/content/guides/self-hosting/docker.mdx
index 648701f8c0e..60206269a65 100644
--- a/apps/docs/content/guides/self-hosting/docker.mdx
+++ b/apps/docs/content/guides/self-hosting/docker.mdx
@@ -131,14 +131,11 @@ mkdir supabase-project
# ├── supabase
# └── supabase-project
-# Copy the compose files over to your project
-cp -rf supabase/docker/* supabase-project
+# Copy the configuration to your project
+cp -rf supabase/docker/. supabase-project
-# Copy the example environment file
-cp supabase/docker/.env.example supabase-project/.env
-
-# Switch to your project directory
-cd supabase-project
+# Switch to the project directory and create a .env from the example
+cd supabase-project && cp .env.example .env
# Pull the latest images
docker compose pull
@@ -167,14 +164,11 @@ mkdir supabase-project
# ├── supabase
# └── supabase-project
-# Copy the compose files over to your project
-cp -rf supabase/docker/* supabase-project
-
-# Copy the example environment file
-cp supabase/docker/.env.example supabase-project/.env
+# Copy the configuration over to your project
+cp -rf supabase/docker/. supabase-project
-# Switch to your project directory
-cd supabase-project
+# Switch to the project directory and create a .env from the example
+cd supabase-project && cp .env.example .env
# Pull the latest images
docker compose pull
diff --git a/apps/docs/content/guides/self-hosting/remove-superuser-access.mdx b/apps/docs/content/guides/self-hosting/remove-superuser-access.mdx
index 896edba2f6b..b18be5ea5d4 100644
--- a/apps/docs/content/guides/self-hosting/remove-superuser-access.mdx
+++ b/apps/docs/content/guides/self-hosting/remove-superuser-access.mdx
@@ -1,5 +1,5 @@
---
-title: 'Remove superuser access from Studio'
+title: 'Remove Superuser Access from Studio'
description: 'Learn how to switch from the supabase_admin to postgres role in self-hosted Supabase.'
subtitle: 'Learn how to switch from the supabase_admin to postgres role in self-hosted Supabase.'
---
diff --git a/supa-mdx-lint/Rule003Spelling.toml b/supa-mdx-lint/Rule003Spelling.toml
index 6e8dd907857..6c67ee97771 100644
--- a/supa-mdx-lint/Rule003Spelling.toml
+++ b/supa-mdx-lint/Rule003Spelling.toml
@@ -159,6 +159,7 @@ allow_list = [
"UncaughtException",
"[Uu]ncomment(ing|ed)?",
"[Uu]nlink(ing|s|ed)?",
+ "[Uu]ntracked",
"[Uu]pserts?",
"[Uu]ptime",
"[Vv]endored",