Refactor Docker Compose examples and documentation

- Updated README.md to include new example files for minimal and production configurations with detailed instructions.
- Added compose.production-alt.example.yml for an annotated production setup.
- Introduced new example files: compose.minimal.example.yml, compose.production.example.yml, nginx.example.conf, and traefik.example.yml for better clarity and usability.
- Removed outdated configuration files and consolidated documentation for OCR language support.
- Adjusted Nginx and Traefik configurations to reflect best practices and added necessary comments for user guidance.
- Minor formatting and consistency improvements across documentation files.
This commit is contained in:
Your Name 2026-01-24 00:36:58 +08:00
parent f6b45627e0
commit 8a84caa503
14 changed files with 175 additions and 821 deletions

View file

@ -6,46 +6,53 @@
## 範例檔案
| 檔案 | 用途 | 說明 |
| --------------------------- | ------------ | ----------------- |
| `最小配置.yml` | 快速啟動 | 最精簡配置 |
| `生產環境配置.yml` | 生產環境 | 包含安全設定 |
| `compose.ocr-languages.yml` | OCR 語言擴展 | 安裝額外 OCR 語言 |
| `Traefik配置.yml` | 反向代理 | Traefik 整合 |
| `Nginx範例配置.conf` | Nginx 設定 | 反向代理設定範例 |
| 檔案 | 用途 | 說明 |
| -------------------------------- | ------------ | ----------------- |
| `compose.minimal.example.yml` | 快速啟動 | 最精簡配置 |
| `compose.production.example.yml` | 生產環境 | 包含安全設定 |
| `compose.ocr-languages.yml` | OCR 語言擴展 | 安裝額外 OCR 語言 |
| `traefik.example.yml` | 反向代理 | Traefik 整合 |
| `nginx.example.conf` | Nginx 設定 | 反向代理設定範例 |
---
## 如何使用
## 快速開始
### 1. 下載範例
### 最小配置(測試 / 個人使用)
```bash
# 下載最小配置
curl -O https://raw.githubusercontent.com/pi-docket/ConvertX-CN/main/docs/samples/compose.minimal.yml
# 1. 複製範例
cp compose.minimal.example.yml docker-compose.yml
# 重命名
mv compose.minimal.yml docker-compose.yml
```
### 2. 修改設定
```bash
# 編輯配置
nano docker-compose.yml
# 重點修改:
# - JWT_SECRET
# - TZ
```
### 3. 啟動
```bash
# 2. 建立資料夾
mkdir -p data
# 3. 修改以下欄位:
# - JWT_SECRET至少 32 字元隨機字串)
# 4. 啟動
docker compose up -d
```
### 生產環境配置
```bash
# 1. 複製範例
cp compose.production.example.yml docker-compose.yml
# 2. 建立資料夾
mkdir -p data
# 3. 修改以下欄位:
# - JWT_SECRET至少 32 字元隨機字串)
# - TZ時區預設 Asia/Taipei
# 4. 啟動
docker compose up -d
```
> 💡 產生隨機 JWT_SECRET`openssl rand -hex 32`
---
## 相關文件