n8n 中文文档

部署

提示

File-based configuration 基于文件的配置

您可以将 _FILE 添加到各个变量,以在单独的文件中提供其配置。有关更多详细信息,请参阅将敏感数据保存在单独的文件中。

此页面列出了自托管 n8n 实例的部署配置选项,包括设置访问 URL、启用模板、自定义加密和配置服务器详细信息。

提示

Proxy variable priorities 代理变量优先级

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_ENFORCE_GLOBAL_USER_AGENT 布尔 false 当设置为 true 时,n8n 会在所有出站 HTTP 请求上将默认的裸 n8n 用户代理字符串替换为符合 RFC 的值 (Mozilla/5.0 (compatible; n8n/<version>; +https://n8n.io/))。启用此选项可防止 Web 应用程序防火墙阻止 n8n 请求。
N8N_GLOBAL_USER_AGENT_VALUE 字符串 - 用于所有出站 HTTP 请求的自定义用户代理字符串。覆盖 N8N_ENFORCE_GLOBAL_USER_AGENT 设置的符合 RFC 的默认值。当您不想向上游服务器透露 n8n 版本时很有用。
N8N_EDITOR_BASE_URL 字符串 - 用户可以访问编辑器的公共 URL。还用于从 n8n 发送的电子邮件以及基于 SAML 的身份验证的重定向 URL。
N8N_DISABLE_UI 布尔 false 设置为 true 以禁用 UI。
N8N_PREVIEW_MODE 布尔 false 设置为 true 以在预览模式下运行。
N8N_CANVAS_ONLY 布尔 false 设置为 true 以在仅画布模式下运行 n8n:查看单个工作流时隐藏页眉、侧边栏和覆盖层元素。自 n8n 2.15.0 起可用。
N8N_TEMPLATES_ENABLED 布尔 true 启用工作流程模板[^1] (true) 或禁用 (false)。
N8N_TEMPLATES_HOST 字符串 https://api.n8n.io 如果创建您自己的工作流模板库,请更改此设置。请注意,要使用您自己的工作流模板库,您的 API 必须提供与 n8n 相同的端点和响应结构。有关详细信息,请参阅工作流程模板。
N8N_ENCRYPTION_KEY 字符串 n8n 生成的随机密钥 提供用于加密 n8n 数据库中的凭据的自定义密钥。默认情况下,n8n 在首次启动时生成随机密钥。
N8N_ENV_FEAT_ENCRYPTION_KEY_ROTATION 布尔 false 在所有实例(主实例和工作实例)上设置为 true 以启用加密密钥轮换。单向更改:首先进行完整数据库备份。
N8N_ENV_FEAT_OAUTH2_JWE 布尔 false 在所有实例(主实例和工作实例)上设置为 true 以启用 OAuth 2.0 凭证的 JWE 令牌解密。预览功能。
N8N_ENV_FEAT_TOKEN_EXCHANGE 布尔 false 设置为 true 以启用嵌入合作伙伴的令牌交换。预览功能。
N8N_OAUTH_JWE_JWKS_PER_MINUTE 数量 60 OAuth 2.0 凭证的 JWE 令牌解密 使用的公共 JWKS 端点 (/rest/.well-known/jwks.json) 的每 IP 速率限制。
N8N_MCP_BASE_URL 字符串 - 实例级 MCP server 面向 MCP clients 的公共 base URL,当它不同于实例 base URL 时使用。适用于将 MCP server 放在专用主机名上的部署,例如同一实例前的 https://n8n-mcp.example.com。设置后,n8n 会在此 URL 上公布 MCP server,并在 OAuth 身份验证期间接受它,同时也接受从实例 base URL 推导出的 URL。不会影响 editor 或 webhook URLs。从 n8n 2.31.0 起可用。
N8N_MCP_SERVER_RATE_LIMIT 数量 100 MCP server 端点 (/mcp-server/http) 每个 IP 每 5 分钟的最大请求数。
N8N_OAUTH_SERVER_REGISTER_RATE_LIMIT 数量 10 OAuth server client registration 端点(/oauth/register 和 /mcp-oauth/register)每个 IP 每 5 分钟的最大请求数。
N8N_OAUTH_SERVER_AUTHORIZE_RATE_LIMIT 数量 50 OAuth server authorization 端点(/oauth/authorize 和 /mcp-oauth/authorize)每个 IP 每 5 分钟的最大请求数。
N8N_OAUTH_SERVER_TOKEN_RATE_LIMIT 数量 20 OAuth server token 端点(/oauth/token 和 /mcp-oauth/token)每个 IP 每 5 分钟的最大请求数。
N8N_OAUTH_SERVER_REVOKE_RATE_LIMIT 数量 30 OAuth server token revocation 端点(/oauth/revoke 和 /mcp-oauth/revoke)每个 IP 每 5 分钟的最大请求数。
N8N_USER_FOLDER 字符串 user-folder 提供 n8n 将在其中创建 .n8n 文件夹的路径。该目录存储用户特定的数据,例如数据库文件和加密密钥。
N8N_PATH 字符串 / n8n 部署到的路径。将 N8N_PATH 与反向代理结合使用可能会导致文件夹导航问题。使用子域(例如 n8n.example.com)或使用 N8N_PATH(无需反向代理)。
N8N_HOST 字符串 localhost 运行主机名为 n8n。
N8N_PORT 数量 5678 HTTP 端口 n8n 运行。
N8N_LISTEN_ADDRESS 字符串 :: 应侦听的 IP 地址 n8n。
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_PUBLIC_API_RATE_LIMIT_ENABLED 布尔 false n8n 是否限制每个 API 密钥可以发出的公共 API 请求数量。超出限制的请求会收到 429 响应。n8n 只统计使用 API 密钥的请求。你设置的每个 N8N_PUBLIC_API_RATE_LIMIT_* 变量都会覆盖 Settings > Policies 中对应的字段,且无法再在该处修改此字段。请参阅 API 速率限制。
N8N_PUBLIC_API_RATE_LIMIT_GLOBAL_READ_LIMIT 数量 1200 每个时间窗口内,一个 API 密钥对所有公共 API 端点合计可发出的读取请求(GET)的最大数量。设置为 0 表示不限制。
N8N_PUBLIC_API_RATE_LIMIT_GLOBAL_READ_WINDOW_SECONDS 数量 60 N8N_PUBLIC_API_RATE_LIMIT_GLOBAL_READ_LIMIT 的时间窗口长度(秒)。窗口结束时重新开始计数。
N8N_PUBLIC_API_RATE_LIMIT_GLOBAL_WRITE_LIMIT 数量 600 每个时间窗口内,一个 API 密钥对所有公共 API 端点合计可发出的写入请求(POST、PUT、PATCH 和 DELETE)的最大数量。设置为 0 表示不限制。
N8N_PUBLIC_API_RATE_LIMIT_GLOBAL_WRITE_WINDOW_SECONDS 数量 60 N8N_PUBLIC_API_RATE_LIMIT_GLOBAL_WRITE_LIMIT 的时间窗口长度(秒)。窗口结束时重新开始计数。
N8N_PUBLIC_API_RATE_LIMIT_ENDPOINT_READ_LIMIT 数量 1000 每个时间窗口内,一个 API 密钥对每个公共 API 端点可发出的读取请求(GET)的最大数量。端点由方法和路径组成,因此对所有工作流 ID 而言,GET /workflows/{id} 都是同一个端点。设置为 0 表示不限制。
N8N_PUBLIC_API_RATE_LIMIT_ENDPOINT_READ_WINDOW_SECONDS 数量 60 N8N_PUBLIC_API_RATE_LIMIT_ENDPOINT_READ_LIMIT 的时间窗口长度(秒)。窗口结束时重新开始计数。
N8N_PUBLIC_API_RATE_LIMIT_ENDPOINT_WRITE_LIMIT 数量 500 每个时间窗口内,一个 API 密钥对每个公共 API 端点可发出的写入请求(POST、PUT、PATCH 和 DELETE)的最大数量。端点由方法和路径组成,因此对所有工作流 ID 而言,DELETE /workflows/{id} 都是同一个端点。设置为 0 表示不限制。
N8N_PUBLIC_API_RATE_LIMIT_ENDPOINT_WRITE_WINDOW_SECONDS 数量 60 N8N_PUBLIC_API_RATE_LIMIT_ENDPOINT_WRITE_LIMIT 的时间窗口长度(秒)。窗口结束时重新开始计数。
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 落后。

[^1]:n8n 模板是由 n8n 和社区成员设计的预构建工作流程,您可以将其导入到您的 n8n 实例中。使用模板时,您可能需要填写凭据并调整配置以满足您的需求。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。