跳到主要内容

Docker Compose 部署

本文档详细介绍如何使用 Docker Compose 部署 UPage，这是一种更便捷的方式来管理 UPage 的部署。

前置条件​

在开始之前，请确保您的系统满足以下要求：

  • Docker 已安装（推荐 Docker 20.10.0 或更高版本）
  • Docker Compose 已安装（推荐 Docker Compose 1.29.0 或更高版本）
  • 至少 2GB 可用内存
  • 至少 2GB 可用磁盘空间
  • 互联网连接（用于拉取 Docker 镜像和访问大模型 API）

安装 Docker 和 Docker Compose​

如果您的系统未安装 Docker，请参考Docker 官方文档进行安装。 如果您的系统未安装 Docker Compose，请参考Docker Compose 官方文档进行安装。

使用 Docker Compose 部署​

准备目录​

创建必要的目录用于持久化数据，例如 ~/upage：

mkdir -p ~/upage/data
mkdir -p ~/upage/logs
mkdir -p ~/upage/storage
cd ~/upage
提示

UPage 所有数据与日志均存储在此目录中，请妥善保管。

创建配置文件​

创建 docker-compose.yml 文件：

version: "3.9"
services:
  upage:
    image: upage-ai:production
    restart: unless-stopped
    ports:
      - "${PORT:-3000}:3000"
    environment:
      - LLM_PROVIDER=${LLM_PROVIDER}
      - PROVIDER_BASE_URL=${PROVIDER_BASE_URL}
      - PROVIDER_API_KEY=${PROVIDER_API_KEY}
      - LLM_DEFAULT_MODEL=${LLM_DEFAULT_MODEL}
      - LLM_MINOR_MODEL=${LLM_MINOR_MODEL}
    volumes:
      - ./data:/app/data
      - ./logs:/app/logs
      - ./storage:/app/storage

volumes:
  upage-db:

启动服务​

在 docker-compose.yml 文件所在目录执行：

docker-compose up -d

服务管理​

使用 Docker Compose 管理服务的常用命令：

# 启动服务
docker-compose up -d

# 停止服务
docker-compose down

# 重启服务
docker-compose restart

# 查看服务日志
docker-compose logs

# 查看服务状态
docker-compose ps

环境变量配置​

UPage 支持通过环境变量进行配置。以下是一些比较重要的环境变量：

提示

完整的配置请参考配置参考。

基础配置​

环境变量描述默认值
PORT服务监听端口3000
NODE_ENVNode.js 环境production
OPERATING_ENV运行环境production
LOG_LEVEL日志级别debug
USAGE_LOG_FILE是否开启文件日志true
MAX_UPLOAD_SIZE_MB附件上传的最大大小 (MB)5
STORAGE_DIR资源文件存储位置/app/storage

模型提供商配置​

根据您选择的 AI 提供商，您还需要配置相应的 API 密钥和基础 URL，例如：

环境变量描述必填示例
LLM_PROVIDER默认 LLM 提供商是OpenAI
PROVIDER_BASE_URLOpenAI 兼容 API 基础 URL否https://your-api-base-url
PROVIDER_API_KEYOpenAI 兼容 API 密钥否your-openai-api-key

大模型配置​

环境变量描述必填示例
LLM_DEFAULT_MODEL生成页面所使用的主要模型是gpt-4-turbo
LLM_MINOR_MODEL辅助页面生成所使用的次级模型是gpt-3.5-turbo

升级 UPage​

当有新版本发布时，您可以按照以下步骤升级 UPage：

docker-compose pull
docker-compose down
docker-compose up -d

下一步​