convertor/docs/部署指南/快速開始.md
Your Name 3f1a5e0fbf Add comprehensive documentation for ConvertX-CN deployment and configuration
- 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
2026-01-23 22:05:09 +08:00

2.8 KiB
Raw Blame History

快速部署指南

本文件提供 ConvertX-CN 的完整部署步驟,適合第一次使用 Docker 的使用者。


前置需求


步驟 1安裝 Docker

Windows / macOS

下載並安裝 Docker Desktop

Linux

curl -fsSL https://get.docker.com | sh
sudo usermod -aG docker $USER
# 登出再登入,讓群組生效

驗證安裝:

docker --version
docker compose version

步驟 2建立專案資料夾

Linux / macOS

mkdir -p ~/convertx-cn/data
cd ~/convertx-cn

Windows (PowerShell)

mkdir C:\convertx-cn\data
cd C:\convertx-cn

⚠️ data 資料夾必須先建立,否則 Docker 會建立匿名 volume導致資料難以存取。


步驟 3建立 docker-compose.yml

在專案資料夾建立 docker-compose.yml

💡 JWT_SECRET 請改成你自己的隨機字串(至少 32 字元)

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=your-random-secret-at-least-32-chars

必要參數說明

參數 說明
./data 存放上傳檔案與轉換結果,必須先建立
JWT_SECRET 登入驗證金鑰,不設會每次重啟被登出

步驟 4啟動服務

docker compose up -d

首次執行會下載映像檔(約 4-6 GB需等待幾分鐘。

查看狀態:

docker compose ps
docker compose logs -f  # Ctrl+C 退出

步驟 5使用

  1. 開啟瀏覽器,訪問 http://localhost:3000
  2. 點擊 Register 註冊帳號
  3. 開始轉換檔案

首次註冊的帳號會自動成為管理員。


常見問題

問題 解法
登入後又被踢回登入頁 加上 HTTP_ALLOWED=true
重啟後資料消失 確認 ./data:/app/data 且資料夾存在
重啟後被登出 設定固定的 JWT_SECRET
3000 埠被佔用 改用 "8080:3000"

更多問題請參考 FAQ


下一步