本地开发

Supabase CLI config


运行supabase init后会生成一个supabase/config.toml文件。

您可以编辑此文件以更改本地运行项目的设置。修改后,需要先使用supabase stop停止,再通过supabase start重新启动才能使更改生效。

通用 Config

project_id

NameDefaultRequired
project_idNonetrue

Description

用于区分同一主机上不同Supabase项目的字符串。运行supabase init时默认为工作目录名称。

Auth Config

auth.enabled

NameDefaultRequired
auth.enabledtruefalse

Description

启用本地 GoTrue 服务。

auth.site_url

NameDefaultRequired
auth.site_url"http://localhost:3000"false

Description

您网站的基础URL。用于重定向白名单以及构建电子邮件中使用的URL。

auth.additional_redirect_urls

NameDefaultRequired
auth.additional_redirect_urls["https://localhost:3000"]false

Description

一个包含授权提供商在认证后允许重定向的_精确_URL列表。

auth.jwt_expiry

NameDefaultRequired
auth.jwt_expiry3600false

Description

令牌有效期,以秒为单位。默认为3600秒(1小时),最大604,800秒(一周)。

auth.enable_manual_linking

NameDefaultRequired
auth.enable_manual_linkingfalsefalse

Description

允许测试手动关联账户

auth.enable_refresh_token_rotation

NameDefaultRequired
auth.enable_refresh_token_rotationtruefalse

Description

如果禁用,刷新令牌将永不过期。

auth.refresh_token_reuse_interval

NameDefaultRequired
auth.refresh_token_reuse_interval10false

Description

允许刷新令牌在过期后重复使用,时间间隔由指定的秒数决定。需要 enable_refresh_token_rotation = true。

auth.rate_limit.email_sent

NameDefaultRequired
auth.rate_limit.email_sent2false

Description

每小时可发送的电子邮件数量。需要启用auth.email.smtp。

auth.rate_limit.sms_sent

NameDefaultRequired
auth.rate_limit.sms_sent30false

Description

每小时可发送的短信数量。需要启用auth.sms。

auth.rate_limit.anonymous_users

NameDefaultRequired
auth.rate_limit.anonymous_users30false

Description

每个IP地址每小时可进行的匿名登录次数。需要 enable_anonymous_sign_ins = true。

auth.rate_limit.token_refresh

NameDefaultRequired
auth.rate_limit.token_refresh150false

Description

每个IP地址在5分钟间隔内可刷新的会话次数。

auth.rate_limit.sign_in_sign_ups

NameDefaultRequired
auth.rate_limit.sign_in_sign_ups30false

Description

每个IP地址在5分钟间隔内可进行的注册和登录请求次数(不包括匿名用户)。

auth.rate_limit.token_verifications

NameDefaultRequired
auth.rate_limit.token_verifications30false

Description

每个IP地址在5分钟间隔内可进行的OTP/魔法链接验证次数。

auth.enable_signup

NameDefaultRequired
auth.enable_signuptruefalse

Description

允许/禁止新用户注册到您的项目。

auth.enable_anonymous_sign_ins

NameDefaultRequired
auth.enable_anonymous_sign_insfalsefalse

Description

允许/禁止匿名登录到您的项目。

See also

auth.email.enable_signup

NameDefaultRequired
auth.email.enable_signuptruefalse

Description

允许/禁止通过电子邮件注册新用户到您的项目。

auth.email.double_confirm_changes

NameDefaultRequired
auth.email.double_confirm_changestruefalse

Description

若启用此选项,用户需同时在旧邮箱地址和新邮箱地址上确认任何邮箱更改。若禁用此选项,则仅需新邮箱地址进行确认。

auth.email.enable_confirmations

NameDefaultRequired
auth.email.enable_confirmationsfalsefalse

Description

如果启用,用户在登录前需要确认其电子邮件地址。

auth.email.secure_password_change

NameDefaultRequired
auth.email.secure_password_changeNonefalse

Description

如果启用,用户在更改密码时需要提供当前密码。

auth.email.max_frequency

NameDefaultRequired
auth.email.max_frequency1mfalse

Description

