Ir al contenido

主手册:Plane 部署和管理(高级版)

针对 Linux 上的 Plane Commercial/Prime Edition 部署、Cloudflare DNS 配置以及通过 prime-cli 管理的综合技术指南。

0阅读

  1. 先决条件和环境准备
  2. 正确安装 Docker 引擎和 Compose V2
  3. DNS 和 SSL 配置(Cloudflare)
  4. Plane 安装和启动
  5. Prime CLI 工具参考手册
  6. 常见问题解决

为确保在主端口(80 和 443)上稳定部署且不发生冲突,需要在干净的服务器上初始化实例:

  • 推荐的操作系统:Ubuntu Server 20.04 LTS、22.04 LTS 或 24.04 LTS。
  • 推荐的最低资源:4 GB 内存 RAM 和 2 个 vCPU(建议生产环境使用 8 GB RAM)。
  • 专用域名:一条指向主机公共 IP 的 DNS 记录(例如 plane.portelcore.com)。

[!IMPORTANT]\n不建议在 Ubuntu 基础仓库中直接使用 apt install docker.io,因为它会安装与 Plane 后端不兼容的旧版软件包。请按照以下标准化流程安装官方引擎。

Ventana de terminal
sudo apt-get remove docker docker-engine docker.io containerd runc

添加官方安全 Docker 仓库的 GPG 密钥:

Ventana de terminal
# Instalar dependencias previas
sudo apt-get update
sudo apt-get install ca-certificates curl gnupg -y
# Crear el llavero seguro en el sistema
sudo install -m 0755 -d /etc/apt/keyrings
# Descargar e importar la clave GPG
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
# Añadir el repositorio a las fuentes estables de Apt
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
Ventana de terminal
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin -y

验证 Docker Compose V2 协调命令是否正确集成:

Ventana de terminal
docker compose version
# Salida esperada: Docker Compose version v2.x.x

为使部署在 --behind-proxy 路由参数下正常运行,请在 Cloudflare 的 DNS 管理面板中完成以下配置:

  1. DNS 记录 (A):为你的子域名(plane)创建一条 A 记录,解析到服务器的公共 IP。
  2. 代理状态:确保橙色云标志处于激活状态(Proxied)。
  3. SSL/TLS 加密:在 Cloudflare 面板中将加密模式配置为 Full 或 Full (Strict)。

Ventana de terminal
mkdir plane-selfhost && cd plane-selfhost
curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/selfhost/install.sh -o setup.sh
chmod +x setup.sh

此步骤至关重要,用于跳过 Plane 的本地 TLS 证书管理并将其 SSL 委托给我们的安全代理:

Ventana de terminal
sudo ./setup.sh --behind-proxy --domain="plane.portelcore.com"

该脚本将下载基础服务镜像(valkey、postgres、minio、核心后端和前端),并在后台启动容器。


Plane Prime 版本通过安装在 /bin/prime-cli 上的命令行界面 prime-cli 进行集中管理。

执行语法:

Ventana de terminal
sudo prime-cli [comando]
  • prime-cli start:启动堆栈中定义的所有容器。主机重启后非常有用。
  • prime-cli stop:有序停止 Plane 容器。在主机维护前必须执行。
  • prime-cli restart:当运行变慢时,对运行中的容器执行完整重启。
  • prime-cli configure:在控制台打开交互式菜单,用于管理 SMTP、企业 S3/MinIO 存储以及应用密钥等环境变量。
  • prime-cli upgrade:将 Plane 更新至官方渠道可用的最新版本,并执行数据库迁移。建议在执行前进行完整备份。
  • prime-cli repair:如果应用启动失败,请重置并修复损坏的依赖项或镜像。
  • prime-cli update-cli:独立更新管理工具 prime-cli。
  • prime-cli backup:生成一个包含本地 MySQL/Postgres 数据库、任务附件以及 .env 配置文件的 .tar.gz 或 .zip 压缩文件。默认存储在 /opt/plane/backups。
  • prime-cli restore:通过加载先前的还原点覆盖当前状态。
  • prime-cli monitor:实时显示所有服务的日志跟踪转储。
  • prime-cli healthcheck:执行内部健康检查,并报告 Redis/Valkey、Postgres、后端及前端微服务的状态。

  • 原因:当前控制台用户缺少对本地套接字 /var/run/docker.sock 的权限。
  • 永久解决方案:将当前用户加入 Docker 操作组:
    Ventana de terminal
    sudo usermod -aG docker $USER
    newgrp docker

错误:502 错误网关(Cloudflare Edge)

Sección titulada «Error: 502 Bad Gateway (Cloudflare Edge)»
  1. 检查本地容器状态:sudo prime-cli healthcheck。
  2. 验证 Plane 容器的反向代理是否在主机分配的内部 HTTP 端口上响应。
  3. 确保网络防火墙(例如 UFW)的策略不会阻止内部通信。