跳转至

Docker-Compose#

这些指导介绍如何在 Linux 服务器上使用 Docker Compose 运行 n8n。

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

您可以在 n8n-hosting 存储库中找到适用于各种架构的 Docker Compose 配置。

自托管知识先决条件

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

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

n8n 建议专家用户使用自托管。错误可能导致数据丢失、安全问题和停机。如果您在管理服务器方面经验不足,n8n 建议使用 n8n Cloud

Latest 和 Next 版本

n8n 几乎每周都会发布新的次要版本。latest 版本用于生产环境。next 是最新的发布版本。您应该将 next 视为测试版:它可能不稳定。如需报告问题,请使用论坛

当前 latest:1.107.3
当前 next:1.108.0

1. 安装 Docker 和 Docker Compose#

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

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

1
2
docker --version
docker compose version

2. 可选:非 root 用户访问#

您可以选择授予在不使用 sudo 命令的情况下运行 Docker 的访问权限。

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

1
2
3
sudo usermod -aG docker ${USER}
# 在不更改主组的情况下,将 `docker` 组成员身份注册到当前会话
exec sg docker newgrp

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

1
sudo usermod -aG docker <USER_TO_RUN_DOCKER>

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

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

1
groups

3. DNS 设置#

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

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

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

4. 创建 .env 文件#

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

1
2
mkdir n8n-compose
cd n8n-compose

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

.env 文件
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
# DOMAIN_NAME 和 SUBDOMAIN 共同决定 n8n 可以从哪里访问
# 要提供服务的顶级域
DOMAIN_NAME=example.com

# 要提供服务的子域
SUBDOMAIN=n8n

# 上述示例在以下位置提供 n8n 服务: https://n8n.example.com

# 可选的时区设置,由 Cron 和其他调度节点使用
# 如果未设置,纽约是默认值
GENERIC_TIMEZONE=Europe/Berlin

# 用于 TLS/SSL 证书创建的电子邮件地址
SSL_EMAIL=[email protected]

5. 创建本地文件目录#

在您的项目目录中,创建一个名为 local-files 的目录,用于在 n8n 实例和主机系统之间共享文件(例如,使用从磁盘读写文件节点):

1
mkdir local-files

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

6. 创建 Docker Compose 文件#

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

compose.yaml file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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: docker.n8n.io/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
      - N8N_RUNNERS_ENABLED=true
      - NODE_ENV=production
      - WEBHOOK_URL=https://${SUBDOMAIN}.${DOMAIN_NAME}/
      - GENERIC_TIMEZONE=${GENERIC_TIMEZONE}
      - TZ=${GENERIC_TIMEZONE}
    volumes:
      - n8n_data:/home/node/.n8n
      - ./local-files:/files

volumes:
  n8n_data:
  traefik_data:

上面的 Docker Compose 文件配置了两个容器:一个用于 n8n,一个用于运行 traefik,这是一个用于管理 TLS/SSL 证书和处理路由的应用程序代理。

它还创建和挂载两个 Docker 卷,并挂载您之前创建的 local-files 目录:

名称 类型 容器挂载点 描述
n8n_data /home/node/.n8n n8n 保存其 SQLite 数据库文件和加密密钥的位置。
traefik_data /letsencrypt traefik 保存 TLS/SSL 证书数据的位置。
./local-files 绑定 /files 在 n8n 实例和主机之间共享的本地目录。在 n8n 中,使用 /files 路径从此目录读取和写入。

7. 启动 Docker Compose#

通过输入以下内容启动 n8n:

1
sudo docker compose up -d

要停止容器,请输入:

1
sudo docker compose stop

8. 完成#

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

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

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

后续步骤#

此页面是否
💬 微信

🚀 与作者交流

关注公众号
n8n实战笔记公众号
n8n实战笔记
📚 教程 💡 案例 🔧 技巧
添加微信
添加作者微信
1对1 专业指导
⚡ 快答 🎯 定制 🚀 支持