# deploygo

**Repository Path**: yonghangpu/deploygo

## Basic Information

- **Project Name**: deploygo
- **Description**: 一套轻量、可落地的零停机发布方案。覆盖了构建产物整理、Nginx 缓存策略、内置发布流程，以及开箱即用的前端版本更新提示组件。核心策略不绑定框架，Vue / React / Angular 等所有 SPA 项目均可适用。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-09
- **Last Updated**: 2026-09-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# deploygo

> 面向静态站点的桌面端发布工具，把零停机部署、版本管理与回滚收进一套可直接使用的产品体验。

deploygo 让前端发布回到一条清晰流程：

- 在业务项目中完成构建
- 在页面根组件接入对应框架的版本更新通知组件
- 在 deploygo 中完成服务器配置、发布、回滚与历史追踪

**下载桌面端（官方完整版，90 天免费试用）：** [GitHub Releases](https://github.com/YongHangPu/deploygo/releases)

## 关于开源版

本仓库是 deploygo 的开源仓库，采用「界面与方案开源、部署引擎闭源」的组织方式。

**开源仓库提供：**

- 完整的桌面端界面实现（Vue 3 + Naive UI + Pinia）
- 五种框架的版本更新通知组件（见 `templates/`，可在业务项目中独立使用，不依赖 deploygo）
- Rust 后端架构骨架（`src-tauri/src/backend/` 契约层 + 桩实现）
- 零停机发布方案的完整文档：发布语义、缓存策略、目录结构约定

**不在本仓库中：**

- 部署引擎：SSH 连接管理、产物上传、原子发布与回滚的执行实现
- 授权与试用系统

**为什么这样拆分：** deploygo 由独立开发者维护，采用商业可持续的开源模式——把对社区最有价值的部分（界面实现、更新通知组件、发布方案文档）完整开源，供学习、参考与直接复用；同时通过官方完整版的授权收入支持项目的持续开发。

**获取完整功能：** 从 [GitHub Releases](https://github.com/YongHangPu/deploygo/releases) 下载官方完整版，提供 90 天免费试用。

**自行构建说明：** 在本仓库执行 `pnpm tauri:build` 得到的是开源展示版——可以启动并浏览全部界面，但部署、连接测试与回滚操作会引导下载官方完整版。

## 接入方式

### 1. 挂载更新通知组件

从 `templates/` 目录选择对应框架的组件放入业务项目，并挂载到应用根组件。组件会轮询线上 `version.json`，在发现新版本后提示用户刷新页面获取最新资源。

这部分与 deploygo 桌面端解耦：即使不使用 deploygo 发布，组件本身也可以配合任何按本文档约定生成 `version.json` 的发布流程独立使用。

支持 Vue / React / Angular / Svelte / 纯 JavaScript 五种版本：

| 框架 | 文件 |
|------|------|
| Vue 3 (TypeScript) | `templates/VersionUpdateNotification.vue` |
| Vue 3 (JavaScript) | `templates/VersionUpdateNotification.vue.js` |
| Vue 2 (TypeScript) | `templates/VersionUpdateNotification.vue2.ts` |
| Vue 2 (JavaScript) | `templates/VersionUpdateNotification.vue2` |
| React | `templates/VersionUpdateNotification.tsx` |
| Angular | `templates/VersionUpdateNotification.angular.ts` |
| Svelte | `templates/VersionUpdateNotification.svelte` |
| 纯 JS（零依赖） | `templates/VersionUpdateNotification.js` |

### 2. 保持业务项目原有构建方式

业务项目只需要按平常方式构建（`npm run build` / `pnpm build` / `yarn build` 等），无需为 deploygo 调整构建流程。

## deploygo 完整版自动完成什么

以下能力由官方完整版的部署引擎执行（参见上方「关于开源版」）：

1. 识别真实构建目录
2. 自动生成 `version.json`
3. 自动生成 release 名称
4. 在本地准备发布目录或压缩包
5. 根据 `live_root_path` 自动推导同级 `releases` 目录
6. 远端自动创建 `live_root`、`releases_root`、备份目录
7. 上传发布内容到远端 release 目录
8. 执行内置零停机发布流程
9. 清理旧版本
10. 写入部署历史，并支持一键回滚
11. 拦截重复发布，避免同一份产物被重复部署

## 使用流程

```
1. 在业务项目中先执行构建
2. 打开 deploygo，添加服务器
3. 添加项目，填写本地构建产物目录和线上发布目录
4. 点击一键部署
5. 如需回滚，到部署历史中选择目标版本
```

### 服务器信息

需要填写：

- 服务器名称
- 主机地址、端口
- 用户名
- 认证方式（密码 或 SSH 密钥）
- 可选：跳板机 / 堡垒机配置

### 项目信息

需要填写：

- 项目名称
- 本地构建产物目录（支持目录选择器）
- 关联服务器
- 线上发布目录
- 保留版本数

deploygo 会自动根据线上发布目录推导同级 `releases` 目录，并在远端完成创建与维护。

## 安全设计

服务器凭证是 deploygo 最敏感的数据，安全设计围绕「凭证不离开本机」展开：

- **无云端架构**：deploygo 是纯本地桌面应用，不内置任何远端服务。凭证与部署流量只在你的电脑与你自己的服务器之间通过 SSH 直连，不经过任何第三方服务器。
- **加密存储**：服务器密码与密钥口令以 AES-256-GCM 加密后写入本地数据库（每次加密使用随机 nonce 与认证标签），解密密钥仅保存在本机用户数据目录（Unix 下权限 `0600`）。
- **内存清零**：密码与派生密钥使用后立即从内存擦除（zeroize），不依赖垃圾回收自然释放。
- **加密备份**：凭证导出文件使用 Argon2id 派生密钥 + AES-256-GCM 加密，不设置密码无法导出；导出文件即使泄露也无法还原凭证。
- **日志脱敏**：部署日志与调试输出不包含任何密码、口令字段。

### 威胁模型边界

加密密钥保存在本机，因此任何能完全控制你电脑的攻击者理论上可以还原凭证——这是所有本地加密工具的共同边界，deploygo 不做例外声明。请在共享或不受信任的设备上谨慎使用；deploygo 不上传任何数据，删除应用数据目录即可彻底删除全部凭证。

## 适用范围

deploygo 适合：

- Vue / React / Angular / Svelte / 纯 HTML 等所有 SPA / 静态站点
- 构建产物包含 hash 资源文件的前端项目
- 线上通过 Nginx 或类似静态文件服务托管的项目
- 没有专门 DevOps 流水线，但又希望发版稳定可回滚的团队

以下场景暂不适合：

- SSR 服务端渲染项目
- 不生成 hash 资源名的静态站点
- 发布时必须立即清空旧资源的场景

## 发布语义

deploygo 的内置发布流程遵循固定顺序：

```text
[1/3] 先同步静态资源（排除 index.html / version.json）
[2/3] 再替换 index.html
[3/3] 最后替换 version.json
```

这样可以保证：

- 旧页面仍然能继续访问已有资源，不会在发布瞬间白屏
- 新用户会逐步进入新版本入口
- 已打开页面的用户会在检测到新版本后收到刷新提示，而不是被强制打断

这一发布顺序与目录结构约定（`live_root` 指向软链 / `releases/` 保存历史版本）是纯方案层面的设计，即使自行实现发布脚本，也可以直接参考。

## 缓存建议

如果页面没有按预期提示新版本，优先检查线上缓存策略：

- `index.html` 不要强缓存
- `version.json` 不要强缓存
- 带 hash 的静态资源可以长缓存

只要项目具备稳定的 hash 构建产物，deploygo 就能提供完整的版本发布体验。

## 演示站

仓库中还提供了 Web 演示页，用于展示：

- 产品介绍与接入说明
- 桌面端使用流程
- 多框架更新通知组件下载

本地运行：

```bash
git clone https://github.com/YongHangPu/deploygo.git
cd deploygo
pnpm install
pnpm dev
```

## 下载桌面端

从 [GitHub Releases](https://github.com/YongHangPu/deploygo/releases) 下载官方完整版（含部署引擎，90 天免费试用）。

开源展示版的自行构建方式见上方「关于开源版」。

## License

[MIT](./LICENSE)