Openship：自托管部署平台

项目简介

Openship 是一个开源、可自托管的部署平台，内置 CI/CD。把它指向一个仓库，它会负责构建、发布、路由并完成 TLS 终止。你可以通过桌面应用、Web 面板或 CLI 来操作它。项目使用 TypeScript 编写，采用 Apache-2.0 许可。

主要功能

• 一条流水线：指向 GitHub 仓库、本地文件夹或预构建产物，即可完成构建与部署。
• 三种入口：桌面应用、Web 面板、CLI，任选其一驱动控制平面。
• 自动域名与证书：Compose 模式下由容器化的 OpenResty edge 在 :80/:443 上处理路由和 Let's Encrypt TLS。
• 多种部署目标：本机（Compose 模式）、通过 SSH 连接的其他服务器，或 Openship Cloud。
• 自托管实例需要登录：由安装向导创建的第一个管理员账号登录使用。
• CLI 补全：支持 bash / zsh / fish 的 Tab 补全。

安装与使用

桌面应用（适合个人、单机）

控制平面只在应用打开时运行在本机，通过 SSH 驱动你的服务器，不需要登录，也没有公网暴露面。

平台	下载
macOS（Apple Silicon）	Openship-arm64.dmg
macOS（Intel）	Openship-x64.dmg
Windows	Openship-win32-x64.zip
Linux	Openship.AppImage

Linux 下运行：

chmod +x Openship.AppImage && ./Openship.AppImage

自托管服务器（适合团队、常驻）

安装 CLI（内含 API 与面板），然后运行 openship，向导会创建第一个管理员、配置域名并把 Openship 安装为开机服务。

curl -fsSL https://get.openship.io | sh          # 或 npm i -g openship（需要 Node 22+）
openship                                          # 引导式安装，随后进入控制面板

CI / 无头机器可以跳过向导，直接使用 openship up：

openship up                                       # 安装并作为后台服务启动（开机自启、自动重启）
openship up --public-url https://openship.example.com

openship up 会自动选择运行方式：Linux + Docker 走 Compose 模式（Postgres、Redis、API、面板和 OpenResty edge 全套容器，可在同一台机器上托管部署的应用）；其他环境走 bare 模式（单个进程 + 内嵌数据库，把应用部署到 SSH 服务器或 Cloud）。可用 --compose、--bare 强制指定。

常用命令：openship open 打开面板、openship stop 停止、openship update 升级、openship up --foreground 前台运行。

部署一个项目

cd your-project
openship init            # 把这个目录关联到一个项目
openship deploy

直接用 Docker Compose 自托管

git clone https://github.com/oblien/openship.git && cd openship
cp .env.example .env          # 然后编辑
docker compose --env-file .env -f docker/docker-compose.yml up -d

该栈由 postgres + redis + api + dashboard + edge 组成，镜像从 ghcr.io/oblien/* 拉取。

注意事项

• 原始 Docker Compose 方式仅支持 Linux（edge 使用 host 网络）；mac/win 请用 openship up 的 bare 模式。
• api 容器挂载宿主 Docker socket，以便控制平面在宿主机上构建和运行应用，因此拥有宿主权限，只应在可信主机上运行。
• 宿主机级操作（:80/:443 接管、邮件引擎、宿主终端/端口扫描）需要容器到宿主的 SSH 通道，openship up 会自动准备，手动 Compose 方式需要按 .env.example 中的说明额外配置。
• 桌面应用本身不会在你的笔记本上托管公开应用。
• 自托管实例始终需要登录。
• openship-dev 是从源码构建的开发版，安装为独立命令并使用隔离的 ~/.openship-dev 目录，不适用于生产环境。

---

本作品整理自 GitHub 开源项目 oblien/openship，原作者 @oblien，许可证 Apache-2.0。中文介绍由 AI 根据项目 README 整理，以原仓库为准。