环境变量

这里列举了Teable 所有可用的环境变量以及相关解释

环境变量描述默认值是否必需示例

PUBLIC_ORIGIN

用于生成完整 URL 的公共源,必须设置为您的应用程序访问地址

-

https://app.teable.io

SECRET_KEY

用于 JWT、会话和共享的密钥,请使用强密码

defaultSecretKey

yourStrongSecretKey

BACKEND_STORAGE_PROVIDER

存储提供商,可选值:local、minio、s3

local

-

s3

BACKEND_STORAGE_S3_REGION

S3 云存储区域,当 BACKEND_STORAGE_PROVIDER 为 s3 时需要配置

-

-

us-east-2

BACKEND_STORAGE_S3_ENDPOINT

S3 云存储端点,当 BACKEND_STORAGE_PROVIDER 为 s3 时需要配置

-

-

https://s3.us-east-2.amazonaws.com

BACKEND_STORAGE_S3_ACCESS_KEY

S3 云存储访问密钥,当 BACKEND_STORAGE_PROVIDER 为 s3 时需要配置

-

-

your_access_key

BACKEND_STORAGE_S3_SECRET_KEY

S3 云存储秘密密钥,当 BACKEND_STORAGE_PROVIDER 为 s3 时需要配置

-

-

your_secret_key

BACKEND_CACHE_PROVIDER

缓存提供商,可选值:sqlite、memory、redis

sqlite

-

redis

BACKEND_CACHE_REDIS_URI

Redis 缓存连接 URI,当 BACKEND_CACHE_PROVIDER 为 redis 时需要配置

-

-

redis://default:teable@127.0.0.1:6379/0

MICROSOFT_CLARITY_ID

Microsoft Clarity 指标 ID,用于启用 Microsoft Clarity 分析

-

-

your-metrics-id

UMAMI_WEBSITE_ID

启用 Umami 分析并设置 WEBSITE_ID

your-umami-website-id

UMAMI_URL

启用 Umami 分析并设置分析 script 加载地址

https://umami.example.com/script.js

TEMPLATE_SPACE_ID

模板基础所在的空间 ID,用于模板中心操作的基本信息

-

-

your-template-space-id

TEMPLATE_SITE_LINK

模板站点链接,需要设置此值才能启用从模板创建的功能

-

-

https://template.teable.io

PORT

应用程序运行的端口

3000

-

3000

LOG_LEVEL

日志级别,可选值:fatal、error、warn、info、debug、trace

info

-

debug

ENABLE_GLOBAL_ERROR_LOGGING

是否启用 4xx 错误日志记录

false

-

true

PRISMA_DATABASE_URL

数据库连接 URL,必须配置

-

postgresql://teable:teable@127.0.0.1:5432/teable

PUBLIC_DATABASE_PROXY

外部数据库访问代理,配置此项才能启用空间数据库外部访问功能

-

-

127.0.0.1:5432

API_DOC_DISENABLED

是否禁用 API 文档

false

-

true

BACKEND_GITHUB_CLIENT_ID

GitHub OAuth 客户端 ID

-

-

github_client_id

BACKEND_GITHUB_CLIENT_SECRET

GitHub OAuth 客户端密钥

-

-

github_client_secret

BACKEND_GOOGLE_CLIENT_ID

Google OAuth 客户端 ID

-

-

google_client_id

BACKEND_GOOGLE_CLIENT_SECRET

Google OAuth 客户端密钥

-

-

google_client_secret

BACKEND_GOOGLE_CALLBACK_URL

Google OAuth 回调 URL

-

-

https://app.teable.io/api/auth/google/callback

BACKEND_OIDC_CLIENT_ID

OIDC 客户端 ID

-

-

google_client_id

BACKEND_OIDC_CLIENT_SECRET

OIDC 客户端密钥

-

-

google_client_secret

BACKEND_OIDC_CALLBACK_URL

OIDC 回调 URL

-

-

https://app.teable.io/api/auth/oidc/callback

BACKEND_OIDC_USER_INFO_URL

OIDC 用户信息 URL

-

-

https://openidconnect.googleapis.com/v1/userinfo

BACKEND_OIDC_TOKEN_URL

OIDC 令牌 URL

-

-

https://oauth2.googleapis.com/token

BACKEND_OIDC_AUTHORIZATION_URL

OIDC 授权 URL

-

-

https://accounts.google.com/o/oauth2/auth

BACKEND_OIDC_ISSUER

OIDC 发行者 URL

-

-

https://accounts.google.com

BACKEND_OIDC_OTHER

OIDC 其他配置,JSON 格式

-

-

{"scope": ["email", "profile"]}

SOCIAL_AUTH_PROVIDERS

社交认证提供商列表,多个提供商用逗号分隔

-

-

github,google,oidc

BACKEND_MAIL_HOST

邮件服务器主机

-

-

smtp.gmail.com

BACKEND_MAIL_PORT

邮件服务器端口

-

-

465

BACKEND_MAIL_SECURE

是否使用安全连接

-

-

true

BACKEND_MAIL_SENDER

发件人邮箱地址

-

-

noreply@company.com

BACKEND_MAIL_SENDER_NAME

发件人名称

-

-

noreply

BACKEND_MAIL_AUTH_USER

邮件服务器认证用户名

-

-

username

BACKEND_MAIL_AUTH_PASS

邮件服务器认证密码

-

-

usertoken

BACKEND_SESSION_EXPIRES_IN

会话过期时间

7d

-

7d

BACKEND_SESSION_SECRET

会话密钥,如果不设置则使用 SECRET_KEY

SECRET_KEY

-

your_session_secret

BACKEND_JWT_EXPIRES_IN

JWT 过期时间

20d

-

20d

BACKEND_JWT_SECRET

JWT 密钥,如果不设置则使用 SECRET_KEY

SECRET_KEY

-

your_jwt_secret

BACKEND_RESET_PASSWORD_EMAIL_EXPIRES_IN

重置密码邮件过期时间

30m

-

30m

最后更新于