两次邮件请求之间必须间隔的最短时间。 通过限制邮件发送频率来防止垃圾邮件。 示例值:"1m"(1分钟)、"1h"(1小时)、"24h"(24小时)

auth.email.otp_length

NameDefaultRequired
auth.email.otp_length6false

Description

邮件中发送的OTP验证码长度。 必须为6至10位数字。

auth.email.otp_exp

NameDefaultRequired
auth.email.otp_exp300false

Description

OTP验证码的过期时间(单位:秒)。 默认为300秒(5分钟)。

auth.email.smtp.host

NameDefaultRequired
auth.email.smtp.hostinbucketfalse

Description

SMTP服务器的主机名或IP地址。

auth.email.smtp.port

NameDefaultRequired
auth.email.smtp.port2500false

Description

SMTP服务器的端口号。

auth.email.smtp.user

NameDefaultRequired
auth.email.smtp.userNonefalse

Description

用于SMTP服务器认证的用户名。

auth.email.smtp.pass

NameDefaultRequired
auth.email.smtp.passNonefalse

Description

用于SMTP服务器认证的密码。

auth.email.smtp.admin_email

NameDefaultRequired
auth.email.smtp.admin_emailadmin@email.comfalse

Description

应用程序发送邮件时使用的发件人邮箱。

auth.email.smtp.sender_name

NameDefaultRequired
auth.email.smtp.sender_nameNonefalse

Description

应用程序发送邮件时使用的发件人显示名称。

auth.email.template.<类型>.subject

NameDefaultRequired
auth.email.template.type.subjectNonefalse

Description

完整的邮件模板类型列表如下:

  • invite 邀请
  • confirmation 确认
  • recovery 恢复
  • magic_link 魔法链接
  • email_change 邮箱变更

auth.email.template.<类型>.content_path

NameDefaultRequired
auth.email.template.type.content_pathNonefalse

Description

完整的邮件模板类型列表如下:

  • invite
  • confirmation
  • recovery
  • magic_link
  • email_change

auth.sms.enable_signup

NameDefaultRequired
auth.sms.enable_signuptruefalse

Description

允许/禁止通过短信向您的项目注册新用户。

auth.sms.enable_confirmations

NameDefaultRequired
auth.sms.enable_confirmationsfalsefalse

Description

如果启用,用户在登录前需要确认其电话号码。

auth.sms.test_otp

NameDefaultRequired
auth.sms.test_otpNonefalse

Description

使用预定义的电话号码到OTP的映射进行测试。

Usage

1[auth.sms.test_otp]
24152127777 = "123456"

auth.sms.<provider>.enabled

NameDefaultRequired
auth.sms.provider.enabledfalsefalse

Description

使用外部短信服务提供商。完整提供商列表如下:

  • twilio
  • twilio_verify
  • messagebird
  • textlocal
  • vonage

auth.sms.<twilio|twilio_verify>.account_sid

NameDefaultRequired
auth.sms.twilio.account_sidNonetrue

Description

Twilio账户SID

auth.sms.<twilio|twilio_verify>.message_service_sid

NameDefaultRequired
auth.sms.twilio.message_service_sidNonetrue

Description

Twilio消息服务SID

auth.sms.<twilio|twilio_verify>.auth_token

NameDefaultRequired
auth.sms.twilio.auth_tokenenv(SUPABASE_AUTH_SMS_TWILIO_AUTH_TOKEN)true

Description

Twilio 认证令牌

请勿将您的 Twilio 认证令牌提交到 git 仓库。请改用环境变量替换。

auth.sms.messagebird.originator

NameDefaultRequired
auth.sms.messagebird.originatorNonetrue

Description

MessageBird 发信号码

auth.sms.messagebird.access_key

NameDefaultRequired
auth.sms.messagebird.access_keyenv(SUPABASE_AUTH_SMS_MESSAGEBIRD_ACCESS_KEY)true

Description

MessageBird访问密钥

请勿将您的MessageBird访问密钥提交到git。请改用环境变量替换。

auth.sms.textlocal.sender

NameDefaultRequired
auth.sms.textlocal.senderNonetrue

Description

TextLocal 发送者

auth.sms.textlocal.api_key

