mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
Add SQL definitions screenshot, move guide to live under getting started section
This commit is contained in:
1 parent
a61900d548
commit
5dc2e9e0d1
14 files changed
+38
-18
No files matched your search
@@ -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',
|
||||
|
||||
@@ -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 }) => <Layout meta={meta} children={children} />
|
||||
|
||||
@@ -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 }) => <Layout meta={meta} children={children} />
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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.',
|
||||
},
|
||||
]
|
||||
|
||||
@@ -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)
|
||||
|
||||
<br />
|
||||
|
||||
|
||||
+21
-4
@@ -359,6 +359,10 @@ create table "public"."cities" (
|
||||
|
||||
```
|
||||
|
||||
Alternately, you can view your table definitions directly from the Table Editor:
|
||||
|
||||

|
||||
|
||||
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 <function_name>
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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).
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 119 KiB |
@@ -235,7 +235,7 @@
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>https://supabase.com/docs/guides/cli/local-development</loc>
|
||||
<loc>https://supabase.com/docs/guides/getting-started/local-development</loc>
|
||||
<changefreq>weekly</changefreq>
|
||||
<changefreq>0.5</changefreq>
|
||||
</url>
|
||||
|
||||
@@ -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',
|
||||
},
|
||||
]
|
||||
Reference in new issue
Block a user