部署环境变量#
¥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
n8n 用于处理代理环境变量(以 _PROXY 结尾的变量)的 proxy-from-env 包会强制执行一定的变量优先级。值得注意的是,对于代理变量,如果同时存在小写版本(例如 http_proxy)和大写版本(例如 HTTP_PROXY),则小写版本优先。
¥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 会将来自节点的所有未加密 HTTP 流量代理到代理 URL。 |
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 可禁用用户界面。 |
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 |
HTTP 端口 n8n 运行。 |
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/ |
用于检索 where 版本信息的端点。 |
N8N_VERSION_NOTIFICATIONS_INFO_URL |
字符串 | https://n8n.nodejs.cn/getting-started/installation/updating.html |
显示在“新版本”面板中以获取更多信息的 URL。 |
N8N_DIAGNOSTICS_ENABLED |
布尔值 | true |
是否将选定的匿名 telemetry 与 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 演示环境)是否已禁用(true)或已启用(false)。 |
N8N_PUBLIC_API_DISABLED |
布尔值 | false |
是否禁用公共 API(启用)或禁用(禁用)。 |
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 运行的反向代理数量。 |