部署环境变量#
基于文件的配置
您可以为单个变量添加 _FILE 后缀,通过独立文件提供配置。更多细节请参阅在独立文件中保存敏感数据。
本文档列出了自托管 n8n 实例的部署配置选项,包括设置访问 URL、启用模板、自定义加密以及配置服务器详细信息。
代理变量优先级
n8n 用于处理代理环境变量(以 _PROXY 结尾的变量)的 proxy-from-env 包规定了特定的变量优先级。值得注意的是,对于代理变量,当大小写形式同时存在时,小写形式(如 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 | 在新版本面板中显示以获取更多信息的 URL。 |
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) 还是 WebSockets (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 演练场)是否禁用 (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 运行所在的反向代理数量。 |