convertor/docs/getting-started.md
Your Name 5c68308c36 feat: 擴展 i18n 支援 65 種語言 + 完整文件系統
🌐 國際化 (i18n)
- 從 5 種語言擴展到 65 種語言支援
- 新增:歐洲語系 (de, fr, es, it, pt, ru, nl, pl, tr, uk, cs, sv, da, fi, no, el, hu, ro, bg, hr, sk, sl, lt, lv, et, is, ga, cy, mt, mk, sq, ca, eu, gl, sr)
- 新增:中東語系 (ar, he, fa)
- 新增:南亞語系 (hi, bn, ta, te, mr, gu, kn, ml, ne, si)
- 新增:東南亞語系 (th, vi, id, ms, fil, my, km, lo)
- 新增:非洲語系 (af, sw, am, zu)
- 完整翻譯所有 UI 文字

📖 文件系統
- 重構 README.md 為入口型首頁
- 新增 docs/getting-started.md - 快速入門指南
- 新增 docs/docker.md - Docker 部署指南
- 新增 docs/environment-variables.md - 環境變數說明
- 新增 docs/url-id-and-storage.md - 儲存結構說明
- 新增 docs/advanced-usage.md - 進階使用指南
- 更新 docs/i18n.md - 65 種語言清單

 建構驗證
- TypeScript 編譯通過
- Docker 建構通過
2026-01-20 11:30:21 +08:00

145 lines
2.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 快速開始
## 系統需求
| 需求 | 最低 | 建議 |
|------|------|------|
| Docker | 20.10+ | 24.0+ |
| RAM | 4 GB | 8 GB |
| 磁碟空間 | 10 GB | 20 GB |
| CPU | 2 核心 | 4 核心 |
---
## 最快方式:一行指令
```bash
docker run -d -p 3000:3000 -v ./data:/app/data -e ACCOUNT_REGISTRATION=true convertx/convertx-cn:latest
```
開啟瀏覽器訪問 `http://localhost:3000`,註冊帳號即可開始使用!
---
## 推薦方式Docker Compose
### 1. 建立配置檔
建立 `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=請更換為一個長且隨機的字串
- ACCOUNT_REGISTRATION=true
- HTTP_ALLOWED=false
- AUTO_DELETE_EVERY_N_HOURS=24
```
### 2. 啟動服務
```bash
docker compose up -d
```
### 3. 開始使用
1. 開啟瀏覽器訪問 `http://localhost:3000`
2. 點擊「Register」建立帳號
3. 登入後即可開始轉換檔案!
---
## 首次設定
### 建立管理員帳號
首次訪問時ConvertX-CN 會顯示設定頁面,讓您建立第一個帳號。此帳號即為管理員。
### 註冊功能
- `ACCOUNT_REGISTRATION=true`:允許其他人註冊
- `ACCOUNT_REGISTRATION=false`:停用註冊(單人使用)
---
## 驗證安裝
### 檢查容器狀態
```bash
docker ps
# 應該看到 convertx-cn 容器正在運行
docker logs convertx-cn
# 應該看到 "🦊 Elysia is running at http://localhost:3000"
```
### 健康檢查
```bash
curl http://localhost:3000/healthcheck
# 應該返回 "OK"
```
---
## 更新版本
```bash
# Docker Compose
docker compose pull
docker compose up -d
# 或 Docker Run
docker pull convertx/convertx-cn:latest
docker stop convertx-cn
docker rm convertx-cn
# 然後重新執行 docker run 指令
```
---
## 常見問題
### 無法訪問頁面
1. 確認容器正在運行:`docker ps`
2. 檢查連接埠是否被占用:`netstat -an | grep 3000`
3. 查看錯誤日誌:`docker logs convertx-cn`
### 權限錯誤
```bash
# 確保 data 目錄有正確權限
chmod -R 777 ./data
```
### 記憶體不足
ConvertX-CN 內建完整依賴,建議至少 4GB RAM。可透過 Docker 限制記憶體使用:
```yaml
deploy:
resources:
limits:
memory: 4G
```
---
## 下一步
- 📖 [Docker 配置](docker.md) - 進階 Docker 設定
- ⚙️ [環境變數](environment-variables.md) - 所有可用設定
- 🔧 [進階用法](advanced-usage.md) - 硬體加速、反向代理
- 🌍 [多語言](i18n.md) - 語言設定與自訂