mirror of
https://github.com/supabase/supabase.git
synced 2026-10-18 15:49:09 +03:00
80 lines
4.3 KiB
YAML
80 lines
4.3 KiB
YAML
# The spec is divided into 2 main sections:
|
|
# info: general information about the tool
|
|
# functions: public functions which the user can access
|
|
|
|
configspec: '001'
|
|
|
|
# This section outlines the general information for the tool.
|
|
info:
|
|
id: 'gotrue' # {string} A unique ID for this tool.
|
|
version: 'next' # {string} The current version number of the tool.
|
|
title: 'GoTrue' # {string} A readable name.
|
|
source: 'https://github.com/supabase/gotrue' # {string} Where developers can find the source code.
|
|
bugs: 'https://github.com/supabase/gotrue/issues' # {string} Where developers can file bugs.
|
|
spec: 'https://github.com/supabase/supabase/blob/master/spec/gotrue_v1_config.yaml' # {string} Where developers can find this spec (to link directly in the docs).
|
|
description: |
|
|
A `config.toml` file is generated after running `supabase init`. This file is located in the `supabase` folder under `supabase/config.toml`.
|
|
tags:
|
|
- id: general
|
|
title: General
|
|
description: General settings.
|
|
|
|
# This section is an array of public functions which a user might need to execute.
|
|
parameters:
|
|
- id: 'project_id' # {string} A unique identifier for this param.
|
|
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`.
|
|
- id: 'GOTRUE_EXTERNAL_GITHUB' # {string} A unique identifier for this param.
|
|
title: 'auth.external.github' # {string} Any name.
|
|
tags: ['general'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
# default: '5432'
|
|
description: |
|
|
Describes whether the Github provider is enabled or not.
|
|
- id: 'GOTRUE_SITE_URL' # {string} A unique identifier for this param.
|
|
title: 'auth.site_url' # {string} Any name.
|
|
tags: ['general'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
The base URL of your website. Used as an allow-list for redirects and for constructing URLs used in emails.
|
|
- id: 'GOTRUE_URI_ALLOW_LIST' # {string} A unique identifier for this param.
|
|
title: 'auth.additional_redirect_urls' # {string} Any name.
|
|
tags: ['general'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
A list of *exact* URLs that auth providers are permitted to redirect to post authentication.
|
|
- id: 'GOTRUE_JWT_EXP' # {string} A unique identifier for this param.
|
|
title: 'auth.jwt_expiry' # {string} Any name.
|
|
tags: ['general'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
How long tokens are valid for, in seconds. Defaults to 3600 (1 hour), maximum 604,800 seconds (one week).
|
|
- id: 'GOTRUE_DISABLE_SIGNUP' # {string} A unique identifier for this param.
|
|
title: 'auth.enable_signup' # {string} Any name.
|
|
tags: ['general'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
Allow/disallow new user signups to your project.
|
|
- id: 'GOTRUE_EXTERNAL_EMAIL_ENABLED' # {string} A unique identifier for this param.
|
|
title: 'auth.email.enable_signup' # {string} Any name.
|
|
tags: ['general', 'email'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
Allow/disallow new user signups via email to your project.
|
|
- id: 'GOTRUE_MAILER_SECURE_EMAIL_CHANGE_ENABLED' # {string} A unique identifier for this param.
|
|
title: 'auth.email.double_confirm_changes' # {string} Any name.
|
|
tags: ['general', 'email'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
If enabled, a user will be required to confirm any email change on both the old, and new email addresses. If disabled, only the new email is required to confirm.
|
|
- id: 'GOTRUE_MAILER_AUTOCONFIRM' # {string} A unique identifier for this param.
|
|
title: 'auth.email.enable_confirmations' # {string} Any name.
|
|
tags: ['general', 'email'] # {string[]} These tags are useful for grouping parameters
|
|
required: true
|
|
description: |
|
|
If enabled, users need to confirm their email address before signing in.
|