NameDefaultRequired
auth.sms.textlocal.api_keyenv(SUPABASE_AUTH_SMS_TEXTLOCAL_API_KEY)true

Description

TextLocal API密钥

请勿将您的TextLocal API密钥提交到git。请改用环境变量替代。

auth.sms.vonage.from

NameDefaultRequired
auth.sms.vonage.fromNonetrue

Description

Vonage 发信号码

auth.sms.vonage.api_key

NameDefaultRequired
auth.sms.vonage.api_keyNonetrue

Description

Vonage API密钥

auth.sms.vonage.api_secret

NameDefaultRequired
auth.sms.vonage.api_secretenv(SUPABASE_AUTH_SMS_VONAGE_API_SECRET)true

Description

Vonage API密钥

请勿将您的Vonage API密钥提交到git。请改用环境变量替换。

auth.external.<provider>.enabled

NameDefaultRequired
auth.external.provider.enabledfalsefalse

Description

使用外部OAuth提供商。完整的提供商列表如下:

  • apple
  • azure
  • bitbucket
  • discord
  • facebook
  • github
  • gitlab
  • google
  • kakao
  • keycloak
  • linkedin_oidc
  • notion
  • twitch
  • twitter
  • slack_oidc
  • spotify
  • workos
  • zoom

auth.external.<provider>.client_id

NameDefaultRequired
auth.external.provider.client_idNonetrue

Description

外部OAuth提供商的客户端ID。

auth.external.<provider>.secret

NameDefaultRequired
auth.external.provider.secretenv(SUPABASE_AUTH_EXTERNAL_<PROVIDER>_SECRET)true

Description

外部OAuth提供商的客户端密钥。

切勿将OAuth提供商密钥提交到git。请改用环境变量替换。

auth.external.<provider>.url

NameDefaultRequired
auth.external.provider.urlNonefalse

Description

用于构建请求授权和访问令牌URL的基础URL。适用于gitlab和keycloak。 对于gitlab,默认值为https://gitlab.com。对于keycloak,您需要将其设置为您的实例地址, 例如:https://keycloak.example.com/realms/myrealm。

auth.external.<provider>.redirect_uri

NameDefaultRequired
auth.external.provider.redirect_uriNonefalse

Description

OAuth2提供商将携带code和state值重定向至此URI。

auth.external.<provider>.skip_nonce_check

NameDefaultRequired
auth.external.provider.skip_nonce_checkNonefalse

Description

在指定提供商的OIDC认证流程中禁用nonce验证。仅在客户端库无法正确处理nonce验证时启用。请注意,这会降低安全性,因为允许使用被盗ID令牌进行潜在的重放攻击。

auth.hook.<hook_name>.enabled

NameDefaultRequired
auth.hook.<hook_name>.enabledfalsefalse

Description

启用认证钩子。hook_name的可能值为:custom_access_tokensend_smssend_emailmfa_verification_attemptpassword_verification_attempt

See also

auth.hook.<hook_name>.uri

NameDefaultRequired
auth.hook.<hook_name>.uriNonefalse

Description

要调用的钩子URI。应为一个http或https函数,或采用以下形式的Postgres函数:pg-functions://<数据库>/<模式>/<函数名>。例如:pg-functions://postgres/auth/custom-access-token-hook

See also

auth.hook.<hook_name>.secrets

NameDefaultRequired
auth.hook.<hook_name>.secretsNonefalse

Description

使用HTTP钩子时配置。接受一个base64编码的逗号分隔值列表以支持密钥轮换。目前Supabase认证仅使用列表中的第一个值。

See also

auth.mfa.totp.enroll_enabled

NameDefaultRequired
auth.mfa.totp.enroll_enabledtruefalse

Description

启用TOTP注册以支持多因素认证。

auth.mfa.totp.verify_enabled

NameDefaultRequired
auth.mfa.totp.verify_enabledtruefalse

Description

启用TOTP验证以实现多因素认证。

auth.mfa.max_enrolled_factors

NameDefaultRequired
auth.mfa.max_enrolled_factors10false

Description

控制每个用户一次可注册的MFA因素数量。

