部署环境变量(Deployment environment variables)#
File-based configuration
You can add _FILE to individual variables to provide their configuration in a separate file. Refer to Keeping sensitive data in separate files for more details.
本页面列出了自托管 n8n 实例的部署配置选项,包括设置访问 URL、启用模板、自定义加密以及配置服务器详细信息。
🌐 This page lists the deployment configuration options for your self-hosted n8n instance, including setting up access URLs, enabling templates, customizing encryption, and configuring server details.
Proxy variable priorities
The proxy-from-env package that n8n uses to handle proxy environment variables (those ending with _PROXY) imposes a certain variable precedence. Notably, for proxy variables, lowercase versions (like http_proxy) have precedence over uppercase variants (for example HTTP_PROXY) when both are present.
To learn more about proxy environment variables, check the environment variables section of the package details.
| 变量 | 类型 | 默认值 | 描述 |
| :------- | :---- | :------- | :---------- |
| HTTP_PROXY | 字符串 | - | 用于代理未加密 HTTP 请求的 URL。设置后,n8n 会通过该代理 URL 转发节点的所有未加密 HTTP 流量。 |
| HTTPS_PROXY | 字符串 | - | 一个用于通过代理 TLS/SSL 加密的 HTTP 请求的 URL。设置后,n8n 会将来自节点的所有 TLS/SSL 加密的 HTTP 流量通过该代理 URL 进行代理。 |
| ALL_PROXY | 字符串 | - | 一个用于通过代理处理未加密和加密 HTTP 请求的 URL。当设置此值时,如果没有更具体的变量(HTTP_PROXY 或 HTTPS_PROXY),n8n 将使用此值。 |
| NO_PROXY | 字符串 | - | 用逗号分隔的主机名或 URL 列表,这些主机名或 URL 应绕过代理。当使用 HTTP_PROXY、HTTPS_PROXY 或 ALL_PROXY 时,n8n 将直接连接此处定义的 URL 或主机名,而不是使用代理。 |
| N8N_ENFORCE_GLOBAL_USER_AGENT | 布尔值 | false | 当设置为 true 时,n8n 会在所有出站 HTTP 请求中用符合 RFC 的值 (Mozilla/5.0 (compatible; n8n/<version>; +https://n8n.nodejs.cn/)) 替换默认的裸 n8n User-Agent 字符串。启用此选项以防止网络应用防火墙阻止 n8n 请求。 |
| N8N_GLOBAL_USER_AGENT_VALUE | 字符串 | - | 用于所有外发 HTTP 请求的自定义 User-Agent 字符串。会覆盖由 N8N_ENFORCE_GLOBAL_USER_AGENT 设置的符合 RFC 的默认值。当你不想向上游服务器透露 n8n 版本时,这个选项很有用。 |
| N8N_EDITOR_BASE_URL | 字符串 | - | 用户可以访问编辑器的公共 URL。也用于 n8n 发送的电子邮件以及基于 SAML 的身份验证的重定向 URL。 |
| N8N_DISABLE_UI | 布尔值 | false | 设置为 true 以禁用用户界面。 |
| 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_PATH 与反向代理结合可能会导致文件夹导航问题。使用子域名(例如,n8n.example.com)或在不使用反向代理的情况下使用 N8N_PATH。 |
| 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://n8n.nodejs.cn/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) 还是 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 所在的反向代理数量。 |