chore: 精简 .env.example,移除未使用的配置项

移除的配置(代码中不存在消费者):
- GOCHAT_VERSION
- GOCHAT_METRICS_ENABLED / GOCHAT_METRICS_PORT
- GOCHAT_WS_* (WebSocket 配置)
- GOCHAT_ANALYTICS_* (Analytics/Reporting 配置)
- SMTP_FROM_EMAIL (代码用 SMTP_FROM / MAILER_SENDER_EMAIL)

新增 Search / Storage 段(代码中有 env binding 但 .env.example 缺失)。
Redis 改为使用 GOCHAT_REDIS_URL(代码实际消费的字段)。
SAML 补充 GOCHAT_SAML_ENABLED 开关。
This commit is contained in:
Rogee
2026-07-29 16:41:05 +08:00
parent fa6737e258
commit 27d8d4ed08
+19 -29
View File
@@ -1,10 +1,8 @@
# GoChat Environment Variables
# Reference: Chatwoot .env.example pattern — comprehensive env config
# Copy to .env and fill in your values. NEVER commit .env to git.
# ---- Application ----
GOCHAT_ENV=prod
GOCHAT_VERSION=v1.0.0
# Keep disabled in production. Enable only for controlled QA/UAT environments.
GOCHAT_ALLOW_FAKE_CHANNEL=false
@@ -25,10 +23,8 @@ GOCHAT_DATABASE_MAX_OPEN_CONNS=100
GOCHAT_DATABASE_CONN_MAX_LIFETIME=3600
# ---- Redis ----
GOCHAT_REDIS_HOST=localhost
GOCHAT_REDIS_PORT=6379
GOCHAT_REDIS_PASSWORD=CHANGE_ME_TO_A_STRONG_PASSWORD
GOCHAT_REDIS_DB=0
GOCHAT_REDIS_URL=redis://localhost:6379
GOCHAT_REDIS_POOL_SIZE=50
# ---- JWT ----
GOCHAT_JWT_SECRET=CHANGE_ME_TO_A_RANDOM_64_CHAR_STRING
@@ -45,7 +41,6 @@ SMTP_ADDRESS=smtp.example.com
SMTP_PORT=587
SMTP_USERNAME=your-email@example.com
SMTP_PASSWORD=your-email-password
SMTP_FROM_EMAIL=noreply@example.com
# ---- Worker ----
GOCHAT_WORKER_CONCURRENCY=10
@@ -53,25 +48,20 @@ GOCHAT_WORKER_CONCURRENCY=10
# ---- Frontend URL ----
FRONTEND_URL=https://your-domain.com
# ---- Monitoring ----
GOCHAT_METRICS_ENABLED=true
GOCHAT_METRICS_PORT=9090
# ---- Search ----
GOCHAT_SEARCH_ENGINE=meilisearch
GOCHAT_SEARCH_HOST=http://localhost:7700
GOCHAT_SEARCH_API_KEY=
GOCHAT_SEARCH_INDEX_PREFIX=gochat_
GOCHAT_SEARCH_TIMEOUT_SECONDS=5
# ---- WebSocket ----
GOCHAT_WS_MAX_MESSAGE_SIZE=65536 # 64KB max WebSocket message size
GOCHAT_WS_READ_BUFFER_SIZE=1024
GOCHAT_WS_WRITE_BUFFER_SIZE=1024
GOCHAT_WS_PING_INTERVAL=30 # seconds between keepalive pings
GOCHAT_WS_PONG_TIMEOUT=60 # seconds to wait for pong before disconnecting
GOCHAT_WS_MAX_SUBSCRIPTIONS=100 # max rooms per client connection
# ---- Storage ----
GOCHAT_STORAGE_PROVIDER=local
GOCHAT_STORAGE_LOCAL_PATH=./uploads
GOCHAT_STORAGE_MAX_FILE_SIZE=20971520 # 20MB
# ---- Analytics / Reporting ----
GOCHAT_ANALYTICS_ENABLED=true
GOCHAT_ANALYTICS_RETENTION_DAYS=90 # how long to keep reporting events
GOCHAT_ANALYTICS_FLUSH_INTERVAL=300 # seconds between rollup flushes
# ---- OAuth Providers ----
# G10: Twitter/X OAuth 2.0 (PKCE) + Account Activity API
# ---- Channel OAuth Providers ----
# Twitter/X OAuth 2.0 (PKCE) + Account Activity API
GOCHAT_OAUTH_TWITTER_CLIENT_ID=
GOCHAT_OAUTH_TWITTER_CLIENT_SECRET=
GOCHAT_OAUTH_TWITTER_REDIRECT_URL=https://your-domain.com/api/v1/accounts/:account_id/twitter_channels/oauth_callback
@@ -79,19 +69,20 @@ GOCHAT_OAUTH_TWITTER_SCOPES=tweet.read,users.read,dm.read,dm.write
TWITTER_API_BASE=https://api.twitter.com/2
TWITTER_WEBHOOK_ENV=gochat
TWITTER_CRC_SECRET=
# G10: Microsoft/Azure AD OAuth 2.0 (Graph API)
# Microsoft/Azure AD OAuth 2.0 (Graph API)
GOCHAT_OAUTH_MICROSOFT_CLIENT_ID=
GOCHAT_OAUTH_MICROSOFT_CLIENT_SECRET=
GOCHAT_OAUTH_MICROSOFT_TENANT_ID=common
GOCHAT_OAUTH_MICROSOFT_REDIRECT_URL=https://your-domain.com/api/v1/accounts/:account_id/microsoft_channels/oauth_callback
GOCHAT_OAUTH_MICROSOFT_SCOPES=Chat.Read,Chat.ReadWrite,offline_access
# ---- SAML (Enterprise SSO) ----
# ---- SAML (Enterprise SSO, disabled by default) ----
GOCHAT_SAML_ENABLED=false
GOCHAT_SAML_IDP_METADATA_URL=
GOCHAT_SAML_SP_ENTITY_ID=gochat
GOCHAT_SAML_SP_ACS_URL=https://your-domain.com/api/v1/auth/saml/acs
# ---- LDAP (Enterprise Authentication) ----
# ---- LDAP (Enterprise Authentication, disabled by default) ----
GOCHAT_LDAP_ENABLED=false
GOCHAT_LDAP_DEFAULT_HOST=ldap.example.com
GOCHAT_LDAP_DEFAULT_PORT=389
@@ -105,7 +96,7 @@ GOCHAT_LDAP_DEFAULT_NAME_ATTRIBUTE=cn
GOCHAT_LDAP_DEFAULT_GROUP_ATTRIBUTE=memberOf
GOCHAT_LDAP_SYNC_INTERVAL=3600
# ---- OIDC (Enterprise OAuth/OIDC SSO) ----
# ---- OIDC (Enterprise OAuth/OIDC SSO, disabled by default) ----
GOCHAT_OIDC_ENABLED=false
GOCHAT_OIDC_DEFAULT_CLIENT_ID=
GOCHAT_OIDC_DEFAULT_CLIENT_SECRET=
@@ -116,4 +107,3 @@ GOCHAT_OIDC_DEFAULT_TOKEN_URL=
GOCHAT_OIDC_DEFAULT_USER_INFO_URL=
GOCHAT_OIDC_DEFAULT_JWKS_URL=
GOCHAT_OIDC_DEFAULT_SCOPES=openid,profile,email