convertor/docs/getting-started.md
Your Name 53b83b425f feat: rebrand to ConvertX-CN, fix TypeScript error, add docs
- Fix TypeScript TS2345 error in i18n/service.ts by parsing cookie from header
- Rebrand all ConvertX references to ConvertX-CN
- Change default language from en to zh-TW
- Fix footer to always display English 'Powered by ConvertX-CN'
- Update GitHub links to pi-docket/ConvertX-CN
- Add /docs folder with documentation:
  - getting-started.md
  - configuration.md
  - converters.md
  - i18n.md
- Update all locale files with new branding
2026-01-20 10:29:17 +08:00

68 lines
1.2 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+
- Docker Compose v2+(推薦)
- 至少 4GB RAM建議 8GB
- 10GB 磁碟空間(用於 Docker image
## 安裝方式
### 方法一Docker Run
```bash
docker run -d \
--name convertx-cn \
-p 3000:3000 \
-v ./data:/app/data \
-e TZ=Asia/Taipei \
convertx/convertx-cn:latest
```
### 方法二Docker Compose推薦
建立 `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=false
- HTTP_ALLOWED=false
- AUTO_DELETE_EVERY_N_HOURS=24
```
啟動服務:
```bash
docker compose up -d
```
## 首次設定
1. 開啟瀏覽器訪問 `http://localhost:3000`
2. 建立第一個帳號(此帳號即為管理員)
3. 登入後即可開始使用
## 更新版本
```bash
docker compose pull
docker compose up -d
```
## 下一步
- 查看 [環境變數設定](./configuration.md)
- 瞭解 [支援的轉換器](./converters.md)
- 閱讀 [多語言設定](./i18n.md)