为用户管理配置自托管 n8n
n8n 中的用户管理允许您邀请人员在您的 n8n 实例中工作。
本文档介绍如何配置 n8n 实例以支持用户管理,以及开始邀请用户的步骤。
有关使用方法的更多信息,请参阅主要的用户管理指南,包括:
有关 LDAP 设置信息,请参阅 LDAP。
有关 SAML 设置信息,请参阅 SAML。
警告
功能可用性
n8n 1.0 中删除了对基本身份验证和 JWT 身份验证的支持。
N8N_USER_MANAGEMENT_DISABLED 环境变量也已从 n8n 1.0 中删除。最新版 n8n 不支持禁用登录屏幕,包括本地或开发用途。如果您需要简化本地开发中的登录,请考虑使用密码管理器、设置简单的本地密码,或编写标准登录流程脚本。
设置
在 n8n 中设置用户管理分为三个阶段:
- 配置您的 n8n 实例以使用 SMTP 服务器。
- 启动 n8n 并按照应用程序中的设置步骤进行操作。
- 邀请用户。
第一步:SMTP
n8n 建议设置 SMTP 服务器,用于用户邀请和密码重置。
提示
功能可用性
从 n8n 0.210.1 开始,设置 SMTP 是可选的。您可以选择手动复制并发送邀请链接,而不是设置 SMTP。请注意,如果跳过此步骤,用户将无法重置密码。
从您的 SMTP 提供商处获取以下信息:
- 服务器名称
- SMTP 用户名
- SMTP 密码
- SMTP 发件人姓名
要为 n8n 设置 SMTP,请配置实例的 SMTP 环境变量。有关如何设置环境变量,请参阅配置。
| 变量 | 类型 | 说明 | 是否必需? |
|---|---|---|---|
N8N_EMAIL_MODE |
字符串 | smtp |
必需 |
N8N_SMTP_HOST |
字符串 | your_SMTP_server_name | 必需 |
N8N_SMTP_PORT |
数字 | your_SMTP_server_port。默认为 465。 |
可选 |
N8N_SMTP_USER |
字符串 | your_SMTP_username | 可选 |
N8N_SMTP_PASS |
字符串 | your_SMTP_password | 可选 |
N8N_SMTP_OAUTH_SERVICE_CLIENT |
字符串 | your_OAuth_service_client | 可选 |
N8N_SMTP_OAUTH_PRIVATE_KEY |
字符串 | your_OAuth_private_key | 可选 |
N8N_SMTP_SENDER |
字符串 | 发件人电子邮件地址。您可以选择包含发件人姓名。名称示例:n8n <[email protected]> |
必需 |
N8N_SMTP_SSL |
布尔值 | 是否为 SMTP 使用 SSL(true)或不使用 SSL(false)。默认为 true。 |
可选 |
N8N_UM_EMAIL_TEMPLATES_INVITE |
字符串 | HTML 电子邮件模板的完整路径。这会覆盖邀请电子邮件的默认模板。 | 可选 |
N8N_UM_EMAIL_TEMPLATES_PWRESET |
字符串 | HTML 电子邮件模板的完整路径。这会覆盖密码重置电子邮件的默认模板。 | 可选 |
N8N_UM_EMAIL_TEMPLATES_WORKFLOW_SHARED |
字符串 | 覆盖用于通知用户工作流已共享的默认 HTML 模板。提供模板的完整路径。 | 可选 |
N8N_UM_EMAIL_TEMPLATES_CREDENTIALS_SHARED |
字符串 | 覆盖默认 HTML 模板,用于通知用户凭证已共享。提供模板的完整路径。 | 可选 |
N8N_UM_EMAIL_TEMPLATES_PROJECT_SHARED |
字符串 | 覆盖默认 HTML 模板,用于通知用户项目已共享。提供模板的完整路径。 | 可选 |
如果您的 n8n 实例已在运行,您需要重新启动它以启用新的 SMTP 设置。
提示
更多配置选项
还有更多配置选项可用作环境变量。有关列表,请参阅 环境变量。其中包括禁用标签、工作流程模板和个性化调查的选项(如果您不希望用户看到它们)。
提示
SMTP 新手?
如果您不熟悉 SMTP,此 SendGrid 的博客文章 提供简短介绍,而 维基百科的简单邮件传输协议文章 提供更详细的技术背景。
第二步:应用内设置
首次设置用户管理时,您将创建一个所有者帐户。
- 打开 n8n。应用程序显示注册屏幕。
- 输入您的详细信息。您的密码必须至少八个字符,包括至少一个数字和一个大写字母。
- 点击下一步。n8n 使用您的新所有者账户登录您。
通过环境变量预配置实例所有者
提示
功能可用性
从 n8n 2.17.0 开始,可以通过环境变量预配置实例所有者。
您可以从环境变量中预先配置实例所有者,而无需进行应用内设置。将 N8N_INSTANCE_OWNER_MANAGED_BY_ENV 设置为 true 并提供所有者详细信息。有关激活模式的工作原理,请参阅 使用环境变量管理实例设置。
要在设置后更改所有者电子邮件,请参阅 更改自托管 n8n 的实例所有者电子邮件。
警告
N8N_INSTANCE_OWNER_PASSWORD_HASH 必须是 bcrypt 哈希
该变量需要一个预先哈希的 bcrypt 值。设置明文密码会中断登录。
| 变量 | 类型 | 默认 | 描述 |
|---|---|---|---|
N8N_INSTANCE_OWNER_MANAGED_BY_ENV |
Boolean | false |
设为 true 后,可通过环境变量管理实例所有者。启用后,n8n 会在每次启动时覆盖下方的实例所有者信息、锁定该用户在 UI 中的相关控件,并拒绝对其进行 API 写入。 |
N8N_INSTANCE_OWNER_EMAIL |
String | - | 实例所有者的邮箱地址。 |
N8N_INSTANCE_OWNER_FIRST_NAME |
String | - | 实例所有者的名字。 |
N8N_INSTANCE_OWNER_LAST_NAME |
String | - | 实例所有者的姓氏。 |
N8N_INSTANCE_OWNER_PASSWORD_HASH |
String | - | 实例所有者密码的 bcrypt 哈希值。填入明文密码会导致无法登录。 |
警告
Owner email must be unique 所有者电子邮件必须是唯一的
N8N_INSTANCE_OWNER_EMAIL 不得已属于实例上的其他用户。此设置更新现有实例所有者帐户;它不会将所有权转让给其他现有用户或合并用户帐户。要使用已属于其他用户的电子邮件地址,请先更改或删除该用户,以便电子邮件可用。
第三步:邀请用户
您现在可以邀请其他人加入您的 n8n 实例。
- 使用所有者账户登录您的 n8n 实例。在 n8n Cloud 上,如果您位于 n8n Cloud 控制台,请在 Overview 概览 页面上选择 Open instance 打开实例。
- 点击左下角用户图标旁边的三个点,然后点击设置。
- 点击用户进入用户页面。
- 点击邀请。
- 输入新用户的电子邮件地址。
- 点击邀请用户。n8n 会发送一封包含链接的电子邮件,供新用户加入。