docs(deploy): 快速开始按推荐度重排,新增 GHCR 镜像与 AI 代部署方式

- 核心功能表改 HTML 表格并给模块/详见列加 nowrap,修复 GitHub 渲染换行
- 快速开始新增方式 C(本机 AI 代部署)与 GHCR 现成镜像,重排为 A=GHCR / B=Compose / C=AI / D=Dev
- 修正过时表述:Docker/GHCR 镜像默认不含 stock-sdk(与 Dockerfile/CI 实际一致)
- docs/deployment.md 四方式同步重排,补镜像直跑用户的更新流程
- 操作说明书新增 2.5 GHCR 镜像启动,25.1 补镜像更新命令
This commit is contained in:
shy3130
2026-09-06 09:54:24 +08:00
parent 900dbea59c
commit ae30b0cb85
3 changed files with 189 additions and 48 deletions
+25 -4
View File
@@ -62,6 +62,8 @@ TickFlow A 股智能量化工作台是一套本地优先的 A 股数据分析与
## 2. 安装与启动
零基础用户可以让本机 AI 编程助手代为部署(见项目 README「快速开始 · 方式 C」);已装 Docker 的用户推荐直接拉取 GHCR 现成镜像(见 2.5),无需本地构建。
### 2.1 环境要求
开发模式建议准备:
@@ -109,7 +111,19 @@ cp .env.example .env
默认访问地址与 macOS/Linux 开发模式一致。
### 2.5 Docker 部署
### 2.5 GHCR 镜像启动
已安装 Docker 的用户可以直接拉取 GitHub Actions 自动构建的现成镜像,无需克隆代码,也不用本地构建:
```bash
docker run -d --name tsp -p 3018:3018 -v ${PWD}/data:/app/data ghcr.io/shy3130/tick-stock-panel:latest
```
启动完成后访问 `http://localhost:3018`。需要配置时,从 `.env.example` 复制出 `.env`,并在命令中追加 `--env-file .env`
现成镜像默认不含 stock-sdk 插件和老 CPU 兼容内核;有这些需求时请改用 Docker 部署并按 [docs/deployment.md](./docs/deployment.md) 传入构建参数。
### 2.6 Docker 部署
在项目根目录执行:
@@ -138,7 +152,7 @@ docker compose logs -f
Docker 中的 `/app/data` 应映射到宿主机持久化目录。不要仅将数据保存在容器可写层,否则重新创建容器后可能丢失数据。
### 2.6 停止系统
### 2.7 停止系统
开发模式可在启动终端中按 `Ctrl+C` 停止。
@@ -1122,9 +1136,16 @@ data/strategies/ai/
## 25. 更新与维护
### 25.1 Docker 更新
### 25.1 镜像与 Docker 更新
更新前先备份,再执行:
GHCR 镜像启动的用户,备份 `data/` 目录后执行:
```bash
docker pull ghcr.io/shy3130/tick-stock-panel:latest
docker rm -f tsp
```
然后按 2.5 重新执行 `docker run`。Docker Compose 用户更新前先备份,再执行:
```bash
git pull