Add comprehensive documentation for ConvertX-CN deployment and configuration
- Create 指定版本部署.md to explain fixed version deployment - Create 最新版.md detailing the use of the latest tag - Create 版本選擇指南.md to guide users on version selection - Add Nginx and Traefik configuration examples for reverse proxy - Introduce minimal and production configuration examples - Develop Docker deployment guide with detailed steps - Implement quick start guide for first-time Docker users - Include version update instructions and rollback procedures - Add troubleshooting section for common issues - Enhance overall documentation structure and links for better navigation
This commit is contained in:
parent
c2d3d13c89
commit
3f1a5e0fbf
51 changed files with 544 additions and 579 deletions
120
docs/版本/指定版本.md
Normal file
120
docs/版本/指定版本.md
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
# 指定版本部署
|
||||
|
||||
本文件說明如何使用固定版本標籤部署 ConvertX-CN。
|
||||
|
||||
---
|
||||
|
||||
## 為什麼要指定版本?
|
||||
|
||||
使用固定版本可以:
|
||||
|
||||
- 確保每次部署結果一致
|
||||
- 避免意外升級造成問題
|
||||
- 方便在多台伺服器部署相同版本
|
||||
- 出問題時容易回滾
|
||||
|
||||
---
|
||||
|
||||
## 如何指定版本
|
||||
|
||||
修改 `docker-compose.yml`:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
convertx:
|
||||
image: convertx/convertx-cn:v0.1.9 # 指定版本
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 查看可用版本
|
||||
|
||||
### GitHub Releases
|
||||
|
||||
[https://github.com/pi-docket/ConvertX-CN/releases](https://github.com/pi-docket/ConvertX-CN/releases)
|
||||
|
||||
### Docker Hub
|
||||
|
||||
```bash
|
||||
# 列出所有標籤
|
||||
docker search convertx/convertx-cn --limit 100
|
||||
|
||||
# 或查看 Docker Hub 網頁
|
||||
# https://hub.docker.com/r/convertx/convertx-cn/tags
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 版本命名規則
|
||||
|
||||
| 格式 | 說明 | 範例 |
|
||||
| -------- | -------------------- | -------- |
|
||||
| `vX.Y.Z` | 正式版本 | `v0.1.9` |
|
||||
| `latest` | 最新穩定版 | - |
|
||||
| `main` | 最新開發版(不穩定) | - |
|
||||
|
||||
---
|
||||
|
||||
## 升級到新版本
|
||||
|
||||
1. 查看 [Changelog](../../CHANGELOG.md) 確認變更
|
||||
2. 修改 docker-compose.yml 的版本號
|
||||
3. 執行更新
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
詳見 [版本更新指南](../部署指南/版本更新.md)。
|
||||
|
||||
---
|
||||
|
||||
## 回滾到舊版本
|
||||
|
||||
如果新版本有問題:
|
||||
|
||||
1. 修改版本號為舊版本
|
||||
|
||||
```yaml
|
||||
image: convertx/convertx-cn:v0.1.8
|
||||
```
|
||||
|
||||
2. 重新部署
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 生產環境建議
|
||||
|
||||
### 部署流程
|
||||
|
||||
1. 在測試環境使用 `latest` 或新版本
|
||||
2. 確認功能正常
|
||||
3. 記錄版本號
|
||||
4. 生產環境使用該固定版本
|
||||
|
||||
### 版本記錄
|
||||
|
||||
建議在 docker-compose.yml 加上註解:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
convertx:
|
||||
# 2026-01-20 升級:修復 PDF 轉換問題
|
||||
image: convertx/convertx-cn:v0.1.9
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [使用 latest 標籤](最新版.md)
|
||||
- [版本更新指南](../部署指南/版本更新.md)
|
||||
- [Changelog](../../CHANGELOG.md)
|
||||
105
docs/版本/最新版.md
Normal file
105
docs/版本/最新版.md
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
# 使用 latest 標籤
|
||||
|
||||
本文件說明使用 `latest` 標籤的注意事項。
|
||||
|
||||
---
|
||||
|
||||
## 什麼是 latest?
|
||||
|
||||
```yaml
|
||||
image: convertx/convertx-cn:latest
|
||||
```
|
||||
|
||||
`latest` 是指向最新穩定版本的標籤。每次發布新版本時,`latest` 會自動更新。
|
||||
|
||||
---
|
||||
|
||||
## 優點
|
||||
|
||||
- 自動獲取新功能與修復
|
||||
- 不需要手動修改 docker-compose.yml
|
||||
- 適合快速測試
|
||||
|
||||
---
|
||||
|
||||
## 風險
|
||||
|
||||
### 意外更新
|
||||
|
||||
當執行 `docker compose pull` 時,會自動下載最新版本:
|
||||
|
||||
```bash
|
||||
docker compose pull # 可能拉到新版本
|
||||
docker compose up -d # 使用新版本啟動
|
||||
```
|
||||
|
||||
如果新版本有重大變更,可能影響正常使用。
|
||||
|
||||
### 無法回滾
|
||||
|
||||
如果沒有記錄使用的版本,出問題時難以回滾。
|
||||
|
||||
### 不一致
|
||||
|
||||
多台伺服器在不同時間部署,可能跑不同版本。
|
||||
|
||||
---
|
||||
|
||||
## 適用情境
|
||||
|
||||
| 情境 | 是否適合 latest |
|
||||
| -------- | --------------- |
|
||||
| 個人測試 | ✅ |
|
||||
| 家庭使用 | ✅ |
|
||||
| 團隊協作 | ⚠️ 視情況 |
|
||||
| 生產環境 | ❌ |
|
||||
|
||||
---
|
||||
|
||||
## 使用建議
|
||||
|
||||
### 測試環境
|
||||
|
||||
```yaml
|
||||
image: convertx/convertx-cn:latest
|
||||
```
|
||||
|
||||
可以使用 `latest`,享受自動更新的便利。
|
||||
|
||||
### 生產環境
|
||||
|
||||
建議使用固定版本:
|
||||
|
||||
```yaml
|
||||
image: convertx/convertx-cn:v0.1.9
|
||||
```
|
||||
|
||||
詳見 [指定版本部署](指定版本.md)。
|
||||
|
||||
---
|
||||
|
||||
## 如何知道 latest 是哪個版本?
|
||||
|
||||
### 方法 1:查看 log
|
||||
|
||||
```bash
|
||||
docker compose logs | head -10
|
||||
```
|
||||
|
||||
### 方法 2:檢查映像檔
|
||||
|
||||
```bash
|
||||
docker inspect convertx/convertx-cn:latest | grep -i version
|
||||
```
|
||||
|
||||
### 方法 3:查看網頁
|
||||
|
||||
開啟 `http://localhost:3000`,頁面底部會顯示版本號。
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [指定版本部署](指定版本.md)
|
||||
- [版本更新指南](../部署指南/版本更新.md)
|
||||
- [GitHub Releases](https://github.com/pi-docket/ConvertX-CN/releases)
|
||||
29
docs/版本/說明文件.md
Normal file
29
docs/版本/說明文件.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# 版本選擇指南
|
||||
|
||||
本目錄說明如何選擇適合的版本標籤。
|
||||
|
||||
---
|
||||
|
||||
## 快速建議
|
||||
|
||||
| 情境 | 建議版本 |
|
||||
| -------- | ----------------------- |
|
||||
| 個人測試 | `latest` |
|
||||
| 家庭使用 | `latest` |
|
||||
| 團隊環境 | 指定版本(如 `v0.1.9`) |
|
||||
| 生產環境 | 指定版本(如 `v0.1.9`) |
|
||||
|
||||
---
|
||||
|
||||
## 文件列表
|
||||
|
||||
- [使用 latest 標籤](最新版.md) - 自動更新的優缺點
|
||||
- [指定版本部署](指定版本.md) - 生產環境推薦做法
|
||||
|
||||
---
|
||||
|
||||
## 相關連結
|
||||
|
||||
- [GitHub Releases](https://github.com/pi-docket/ConvertX-CN/releases)
|
||||
- [Changelog](../../CHANGELOG.md)
|
||||
- [版本更新指南](../部署指南/版本更新.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue