true
- None
- true"http://localhost:3000"true["https://localhost:3000"]true3600truetruetruetruetruetruetruetruetruetruetrue""true""true54321true["extensions"]true1000true54322true14true
- 54323
- true54324supabase secrets list
-
-
--
- supabase secrets set
-
-
--
- supabase secrets unset
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for secrets
-```
-
-
-
-supabase projects create
-
-
--
- supabase projects list
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for projects
-```
-
-
-
-supabase orgs list
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for orgs
-```
-
-
-
-supabase migration list
-
-
--
- supabase migration new
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for migration
-```
-
-
-
-supabase gen types
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for gen
-```
-
-
-
-supabase gen types typescript
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for types
-```
-
-
-
-supabase functions delete
-
-
--
- supabase functions deploy
-
-
--
- supabase functions new
-
-
--
- supabase functions serve
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for functions
-```
-
-
-
-supabase db branch
-
-
--
- supabase db diff
-
-
--
- supabase db push
-
-
--
- supabase db remote
-
-
--
- supabase db reset
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for db
-```
-
-
-
-supabase db remote changes
-
-
--
- supabase db remote commit
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for remote
- -p, --password string Password to your remote Postgres database.
-```
-
-
-
-supabase db branch create
-
-
--
- supabase db branch delete
-
-
--
- supabase db branch list
-
-
--
- supabase db branch switch
-
-
-
-
-**Options**
-
-```sh
- -h, --help help for branch
-```
-
-
-
-trueNone- You have been invited to create a user on {{ .SiteURL }}. Follow this link to - accept the invite: -
- -``` - -| Parameter | Type | Description | -| :------------------------------------------------------------------------------ | :------- | :-------------------------------------------------------------------------------------------------------------------------------- | -| `MAILER_TEMPLATES_CONFIRMATION` | `string` | URL path to an email template to use when confirming a signup. `SiteURL`, `Email`, and `ConfirmationURL` variables are available. | - -Default Content (if template is unavailable): - -```html -Follow this link to confirm your user:
- -``` - -| Parameter | Type | Description | -| :---------------------------------------------------------------------- | :------- | :--------------------------------------------------------------------------------------------------------------------------------- | -| `MAILER_TEMPLATES_RECOVERY` | `string` | URL path to an email template to use when resetting a password. `SiteURL`, `Email`, and `ConfirmationURL` variables are available. | - -Default Content (if template is unavailable): - -```html -Follow this link to reset the password for your user:
- -``` - -| Parameter | Type | Description | -| :-------------------------------------------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------- | -| `MAILER_TEMPLATES_MAGIC_LINK` | `string` | URL path to an email template to use when sending magic link. `SiteURL`, `Email`, and `ConfirmationURL` variables are available. | - -Default Content (if template is unavailable): - -```html -Follow this link to login:
- -``` - -| Parameter | Type | Description | -| :------------------------------------------------------------------------------ | :------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `MAILER_TEMPLATES_EMAIL_CHANGE` | `string` | URL path to an email template to use when confirming the change of an email address. `SiteURL`, `Email`, `NewEmail` and `ConfirmationURL` variables are available. | - -Default Content (if template is unavailable): - -```html -- Follow this link to confirm the update of your email from {{ .Email }} to {{ - .NewEmail }}: -
- -``` - -### Phone Auth - -These options control the SMS-es sent from GoTrue. - -| Parameter | Type | Description | -| :------------------------------------------------------ | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | -| `SMS_AUTOCONFIRM` | `bool` | If you do not require phone confirmation, you may set this to `true`. Defaults to `false`. | -| `SMS_MAX_FREQUENCY` | `number` | Controls the minimum amount of time that must pass before sending another sms otp. The value is the number of seconds. Defaults to 60 (1 minute)). | -| `SMS_OTP_EXP` | `number` | Controls the duration an sms otp is valid for. | -| `SMS_OTP_LENGTH` | `number` | Controls the number of digits of the sms otp sent. Valid otp lengths are between [6 - 10] digits | -| `SMS_PROVIDER` | `string` | Available options are: `twilio`, `messagebird`, `textlocal`, and `vonage` | - -If you're using twilio, you can obtain your credentials from the [twilio dashboard](https://www.twilio.com/docs/usage/requests-to-twilio#credentials): - -You can find the `SMS_TWILIO_ACCOUNT_SID` and `SMS_TWILIO_AUTH_TOKEN` in the account info page of the twilio console dashboard. - -| Parameter | Type | Description | -| :---------------------------------------------------------------------------- | :------- | :------------------------------------------- | -| `SMS_TWILIO_ACCOUNT_SID` | `string` | Your twilio account string identifier (SID). | -| `SMS_TWILIO_AUTH_TOKEN` | `string` | Your twilio auth token. | -| `SMS_TWILIO_MESSAGE_SERVICE_SID` | `string` | Your twilio sender mobile number | - -If you're using MessageBird, you can obtain your credentials from the [MessageBird dashboard](https://dashboard.messagebird.com/en/developers/access): - -| Parameter | Type | Description | -| :-------------------------------------------------------------------- | :------- | :----------------------------------------------------------- | -| `SMS_MESSAGEBIRD_ACCESS_KEY` | `string` | Your MessageBird access key. | -| `SMS_MESSAGEBIRD_ORIGINATOR` | `string` | Your MessageBird sender phone number with + or company name. | - -## Logging - -| Parameter | Type | Description | -| :-------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------- | -| `LOG_LEVEL` | `string` | Controls what log levels are output. Choose from `panic`, `fatal`, `error`, `warn`, `info`, or `debug`. Defaults to `info`. | -| `LOG_FILE` | `string` | If you wish logs to be written to a file, set `log_file` to a valid file path. | - -## Opentracing - -Currently Datadog is the only tracer supported. - -| Parameter | Type | Description | -| :-------------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `TRACING_ENABLED` | `bool` | Whether tracing is enabled or not. Defaults to `false`. | -| `TRACING_HOST` | `string` | The tracing destination. (e.g. `GOTRUE_TRACING_HOST=127.0.0.1`) | -| `TRACING_PORT` | `int` | The port for the tracing host. | -| | `string` | A comma separated list of key:value pairs. These key value pairs will be added as tags to all opentracing spans. (e.g. `GOTRUE_TRACING_TAGS="tag1:value1,tag2:value2"`) | -| `SERVICE_NAME` | `string` | The name to use for the service. | - -## Webhooks - -| Parameter | Type | Description | -| :---------------------------------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `WEBHOOK_URL` | `string` | URL of the webhook receiver endpoint. This will be called when events like `validate`, `signup` or `login` occur. | -| `WEBHOOK_SECRET` | `string` | Shared secret to authorize webhook requests. This secret signs the [JSON Web Signature](https://tools.ietf.org/html/draft-ietf-jose-json-web-signature-41) of the request. You _should_ use this to verify the integrity of the request. Otherwise others can feed your webhook receiver with fake data. | -| `WEBHOOK_RETRIES` | `number` | How often GoTrue should try a failed hook. | -| `WEBHOOK_TIMEOUT_SEC` | `number` | Time between retries (in seconds). | -| `WEBHOOK_EVENTS` | `list` | Which events should trigger a webhook. You can provide a comma separated list. For example to listen to all events, provide the values `validate,signup,login`. | diff --git a/apps/reference/_storage/generated/config.mdx b/apps/reference/_storage/generated/config.mdx deleted file mode 100644 index 2cfc75f1a27..00000000000 --- a/apps/reference/_storage/generated/config.mdx +++ /dev/null @@ -1,264 +0,0 @@ ---- -id: config -slug: /config -title: Configuration -toc_max_heading_level: 3 ---- - - - -A sample `.env` file is located in the [storage repository](https://github.com/supabase/storage-api/blob/master/.env.sample). - -Use this file to configure your environment variables for your Storage server. - - - - - - -## General {#general} - - - -### `ANON_KEY` {#ANON_KEY} - -A long-lived JWT with anonymous Postgres privileges. - - -trueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNonetrueNoneobject
-
- string
-
- object
-
- object
-
- string
-
- File
-
- FileOptions
-
- string
-
- string
-
- boolean
-
- string
-
- object
-
- string
-
- object
-
- object
-
- string
-
- ArrayBuffer | ArrayBufferView | Blob | Buffer | File | FormData | ReadableStream | ReadableStream | URLSearchParams | string
-
- FileOptions
-
- string
-
- object
-
- object
-
- object
-
- string
-
- boolean
-
- string
-
- string
-
- boolean
-
- object
-
- string
-
- GenerateSignupLinkParams | GenerateInviteOrMagiclinkParams | GenerateRecoveryLinkParams | GenerateEmailChangeLinkParams
-
- object
-
- object
-
- object
-
- object
-
- string
-
- string
-
- object
-
- object
-
- string
-
- string
-
- object
-
- object
-
- object
-
- string
-
- boolean
-
- string
-
- string
-
- boolean
-
- object
-
- string
-
- object
-
- string
-
- object
-
- string
-
- string
-
- string
-
- object
-
- Provider
-
- object
-
- object
-
- string
-
- string
-
- reflection | reflection
-
- object
-
-
- required
-
-
- object
-
- string
-
- object
-
- string
-
- boolean
-
- object
-
-
- required
-
-
- object
-
- string
-
- object
-
- string
-
- string
-
- boolean
-
- reflection | reflection
-
- object
-
-
- required
-
-
- object
-
- string
-
- string
-
- object
-
- string
-
- object
-
-
- required
-
-
- object
-
- string
-
- string
-
- object
-
- string
-
- reflection | reflection
-
- object
-
-
- required
-
-
- object
-
- string
-
- string
-
- object
-
- string
-
- object
-
- object
-
-
- required
-
-
- object
-
- string
-
- string
-
- object
-
- string
-
- object
-
- string
-
- object
-
- object
-
- string
-
- string
-
- string
-
- VerifyMobileOtpParams | VerifyEmailOtpParams
-
- object
-
- object
-
- ColumnName
-
- string | Record | array
-
- object
-
-
- required
-
-
- object
-
- object
-
- object
-
- ColumnName
-
- string | Record | array
-
- object
-
-
- required
-
-
- object
-
- object
-
- object
-
- AbortSignal
-
- object
-
- boolean
-
- boolean
-
- text | json
-
- boolean
-
- boolean
-
- boolean
-
- Query
-
- object
-
- exact | planned | estimated
-
- ColumnName
-
- object
-
- ColumnName
-
- FilterOperator | not.eq | not.neq | not.gt | not.gte | not.lt | not.lte | not.like | not.ilike | not.is | not.in | not.cs | not.cd | not.sl | not.sr | not.nxl | not.nxr | not.adj | not.ov | not.fts | not.plfts | not.phfts | not.wfts
-
- object
-
- unknown
-
- ColumnName
-
- object
-
- ColumnName
-
- object
-
- ColumnName
-
- string
-
- ColumnName
-
- object
-
- string
-
- string
-
- object
-
- object
-
- boolean
-
- object
-
- boolean
-
- boolean
-
- object
-
- string
-
- object
-
- SchemaName
-
- object
-
- Fetch
-
- Record
-
- RealtimeClientOptions
-
- Row | array
-
- object
-
-
- required
-
-
- object
-
- object
-
- object
-
- exact | planned | estimated
-
- string
-
- object
-
- File | Blob | ArrayBuffer | FormData | ReadableStream | Record | string
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- ColumnName
-
- object
-
- ColumnName
-
- string
-
- number
-
- object
-
- string
-
- ColumnName
-
- object
-
- ColumnName
-
- object
-
- Record
-
- ColumnName
-
- object
-
- ColumnName
-
- FilterOperator
-
- object
-
- string
-
- object
-
- string
-
- ColumnName
-
- object
-
- boolean
-
- undefined
-
- boolean
-
- ColumnName
-
- string | array
-
- object
-
-
- required
-
-
- object
-
- object
-
- number
-
- number
-
- object
-
- string
-
- ColumnName
-
- string
-
- ColumnName
-
- string
-
- ColumnName
-
- string
-
- ColumnName
-
- string
-
- ColumnName
-
- string
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- string
-
- number
-
- object
-
- CHANNEL_STATES
-
- default
-
- object
-
- object
-
- object
-
- default
-
- object
-
- object
-
- object
-
- object
-
- default
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- default
-
- boolean
-
- object
-
- object
-
- object
-
- object
-
- object
-
- any
-
- object
-
- any
-
- object
-
- object
-
- object
-
- FunctionName
-
- object
-
- object
-
- exact | planned | estimated
-
- boolean
-
- Query
-
- object
-
- exact | planned | estimated
-
- boolean
-
- string
-
- object
-
- boolean
-
- string
-
- string
-
- string
-
- string
-
- string
-
- number
-
- object
-
- number
-
- string
-
- string
-
- string
-
- object
-
- number
-
- number
-
- string
-
- SortBy
-
- object
-
- AbortSignal
-
- string
-
- string
-
- object
-
- string
-
- string | ArrayBuffer | ArrayBufferView | Blob | Buffer | File | FormData | ReadableStream | ReadableStream | URLSearchParams
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- string
-
- string
-
- boolean
-
- string
-
- string | ArrayBuffer | ArrayBufferView | Blob | Buffer | File | FormData | ReadableStream | ReadableStream | URLSearchParams
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- object
-
- string
-
- string
-
- boolean
-
- string
-
- string
-
- object
-
- boolean
-
- string
-
- object
-
- Function
-
- ColumnName
-
- string
-
- object
-
- string
-
- plain | phrase | websearch
-
- Row
-
- object
-
- exact | planned | estimated
-
- Row | array
-
- object
-
-
- required
-
-
- object
-
- object
-
- object
-
- exact | planned | estimated
-
- boolean
-
- string
-
- AdminUserAttributes
-
- string
-
- signup | magiclink | recovery | invite | email_change_current | email_change_new
-
- string
-
- object
-
- object
-
- string
-
- string
-
- string
-
- string
-
- object
-
- object
-
- string
-
- string
-
- object
-
- string
-
- string
-
- string
-
- object
-
- string
-
- boolean
-
- string
-
- AdminUserAttributes
-
- object
-
- string
-
- UserCredentials
-
- object
-
- string
-
- object
-
- string
-
- string
-
- boolean
-
- UserCredentials
-
- object
-
- string
-
- object
-
- string
-
- UserAttributes
-
- object
-
- minimal | representation
-
- null | exact | planned | estimated
-
- object
-
- object
-
- object
-
- FilterOperator
-
- any
-
- object
-
- object
-
- object
-
- object
-
- object
-
- string
-
- object
-
- object
-
- Partial | array
-
- undefined | reflection
-
- string
-
- FunctionInvokeOptions
-
- object
-
- boolean | null
-
- object
-
- string
-
- number
-
- object
-
- undefined | string
-
- object
-
- object
-
- object
-
- object
-
- Record
-
- object
-
- object
-
- object
-
- FilterOperator
-
- any
-
- string
-
- object
-
- undefined | string
-
- object
-
- object
-
- boolean
-
- undefined | string
-
- boolean
-
- number
-
- number
-
- object
-
- undefined | string
-
- default
-
- string
-
- undefined | object
-
- object
-
- boolean
-
- null | exact | planned | estimated
-
- string
-
- object
-
- boolean
-
- null | exact | planned | estimated
-
- string
-
- object
-
- boolean
-
- string
-
- string
-
- string
-
- string
-
- string
-
- number
-
- object
-
- number
-
- string
-
- string
-
- undefined | string
-
- SearchOptions
-
- FetchParameters
-
- string
-
- string
-
- object
-
- string
-
- ArrayBuffer | ArrayBufferView | Blob | Buffer | File | FormData | ReadableStream | ReadableStream | URLSearchParams | string
-
- FileOptions
-
- string
-
- ArrayBuffer | ArrayBufferView | Blob | Buffer | File | FormData | ReadableStream | ReadableStream | URLSearchParams | string
-
- FileOptions
-
- string
-
- string
-
- object
-
- boolean
-
- SupabaseEventTypes
-
- object
-
- object
-
- string
-
- object
-
- undefined | string
-
- Partial
-
- object
-
- minimal | representation
-
- null | exact | planned | estimated
-
- Partial | array
-
- object
-
- minimal | representation
-
- undefined | string
-
- boolean
-
- null | exact | planned | estimated
-
-