n8n 中文文档

备份和恢复

备份自托管 n8n 实例,以便在数据丢失后恢复、回滚失败的更新,或迁移到新服务器。完整备份包含的内容多于 CLI 导出命令单独生成的内容。本页介绍完整备份包含哪些内容、CLI --backup 标志会导出什么,以及如何恢复每种备份。

完整备份包含的内容

自托管 n8n 实例的完整备份由两部分组成:

  • .n8n 用户文件夹,默认为 ~/.n8n。其中的 config 文件存储凭据加密密钥。使用默认 SQLite 数据库时,该文件夹还包含数据库文件本身。如果二进制数据或执行数据使用 filesystem 存储模式,这些数据也保存在其中。

你可以使用 N8N_USER_FOLDER 环境变量更改该文件夹的位置:n8n 会使用所设路径下的 .n8n 子文件夹。 * 如果使用 PostgreSQL 而非默认的 SQLite,则还要备份外部数据库。请使用数据库自身的工具进行备份。.n8n 文件夹仍是备份的一部分,因为数据库中的凭据使用该文件夹内的密钥加密。

如果为二进制数据或执行数据配置了外部存储(例如 S3 或 Azure Blob Storage),也要备份该存储。如果二进制数据或执行数据保存在自定义文件系统路径中,也请将该位置纳入备份。如果从 N8N_CUSTOM_EXTENSIONS 环境变量指定的目录加载自定义节点,也要备份这些目录;恢复后的实例如果缺少这些目录,就会缺少工作流引用的节点。

使用默认 SQLite 数据库时,请在复制 .n8n 文件夹前停止 n8n。在 n8n 写入数据库文件时复制该文件,可能产生不一致的备份。如果无法停止 n8n,请改用能够对 SQLite 文件创建一致性快照的工具。

如果在 Docker 中运行 n8n,.n8n 文件夹位于 n8n_data 卷中,并挂载到 /home/node/.n8n。有关 Docker 持久化数据的更多信息,请参阅使用 Docker 安装。

提示

恢复凭据需要加密密钥

n8n 以加密形式将凭据保存到数据库。如果没有 config 文件中的加密密钥或自定义 N8N_ENCRYPTION_KEY,就无法解密恢复后的数据库或加密凭据导出。有关更多信息,请参阅设置自定义加密密钥。

n8n 建议在更新前创建完整备份。有关更新过程,请参阅更新 n8n。

使用 CLI 备份工作流和凭据

可以使用 Server CLI 将工作流和凭据导出为 JSON 文件:

n8n export:workflow --backup --output=backups/workflows/
n8n export:credentials --backup --output=backups/credentials/

--backup 标志会设置 --all --pretty --separate,因此每个工作流和凭据都会写入单独、易读的 JSON 文件。

请为每条命令使用不同的输出目录。如果输入目录同时包含工作流文件,import:credentials --separate 目前会失败。这是一个已知问题。

如果在 Docker 中运行 n8n,容器内的 backups/ 目录不会持久化:只有 .n8n 文件夹位于卷中。请为备份绑定挂载一个主机目录,或在重新创建容器前将导出的文件复制到容器外。

CLI 备份不包含的内容

--backup 导出只包含工作流和凭据,不包含:

  • 用户及其角色。导入到全新实例后,n8n 会再次显示所有者设置界面,第一个完成设置的人将成为所有者。
  • 执行历史记录和日志。
  • 变量。
  • 实例设置,包括加密密钥。

这意味着 CLI 备份足以在实例之间迁移工作流,但无法单独恢复完整实例。要恢复完整实例,请按照完整备份包含的内容中的说明,保留 .n8n 文件夹和外部数据库的备份。

恢复

恢复工作流和凭据

导入 CLI 备份中的文件。在全新实例上,请先完成所有者设置:导入命令需要现有用户,而导入的凭据需要所有者。如果实例有多个用户或项目,请使用 --userId 或 --projectId 分配导入的凭据。

n8n import:workflow --separate --input=backups/workflows/
n8n import:credentials --separate --input=backups/credentials/

导出内容包含原始工作流和凭据 ID。如果目标实例已有相同 ID 的项目,它们会被覆盖。导入的工作流默认处于停用状态。请在导入后通过 UI 激活,或传入 --activeState=fromJson 恢复每个工作流导出时的 active 状态;后者仅适用于队列模式或多主实例模式。有关完整标志列表和注意事项,请参阅使用命令行。

要恢复凭据,执行导入的实例必须能够解密凭据。可以选择以下两种方式之一:

  • 使用与导出实例相同的加密密钥。将 config 文件恢复到 .n8n 文件夹,或设置相同的 N8N_ENCRYPTION_KEY 环境变量。
  • 使用 --decrypted 标志导出,该标志会以明文写入凭据。

警告

敏感信息

--decrypted 导出以明文包含所有凭据数据。请像保护凭据本身一样妥善保管,并在恢复完成后将其删除。

恢复完整实例

要恢复完整实例:

  1. 停止 n8n。
  2. 将 .n8n 文件夹恢复到原始位置,同时恢复使用 N8N_CUSTOM_EXTENSIONS 配置的所有自定义节点目录。
  3. 如果使用 PostgreSQL 数据库,请从备份中恢复它。
  4. 恢复部署配置:数据库连接环境变量、使用的自定义 N8N_ENCRYPTION_KEY,以及所有外部存储设置。如果缺少这些配置,恢复后的实例将无法访问数据库或解密数据。
  5. 启动 n8n。

使用默认 SQLite 数据库时,.n8n 文件夹包含恢复实例所需的一切:包含用户、设置和执行数据的 SQLite 数据库文件、加密密钥,以及在文件系统存储模式下的二进制数据和执行数据。使用 PostgreSQL 时,.n8n 文件夹仍保存加密密钥,其余内容保存在数据库备份中。

相关内容

相关资源

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