Elijah/convertor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add comprehensive documentation for ConvertX-CN deployment and configuration

Browse source 
- 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:
Your Name 2026-01-23 22:05:09 +08:00
parent c2d3d13c89
commit 3f1a5e0fbf
51 changed files with 544 additions and 579 deletions
Download patch file Download diff file Expand all files Collapse all files

63
docs/docker-compose/README.md
View file

@ -1,63 +0,0 @@
# Docker Compose 範例檔案
本資料夾提供不同情境的 Docker Compose 範例。
## 範例檔案
| 檔案 | 適用情境 | 說明 |
| ------------------------------------------------ | ----------- | --------------------- |
| [compose.minimal.yml](compose.minimal.yml) | Docker 老手 | 最精簡的可用配置 |
| [compose.production.yml](compose.production.yml) | 生產環境 | 含 Reverse Proxy 設定 |
| [compose.reference.yml](compose.reference.yml) | 參考文件 | 所有設定的完整參考 |
## 快速選擇
| 你是... | 使用 |
| ------------ | ------------------------------ |
| 新手 | [README 主頁](../../README.md) |
| Docker 熟手 | compose.minimal.yml |
| 生產環境 | compose.production.yml |
| 查詢所有選項 | compose.reference.yml |
## 如何使用
```bash
# 下載範例
curl -O https://raw.githubusercontent.com/pi-docket/ConvertX-CN/main/docs/docker-compose/compose.minimal.yml
# 重命名
mv compose.minimal.yml docker-compose.yml
# 建立 data 資料夾
mkdir -p data
# 修改 JWT_SECRET
nano docker-compose.yml
# 啟動
docker compose up -d
```
## 相關文件
- [Docker Compose 詳解](../deployment/docker-compose.md)
- [環境變數說明](../config/environment.md)
- [版本選擇指南](../versions/)
### 我要部署到正式環境
使用 [compose.production.yml](compose.production.yml)，包含：
- Reverse Proxy 設定說明
- 安全性設定建議
- HTTPS 配置範例
### 我想了解所有設定
參考 [compose.reference.yml](compose.reference.yml)，包含所有環境變數的說明。
## 相關文件
- [環境變數完整說明](../environment-variables.md)
- [進階部署指南](../deployment.md)
- [Docker 進階配置](../docker.md)