n8n 中文文档

Docker-Compose

这些说明涵盖了如何使用Docker Compose在Linux服务器上运行n8n。

如果您已经安装了Docker和Docker-Compose,那么您可以从步骤3开始。

您可以在n8n-hosting存储库{:target=_blank .external-link}中找到各种架构的Docker Compose配置。

提示

Self-hosting knowledge prerequisites 自托管知识先决条件

自托管 n8n 需要技术知识,包括:

  • 设置和配置服务器和容器
  • 管理应用程序资源和扩展
  • 保护服务器和应用程序
  • 配置 n8n

n8n 建议专家用户使用自托管。错误可能会导致数据丢失、安全问题和停机。如果您没有管理服务器的经验,n8n 推荐 n8n Cloud。

提示

稳定版和测试版

n8n 每周都会发布新的次要版本。 stable 版本用于生产用途。 beta 是最新版本。 beta版本可能不稳定。要报告问题,请使用 论坛。

当前 stable:2.47.7 当前 beta:2.48.4

1. 安装 Docker 和 Docker Compose

安装Docker和Docker Compose的方式取决于您的Linux发行版。您可以在下面的链接中找到每个组件的具体说明:

按照安装说明后,通过输入以下命令验证Docker和Docker Compose是否可用:

docker --version
docker compose version

2.可选:非root用户访问

您可以选择授予运行 Docker 而无需 sudo 命令的权限。

要向您当前登录的用户授予访问权限(假设该用户有 sudo 访问权限),请运行:

sudo usermod -aG docker ${USER}
# Register the `docker` group membership with current session without changing your primary group <a href="#register-the-docker-group-membership-with-current-session-without-changing-your-primary-group" id="register-the-docker-group-membership-with-current-session-without-changing-your-primary-group"></a>
exec sg docker newgrp

要向不同的用户授予访问权限,请输入以下内容,将 <USER_TO_RUN_DOCKER> 替换为适当的用户名:

sudo usermod -aG docker <USER_TO_RUN_DOCKER>

您需要从该用户的任何现有会话中运行 exec sg docker newgrp 以访问新的组权限。

您可以通过输入以下内容来验证您当前的会话是否识别 docker 组:

groups

3. DNS设置

要在网络上或在线托管n8n,请创建一个指向您服务器的专用子域。

添加A记录以相应地路由子域:

记录类型 名称 目标
A n8n(或您想要的子域) <your_server_IP_address>

4.创建.env文件

创建一个项目目录来存储您的n8n环境配置和Docker Compose文件,并导航到其中:

mkdir n8n-compose
cd n8n-compose

在n8n-compose目录内,创建一个.env文件来自定义您的n8n实例的详细信息。更改它以匹配您自己的信息:

```shell title=".env file"

DOMAIN_NAME and SUBDOMAIN together determine where n8n will be reachable from

The top level domain to serve from

DOMAIN_NAME=example.com

The subdomain to serve from

SUBDOMAIN=n8n

The above example serve n8n at: https://n8n.example.com

Optional timezone to set which gets used by Cron and other scheduling nodes

New York is the default value if not set

GENERIC_TIMEZONE=Europe/Berlin

The email address to use for the TLS/SSL certificate creation

[email protected]


## 5.创建本地文件目录<a href="#5-create-local-files-directory" id="5-create-local-files-directory"></a>

在项目目录中,创建一个名为 `local-files` 的目录,用于在 n8n 实例和主机系统之间共享文件(例如,使用 [从磁盘节点读取/写入文件](https://app.gitbook.com/s/BKcbOzIWja8NfqKDcqHc/builtin/core-nodes/n8n-nodes-base.readwritefile)):

```shell
mkdir local-files

下面的Docker Compose文件可以自动创建此目录,但手动执行可确保使用正确的所有权和权限创建它。

6. 创建 Docker Compose 文件

创建一个compose.yaml文件。将以下内容粘贴到文件中:

