Environment Variables

All configurable environment variables

Environment Variable	Description	Default Value	Required	Example
PUBLIC_ORIGIN	Public origin for generating full URLs, must be set to your application's access address	-	Yes	https://app.teable.io
SECRET_KEY	Key for JWT, sessions, and sharing; use a strong password	defaultSecretKey	Yes	yourStrongSecretKey
PRISMA_DATABASE_URL	Database connection URL, must be configured	-	Yes	postgresql://teable:teable@127.0.0.1:5432/teable
BACKEND_STORAGE_PROVIDER	Storage provider, options: local, minio, s3	local	-	s3
BACKEND_STORAGE_S3_REGION	S3 cloud storage region, required when BACKEND_STORAGE_PROVIDER is s3	-	-	us-east-2
BACKEND_STORAGE_S3_ENDPOINT	S3 cloud storage endpoint, required when BACKEND_STORAGE_PROVIDER is s3	-	-	https://s3.us-east-2.amazonaws.com
BACKEND_STORAGE_S3_ACCESS_KEY	S3 cloud storage access key, required when BACKEND_STORAGE_PROVIDER is s3	-	-	your_access_key
BACKEND_STORAGE_S3_SECRET_KEY	S3 cloud storage secret key, required when BACKEND_STORAGE_PROVIDER is s3	-	-	your_secret_key
BACKEND_CACHE_PROVIDER	Cache provider, options: sqlite, memory, redis	sqlite	-	redis
BACKEND_CACHE_REDIS_URI	Redis cache connection URI, required when BACKEND_CACHE_PROVIDER is redis	-	-	redis://default:teable@127.0.0.1:6379/0
MICROSOFT_CLARITY_ID	Microsoft Clarity metrics ID, used to enable Microsoft Clarity analytics	-	-	your-metrics-id
UMAMI_WEBSITE_ID	Umami website ID, used to enable Umami analytics			your-umami-website-id
UMAMI_URL	Umami script url, required if you enabled umami			https://umami.example.com/script.js
TEMPLATE_SPACE_ID	Space ID where template base is located, used for basic information in template center operations	-	-	your-template-space-id
TEMPLATE_SITE_LINK	Template site link, must be set to enable creation from templates	-	-	https://template.teable.io
PORT	Port on which the application runs	3000	-	3000
LOG_LEVEL	Log level, options: fatal, error, warn, info, debug, trace	info	-	debug
ENABLE_GLOBAL_ERROR_LOGGING	Whether to enable 4xx error logging	false	-	true
PUBLIC_DATABASE_PROXY	External database access proxy, configure to enable external access to space databases	-	-	127.0.0.1:5432
API_DOC_DISENABLED	Whether to disable API documentation	false	-	true
BACKEND_GITHUB_CLIENT_ID	GitHub OAuth client ID	-	-	github_client_id
BACKEND_GITHUB_CLIENT_SECRET	GitHub OAuth client secret	-	-	github_client_secret
BACKEND_GOOGLE_CLIENT_ID	Google OAuth client ID	-	-	google_client_id
BACKEND_GOOGLE_CLIENT_SECRET	Google OAuth client secret	-	-	google_client_secret
BACKEND_GOOGLE_CALLBACK_URL	Google OAuth callback URL	-	-	https://app.teable.io/api/auth/google/callback
BACKEND_OIDC_CLIENT_ID	OIDC client ID	-	-	google_client_id
BACKEND_OIDC_CLIENT_SECRET	OIDC client secret	-	-	google_client_secret
BACKEND_OIDC_CALLBACK_URL	OIDC callback URL	-	-	https://app.teable.io/api/auth/oidc/callback
BACKEND_OIDC_USER_INFO_URL	OIDC user info URL	-	-	https://openidconnect.googleapis.com/v1/userinfo
BACKEND_OIDC_TOKEN_URL	OIDC token URL	-	-	https://oauth2.googleapis.com/token
BACKEND_OIDC_AUTHORIZATION_URL	OIDC authorization URL	-	-	https://accounts.google.com/o/oauth2/auth
BACKEND_OIDC_ISSUER	OIDC issuer URL	-	-	https://accounts.google.com
BACKEND_OIDC_OTHER	OIDC other configurations, in JSON format	-	-	{"scope": ["email", "profile"]}
SOCIAL_AUTH_PROVIDERS	List of social authentication providers, separated by commas	-	-	github,google,oidc
BACKEND_MAIL_HOST	Mail server host	-	-	smtp.gmail.com
BACKEND_MAIL_PORT	Mail server port	-	-	465
BACKEND_MAIL_SECURE	Whether to use secure connection	-	-	true
BACKEND_MAIL_SENDER	Sender's email address	-	-	[e-mail]
BACKEND_MAIL_SENDER_NAME	Sender's name	-	-	noreply
BACKEND_MAIL_AUTH_USER	Mail server authentication username	-	-	username
BACKEND_MAIL_AUTH_PASS	Mail server authentication password	-	-	usertoken
BACKEND_SESSION_EXPIRES_IN	Session expiration time	7d	-	7d
BACKEND_SESSION_SECRET	Session secret, uses SECRET_KEY if not set	SECRET_KEY	-	your_session_secret
BACKEND_JWT_EXPIRES_IN	JWT expiration time	20d	-	20d
BACKEND_JWT_SECRET	JWT secret, uses SECRET_KEY if not set	SECRET_KEY	-	your_jwt_secret
BACKEND_RESET_PASSWORD_EMAIL_EXPIRES_IN	Reset password email expiration time	30m	-	30m
MAX_UNDO_STACK_SIZE	the undo redo stack size	200		200
UNDO_EXPIRATION_TIME	the undo redo expiration time (s)	86400		86400