auth.mfa.phone.enroll_enabled

NameDefaultRequired
auth.mfa.phone.enroll_enabledfalsefalse

Description

启用电话注册以进行多因素认证。

auth.mfa.phone.otp_length

NameDefaultRequired
auth.mfa.phone.otp_length6false

Description

使用电话多因素认证时发送的OTP代码长度

auth.mfa.phone.max_frequency

NameDefaultRequired
auth.mfa.phone.max_frequency10sfalse

Description

两次手机请求之间必须间隔的最短时间。 通过限制消息发送频率来防止垃圾信息。 示例值:"10秒"、"20秒"、"1分钟"

auth.mfa.phone.otp_length

NameDefaultRequired
auth.mfa.phone.otp_length6false

Description

使用手机多因素认证时发送的OTP长度

auth.mfa.phone.verify_enabled

NameDefaultRequired
auth.mfa.phone.verify_enabledfalsefalse

Description

启用手机验证以进行多因素认证。

auth.mfa.web_authn.enroll_enabled

NameDefaultRequired
auth.mfa.web_authn.enroll_enabledfalsefalse

Description

启用WebAuthn注册以进行多因素认证。

auth.mfa.web_authn.verify_enabled

NameDefaultRequired
auth.mfa.web_authn.verify_enabledfalsefalse

Description

启用WebAuthn验证以进行多因素认证。

auth.sessions.timebox

NameDefaultRequired
auth.sessions.timeboxNonefalse

Description

在指定持续时间后强制注销。示例值包括:'50分钟'、'20小时'。

See also

auth.sessions.inactivity_timeout

NameDefaultRequired
auth.sessions.inactivity_timeoutNonefalse

Description

如果用户不活跃时间超过指定时长,则强制注销。示例值包括:'50分钟'、'20小时'。

See also

auth.third_party.aws_cognito.enabled

NameDefaultRequired
auth.third_party.aws_cognito.enabledfalsefalse

Description

启用AWS Cognito(Amplify)的第三方认证

auth.third_party.aws_cognito.user_pool_id

NameDefaultRequired
auth.third_party.aws_cognito.user_pool_idfalsefalse

Description

您正在集成的AWS Cognito(Amplify)用户池ID

auth.third_party.aws_cognito.user_pool_region

NameDefaultRequired
auth.third_party.aws_cognito.user_pool_regionfalsefalse

Description

您正在集成的AWS Cognito(Amplify)用户池所在区域。示例值:'ap-southeast-1'(亚太东南1区),'us-east-1'(美国东部1区)

auth.third_party.auth0.enabled

NameDefaultRequired
auth.third_party.auth0.enabledfalsefalse

Description

启用Auth0第三方认证

auth.third_party.auth0.tenant

NameDefaultRequired
auth.third_party.auth0.tenantfalsefalse

Description

您正在集成的Auth0实例的租户标识符

auth.third_party.tenant_region

NameDefaultRequired
auth.third_party.auth0.tenant_regionfalsefalse

Description

您正在集成的Auth0实例的租户区域

auth.third_party.firebase.enabled

NameDefaultRequired
auth.third_party.firebase.enabledfalsefalse

Description

启用Firebase第三方认证

auth.third_party.firebase.project_id

NameDefaultRequired
auth.third_party.firebase.project_idfalsefalse

Description

要集成的Firebase实例的项目ID

API Config

api.enabled

NameDefaultRequired
api.enabledtruefalse

Description

启用本地PostgREST服务。

api.port

NameDefaultRequired
api.port54321false

Description

API URL使用的端口号。

Usage

1[api]
2port = 54321

api.schemas

NameDefaultRequired
api.schemas["public", "storage", "graphql_public"]false

Description

在API中公开的数据库模式。该模式中的表、视图和函数将获得API端点。publicstorage模式始终包含在内。

api.extra_search_path

NameDefaultRequired
api.extra_search_path["public", "extensions"]false

Description

为每个请求的搜索路径添加额外的模式。public 模式始终包含在内。

api.max_rows

NameDefaultRequired
api.max_rows1000false

Description

从视图、表或存储过程返回的最大行数。用于限制意外或恶意请求的有效载荷大小。

