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
54
docs/範例配置/說明文件.md
Normal file
54
docs/範例配置/說明文件.md
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
# Docker Compose 範例與配置
|
||||
|
||||
本目錄提供各種場景的 Docker Compose 範例配置。
|
||||
|
||||
---
|
||||
|
||||
## 範例檔案
|
||||
|
||||
| 檔案 | 用途 | 說明 |
|
||||
| -------------------------- | ---------- | ---------------- |
|
||||
| `compose.minimal.yml` | 快速啟動 | 最精簡配置 |
|
||||
| `compose.production.yml` | 生產環境 | 包含安全設定 |
|
||||
| `compose.with-traefik.yml` | 反向代理 | Traefik 整合 |
|
||||
| `nginx.example.conf` | Nginx 設定 | 反向代理設定範例 |
|
||||
|
||||
---
|
||||
|
||||
## 如何使用
|
||||
|
||||
### 1. 下載範例
|
||||
|
||||
```bash
|
||||
# 下載最小配置
|
||||
curl -O https://raw.githubusercontent.com/pi-docket/ConvertX-CN/main/docs/samples/compose.minimal.yml
|
||||
|
||||
# 重命名
|
||||
mv compose.minimal.yml docker-compose.yml
|
||||
```
|
||||
|
||||
### 2. 修改設定
|
||||
|
||||
```bash
|
||||
# 編輯配置
|
||||
nano docker-compose.yml
|
||||
|
||||
# 重點修改:
|
||||
# - JWT_SECRET
|
||||
# - TZ
|
||||
```
|
||||
|
||||
### 3. 啟動
|
||||
|
||||
```bash
|
||||
mkdir -p data
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相關文件
|
||||
|
||||
- [Docker 部署](../部署指南/Docker部署.md)
|
||||
- [環境變數](../配置設定/環境變數.md)
|
||||
- [反向代理](../部署指南/反向代理.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue