Merge pull request #11790 from supabase/bs/cli-config

docs: update CLI config

apps/docs/pages/reference/cli/config.tsx

@@ -4,7 +4,7 @@ import { Parameter } from '~/lib/refGenerator/refTypes'
 import ReactMarkdown from 'react-markdown'
 
 // Parameters are grouped on the page by tag
-const TAGS = ['general', 'auth', 'api', 'database', 'dashboard', 'local']
+const TAGS = ['general', 'auth', 'api', 'database', 'dashboard', 'local', 'edge-functions']
 
 export default function Config() {
   return (

spec/cli_v1_config.yaml

@@ -35,6 +35,9 @@ info:
     - id: local
       title: Local Development
       description: Local Development.
+    - id: edge-functions
+      title: Edge Functions
+      description: Edge Functions.
 
 # This section is an array of public functions which a user might need to execute.
 parameters:
@@ -42,7 +45,6 @@ parameters:
     title: 'project_id' # {string} Any name.
     tags: ['general'] # {string[]} These tags are useful for grouping parameters
     required: true
-    # default: '5432'
     description: |
       A string used to distinguish different Supabase projects on the same host. Defaults to the working directory name when running `supabase init`.
 
@@ -50,20 +52,32 @@ parameters:
     title: 'api.port'
     tags: ['api']
     required: true
-    default: '54321'
     description: |
       Port to use for the API URL.
     links:
       - name: 'PostgREST configuration'
         link: 'https://postgrest.org/en/stable/configuration.html'
 
+  - id: 'api.schemas'
+    title: 'api.schemas'
+    tags: ['api']
+    required: false
+    default: '["public", "storage", "graphql_public"]'
+    description: |
+      Schemas to expose in your API. Tables, views and functions in this schema
+      will get API endpoints. `public` and `storage` are always included.
+    links:
+      - name: 'PostgREST configuration'
+        link: 'https://postgrest.org/en/stable/configuration.html'
+
   - id: 'api.extra_search_path'
     title: 'api.extra_search_path'
     tags: ['api']
-    required: true
-    default: '["extensions"]'
+    required: false
+    default: '["public"]'
     description: |
-      Extra schemas to add to the `search_path` of every request.
+      Extra schemas to add to the search_path of every request. public is always
+      included.
     links:
       - name: 'PostgREST configuration'
         link: 'https://postgrest.org/en/stable/configuration.html'
@@ -71,7 +85,7 @@ parameters:
   - id: 'api.max_rows'
     title: 'api.max_rows'
     tags: ['api']
-    required: true
+    required: false
     default: '1000'
     description: |
       The maximum number of rows returned from a view, table, or stored procedure. Limits payload size for accidental or malicious requests.
@@ -83,13 +97,21 @@ parameters:
     title: 'db.port'
     tags: ['database']
     required: true
-    default: '54322'
     description: |
       Port to use for the local database URL.
     links:
       - name: 'PostgreSQL configuration'
         link: 'https://postgrest.org/en/stable/configuration.html'
 
+  - id: 'db.shadow_port'
+    title: 'db.shadow_port'
+    tags: ['database']
+    required: false
+    default: '54320'
+    description: |
+      Port to use for the local shadow database.
+    links: []
+
   - id: 'db.major_version'
     title: 'db.major_version'
     tags: ['database']
@@ -105,7 +127,6 @@ parameters:
     title: 'studio.port'
     tags: ['dashboard']
     required: true
-    default: '54323'
     description: |
       Port to use for Supabase Studio.
     links: []
@@ -114,7 +135,6 @@ parameters:
     title: 'inbucket.port'
     tags: ['local']
     required: true
-    default: '54324'
     description: |
       Port to use for the email testing server web interface.
 
@@ -123,6 +143,44 @@ parameters:
       - name: 'Inbucket documentation'
         link: 'https://www.inbucket.org'
 
+  - id: 'inbucket.smtp_port'
+    title: 'inbucket.smtp_port'
+    tags: ['local']
+    required: false
+    description: |
+      Port to use for the email testing server SMTP port.
+
+      Emails sent with the local dev setup are not actually sent - rather, they are monitored, and you can view the emails that would have been sent from the web interface.
+
+      If set, you can access the SMTP server from this port.
+    links:
+      - name: 'Inbucket documentation'
+        link: 'https://www.inbucket.org'
+
+  - id: 'inbucket.pop3_port'
+    title: 'inbucket.pop3_port'
+    tags: ['local']
+    required: false
+    description: |
+      Port to use for the email testing server POP3 port.
+
+      Emails sent with the local dev setup are not actually sent - rather, they are monitored, and you can view the emails that would have been sent from the web interface.
+
+      If set, you can access the POP3 server from this port.
+    links:
+      - name: 'Inbucket documentation'
+        link: 'https://www.inbucket.org'
+
+  - id: 'storage.file_size_limit'
+    title: 'storage.file_size_limit'
+    tags: ['local']
+    required: false
+    description: |
+      The maximum file size allowed (e.g. "5MB", "500KB").
+    links:
+      - name: 'Storage server configuration'
+        link: 'https://supabase.com/docs/guides/self-hosting/storage/config'
+
   - id: 'auth.site_url'
     title: 'auth.site_url'
     tags: ['auth']
@@ -228,7 +286,6 @@ parameters:
     title: 'auth.external.<provider>.client_id'
     tags: ['auth']
     required: true
-    default: '""'
     description: |
       Client ID for the external OAuth provider.
     links:
@@ -239,9 +296,61 @@ parameters:
     title: 'auth.external.<provider>.secret'
     tags: ['auth']
     required: true
-    default: '""'
     description: |
       Client secret for the external OAuth provider.
     links:
       - name: 'Auth Server configuration'
         link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.external.provider.url'
+    title: 'auth.external.<provider>.url'
+    tags: ['auth']
+    required: false
+    default: '""'
+    description: |
+      The base URL used for constructing the URLs to request authorization and
+      access tokens. Used by gitlab and keycloak. For gitlab it defaults to
+      https://gitlab.com. For keycloak you need to set this to your instance,
+      for example: https://keycloak.example.com/realms/myrealm .
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'auth.external.provider.redirect_uri'
+    title: 'auth.external.<provider>.redirect_uri'
+    tags: ['auth']
+    required: false
+    default: '""'
+    description: |
+      The URI a OAuth2 provider will redirect to with the code and state values.
+    links:
+      - name: 'Auth Server configuration'
+        link: 'https://supabase.com/docs/reference/auth'
+
+  - id: 'functions.function_name.verify_jwt'
+    title: 'functions.<function_name>.verify_jwt'
+    tags: ['edge-functions']
+    required: false
+    default: 'true'
+    description: |
+      By default, when you deploy your Edge Functions or serve them locally, it
+      will reject requests without a valid JWT in the Authorization header.
+      Setting this configuration changes the default behavior.
+
+      Note that the `--no-verify-jwt` flag overrides this configuration.
+    links:
+      - name: '`supabase functions` CLI subcommands'
+        link: 'https://supabase.com/docs/reference/cli/supabase-functions'
+
+  - id: 'functions.function_name.import_map'
+    title: 'functions.<function_name>.import_map'
+    tags: ['edge-functions']
+    required: false
+    default: 'true'
+    description: |
+      Specify the Deno import map file to use for the Function.
+
+      Note that the `--import-map` flag overrides this configuration.
+    links:
+      - name: '`supabase functions` CLI subcommands'
+        link: 'https://supabase.com/docs/reference/cli/supabase-functions'