![ConvertX-CN](images/logo.png) # ConvertX-CN **開箱即用的全功能檔案轉換服務** — 一個 Docker 命令，5 分鐘部署完成 [![Docker Pulls](https://img.shields.io/docker/pulls/convertx/convertx-cn?style=flat&logo=docker)](https://hub.docker.com/r/convertx/convertx-cn) [![GitHub Release](https://img.shields.io/github/v/release/pi-docket/ConvertX-CN)](https://github.com/pi-docket/ConvertX-CN/releases) [![License AGPL-3.0](https://img.shields.io/badge/license-AGPL--3.0-blue)](LICENSE) ![Docker Image Size (Latest Lite)]() --- ## 為什麼選擇 ConvertX-CN？ | 特色 | 說明 | | ----------------- | --------------------------------------- | | 📁 **1000+ 格式** | 文件、圖片、影音、電子書一次搞定 | | 🔧 **25+ 引擎** | LibreOffice、FFmpeg、Pandoc 全到位 | | 🈶 **中文優化** | 內建中日韓字型與 OCR，告別亂碼 | | 🌐 **65 種語言** | 跨國團隊無障礙使用 | | 📊 **PDF 翻譯** | PDFMathTranslate + BabelDOC 雙引擎 | | 📄 **PDF 轉 MD** | MinerU 智能擷取（保留表格、公式、圖片） | --- ## 📚 文件目錄 完整文件請參閱 **[專案總覽](docs/00-專案總覽.md)** | 章節 | 說明 | 連結 | | ---- | ---- | ---- | | 📖 **00 專案總覽** | 專案定位、功能特色、版本比較 | [查看](docs/00-專案總覽.md) | | 🚀 **01 快速開始** | 5 分鐘部署完成 | [查看](docs/01-快速開始.md) | | 🐳 **02 部署指南** | Docker 設定、反向代理、HTTPS | [查看](docs/02-部署指南.md) | | ⚙️ **03 環境變數** | 所有可用設定與推薦值 | [查看](docs/03-環境變數與設定.md) | | 🔌 **04 功能總覽** | 轉換器、OCR、PDF 翻譯 | [查看](docs/04-功能總覽.md) | | 🔗 **05 API 文件** | REST & GraphQL API | [查看](docs/05-API文件.md) | | 🔧 **06 錯誤排查** | 常見問題與解決方案 | [查看](docs/06-錯誤排查與支援.md) | | 👩‍💻 **07 開發指南** | 專案結構、貢獻規範 | [查看](docs/07-開發與貢獻指南.md) | | 📄 **08 授權說明** | AGPL-3.0 授權 | [查看](docs/08-授權說明.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=Xk9mPqL2vN7wR4tY6uI8oA3sD5fG1hJ0 \ convertx/convertx-cn:latest ``` > ⚠️ **安全提醒**：正式環境請更換 `JWT_SECRET` 為自己的隨機字串（至少 32 字元） 開啟瀏覽器：`http://localhost:3000` ### Docker Compose（推薦） > 💡 以下命令會自動建立 `~/convertx-cn/data` 資料夾、產生 `docker-compose.yml` 並啟動服務 ```bash mkdir -p ~/convertx-cn/data && cd ~/convertx-cn && \ 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=Xk9mPqL2vN7wR4tY6uI8oA3sD5fG1hJ0 EOF docker compose up -d ``` > ⚠️ **安全提醒**：正式環境請更換 `JWT_SECRET` 為自己的隨機字串（至少 32 字元） 開啟瀏覽器：`http://localhost:3000` > 📖 詳細說明請參閱 [快速開始](docs/快速入門/快速開始.md) --- ## 🔗 線上示範 [![Live Demo](https://img.shields.io/badge/demo-online-brightgreen)](https://convertx-cn.bioailab.qzz.io) 🔗 **https://convertx-cn.bioailab.qzz.io** | 項目 | 內容 | | ---- | ----------------- | | 帳號 | admin@example.com | | 密碼 | admin | > ⚠️ 示範站僅供測試，請勿上傳敏感檔案，會定期清理資料。 --- ## ⚡ 常見問題速查 | 問題 | 解決方法 | | ------------------ | ---------------------------------------------- | | 登入後被踢回登入頁 | 加上 `HTTP_ALLOWED=true` 或 `TRUST_PROXY=true` | | 重啟後資料消失 | 確認 `./data:/app/data` 且資料夾存在 | | 重啟後被登出 | 設定固定的 `JWT_SECRET` | 更多問題 → [FAQ](docs/快速入門/常見問題.md) --- ## 📦 支援格式 | 轉換器 | 用途 | 格式數 | | ---------------- | --------------- | ------ | | FFmpeg | 影音 | 400+ | | ImageMagick | 圖片 | 200+ | | LibreOffice | 文件 | 60+ | | Pandoc | 文件 | 100+ | | Calibre | 電子書 | 40+ | | Inkscape | 向量圖 | 20+ | | PDFMathTranslate | PDF 翻譯 | 15+ | | BabelDOC | PDF 翻譯/轉換 | 15+ | | MinerU | PDF 轉 Markdown | 10+ | 完整列表 → [轉換器文件](docs/功能說明/轉換器.md) --- ## 🖼️ 預覽 ![ConvertX-CN Preview](images/preview.png) --- ## 🔄 更新 ```bash docker compose down docker compose pull docker compose up -d ``` --- ## 🎯 版本選擇：Lite / 一般版 / Full ConvertX-CN 提供三個版本，滿足不同需求： | 特性 | Lite 版 | 一般版（推薦） | Full 版 | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | ------------ | | **Image 大小** | ![Docker Image Size (Lite)]() | ![Docker Image Size](https://img.shields.io/docker/image-size/convertx/convertx-cn/latest?label=image%20size%20) | 約 12-15+ GB | | **部署速度** | 最快 | 中等 | 較慢 | | **適用對象** | 輕量使用者 | 一般使用者 | 進階/多語言 | | **基本轉檔** | ✅ | ✅ | ✅ | | **OCR（7語言）** | ❌ | ✅ | ✅ | | **PDF 翻譯** | ❌ | ✅ | ✅ | | **MinerU AI** | ❌ | ✅ | ✅ | | **OCR（65語言）** | ❌ | ❌ | ✅ | | **完整 TexLive** | ❌ | ❌ | ✅ | ### 版本標籤 | Tag | 說明 | | ------------- | ----------------- | | `latest` | 一般版最新穩定版 | | `latest-lite` | Lite 版最新穩定版 | | `0.1.16` | 一般版指定版本 | | `0.1.16-lite` | Lite 版指定版本 | ### Lite 版快速啟動 ```bash docker run -d \ --name convertx-cn-lite \ -p 3000:3000 \ -v ./data:/app/data \ -e JWT_SECRET=你的隨機字串至少32字元 \ convertx/convertx-cn:latest-lite ``` > 📖 詳細說明請參閱 [部署指南](docs/02-部署指南.md) --- ## 📄 授權 本專案採用 **[GNU Affero General Public License v3.0 (AGPL-3.0)](LICENSE)** 授權。 ### 授權摘要 | 權利 | 說明 | |------|------| | ✅ 自由使用 | 個人、商業、教育用途均可 | | ✅ 自由修改 | 可修改原始碼 | | ✅ 自由分發 | 可重新分發 | ### 義務 - 分發時需保留授權聲明 - 修改後需公開原始碼 - 網路服務需提供原始碼取得方式 - 衍生作品需使用相同授權 > 📖 詳細說明請參閱 [授權說明](docs/08-授權說明.md) --- ## 🙏 致謝 本專案基於 [C4illin/ConvertX](https://github.com/C4illin/ConvertX) 開發，感謝原作者的貢獻。 --- ## 📞 聯繫方式 - **GitHub Issues**: [建立 Issue](https://github.com/pi-docket/ConvertX-CN/issues) - **GitHub Discussions**: [社群討論](https://github.com/pi-docket/ConvertX-CN/discussions)