```yaml title="compose.yaml 文件" services: traefik: image: "traefik" restart: always command: - "--api.insecure=true" - "--providers.docker=true" - "--providers.docker.exposedbydefault=false" - "--entrypoints.web.address=:80" - "--entrypoints.web.http.redirections.entryPoint.to=websecure" - "--entrypoints.web.http.redirections.entrypoint.scheme=https" - "--entrypoints.websecure.address=:443" - "--certificatesresolvers.mytlschallenge.acme.tlschallenge=true" - "--certificatesresolvers.mytlschallenge.acme.email=${SSL_EMAIL}" - "--certificatesresolvers.mytlschallenge.acme.storage=/letsencrypt/acme.json" ports: - "80:80" - "443:443" volumes: - traefik_data:/letsencrypt - /var/run/docker.sock:/var/run/docker.sock:ro

n8n: image: n8nio/n8n restart: always ports: - "127.0.0.1:5678:5678" labels: - traefik.enable=true - traefik.http.routers.n8n.rule=Host(${SUBDOMAIN}.${DOMAIN_NAME}) - traefik.http.routers.n8n.tls=true - traefik.http.routers.n8n.entrypoints=web,websecure - traefik.http.routers.n8n.tls.certresolver=mytlschallenge - traefik.http.middlewares.n8n.headers.SSLRedirect=true - traefik.http.middlewares.n8n.headers.STSSeconds=315360000 - traefik.http.middlewares.n8n.headers.browserXSSFilter=true - traefik.http.middlewares.n8n.headers.contentTypeNosniff=true - traefik.http.middlewares.n8n.headers.forceSTSHeader=true - traefik.http.middlewares.n8n.headers.SSLHost=${DOMAIN_NAME} - traefik.http.middlewares.n8n.headers.STSIncludeSubdomains=true - traefik.http.middlewares.n8n.headers.STSPreload=true - traefik.http.routers.n8n.middlewares=n8n@docker environment: - N8N_ENFORCE_SETTINGS_FILE_PERMISSIONS=true - N8N_HOST=${SUBDOMAIN}.${DOMAIN_NAME} - N8N_PORT=5678 - N8N_PROTOCOL=https - NODE_ENV=production - N8N_WEBHOOK_URL=https://${SUBDOMAIN}.${DOMAIN_NAME}/ - GENERIC_TIMEZONE=${GENERIC_TIMEZONE} - TZ=${GENERIC_TIMEZONE} - N8N_RESTRICT_FILE_ACCESS_TO=/files volumes: - n8n_data:/home/node/.n8n - ./local-files:/files

volumes: n8n_data: traefik_data:


`N8N_WEBHOOK_URL` 从 n8n 2.30.0 起可用;更早的版本请使用 `WEBHOOK_URL`。

上面的 Docker Compose 文件配置了两个容器:一个用于 n8n,一个用于运行 [Traefik](https://github.com/traefik/traefik){:target=_blank .external-link},这是一个用于管理 TLS/SSL 证书和处理路由的应用程序代理。

它还创建并挂载两个 [Docker 卷](https://docs.docker.com/engine/storage/volumes/){:target=_blank .external-link},并挂载您之前创建的 `local-files` 目录:

| 名称            | 类型                                                        | 容器挂载   | 描述                                                                                                                         |
|-----------------|-------------------------------------------------------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| `n8n_data`      | [Volume](https://docs.docker.com/engine/storage/volumes/){:target=_blank .external-link}   | `/home/node/.n8n` | n8n保存其SQLite数据库文件和加密密钥的位置。                                                                        |
| `traefik_data`  | [Volume](https://docs.docker.com/engine/storage/volumes/){:target=_blank .external-link}   | `/letsencrypt`    | Traefik 保存 TLS/SSL 证书数据的位置。                                                                                       |
| `./local-files` | [Bind](https://docs.docker.com/engine/storage/bind-mounts/){:target=_blank .external-link} | `/files`          | n8n实例和主机之间共享的本地目录。在n8n中,使用`/files`路径从此目录读取和写入。 |

## 7. 启动 Docker Compose <a href="#7-start-docker-compose" id="7-start-docker-compose"></a>

通过输入以下命令启动n8n:

```shell
sudo docker compose up -d

要停止容器,请输入:

sudo docker compose stop

8. 完成

您现在可以使用在.env文件配置中定义的子域+域组合访问n8n。上述示例将产生https://n8n.example.com。

n8n只能通过安全的HTTPS访问,不能通过普通HTTP访问。

如果您在访问实例时遇到问题,请检查服务器的防火墙设置和 DNS 配置。

后续步骤

相关资源

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