116 lines
2.6 KiB
Markdown
116 lines
2.6 KiB
Markdown
# SSH Manager 交付指南
|
||
|
||
更新时间：2026-04-14
|
||
|
||
## 目标
|
||
|
||
把当前仓库整理成三种可直接交付给买家的形态：
|
||
|
||
- 源码仓库版
|
||
- Docker 一键版
|
||
- Windows 安装版
|
||
|
||
## 源码仓库版
|
||
|
||
适合会自己部署、需要二开或想长期自主管理的买家。
|
||
|
||
### 交付内容
|
||
|
||
- 当前仓库源码
|
||
- `README.md` 或独立部署文档
|
||
- 环境变量说明
|
||
- 初始化账号说明
|
||
- 备份示例或演示数据说明
|
||
|
||
### 推荐说明
|
||
|
||
- 默认提供 Docker 启动方式
|
||
- 明确 Java / Node / Maven 版本要求
|
||
- 明确默认账号、密码修改和数据目录位置
|
||
- 保留“关于与交付信息”页面给买家查看诊断摘要
|
||
|
||
## Docker 一键版
|
||
|
||
适合想快速运行源码版的买家。
|
||
|
||
### 直接启动
|
||
|
||
Windows：
|
||
|
||
- `scripts/windows/start-docker.bat`
|
||
|
||
停止：
|
||
|
||
- `scripts/windows/stop-docker.bat`
|
||
|
||
### 说明
|
||
|
||
- 数据默认保存在 Docker volume `app-data`
|
||
- 不要执行 `docker compose down -v`
|
||
|
||
## Windows 安装版
|
||
|
||
适合完全不想部署环境的买家。
|
||
|
||
### 构建前准备
|
||
|
||
- 安装 Node.js 18+
|
||
- 安装 Maven 3.6+
|
||
- 安装 Inno Setup
|
||
- 准备一个已解压的 Windows JRE，并设置环境变量：
|
||
- `SSH_MANAGER_WINDOWS_JRE_DIR=D:\runtime\jdk-17-jre`
|
||
- 安装包版本号默认读取 `backend/pom.xml` 中的 `<version>`
|
||
|
||
### 发布前预检
|
||
|
||
建议先执行：
|
||
|
||
- `scripts\release\check-windows-release.bat`
|
||
|
||
作用：
|
||
|
||
- 检查 Node.js / Maven / PowerShell / JRE / Inno Setup
|
||
- 检查图标、安装器脚本、买家说明、售后 FAQ 是否齐全
|
||
- 构建前端
|
||
- 以内嵌前端静态资源的方式打包后端
|
||
|
||
### 构建命令
|
||
|
||
Windows：
|
||
|
||
- `scripts\release\build-windows-installer.bat`
|
||
|
||
### 产物
|
||
|
||
- `release/windows-app/`
|
||
- 安装前的应用目录
|
||
- 包含 jar、启动器脚本、安装器图标、说明文档和内置 JRE
|
||
- `release/windows-installer/`
|
||
- 若安装了 Inno Setup，则输出 `SSHManager-Setup-*.exe`
|
||
|
||
### 安装后行为
|
||
|
||
- 程序文件默认安装到 `C:\Program Files\SSH Manager\`
|
||
- 用户数据默认保存在 `%LOCALAPPDATA%\SSHManager\`
|
||
- 首次启动自动生成本地密钥
|
||
- 双击快捷方式会后台启动服务并自动打开浏览器
|
||
- 开始菜单会同时提供“买家使用说明”和“售后排查 FAQ”
|
||
|
||
## 本地打包
|
||
|
||
已提供本地打包脚本，可用于你自己验证交付前构建是否完整：
|
||
|
||
- `scripts/release/build-local-package.sh`
|
||
- `scripts/release/build-local-package.bat`
|
||
|
||
作用：
|
||
|
||
- 构建前端
|
||
- 以内嵌前端静态资源的方式打包后端
|
||
- 输出到 `release/local-package/`
|
||
|
||
## 后续建议
|
||
|
||
- 再补一个“首次启动引导页”
|
||
- 再补一个“关于 / 交付信息 / 诊断摘要”页面
|