da856d89ff
- Create README.md for internationalization (i18n) documentation - Add English translation for main README and quick start guide - Add Japanese translation for main README - Add Simplified Chinese translation for main README - Introduce sample Docker Compose configurations for various deployment scenarios - Implement CI/CD documentation for testing and deployment workflows - Establish end-to-end testing guidelines and strategies - Create test strategy documentation outlining unit, integration, and E2E tests
147 lines
4.7 KiB
Markdown
147 lines
4.7 KiB
Markdown
|
||
|
||
# ConvertX-CN
|
||
|
||
**開箱即用的全功能檔案轉換服務** — 一個 Docker 命令，5 分鐘部署完成
|
||
|
||
[](https://hub.docker.com/r/convertx/convertx-cn)
|
||
[](https://github.com/pi-docket/ConvertX-CN/releases)
|
||
|
||
---
|
||
|
||
## 為什麼選擇 ConvertX-CN？
|
||
|
||
| 特色 | 說明 |
|
||
| ----------------- | ------------------------------------ |
|
||
| 📁 **1000+ 格式** | 文件、圖片、影音、電子書一次搞定 |
|
||
| 🔧 **20+ 引擎** | LibreOffice、FFmpeg、Pandoc 全到位 |
|
||
| 🈶 **中文優化** | 內建中日韓字型與 OCR，告別亂碼 |
|
||
| 🌐 **65 種語言** | 跨國團隊無障礙使用 |
|
||
| 📊 **PDF 翻譯** | 數學公式完整保留（PDFMathTranslate） |
|
||
|
||
---
|
||
|
||
## 📚 文件
|
||
|
||
完整文件請參閱 **[文件中心](docs/README.md)**
|
||
|
||
| 分類 | 連結 |
|
||
| ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||
| 🚀 快速入門 | [概覽](docs/getting-started/overview.md) · [快速開始](docs/getting-started/quick-start.md) · [FAQ](docs/getting-started/faq.md) |
|
||
| 🐳 部署指南 | [Docker](docs/deployment/docker.md) · [反向代理](docs/deployment/reverse-proxy.md) |
|
||
| ⚙️ 配置設定 | [環境變數](docs/configuration/environment-variables.md) · [安全性](docs/configuration/security.md) |
|
||
| 🔌 功能說明 | [轉換器](docs/features/converters.md) · [OCR](docs/features/ocr.md) · [翻譯](docs/features/translation.md) |
|
||
| 🔗 API | [API 總覽](docs/api/overview.md) · [端點說明](docs/api/endpoints.md) |
|
||
| 👩💻 開發 | [專案結構](docs/development/project-structure.md) · [貢獻指南](docs/development/contribution.md) |
|
||
|
||
---
|
||
|
||
## 🚀 快速開始
|
||
|
||
### Docker Compose（推薦）
|
||
|
||
```bash
|
||
# 1. 建立專案資料夾
|
||
mkdir -p ~/convertx-cn && cd ~/convertx-cn
|
||
|
||
# 2. 建立 docker-compose.yml
|
||
cat > docker-compose.yml << 'EOF'
|
||
services:
|
||
convertx:
|
||
image: convertx/convertx-cn:latest
|
||
container_name: convertx-cn
|
||
restart: unless-stopped
|
||
ports:
|
||
- "3000:3000"
|
||
volumes:
|
||
- ./data:/app/data
|
||
environment:
|
||
- TZ=Asia/Taipei
|
||
- JWT_SECRET=請更換為長且隨機的字串至少32字元
|
||
EOF
|
||
|
||
# 3. 啟動
|
||
docker compose up -d
|
||
```
|
||
|
||
開啟瀏覽器：`http://localhost:3000`
|
||
|
||
> 📖 詳細說明請參閱 [快速開始](docs/getting-started/quick-start.md)
|
||
|
||
### Docker Run
|
||
|
||
```bash
|
||
mkdir -p ~/convertx-cn/data && cd ~/convertx-cn
|
||
|
||
docker run -d \
|
||
--name convertx-cn \
|
||
--restart unless-stopped \
|
||
-p 3000:3000 \
|
||
-v ./data:/app/data \
|
||
-e TZ=Asia/Taipei \
|
||
-e JWT_SECRET=請更換為長且隨機的字串 \
|
||
convertx/convertx-cn:latest
|
||
```
|
||
|
||
---
|
||
|
||
## 🔗 線上示範
|
||
|
||
🔗 **https://convertx-cn.bioailab.qzz.io**
|
||
|
||
| 項目 | 內容 |
|
||
| ---- | ----------------- |
|
||
| 帳號 | admin@example.com |
|
||
| 密碼 | admin |
|
||
|
||
> ⚠️ 示範站僅供測試，請勿上傳敏感檔案
|
||
|
||
---
|
||
|
||
## ⚡ 常見問題速查
|
||
|
||
| 問題 | 解決方法 |
|
||
| ------------------ | ---------------------------------------------- |
|
||
| 登入後被踢回登入頁 | 加上 `HTTP_ALLOWED=true` 或 `TRUST_PROXY=true` |
|
||
| 重啟後資料消失 | 確認 `./data:/app/data` 且資料夾存在 |
|
||
| 重啟後被登出 | 設定固定的 `JWT_SECRET` |
|
||
|
||
更多問題 → [FAQ](docs/getting-started/faq.md)
|
||
|
||
---
|
||
|
||
## 📦 支援格式
|
||
|
||
| 轉換器 | 用途 | 格式數 |
|
||
| ---------------- | -------- | ------ |
|
||
| FFmpeg | 影音 | 400+ |
|
||
| ImageMagick | 圖片 | 200+ |
|
||
| LibreOffice | 文件 | 60+ |
|
||
| Pandoc | 文件 | 100+ |
|
||
| Calibre | 電子書 | 40+ |
|
||
| Inkscape | 向量圖 | 20+ |
|
||
| PDFMathTranslate | PDF 翻譯 | 15+ |
|
||
|
||
完整列表 → [轉換器文件](docs/features/converters.md)
|
||
|
||
---
|
||
|
||
## 🖼️ 預覽
|
||
|
||
|
||
|
||
---
|
||
|
||
## 🔄 更新
|
||
|
||
```bash
|
||
docker compose down
|
||
docker compose pull
|
||
docker compose up -d
|
||
```
|
||
|
||
---
|
||
|
||
## 📄 License
|
||
|
||
[MIT](LICENSE) | 基於 [C4illin/ConvertX](https://github.com/C4illin/ConvertX)
|