diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index 4e4b03ecbec..a9a53500320 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -45,7 +45,7 @@ export const gettingstarted = { items: [ { name: 'Features', url: '/guides/getting-started/features' }, { name: 'Architecture', url: '/guides/getting-started/architecture' }, - // { name: 'Local Development', url: '/guides/cli/local-development' }, // Disabling this until we actually move the doc into this section + { name: 'Local Development', url: '/guides/getting-started/local-development' }, { name: 'Framework Quickstarts', items: [ @@ -141,7 +141,6 @@ export const cli = { title: 'CLI', items: [ { name: 'Overview', url: '/guides/cli' }, - { name: 'Local Development', url: '/guides/cli/local-development' }, { name: 'Managing Environments', url: '/guides/cli/managing-environments' }, ], } @@ -688,7 +687,6 @@ export const supabase_cli = { url: '/guides/cli', items: [ { name: 'Overview', url: '/guides/cli' }, - { name: 'Local Development', url: '/guides/cli/local-development' }, { name: 'Managing Environments', url: '/guides/cli/managing-environments' }, { name: 'Reference', diff --git a/apps/docs/pages/guides/cli.mdx b/apps/docs/pages/guides/cli.mdx index 7cb2b6fa5ce..9af544d1c51 100644 --- a/apps/docs/pages/guides/cli.mdx +++ b/apps/docs/pages/guides/cli.mdx @@ -118,7 +118,7 @@ brew upgrade supabase - [Supabase CLI Reference](/docs/reference/cli/introduction) - [Supabase CLI Configuration](/docs/reference/cli/config) -- [Local Development](/docs/guides/cli/local-development) +- [Local Development](/docs/guides/getting-started/local-development) - [Managing Environments](/docs/guides/cli/managing-environments) export const Page = ({ children }) => diff --git a/apps/docs/pages/guides/functions/dart-edge.mdx b/apps/docs/pages/guides/functions/dart-edge.mdx index 4cb5bac9d9f..36efc06b31b 100644 --- a/apps/docs/pages/guides/functions/dart-edge.mdx +++ b/apps/docs/pages/guides/functions/dart-edge.mdx @@ -133,7 +133,7 @@ edge build supabase_functions supabase functions deploy dart_edge ``` -You will be asked to provide the project reference of your Supabase instance to which you want to deploy the function. You can [link your local project to your Supabase instance](https://supabase.com/docs/guides/cli/local-development#link-your-project) to avoid having to provide the Supabase reference every time you deploy. +You will be asked to provide the project reference of your Supabase instance to which you want to deploy the function. You can [link your local project to your Supabase instance](https://supabase.com/docs/guides/getting-started/local-development#link-your-project) to avoid having to provide the Supabase reference every time you deploy. export const Page = ({ children }) => diff --git a/apps/docs/pages/guides/functions/quickstart.mdx b/apps/docs/pages/guides/functions/quickstart.mdx index ce34b931a66..9563322a715 100644 --- a/apps/docs/pages/guides/functions/quickstart.mdx +++ b/apps/docs/pages/guides/functions/quickstart.mdx @@ -25,7 +25,7 @@ Follow the steps to prepare your Supabase project on your local machine. - Install the Supabase CLI. [Docs](/docs/guides/cli). - Login to the CLI using the command: `supabase login`. [Docs](/docs/reference/cli/usage#supabase-login). -- Initialize Supabase inside your project using the command: `supabase init`. [Docs](/docs/guides/cli/local-development#getting-started). +- Initialize Supabase inside your project using the command: `supabase init`. [Docs](/docs/guides/getting-started/local-development#getting-started). - Link to your Remote Project using the command `supabase link --project-ref your-project-ref`. [Docs](/docs/reference/cli/usage#supabase-link). - Optional: Setup your environment: Follow [this setup guide](https://deno.land/manual/getting_started/setup_your_environment) to integrate the Deno language server with your editor. diff --git a/apps/docs/pages/guides/getting-started.mdx b/apps/docs/pages/guides/getting-started.mdx index 8032bc3a0b8..f2e4d4532c5 100644 --- a/apps/docs/pages/guides/getting-started.mdx +++ b/apps/docs/pages/guides/getting-started.mdx @@ -286,7 +286,7 @@ export const resources = [ { title: 'Local Development', hasLightIcon: true, - href: '/guides/cli/local-development', + href: '/guides/getting-started/local-development', description: 'Use the Supabase CLI to develop locally and collaborate between teams.', }, ] diff --git a/apps/docs/pages/guides/getting-started/features.mdx b/apps/docs/pages/guides/getting-started/features.mdx index 845dbb6914e..033af050669 100755 --- a/apps/docs/pages/guides/getting-started/features.mdx +++ b/apps/docs/pages/guides/getting-started/features.mdx @@ -44,7 +44,7 @@ Encrypt sensitive data and store secrets using our Postgres extension, Supabase ### Database migrations -Develop locally and push your changes to your production database using migrations. [Docs](/docs/guides/cli/local-development#database-migrations) +Develop locally and push your changes to your production database using migrations. [Docs](/docs/guides/getting-started/local-development#database-migrations)
diff --git a/apps/docs/pages/guides/cli/local-development.mdx b/apps/docs/pages/guides/getting-started/local-development.mdx similarity index 95% rename from apps/docs/pages/guides/cli/local-development.mdx rename to apps/docs/pages/guides/getting-started/local-development.mdx index ca38587e786..ec33084b259 100644 --- a/apps/docs/pages/guides/cli/local-development.mdx +++ b/apps/docs/pages/guides/getting-started/local-development.mdx @@ -359,6 +359,10 @@ create table "public"."cities" ( ``` +Alternately, you can view your table definitions directly from the Table Editor: + +![SQL Definition](/docs/img/guides/cli/sql-definitions.png) + You can then copy this SQL into a new migration file, and run `supabase db reset` to apply the changes. The last step is deploying these changes to a live Supabase project. @@ -407,6 +411,19 @@ If your project uses Edge Functions, you can deploy these using [`functions depl supabase functions deploy ``` +### Use Auth locally + +To use Auth locally, update your project's `supabase/config.toml` file that gets created after running `supabase init`. Add any providers you want, and set enabled to `true` + +```bash config.toml +[auth.external.github] +enabled = true +client_id = "" +secret = "" +``` + +For these changes to take effect, you need to run `supabase stop` and `supabase start` again. + ### Enabling Local Logging Local logs rely on the Supabase Analytics Server. This can be enabled via the CLI configuration, and requires a Google Cloud project and BigQuery access. @@ -424,9 +441,9 @@ Requirements: Once you have these 3 items, follow these steps: -1. Update your project's `config.toml` and fill in the following: +First, update your project's `supabase/config.toml`: -``` +```bash [analytics] enabled = true gcp_project_number = "123456" @@ -434,9 +451,9 @@ gcp_project_id = "my-project-id" gcp_jwt_path = "supabase/gcloud.json" ``` -2. Place your service account key (a JSON file) at the corresponding path and ensure that it is correctly named. +Next, place your service account key (a JSON file) at the corresponding path and ensure that it is correctly named. -3. Start your local stack using `supabase start` +Last, start your local stack using `supabase start` This will switch the logging drivers and will direct logs to the Analytics server. You will be able to view and query your logs via the Studio Logs Explorer and Logs UI. diff --git a/apps/docs/pages/guides/integrations/directus.mdx b/apps/docs/pages/guides/integrations/directus.mdx index ba6e59e46cd..05601847348 100644 --- a/apps/docs/pages/guides/integrations/directus.mdx +++ b/apps/docs/pages/guides/integrations/directus.mdx @@ -38,7 +38,7 @@ Let's dive into how we actually set up and link these two platforms to create a ## Create a Supabase Project -As mentioned, while you can [deploy Supabase locally](/docs/guides/cli/local-development). For the purpose of this guide, we'll use Supabase Cloud: +As mentioned, while you can [deploy Supabase locally](/docs/guides/getting-started/local-development). For the purpose of this guide, we'll use Supabase Cloud: 1. Create a **Supabase** account by signing in with GitHub. 2. Give your organization a name (this can be changed later). diff --git a/apps/docs/pages/guides/platform/custom-domains.mdx b/apps/docs/pages/guides/platform/custom-domains.mdx index d6f838187f8..6bf9f41472a 100644 --- a/apps/docs/pages/guides/platform/custom-domains.mdx +++ b/apps/docs/pages/guides/platform/custom-domains.mdx @@ -29,7 +29,7 @@ This example assumes your Supabase project is `foobarbaz` with a corresponding A To get started: 1. [Install](/docs/guides/resources/supabase-cli) the Supabase CLI 1.11.3+. -1. [Log in](/docs/guides/resources/supabase-cli/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. +1. [Log in](/docs/guides/resources/supabase-getting-started/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. ### Configure a CNAME @@ -98,7 +98,7 @@ Vanity Subdomains allow you to present a basic branded experience, compared to c To get started: 1. [Install](/docs/guides/resources/supabase-cli) the Supabase CLI 1.22.0+. -1. [Log in](/docs/guides/resources/supabase-cli/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. +1. [Log in](/docs/guides/resources/supabase-getting-started/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. 1. Ensure that you have [Owner or Admin permissions](/docs/guides/platform/access-control#manage-team-members) for the project you'd like to set up a vanity subdomain for. 1. Ensure that your project has a paid subscription (Pro/Pay as you go/Enterprise tier) in the [Billing page of the Dashboard](https://app.supabase.com/project/_/settings/billing/subscription). diff --git a/apps/docs/pages/guides/platform/network-restrictions.mdx b/apps/docs/pages/guides/platform/network-restrictions.mdx index 0564d57560a..062ea2b2dec 100644 --- a/apps/docs/pages/guides/platform/network-restrictions.mdx +++ b/apps/docs/pages/guides/platform/network-restrictions.mdx @@ -17,7 +17,7 @@ Each Supabase project comes with configurable restrictions on the IP ranges that To get started: 1. [Install](/docs/guides/cli) the Supabase CLI 1.22.0+. -1. [Log in](/docs/guides/cli/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. +1. [Log in](/docs/guides/getting-started/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. 1. If your project was created before 23rd December 2022, it will need to be [upgraded to the latest Supabase version](/docs/guides/platform/migrating-and-upgrading-projects) before Network Restrictions can be used. 1. Ensure that you have [Owner or Admin permissions](/docs/guides/platform/access-control#manage-team-members) for the project that you are enabling network restrictions. diff --git a/apps/docs/pages/guides/platform/ssl-enforcement.mdx b/apps/docs/pages/guides/platform/ssl-enforcement.mdx index ee70d7fbcaf..2c20dcffa1d 100644 --- a/apps/docs/pages/guides/platform/ssl-enforcement.mdx +++ b/apps/docs/pages/guides/platform/ssl-enforcement.mdx @@ -18,7 +18,7 @@ SSL enforcement only applies to connections to both Postgres and PgBouncer ("Con To get started: 1. [Install](/docs/guides/cli) the Supabase CLI 1.37.0+. -1. [Log in](/docs/guides/cli/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. +1. [Log in](/docs/guides/getting-started/local-development#log-in-to-the-supabase-cli) to your Supabase account using the CLI. 1. Ensure that you have [Owner or Admin permissions](/docs/guides/platform/access-control#manage-team-members) for the project that you are enabling SSL enforcement. ## Check enforcement status diff --git a/apps/docs/public/img/guides/cli/sql-definitions.png b/apps/docs/public/img/guides/cli/sql-definitions.png new file mode 100644 index 00000000000..5a654bf5d04 Binary files /dev/null and b/apps/docs/public/img/guides/cli/sql-definitions.png differ diff --git a/apps/docs/public/sitemap.xml b/apps/docs/public/sitemap.xml index 01fc1040a98..78ce4d811b9 100644 --- a/apps/docs/public/sitemap.xml +++ b/apps/docs/public/sitemap.xml @@ -235,7 +235,7 @@ - https://supabase.com/docs/guides/cli/local-development + https://supabase.com/docs/guides/getting-started/local-development weekly 0.5 diff --git a/apps/www/lib/redirects.js b/apps/www/lib/redirects.js index 06bcb44ca6e..5c57d2f3456 100644 --- a/apps/www/lib/redirects.js +++ b/apps/www/lib/redirects.js @@ -1908,4 +1908,9 @@ module.exports = [ source: '/docs/support', destination: '/support', }, + { + permanent: true, + source: '/docs/guides/cli/local-development', + destination: '/docs/guides/getting-started/local-development', + }, ]