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

139
docs/多語言/en/Getting-Started/Quick-Start.md Normal file
View file

@ -0,0 +1,139 @@
# Quick Start
> 🌐 **Language / 語言**
> [繁體中文](../../getting-started/quick-start.md) | **English** | [简体中文](../zh-CN/getting-started/quick-start.md)
> 🌐 **Translation Info**
>
> - Original: [繁體中文版](../../getting-started/quick-start.md)
> - Translation Version: v0.1.0
> - Last Updated: 2026-01-23
> - Status: 🚧 In Progress
---
Deploy ConvertX-CN in 5 minutes.
---
## Prerequisites
- Docker 20.10+ ([Install Guide](https://docs.docker.com/get-docker/))
- 4GB+ RAM
- 10GB+ Disk Space
---
## Method 1: Docker Run (Fastest)
### 1. Create Data Folder
```bash
# Linux / macOS
mkdir -p ~/convertx-cn/data && cd ~/convertx-cn
# Windows PowerShell
mkdir C:\convertx-cn\data; cd C:\convertx-cn
# Windows CMD
mkdir C:\convertx-cn\data
cd C:\convertx-cn
```
### 2. Start Container
```bash
docker run -d \
--name convertx-cn \
--restart unless-stopped \
-p 3000:3000 \
-v ./data:/app/data \
-e TZ=Asia/Taipei \
-e JWT_SECRET=your-random-string-at-least-32-chars \
convertx/convertx-cn:latest
```
### 3. Start Using
Open browser: `http://localhost:3000`
1. Click **Register** in the top right corner
2. Enter Email and Password
3. Done! Start converting files
---
## Method 2: Docker Compose (Recommended)
### 1. Create Project Folder
```bash
mkdir -p ~/convertx-cn && cd ~/convertx-cn
```
### 2. Create Configuration File
Create `docker-compose.yml`:
```yaml
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=please-replace-with-a-long-random-string
```
### 3. Start Service
```bash
docker compose up -d
```
---
## Verify Installation
### Check Container Status
```bash
docker ps
# Should see convertx-cn container running
docker logs convertx-cn
# Should see "🦊 Elysia is running at http://localhost:3000"
```
### Health Check
```bash
curl http://localhost:3000/healthcheck
# Should return "OK"
```
---
## Common Startup Issues
| Issue | Solution |
| ------------------------------- | --------------------------------------------- |
| Port already in use | Use another port, e.g., `-p 8080:3000` |
| Redirected to login after login | Add `HTTP_ALLOWED=true` or `TRUST_PROXY=true` |
| Logged out after restart | Set a fixed `JWT_SECRET` |
| Data lost after restart | Confirm `./data:/app/data` and folder exists |
| Permission error | Run `chmod -R 777 ./data` |
---
## Next Steps
- 📖 [Docker Configuration](../deployment/docker.md)
- ⚙️ [Environment Variables](../configuration/environment-variables.md)
- 🔒 [Security Settings](../configuration/security.md)
- 🔧 [Reverse Proxy Setup](../deployment/reverse-proxy.md)

100
docs/多語言/en/Overview.md Normal file
View file

@ -0,0 +1,100 @@
# ConvertX-CN Documentation
> 🌐 **Language / 語言**
> [繁體中文](../../說明文件.md) | **English** | [简体中文](../zh-CN/概述.md)
> 🌐 **Translation Info**
>
> - Original: [繁體中文版](../../說明文件.md)
> - Translation Version: v0.1.0
> - Last Updated: 2026-01-23
> - Status: 🚧 In Progress
> ⚠️ **Translation Notice**
>
> This is a work-in-progress translation. Many links point to pages that haven't been translated yet.
> For complete documentation, please refer to the [繁體中文版](../../說明文件.md).
---
Welcome to ConvertX-CN Documentation! Choose your role to find the information you need.
---
## 🚀 Quick Start
New to ConvertX-CN? Start here:
1. **[Overview](getting-started/overview.md)** — What is ConvertX-CN
2. **[Quick Start](getting-started/quick-start.md)** — Deploy in 5 minutes
3. **[FAQ](getting-started/faq.md)** — Common questions
---
## 👤 User Guide
For general users:
| Document | Description |
| ---------------------------------------------- | ------------------------------------ |
| [Quick Start](getting-started/quick-start.md) | Fastest deployment method |
| [Supported Converters](features/converters.md) | All available formats |
| [OCR](features/ocr.md) | Optical Character Recognition |
| [Translation](features/translation.md) | PDF translation (preserves formulas) |
| [Languages](features/i18n.md) | Interface language settings |
| [FAQ](getting-started/faq.md) | Frequently Asked Questions |
---
## 🛠️ Administrator Guide
For deployment and maintenance:
### Deployment
| Document | Description |
| -------------------------------------------- | --------------------------- |
| [Docker Deployment](deployment/docker.md) | Docker Run & Docker Compose |
| [Reverse Proxy](deployment/reverse-proxy.md) | Nginx / Traefik / Caddy |
| [Sample Configs](samples/README.md) | Ready-to-use configurations |
### Configuration
| Document | Description |
| --------------------------------------------------------------- | --------------------------------- |
| [Environment Variables](configuration/environment-variables.md) | All available settings |
| [Security](configuration/security.md) | HTTPS, authentication, protection |
| [Cleanup & Limits](configuration/limits-and-cleanup.md) | Auto cleanup, resource limits |
---
## 👩‍💻 Developer Guide
For contributors and extension development:
### Development
| Document | Description |
| ----------------------------------------------------- | --------------------- |
| [Project Structure](development/project-structure.md) | Code structure |
| [Local Development](development/local-development.md) | Dev environment setup |
| [Contribution Guide](development/contribution.md) | How to contribute |
### API
| Document | Description |
| --------------------------------- | ------------------ |
| [API Overview](api/overview.md) | REST & GraphQL API |
| [API Endpoints](api/endpoints.md) | Endpoint details |
---
## 🔗 Quick Links
- 📦 [GitHub Repo](https://github.com/pi-docket/ConvertX-CN)
- 🐛 [Issues](https://github.com/pi-docket/ConvertX-CN/issues)
- 💬 [Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)
---
> 💡 **Can't find what you need?** Ask in [GitHub Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)!

100
docs/多語言/ja/概要.md Normal file
View file

@ -0,0 +1,100 @@
# ConvertX-CN ドキュメント
> 🌐 **Language / 語言**
> [繁體中文](../../說明文件.md) | [English](../en/Overview.md) | [简体中文](../zh-CN/概述.md) | **日本語**
> 🌐 **翻訳情報**
>
> - 原文：[繁體中文版](../../說明文件.md)
> - 翻訳バージョン：v0.1.0
> - 最終更新：2026-01-23
> - ステータス：📋 計画中
> ⚠️ **翻訳について**
>
> この翻訳は進行中です。多くのリンクはまだ翻訳されていないページを指しています。
> 完全なドキュメントは [繁體中文版](../../說明文件.md) をご覧ください。
---
ConvertX-CN ドキュメントへようこそ！役割を選択して必要な情報を見つけてください。
---
## 🚀 クイックスタート
初めての方はこちらから：
1. **[概要](getting-started/overview.md)** — ConvertX-CN とは
2. **[クイックスタート](getting-started/quick-start.md)** — 5分でデプロイ
3. **[FAQ](getting-started/faq.md)** — よくある質問
---
## 👤 ユーザーガイド
一般ユーザー向け：
| ドキュメント | 説明 |
| -------------------------------------------------- | ------------------- |
| [クイックスタート](getting-started/quick-start.md) | 最速デプロイ方法 |
| [対応コンバーター](features/converters.md) | 利用可能な変換形式 |
| [OCR機能](features/ocr.md) | 光学文字認識 |
| [翻訳機能](features/translation.md) | PDF翻訳（数式保持） |
| [多言語インターフェース](features/i18n.md) | 言語設定 |
| [FAQ](getting-started/faq.md) | よくある質問 |
---
## 🛠️ 管理者ガイド
デプロイと運用担当者向け：
### デプロイ
| ドキュメント | 説明 |
| ----------------------------------------------- | --------------------------- |
| [Dockerデプロイ](deployment/docker.md) | Docker Run & Docker Compose |
| [リバースプロキシ](deployment/reverse-proxy.md) | Nginx / Traefik / Caddy |
| [設定サンプル](samples/README.md) | すぐ使える設定ファイル |
### 設定
| ドキュメント | 説明 |
| ----------------------------------------------------------- | ---------------------- |
| [環境変数](configuration/environment-variables.md) | 全設定項目 |
| [セキュリティ](configuration/security.md) | HTTPS、認証、保護 |
| [クリーンアップと制限](configuration/limits-and-cleanup.md) | 自動削除、リソース制限 |
---
## 👩‍💻 開発者ガイド
コントリビューターと拡張開発向け：
### 開発
| ドキュメント | 説明 |
| --------------------------------------------------------- | ------------ |
| [プロジェクト構造](development/project-structure.md) | コード構造 |
| [ローカル開発](development/local-development.md) | 開発環境設定 |
| [コントリビューションガイド](development/contribution.md) | 貢献方法 |
### API
| ドキュメント | 説明 |
| ------------------------------------- | ------------------ |
| [API概要](api/overview.md) | REST & GraphQL API |
| [APIエンドポイント](api/endpoints.md) | エンドポイント詳細 |
---
## 🔗 クイックリンク
- 📦 [GitHub Repo](https://github.com/pi-docket/ConvertX-CN)
- 🐛 [Issues](https://github.com/pi-docket/ConvertX-CN/issues)
- 💬 [Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)
---
> 💡 **必要な情報が見つかりませんか？** [GitHub Discussions](https://github.com/pi-docket/ConvertX-CN/discussions) で質問してください！

100
docs/多語言/zh-CN/概述.md Normal file
View file

@ -0,0 +1,100 @@
# ConvertX-CN 文档中心
> 🌐 **Language / 語言**
> [繁體中文](../../說明文件.md) | [English](../en/Overview.md) | **简体中文**
> 🌐 **翻译信息**
>
> - 原文：[繁體中文版](../../說明文件.md)
> - 翻译版本：v0.1.0
> - 最后更新：2026-01-23
> - 状态：📋 计划中
> ⚠️ **翻译说明**
>
> 此翻译正在进行中，许多链接指向尚未翻译的页面。
> 完整文档请参阅 [繁體中文版](../../說明文件.md)。
---
欢迎来到 ConvertX-CN 文档！选择您的角色快速找到所需信息。
---
## 🚀 快速入门
刚开始使用？从这里开始：
1. **[概览](getting-started/overview.md)** — 了解 ConvertX-CN 是什么
2. **[快速开始](getting-started/quick-start.md)** — 5 分钟内完成部署
3. **[常见问题](getting-started/faq.md)** — 解决常见问题
---
## 👤 用户指南
适合一般用户：
| 文档 | 说明 |
| ------------------------------------------ | -------------------- |
| [快速开始](getting-started/quick-start.md) | 最快部署方式 |
| [支持的转换器](features/converters.md) | 所有可用的转换格式 |
| [OCR 功能](features/ocr.md) | 光学字符识别 |
| [翻译功能](features/translation.md) | PDF 翻译（保留公式） |
| [多语言界面](features/i18n.md) | 切换界面语言 |
| [常见问题](getting-started/faq.md) | FAQ |
---
## 🛠️ 系统管理员指南
适合部署与维护人员：
### 部署
| 文档 | 说明 |
| --------------------------------------- | --------------------------- |
| [Docker 部署](deployment/docker.md) | Docker Run & Docker Compose |
| [反向代理](deployment/reverse-proxy.md) | Nginx / Traefik / Caddy |
| [示例配置](samples/README.md) | 可直接使用的配置文件 |
### 配置
| 文档 | 说明 |
| -------------------------------------------------- | ------------------ |
| [环境变量](configuration/environment-variables.md) | 所有可用设置 |
| [安全性设置](configuration/security.md) | HTTPS、认证、防护 |
| [清理与限制](configuration/limits-and-cleanup.md) | 自动清理、资源限制 |
---
## 👩‍💻 开发者指南
适合贡献者与扩展开发：
### 开发
| 文档 | 说明 |
| -------------------------------------------- | ------------ |
| [项目结构](development/project-structure.md) | 代码结构说明 |
| [本地开发](development/local-development.md) | 开发环境设置 |
| [贡献指南](development/contribution.md) | 如何参与项目 |
### API
| 文档 | 说明 |
| ---------------------------- | ------------------ |
| [API 概览](api/overview.md) | REST & GraphQL API |
| [API 端点](api/endpoints.md) | 详细端点说明 |
---
## 🔗 快速链接
- 📦 [GitHub Repo](https://github.com/pi-docket/ConvertX-CN)
- 🐛 [Issues](https://github.com/pi-docket/ConvertX-CN/issues)
- 💬 [Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)
---
> 💡 **找不到您需要的信息？** 欢迎到 [GitHub Discussions](https://github.com/pi-docket/ConvertX-CN/discussions) 发问！

164
docs/多語言/翻譯指南.md Normal file
View file

@ -0,0 +1,164 @@
# 多語言文件支援（Internationalization）
本目錄包含 ConvertX-CN 文件的多語言翻譯版本。
---
## 支援語言
| 語言代碼 | 語言 | 狀態 | 維護者 |
| -------- | -------- | ----------- | -------- |
| `zh-TW` | 繁體中文 | ✅ 主要語言 | 核心團隊 |
| `en` | English | 🚧 進行中 | 待招募 |
| `zh-CN` | 简体中文 | 📋 計畫中 | 待招募 |
| `ja` | 日本語 | 📋 計畫中 | 待招募 |
---
## 目錄結構
```
docs/
├── README.md # 繁體中文（主要語言）
├── getting-started/ # 繁體中文文件
├── deployment/
├── configuration/
├── ...
└── i18n/ # 多語言翻譯
├── README.md # 本文件
├── en/ # English
│ ├── README.md
│ ├── getting-started/
│ └── ...
├── zh-CN/ # 简体中文
│ └── ...
└── ja/ # 日本語
└── ...
```
---
## 翻譯指南
### 翻譯優先順序
1. **核心文件**（優先翻譯）
- `README.md`（文件總覽）
- `getting-started/quick-start.md`
- `getting-started/faq.md`
2. **重要文件**
- `deployment/docker.md`
- `configuration/environment-variables.md`
- `features/converters.md`
3. **進階文件**
- 其他所有文件
### 翻譯規範
1. **保持結構一致**：翻譯後的檔案結構應與原文相同
2. **保留技術術語**：專有名詞可保留英文（如 Docker、API）
3. **更新連結**：確保所有連結指向正確的翻譯版本
4. **標註翻譯狀態**：在文件開頭標註翻譯版本與日期
### 翻譯檔案範本
```markdown
# 文件標題
> 🌐 **翻譯資訊**
>
> - 原文：[繁體中文版](../../getting-started/quick-start.md)
> - 翻譯版本：v0.1.0
> - 最後更新：2026-01-23
> - 翻譯者：@username
---
（翻譯內容）
```
---
## 如何貢獻翻譯
### 1. 選擇要翻譯的文件
查看 [翻譯進度追蹤](#翻譯進度追蹤) 確認哪些文件需要翻譯。
### 2. Fork 專案
```bash
git clone https://github.com/YOUR_USERNAME/ConvertX-CN.git
cd ConvertX-CN
```
### 3. 建立翻譯檔案
```bash
# 例如：翻譯 quick-start.md 為英文
mkdir -p docs/i18n/en/getting-started
cp docs/getting-started/quick-start.md docs/i18n/en/getting-started/
```
### 4. 進行翻譯
編輯檔案，翻譯內容並加上翻譯資訊標頭。
### 5. 提交 Pull Request
```bash
git add .
git commit -m "docs(i18n): add English translation for quick-start.md"
git push origin feature/en-quick-start
```
---
## 翻譯進度追蹤
### English (en)
| 文件 | 狀態 | 翻譯者 |
| -------------------------------------- | --------- | ------ |
| README.md | 🚧 進行中 | - |
| getting-started/overview.md | ⬜ 未開始 | - |
| getting-started/quick-start.md | ⬜ 未開始 | - |
| getting-started/faq.md | ⬜ 未開始 | - |
| deployment/docker.md | ⬜ 未開始 | - |
| deployment/reverse-proxy.md | ⬜ 未開始 | - |
| configuration/environment-variables.md | ⬜ 未開始 | - |
| configuration/security.md | ⬜ 未開始 | - |
| features/converters.md | ⬜ 未開始 | - |
**圖例：** ✅ 完成 | 🚧 進行中 | ⬜ 未開始
---
## 語言切換
### 在文件中加入語言切換
每個翻譯文件的開頭可以加入語言切換連結：
```markdown
> 🌐 **Language / 語言**
> [繁體中文](../../說明文件.md) | [English](en/Overview.md) | [简体中文](zh-CN/概述.md)
```
---
## 相關資源
- [貢獻指南](../開發指南/貢獻指南.md)
- [GitHub Issues - 翻譯](https://github.com/pi-docket/ConvertX-CN/labels/translation)
- [Discussions - 翻譯討論](https://github.com/pi-docket/ConvertX-CN/discussions/categories/translations)
---
## 致謝
感謝所有翻譯貢獻者！
<!-- 翻譯貢獻者名單將在此更新 -->