Openship部署平台快速上手:从安装到生产环境只需10步
【免费下载链接】openshipSelf-hosted deployment platform项目地址: https://gitcode.com/GitHub_Trending/ope/openship
Openship 是一个开源、免费的自托管部署平台,内置 CI/CD、自动域名绑定与免费 SSL 证书,支持 Node、Python、Go、Rust 等任意技术栈。把代码仓库指给它,它就能自动检测技术栈、构建、发布并接管 TLS 终止。本文带你快速上手:从一键安装到生产环境上线,只需 10 个简单步骤。
为什么选择 Openship 部署平台?
- 📦零配置:读取
package.json、框架配置和锁文件,自动推断构建/启动命令与端口,无需写 YAML - 🔒域名 + SSL 全自动:OpenResty 边缘代理 + Let's Encrypt 免费证书,自动续期
- 📡推送即部署:GitHub 推送触发流水线,monorepo 只重建被改动的服务
- 🖥️三种界面:桌面应用、Web 控制台、CLI,外加 REST API 与 MCP 端点
完整能力清单见 README.md,中文说明见 docs/i18n/README.zh.md。
第1步:选择部署模式——桌面、自托管还是云
先决定Openship 本身运行在哪里,之后所有操作完全一致:
| 你的场景 | 推荐模式 | 应用运行位置 |
|---|---|---|
| 单人、无运维 | 桌面应用 | 通过 SSH 连接的服务器 |
| 团队 / 需要推送即部署 / 主机上跑应用 | 自托管服务器(openship up) | 该服务器(Compose 模式) |
| 不想运维任何东西 | Openship Cloud | 托管沙箱,零配置 |
⚠️ 新手建议:想体验完整生产流程(自动域名、TLS、webhook),请选择自托管服务器模式——也就是本文的主线。
第2步:一键安装 Openship 命令行工具
在一台 Linux 服务器(建议 2 vCPU / 4GB 内存,带 Docker)上执行:
npm i -g openship # 需要 Node 22+;官方安装脚本会自动携带 Node 运行时安装器内置了 API 服务与 Web 控制台,无需额外组件。CLI 源码入口:apps/cli/src/index.ts。
第3步:运行交互式向导完成初始化
直接输入命令名,向导会自动接管:
openship向导将完成三件事:创建首个管理员账号、绑定你的域名、把 Openship 注册为开机自启服务(崩溃自动重启)。
💡 提示:请先在 DNS 处把域名的 A 记录指向服务器。CI 或无头机器可跳过向导,直接一条命令完成:
openship up --public-url https://openship.你的域名.comLinux + Docker 环境下会自动选择Compose 模式:拉起 Postgres、Redis、API、控制台,以及监听 :80/:443 的 OpenResty 边缘容器——这也是让"部署的应用直接跑在这台机器上"的关键。完整流程见 docs/installation.md。
第4步:验证服务并打开 Web 控制台
openship status # 确认运行状态与端口 openship open # 在浏览器中打开部署控制台用第 3 步创建的管理员登录。注意:自托管实例关闭公开注册,之后所有成员只能被邀请加入(Settings → Team)。
第5步:创建项目并自动识别技术栈
在控制台点击New Project,指向一个 GitHub 仓库或本地目录。Openship 会自动:
- 读取
package.json、框架配置、锁文件与docker-compose.yml - 推断技术栈、包管理器、构建/启动命令与端口
- 生成一份冻结的构建快照——重新部署和回滚时执行的严格一致
不想全自动?在项目里放一个openship.json即可覆盖任何猜测。仓库中还有 fixtures/deploy/ 下的 Node、Go、Python、Rust、.NET 等最小示例项目,适合拿来试水。
第6步:确认零配置构建参数
打开刚创建的项目,你会看到控制台已自动填好的部署配置(参考上方截图):
- Build:安装与构建命令(如
npm i --force/npm run build) - Start:启动命令与服务端口
- Domain:可先用免费的
*.opsh.io子域名,也可绑定自己的自定义域名
绝大多数项目无需修改任何一项,直接进入下一步。
第7步:绑定域名,免费 SSL 证书自动签发
在 Domain 区域填入你的域名,Openship 会通过 OpenResty 边缘:
- 为该域名写入反向代理 vhost
- 以 HTTP-01 方式向 Let's Encrypt 申请免费证书,并自动续期
✅ 设计亮点:路由与 TLS 发生在应用启动之后,即使 DNS 或证书出现问题,只会标记"需要处理",而不会让部署失败或应用下线。
第8步:一键部署,应用正式上线
在项目目录中执行:
openship init # 关联当前目录到一个项目 openship deploy # 触发构建 + 发布应用以 Docker 容器运行,仅暴露到 loopback(永不直接暴露公网端口),所有流量都经过边缘代理的 TLS 终止与缓存(支持 HTTP/3 与 Brotli 压缩)。构建日志可在控制台实时查看,或用openship logs <deploymentId> -f在终端跟踪。
第9步:开启推送即部署(Push-to-Deploy CI/CD)
绑定 GitHub 仓库后,Openship 注册 webhook:每次推送到跟踪分支都会自动重跑整条流水线——检测、构建、发布、路由。Monorepo 推送只会重建实际被触及的服务。
这一步让你的服务器具备了完整的CI/CD 部署能力:提交代码 → 自动上线,无需 Jenkins 或 GitHub Actions 配置。
第10步:生产环境运营——监控、备份与升级
上线只是开始。Openship 把生产运营也收进了同一个控制台:
- 📊实时监控:每个项目的 Monitoring 页回答三个问题——现在用了多少资源、流量来自哪里、返回码分布如何。其设计目标是"对访客零成本":每次请求仅约1.4 µs的内存计数、请求路径上零数据库写入,架构细节见 docs/monitoring.md
- 💾定时备份:数据库 + 数据卷的定时快照,支持一键恢复与随时导出
- ⬆️升级与救援:
openship update升级平台;忘记密码用openship reset-admin-password本地重置,无需登录
常用命令速查:
| 命令 | 作用 |
|---|---|
openship up/stop/status | 启动 / 停止 / 查看实例 |
openship deploy/logs <id> | 部署 / 查看日志 |
openship open | 打开 Web 控制台 |
openship doctor | 诊断 CLI 配置问题 |
隐藏福利:内置邮件服务器
生产环境通常需要发验证码、通知邮件——多数团队要另外接 Mailgun 或 SES。Openship 内置 SMTP 邮件引擎(支持 DKIM/SPF/DMARC),收件箱自带 AI 摘要与搜索:
其架构采用"收件自托管 + 发信中继"的拆分设计,收件数据完全归你所有,发件则交给信誉良好的中继保障送达率:
总结:10 步回顾
1️⃣ 选模式 → 2️⃣ 装 CLI → 3️⃣ 向导初始化 → 4️⃣ 验证并登录 → 5️⃣ 创建项目自动识别技术栈 → 6️⃣ 确认构建参数 → 7️⃣ 绑定域名免费 SSL → 8️⃣ 一键部署上线 → 9️⃣ 开启推送即部署 → 🔟 监控备份管生产
至此,你拥有一套完整的自托管部署平台:代码推上去,应用就上线,域名、证书、CDN、邮件、备份全部在同一处管理。整个平台基于 Apache 2.0 开源协议,自托管完全免费。
延伸阅读:安装排错与 Docker Compose 裸部署方案见 docs/installation.md(Docker 编排文件位于 docker/docker-compose.yml);贡献指南见 CONTRIBUTING.md。
【免费下载链接】openshipSelf-hosted deployment platform项目地址: https://gitcode.com/GitHub_Trending/ope/openship
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考