n8n 中文文档

安装私有节点

您可以构建自己的节点并将其安装在 n8n 实例中,而无需在 npm 上发布它们。这对于您为公司内部使用而创建的节点很有用。

在 Docker n8n 实例中安装节点

扩展官方 n8n 镜像,将编译好的私有节点加入其中。您无需从源码构建 n8n,也无需下载其 entrypoint 脚本。

开始之前,请先使用 n8n node CLI 构建节点。本示例使用 n8n 2.42.0,适用于运行时只依赖 n8n-workflow 的节点。如果您的节点导入了其他包,还必须让这些包在容器中可用。

  1. 在节点项目中运行构建命令:

    sh npm run build

    检查 dist/ 中是否包含编译后的 .node.js 文件及其资源文件。

  2. 在节点项目中、dist/ 旁边创建一个 Dockerfile:

    ```dockerfile FROM n8nio/n8n:2.42.0@sha256:862c954d784885f0406b19d9ee8f6a2ec9f93e976e2a6580ad85dedd58463bb1

    ENV N8N_CUSTOM_EXTENSIONS=/opt/n8n-custom ENV NODE_PATH=/usr/local/lib/node_modules/n8n/node_modules

    COPY --chown=node:node dist/ /opt/n8n-custom/ USER node ```

    N8N_CUSTOM_EXTENSIONS 告诉 n8n 从哪里加载您的节点。该目录位于 /home/node/.n8n 之外,因此数据卷不会遮挡节点文件。

    NODE_PATH 让您的节点能够从这个 n8n 镜像中解析 n8n-workflow。更换镜像版本前,请重新测试此路径和您的节点。

    镜像以 node 用户身份运行。COPY --chown=node:node 让该用户拥有编译后的文件。请确保这些文件对该用户可读,其所在目录对该用户可访问。

  3. 在 Dockerfile 旁边创建 .dockerignore 文件:

    text * !Dockerfile !dist/

    这样可以将构建上下文限制为 Dockerfile 和编译后的文件。不要把主机上的 node_modules 目录复制到镜像中。

  4. 在节点项目目录中构建镜像:

    sh docker build --tag customizedn8n:2.42.0 .

  5. 使用单独的数据卷启动测试实例:

    sh docker run -d --name n8n-private-node \ -p 127.0.0.1:5682:5678 \ -v n8n-private-node-data:/home/node/.n8n \ customizedn8n:2.42.0

    数据目录必须对 node 用户可写。本示例使用 Docker 管理的卷。

  6. 打开 http://127.0.0.1:5682,为测试实例完成所有者设置。

  7. 创建一个带有 Manual Trigger 节点的工作流。从节点面板添加您的私有节点,并将触发器连接到您的节点。

  8. 选择 Execute workflow 执行工作流。检查您的节点是否返回预期输出。

重新创建容器前请先保存工作流。重新创建时使用相同的数据卷和自定义镜像,并确认保存的工作流仍包含您的节点且返回预期输出。

在全局 n8n 实例中安装节点

如果您已全局安装 n8n,请确保在 n8n 内部安装您的节点。n8n 将找到该模块并自动加载它。

相关资源

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