mirror of
https://github.com/supabase/supabase.git
synced 2026-07-05 04:14:46 +08:00
360 lines
7.1 KiB
Plaintext
360 lines
7.1 KiB
Plaintext
---
|
|
id: config
|
|
title: Configuration
|
|
---
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
A `config.toml` file is generated after running `supabase init`.
|
|
|
|
This file is located in the `supabase` folder under `supabase/config.toml`.
|
|
|
|
|
|
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
## General
|
|
|
|
|
|
### `project_id`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `project_id` | `true` | `` |
|
|
|
|
A string used to distinguish different Supabase projects on the same host. Defaults to the working directory name when running `supabase init`.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
## API
|
|
|
|
|
|
### `api.port`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `api.port` | `true` | `54321` |
|
|
|
|
Port to use for the API URL.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [PostgREST configuration](https://postgrest.org/en/stable/configuration.html)
|
|
|
|
|
|
|
|
### `api.extra_search_path`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `api.extra_search_path` | `true` | `["extensions"]` |
|
|
|
|
Extra schemas to add to the `search_path` of every request.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [PostgREST configuration](https://postgrest.org/en/stable/configuration.html)
|
|
|
|
|
|
|
|
### `api.max_rows`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `api.max_rows` | `true` | `1000` |
|
|
|
|
The maximum number of rows returned from a view, table, or stored procedure. Limits payload size for accidental or malicious requests.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [PostgREST configuration](https://postgrest.org/en/stable/configuration.html)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
## Database
|
|
|
|
|
|
### `db.port`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `db.port` | `true` | `54322` |
|
|
|
|
Port to use for the local database URL.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [PostgreSQL configuration](https://postgrest.org/en/stable/configuration.html)
|
|
|
|
|
|
|
|
### `db.major_version`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `db.major_version` | `true` | `14` |
|
|
|
|
The database major version to use. This has to be the same as your remote database's. Run `SHOW server_version;` on the remote database to check.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [PostgreSQL configuration](https://postgrest.org/en/stable/configuration.html)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
## Dashboard
|
|
|
|
|
|
### `studio.port`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `studio.port` | `true` | `54323` |
|
|
|
|
Port to use for Supabase Studio.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
## Local Development
|
|
|
|
|
|
### `inbucket.port`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `inbucket.port` | `true` | `54324` |
|
|
|
|
Port to use for the email testing server web interface.
|
|
|
|
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.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Inbucket documentation](https://www.inbucket.org)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- AUTOGENERATED: DO NOT EDIT DIRECTLY -->
|
|
|
|
## Auth
|
|
|
|
|
|
### `auth.site_url`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.site_url` | `true` | `"http://localhost:3000"` |
|
|
|
|
The base URL of your website. Used as an allow-list for redirects and for constructing URLs used in emails.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.additional_redirect_urls`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.additional_redirect_urls` | `true` | `["https://localhost:3000"]` |
|
|
|
|
A list of _exact_ URLs that auth providers are permitted to redirect to post authentication.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.jwt_expiry`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.jwt_expiry` | `true` | `3600` |
|
|
|
|
How long tokens are valid for, in seconds. Defaults to 3600 (1 hour), maximum 604,800 seconds (one week).
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.enable_signup`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.enable_signup` | `true` | `true` |
|
|
|
|
Allow/disallow new user signups to your project.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.email.enable_signup`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.email.enable_signup` | `true` | `true` |
|
|
|
|
Allow/disallow new user signups via email to your project.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.email.double_confirm_changes`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.email.double_confirm_changes` | `true` | `true` |
|
|
|
|
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.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.email.enable_confirmations`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.email.enable_confirmations` | `true` | `true` |
|
|
|
|
If enabled, users need to confirm their email address before signing in.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.external.<provider>.enabled`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.external.<provider>.enabled` | `true` | `true` |
|
|
|
|
Use an external OAuth provider. The full list of providers are:
|
|
|
|
- `apple`
|
|
- `azure`
|
|
- `bitbucket`
|
|
- `discord`
|
|
- `facebook`
|
|
- `github`
|
|
- `gitlab`
|
|
- `google`
|
|
- `twitch`
|
|
- `twitter`
|
|
- `slack`
|
|
- `spotify`
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.external.<provider>.client_id`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.external.<provider>.client_id` | `true` | `""` |
|
|
|
|
Client ID for the external OAuth provider.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
### `auth.external.<provider>.secret`
|
|
|
|
| Parameter | Required | Default |
|
|
| :-------- | :------- | :------------------------- |
|
|
| `auth.external.<provider>.secret` | `true` | `""` |
|
|
|
|
Client secret for the external OAuth provider.
|
|
|
|
|
|
See also:
|
|
|
|
|
|
- [Auth Server configuration](https://supabase.com/docs/reference/tools/reference-auth)
|
|
|
|
|
|
|
|
|