环境变量

以下内容翻译自Umami 官网，翻译时间为2023年11月20日。

你可以通过环境变量配置 Umami。这些变量需要与 DATABASE_URL 一起放置在 .env 文件中。

运行时变量

这些变量在 Umami 运行时生效。需在应用程序启动前设置。

• CLOUD_MODE = 1
  禁用用户、团队和网站设置页面。

• CORS_MAX_AGE = <number>
  CORS 预检请求缓存时间（秒），默认 24 小时。

• disable_bot_check = 1
  禁用机器人检测（默认统计中排除机器人流量）。

• disable_login = 1
  禁用登录页面。

• enable_test_console = 1
  启用内部测试页面 {host}/console（需管理员权限），支持手动发送页面浏览和事件。

• APP_SECRET = <随机字符串>
  用于生成唯一值的随机密钥。

• CLIENT_IP_HEADER = <header 名称>
  指定获取客户端 IP 的 HTTP 头字段（适用于代理服务器场景）。

• COLLECT_API_ENDPOINT = <API 端点>
  自定义指标上报端点（默认 /api/send），用于规避广告拦截器。

• DATABASE_URL = <连接字符串>
  必填 数据库连接字符串。

• DEBUG = <调试值>
  启用特定模块的调试日志，可选值：
  umami:auth | umami:clickhouse | umami:kafka | umami:middleware | umami:prisma

• disable_updates = 1
  禁用版本更新检查。

• disable_telemetry = 1
  禁用匿名遥测数据收集。

• HOSTNAME = <主机名>

• PORT = <端口号>
  指定绑定主机名/端口（如 Heroku 环境），需使用 npm run start-env 启动。

• IGNORE_IP = <IP 地址>
  忽略指定 IP 地址（逗号分隔）。

• IGNORE_HOSTNAME = <主机名>
  忽略指定主机名的 DNS 解析结果（逗号分隔）。

• LOG_QUERY = 1
  开发模式下记录数据库查询日志。

• remove_trailing_slash = 1
  自动移除 URL 尾部斜杠。

• TRACKER_SCRIPT_NAME = <脚本名称>
  自定义跟踪脚本路径（避开广告拦截器），示例：

  TRACKER_SCRIPT_NAME=         # 默认路径 /script.js
  TRACKER_SCRIPT_NAME=custom   # 路径 /custom
  TRACKER_SCRIPT_NAME=custom.js # 路径 /custom.js
  

构建时变量

这些变量需在构建过程（包括 Docker 镜像构建）中设置。

• ALLOWED_FRAME_URLS = <允许的 URL>
  允许 iframe 嵌入的 URL 列表（空格分隔）。

• BASE_PATH = <路径>
  指定子目录托管路径（需配置反向代理）。

• DATABASE_TYPE = <postgresql | mysql>
  仅 Docker 构建时需要指定数据库类型。

• FORCE_SSL = 1
  强制启用 HSTS 安全头。

• skip_db_check = 1
  跳过数据库检查步骤（用于 Docker 构建）。