数据库 Config

db.port

NameDefaultRequired
db.port54322false

Description

本地数据库URL使用的端口。

db.shadow_port

NameDefaultRequired
db.shadow_port54320false

Description

本地影子数据库使用的端口。

See also

    db.major_version

    NameDefaultRequired
    db.major_version15false

    Description

    要使用的数据库主版本号。必须与远程数据库的版本一致。请在远程数据库上运行SHOW server_version;命令进行确认。

    db.pooler.enabled

    NameDefaultRequired
    db.pooler.enabledfalsefalse

    Description

    启用本地PgBouncer服务。

    db.pooler.port

    NameDefaultRequired
    db.pooler.port54329false

    Description

    用于本地连接池的端口。

    db.pooler.pool_mode

    NameDefaultRequired
    db.pooler.pool_mode"transaction"false

    Description

    指定服务器连接何时可被其他客户端重复使用。配置支持的连接池模式之一:transaction(事务模式)、session(会话模式)。

    db.pooler.default_pool_size

    NameDefaultRequired
    db.pooler.default_pool_size20false

    Description

    每个用户/数据库对允许建立的服务器连接数。

    db.settings.effective_cache_size

    NameDefaultRequired
    db.settings.effective_cache_sizeNonefalse

    Description

    设置规划器对磁盘缓存有效大小的假设。 这是一个查询规划器参数,不会影响实际的内存分配。

    db.settings.logical_decoding_work_mem

    NameDefaultRequired
    db.settings.logical_decoding_work_memNonefalse

    Description

    指定逻辑解码在将数据写入本地磁盘前使用的内存量。

    db.settings.maintenance_work_mem

    NameDefaultRequired
    db.settings.maintenance_work_memNonefalse

    Description

    指定维护操作(如VACUUM、CREATE INDEX和ALTER TABLE ADD FOREIGN KEY)可使用的最大内存量。

    db.settings.max_connections

    NameDefaultRequired
    db.settings.max_connectionsNonefalse

    Description

    确定与数据库服务器建立的最大并发连接数。 注意:更改此参数需要重启数据库。

    db.settings.max_locks_per_transaction

    NameDefaultRequired
    db.settings.max_locks_per_transactionNonefalse

    Description

    控制为每个事务分配的对象锁的平均数量。 注意:更改此参数需要重启数据库。

    db.settings.max_parallel_maintenance_workers

    NameDefaultRequired
    db.settings.max_parallel_maintenance_workersNonefalse

    Description

    设置单个实用程序命令可以启动的最大并行工作线程数。

    db.settings.max_parallel_workers

    NameDefaultRequired
    db.settings.max_parallel_workersNonefalse

    Description

    设置系统支持的最大并行工作线程数。 注意:更改此参数需要重启数据库。

    db.settings.max_parallel_workers_per_gather

    NameDefaultRequired
    db.settings.max_parallel_workers_per_gatherNonefalse

    Description

    设置单个Gather或Gather Merge节点可启动的最大并行工作进程数。

    db.settings.max_replication_slots

    NameDefaultRequired
    db.settings.max_replication_slotsNonefalse

    Description

    指定服务器可支持的最大复制槽数量。 注意:更改此参数需要重启数据库。

    db.settings.max_slot_wal_keep_size

    NameDefaultRequired
    db.settings.max_slot_wal_keep_sizeNonefalse

    Description

    指定复制槽允许在pg_wal目录中保留的WAL文件的最大大小。

    db.settings.max_standby_archive_delay

    NameDefaultRequired
    db.settings.max_standby_archive_delayNonefalse

    Description

    设置热备服务器处理归档WAL数据时,取消查询前的最大延迟时间。

    db.settings.max_standby_streaming_delay

    NameDefaultRequired
    db.settings.max_standby_streaming_delayNonefalse

    Description

    设置热备服务器处理流式WAL数据时,取消查询前的最大延迟时间。

    db.settings.max_wal_size

    NameDefaultRequired
    db.settings.max_wal_sizeNonefalse

    Description

    设置系统将在pg_wal目录中保留的WAL文件的最大大小。

    db.settings.max_wal_senders

    NameDefaultRequired
    db.settings.max_wal_sendersNonefalse

    Description

    指定从备用服务器或流式基础备份客户端并发连接的最大数量。 注意:更改此参数需要重启数据库。

    db.settings.max_worker_processes

    NameDefaultRequired
    db.settings.max_worker_processesNonefalse

    Description

    设置系统支持的后台进程最大数量。 注意:更改此参数需要重启数据库。

    db.settings.session_replication_role

    NameDefaultRequired
    db.settings.session_replication_roleNonefalse

    Description

    控制是否启用触发器和重写规则。有效值为:"origin"(源端)、"replica"(副本端)或"local"(本地端)

    db.settings.shared_buffers

    NameDefaultRequired
    db.settings.shared_buffersNonefalse

    Description

    设置数据库服务器用于共享内存缓冲区的内存量。 注意:修改此参数需要重启数据库。

    db.settings.statement_timeout

    NameDefaultRequired
    db.settings.statement_timeoutNonefalse

    Description

    终止任何执行时间超过指定时长的语句。

    db.settings.track_activity_query_size

    NameDefaultRequired
    db.settings.track_activity_query_sizeNonefalse

    Description

    设置将被跟踪在pg_stat_activity.current_query字段中的查询字符串的最大长度。 注意:更改此参数需要重启数据库。

    db.settings.track_commit_timestamp

    NameDefaultRequired
    db.settings.track_commit_timestampNonefalse

    Description

    记录事务的提交时间。 注意:更改此参数需要重启数据库。

    db.settings.wal_keep_size

    NameDefaultRequired
    db.settings.wal_keep_sizeNonefalse

    Description

    指定保留在pg_wal目录中的历史日志文件段的最小大小。

    db.settings.wal_sender_timeout

    NameDefaultRequired
    db.settings.wal_sender_timeoutNonefalse

    Description

    终止超过此时间未活动的复制连接。

    db.settings.work_mem

    NameDefaultRequired
    db.settings.work_memNonefalse

    Description

    指定在写入临时磁盘文件之前,内部排序操作和哈希表使用的内存量。

    db.pooler.max_client_conn

    NameDefaultRequired
    db.pooler.max_client_conn100false

    Description

    允许的最大客户端连接数。

    db.seed.enabled

    NameDefaultRequired
    db.seed.enabledtruefalse

    Description

    在启动或重置数据库时启用种子数据运行。

    See also

      db.seed.sql_paths

      NameDefaultRequired
      db.seed.sql_paths["./seed.sql"]false

      Description

      用于查找种子文件的文件数组或全局模式。

      仪表盘 Config

      studio.enabled

      NameDefaultRequired
      studio.enabledtruefalse

      Description

      启用本地Supabase Studio仪表板。

      See also

        studio.port

        NameDefaultRequired
        studio.port54323false

        Description

        Supabase Studio使用的端口。

        See also

          studio.api_url

          NameDefaultRequired
          studio.api_url"http://localhost"false

          Description

          前端连接的API服务器的外部URL。

          See also

            studio.openai_api_key

            NameDefaultRequired
            studio.openai_api_keyenv(OPENAI_API_KEY)false

            Description

            用于Studio仪表板中AI功能的OpenAI API密钥。 切勿将您的OpenAI API密钥提交到git。请改用环境变量替换。

            实时 Config

            realtime.enabled

            NameDefaultRequired
            realtime.enabledtruefalse

            Description

            启用本地实时服务。

            See also

              realtime.ip_version

              NameDefaultRequired
              realtime.ip_version"IPv6"false

              Description

              通过IPv4或IPv6进行实时绑定。(默认:IPv6)

              See also

                存储 Config

                storage.enabled

                NameDefaultRequired
                storage.enabledtruefalse

                Description

                启用本地存储服务。

                storage.file_size_limit

                NameDefaultRequired
                storage.file_size_limit"50MiB"false

                Description

                项目内所有存储桶允许的最大文件大小。

                storage.buckets.<bucket_name>.public

                NameDefaultRequired
                storage.buckets.bucket_name.publicfalsefalse

                Description

                启用对该存储桶的公共访问权限。

                storage.buckets.<bucket_name>.file_size_limit

                NameDefaultRequired
                storage.buckets.bucket_name.file_size_limitNonefalse

                Description

                允许的最大文件大小(例如"5MB"、"500KB")。

                storage.buckets.<bucket_name>.allowed_mime_types

                NameDefaultRequired
                storage.buckets.bucket_name.allowed_mime_typesNonefalse

                Description

                存储桶中对象允许的MIME类型列表。

                storage.buckets.<bucket_name>.objects_path

                NameDefaultRequired
                storage.buckets.bucket_name.objects_pathNonefalse

                Description

                上传对象到存储桶的本地目录。

                边缘函数 Config

                edge_runtime.enabled

                NameDefaultRequired
                edge_runtime.enabledtruefalse

                Description

                为边缘函数启用本地边缘运行时服务。

                See also

                  edge_runtime.policy

                  NameDefaultRequired
                  edge_runtime.policy"oneshot"false

                  Description

                  配置边缘函数的请求处理策略。可用选项:

                  • oneshot:推荐用于支持热重载的开发环境
                  • per_worker:推荐用于负载测试场景

                  See also

                    edge_runtime.inspector_port

                    NameDefaultRequired
                    edge_runtime.inspector_port8083false

                    Description

                    用于附加 Chrome 检查器以调试 Edge Functions 的端口。

                    See also

                      functions.<function_name>.enabled

                      NameDefaultRequired
                      functions.function_name.enabledtruefalse

                      Description

                      控制是否部署或提供函数服务。当设置为 false 时, 该函数在部署过程中将被跳过且不会在本地提供服务。 这对于禁用演示函数或临时禁用某个函数而不删除其代码非常有用。

                      functions.<function_name>.verify_jwt

                      NameDefaultRequired
                      functions.function_name.verify_jwttruefalse

                      Description

                      默认情况下,当您部署边缘函数或在本地运行它们时, 系统会拒绝Authorization头中不含有效JWT的请求。 设置此配置将改变默认行为。

                      请注意--no-verify-jwt标志会覆盖此配置。

                      functions.<function_name>.import_map

                      NameDefaultRequired
                      functions.function_name.import_mapNonefalse

                      Description

                      指定用于该函数的Deno导入映射文件。 未指定时,默认使用supabase/functions/<function_name>/deno.json

                      请注意--import-map标志会覆盖此配置。

                      functions.<函数名称>.entrypoint

                      NameDefaultRequired
                      functions.function_name.entrypointNonefalse

                      Description

                      为函数指定相对于项目根目录的自定义入口点路径。 若未指定,则默认为 supabase/functions/<函数名称>/index.ts

                      Usage

                      1[functions.my_function]
                      2entrypoint = "path/to/custom/function.ts"

                      functions.<函数名称>.static_files

                      NameDefaultRequired
                      functions.function_name.static_filesNonefalse

                      Description

                      指定要与函数捆绑的静态文件数组。支持 glob 模式。

                      注意:目前仅支持 functions 目录内的文件路径。

                      Usage

                      1[functions.my_function]
                      2static_files = [ "./functions/MY_FUNCTION_NAME/*.html", "./functions/MY_FUNCTION_NAME/custom.wasm" ]

                      分析 Config

                      analytics.enabled

                      NameDefaultRequired
                      analytics.enabledfalsefalse

                      Description

                      启用本地 Logflare 服务。

                      analytics.port

                      NameDefaultRequired
                      analytics.port54327false

                      Description

                      本地 Logflare 服务的端口。

                      See also

                        analytics.vector_port

                        NameDefaultRequired
                        analytics.vector_port54328false

                        Description

                        本地 syslog 接收服务的端口。

                        See also

                          analytics.backend

                          NameDefaultRequired
                          analytics.backend"postgres"false

                          Description

                          配置以下支持的数据库后端之一:

                          • postgres
                          • bigquery

                          实验性功能 Config

                          experimental.webhooks.enabled

                          NameDefaultRequired
                          experimental.webhooks.enabledfalsefalse

                          Description

                          自动在每个新创建的分支上启用webhook功能 注意:此为实验性功能,未来版本可能变更。

                          See also

                            experimental.orioledb_version

                            NameDefaultRequired
                            experimental.orioledb_versionNonefalse

                            Description

                            配置Postgres存储引擎以使用支持S3的OrioleDB。 注意:这是一个实验性功能,可能在未来的版本中发生变化。

                            See also

                              experimental.s3_host

                              NameDefaultRequired
                              experimental.s3_hostenv(S3_HOST)false

                              Description

                              为OrioleDB存储配置S3存储桶URL。 格式示例:<bucket_name>.s3-<region>.amazonaws.com 注意:这是一个实验性功能,可能在未来的版本中发生变化。

                              See also

                                experimental.s3_region

                                NameDefaultRequired
                                experimental.s3_regionenv(S3_REGION)false

                                Description

                                为OrioleDB存储配置S3存储桶区域。 示例:us-east-1 注意:这是一个实验性功能,可能在未来的版本中发生变化。

                                See also

                                  experimental.s3_access_key

                                  NameDefaultRequired
                                  experimental.s3_access_keyenv(S3_ACCESS_KEY)false

                                  Description

                                  配置用于访问S3存储桶的AWS_ACCESS_KEY_ID。 切勿将您的AWS访问密钥提交到git。请改用环境变量替换。 注意:此为实验性功能,可能在未来的版本中变更。

                                  See also

                                    experimental.s3_secret_key

                                    NameDefaultRequired
                                    experimental.s3_secret_keyenv(S3_SECRET_KEY)false

                                    Description

                                    配置用于访问S3存储桶的AWS_SECRET_ACCESS_KEY。 切勿将您的AWS密钥提交到git。请改用环境变量替换。 注意:此为实验性功能,可能在未来的版本中变更。

                                    See also

                                      本地开发 Config

                                      inbucket.enabled

                                      NameDefaultRequired
                                      inbucket.enabledtruefalse

                                      Description

                                      启用本地InBucket服务。

                                      inbucket.port

                                      NameDefaultRequired
                                      inbucket.port54324false

                                      Description

                                      用于电子邮件测试服务器Web界面的端口。

                                      使用本地开发设置发送的电子邮件实际上不会被发送——而是会被监控,您可以从Web界面查看本应发送的电子邮件。

                                      inbucket.smtp_port

                                      NameDefaultRequired
                                      inbucket.smtp_port54325false

                                      Description

                                      用于电子邮件测试服务器SMTP端口的端口号。

                                      本地开发设置中发送的邮件并不会实际发出——而是会被监控,您可以通过网页界面查看那些本应发送的邮件。

                                      若设置此端口,您可通过该端口访问SMTP服务器。

                                      inbucket.pop3_port

                                      NameDefaultRequired
                                      inbucket.pop3_port54326false

                                      Description

                                      用于电子邮件测试服务器POP3端口的端口号。

                                      本地开发设置发送的电子邮件实际上并未发送——而是被监控,您可以通过网页界面查看本应发送的电子邮件内容。

                                      若设置此端口,您可从此端口访问POP3服务器。

                                      inbucket.admin_email

                                      NameDefaultRequired
                                      inbucket.admin_emailadmin@email.comfalse

                                      Description

                                      作为应用程序发送邮件的发件人邮箱地址。

                                      inbucket.sender_name

                                      NameDefaultRequired
                                      inbucket.sender_nameAdminfalse

                                      Description

                                      应用程序发送邮件时显示的发送者名称。

                                      分支 Config

                                      remotes.<branch_name>.project_id

                                      NameDefaultRequired
                                      remotes.branch_name.project_idNonetrue

                                      Description

                                      特定持久化Supabase分支的项目参考ID。 该ID用于在config.toml文件中配置分支部署的分支特定设置。 根配置中所有其他可用的配置选项在remotes块中也受支持。 例如,您可以像这样指定分支特定的数据库设置:

                                      Usage

                                      1[remotes.<branch_name>]
                                      2project_id = "your-project-ref"
                                      3
                                      4[remotes.<branch_name>.db.seed]
                                      5sql_paths = ["./seeds/staging.sql"]