部署托管/Configuration/Environment_variables
部署环境变量#
基于文件的配置
你可以为单个变量添加 _FILE 后缀,以从单独的文件中提供其配置。更多详情请参阅将敏感数据保存在独立文件中。
本文列出了自托管 n8n 实例的部署配置选项,包括设置访问 URL、启用模板、自定义加密方式以及配置服务器详细信息。
代理变量优先级
n8n 使用 proxy-from-env 包来处理代理环境变量(即以 _PROXY 结尾的变量),该包规定了特定的变量优先级。值得注意的是,当同时存在大小写形式时,小写变量(如 http_proxy)的优先级高于大写变量(如 HTTP_PROXY)。
有关代理环境变量的更多信息,请查看该包文档中的 环境变量部分。
| 变量 | 类型 | 默认值 | 说明 |
|---|---|---|---|
HTTP_PROXY | 字符串 | - | 用于代理未加密 HTTP 请求的 URL。设置后,n8n 会通过此代理 URL 转发节点发出的所有未加密 HTTP 流量。 |
HTTPS_PROXY | 字符串 | - | 用于代理 TLS/SSL 加密 HTTP 请求的 URL。设置后,n8n 会通过此代理 URL 转发节点发出的所有 TLS/SSL 加密 HTTP 流量。 |
ALL_PROXY | 字符串 | - | 用于代理所有未加密和已加密 HTTP 请求的 URL。当更具体的变量(HTTP_PROXY 或 HTTPS_PROXY)未设置时,n8n 将使用此值。 |
NO_PROXY | 字符串 | - | 用逗号分隔的主机名或 URL 列表,这些地址将绕过代理。当设置了 HTTP_PROXY、HTTPS_PROXY 或 ALL_PROXY 时,n8n 会直接连接此处列出的 URL 或主机名,而不使用代理。 |
N8N_EDITOR_BASE_URL | 字符串 | - | 用户可访问编辑器的公共 URL。也用于 n8n 发送的邮件以及基于 SAML 的身份验证重定向 URL。 |
N8N_CONFIG_FILES (已弃用) | 字符串 | - | 用于指定 JSON 配置文件的路径。此选项已被弃用,将在未来版本中移除。请改用 .env 文件或 *_FILE 环境变量。 |
N8N_DISABLE_UI | 布尔值 | false | 设置为 true 可禁用用户界面(UI)。 |
N8N_PREVIEW_MODE | 布尔值 | false | 设置为 true 以预览模式运行。 |
N8N_TEMPLATES_ENABLED | 布尔值 | false | 启用(true)或禁用(false)工作流模板。 |
N8N_TEMPLATES_HOST | 字符串 | https://api.n8n.io | 如果你构建自己的工作流模板库,请更改此项。请注意,要使用自定义的工作流模板库,你的 API 必须提供与 n8n 相同的端点和响应结构。更多信息请参见工作流模板。 |
N8N_ENCRYPTION_KEY | 字符串 | n8n 生成的随机密钥 | 提供用于加密 n8n 数据库中凭证的自定义密钥。默认情况下,n8n 在首次启动时生成一个随机密钥。 |
N8N_USER_FOLDER | 字符串 | user-folder | 指定 n8n 创建 .n8n 文件夹的路径。该目录用于存储用户特定的数据,例如数据库文件和加密密钥。 |
N8N_PATH | 字符串 | / | n8n 部署的路径。 |
N8N_HOST | 字符串 | localhost | n8n 运行所使用的主机名。 |
N8N_PORT | 数字 | 5678 | n8n 使用的 HTTP 端口。 |
N8N_LISTEN_ADDRESS | 字符串 | :: | n8n 应监听的 IP 地址。 |
N8N_PROTOCOL | 枚举字符串:http, https | http | 用于访问 n8n 的协议。 |
N8N_SSL_KEY | 字符串 | - | HTTPS 协议使用的 SSL 密钥。 |
N8N_SSL_CERT | 字符串 | - | HTTPS 协议使用的 SSL 证书。 |
N8N_PERSONALIZATION_ENABLED | 布尔值 | true | 是否向用户询问个性化问题并据此定制 n8n。 |
N8N_VERSION_NOTIFICATIONS_ENABLED | 布尔值 | true | 启用后,n8n 将发送新版本和安全更新的通知。 |
N8N_VERSION_NOTIFICATIONS_ENDPOINT | 字符串 | https://api.n8n.io/versions/ | 获取版本信息的端点。 |
N8N_VERSION_NOTIFICATIONS_INFO_URL | 字符串 | https://docs.n8n.io/getting-started/installation/updating.html | “新版本”面板中显示的更多信息链接。 |
N8N_DIAGNOSTICS_ENABLED | 布尔值 | true | 是否将选定的匿名遥测数据共享给 n8n。注意:如果设置为 false,则无法在代码节点中启用“Ask AI”功能。 |
N8N_DIAGNOSTICS_CONFIG_FRONTEND | 字符串 | 1zPn9bgWPzlQc0p8Gj1uiK6DOTn;https://telemetry.n8n.io | 前端的遥测配置。 |
N8N_DIAGNOSTICS_CONFIG_BACKEND | 字符串 | 1zPn7YoGC3ZXE9zLeTKLuQCB4F6;https://telemetry.n8n.io/v1/batch | 后端的遥测配置。 |
N8N_PUSH_BACKEND | 字符串 | websocket | 选择 n8n 后端使用服务器发送事件(sse)还是 WebSocket(websocket)将变更推送到 UI。 |
VUE_APP_URL_BASE_API | 字符串 | http://localhost:5678/ | 手动构建 n8n-editor-ui 包时使用,用于设置前端如何访问后端 API。详见配置基础 URL。 |
N8N_HIRING_BANNER_ENABLED | 布尔值 | true | 是否在控制台中显示 n8n 招聘横幅(true 显示,false 不显示)。 |
N8N_PUBLIC_API_SWAGGERUI_DISABLED | 布尔值 | false | 是否禁用 Swagger UI(API playground)(true 禁用,false 启用)。 |
N8N_PUBLIC_API_DISABLED | 布尔值 | false | 是否禁用公共 API(true 禁用,false 启用)。 |
N8N_PUBLIC_API_ENDPOINT | 字符串 | api | 公共 API 端点的路径。 |
N8N_GRACEFUL_SHUTDOWN_TIMEOUT | 数字 | 30 | n8n 进程在退出前应等待组件关闭的时间(单位:秒)。 |
N8N_DEV_RELOAD | 布尔值 | false | 在开发 n8n 源码时,设置为 true 可在源文件发生变化时自动重新加载或重启应用。 |
N8N_REINSTALL_MISSING_PACKAGES | 布尔值 | false | 若设为 true,n8n 将自动尝试重新安装任何缺失的包。 |
N8N_TUNNEL_SUBDOMAIN | 字符串 | - | 指定 n8n 隧道的子域名。若未设置,n8n 将生成一个随机子域名。 |
N8N_PROXY_HOPS | 数字 | 0 | n8n 所处反向代理的数量。 |