Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
191 lines (147 loc) · 4.47 KB

DEPLOYMENT.md

File metadata and controls

191 lines (147 loc) · 4.47 KB

部署指南 / Deployment Guide

English | 中文

中文

Docker Hub 自动部署

此项目已配置 GitHub Actions，会自动构建并推送 Docker 镜像到 Docker Hub。

触发条件

  • 推送到 main 或 master 分支
  • 创建新的版本标签 (v*)
  • 提交 Pull Request（仅构建，不推送）

镜像标签策略

  • latest - 最新的 main 分支构建
  • v1.0.1 - 具体版本号
  • 1.0 - 主要版本号
  • 1 - 大版本号

使用预构建镜像

Docker Hub仓库：https://hub.docker.com/r/zerob13/mock-openai-api

# 拉取最新镜像
docker pull zerob13/mock-openai-api:latest

# 运行容器
docker run -d -p 3000:3000 --name mock-openai-api zerob13/mock-openai-api:latest

# 检查健康状态
curl http://localhost:3000/health

Docker Compose 部署

  1. 下载 docker-compose.yml 文件
  2. 根据需要修改环境变量
  3. 启动服务：
docker-compose up -d

生产环境部署建议

1. 使用具体版本标签

docker run -d -p 3000:3000 zerob13/mock-openai-api:v1.0.1

2. 配置反向代理（Nginx）

server {
    listen 80;
    server_name your-domain.com;
    
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        
        # 支持 Server-Sent Events
        proxy_buffering off;
        proxy_cache off;
        proxy_set_header Connection '';
        proxy_http_version 1.1;
        chunked_transfer_encoding off;
    }
}

3. 设置资源限制

docker run -d \
  --name mock-openai-api \
  --restart unless-stopped \
  --memory="256m" \
  --cpus="0.5" \
  -p 3000:3000 \
  zerob13/mock-openai-api:latest

环境变量配置

变量名 描述 默认值
NODE_ENV Node.js 环境 production
PORT 服务端口 3000
HOST 绑定地址 0.0.0.0
VERBOSE 详细日志 false
TZ 时区设置 UTC

English

Automatic Docker Hub Deployment

This project is configured with GitHub Actions to automatically build and push Docker images to Docker Hub.

Trigger Conditions

  • Push to main or master branch
  • Create new version tags (v*)
  • Submit Pull Request (build only, no push)

Image Tagging Strategy

  • latest - Latest main branch build
  • v1.0.1 - Specific version number
  • 1.0 - Major version number
  • 1 - Major version number

Using Pre-built Images

Docker Hub Repository: https://hub.docker.com/r/zerob13/mock-openai-api

# Pull latest image
docker pull zerob13/mock-openai-api:latest

# Run container
docker run -d -p 3000:3000 --name mock-openai-api zerob13/mock-openai-api:latest

# Check health status
curl http://localhost:3000/health

Docker Compose Deployment

  1. Download the docker-compose.yml file
  2. Modify environment variables as needed
  3. Start services:
docker-compose up -d

Production Deployment Recommendations

1. Use Specific Version Tags

docker run -d -p 3000:3000 zerob13/mock-openai-api:v1.0.1

2. Configure Reverse Proxy (Nginx)

server {
    listen 80;
    server_name your-domain.com;
    
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        
        # Support Server-Sent Events
        proxy_buffering off;
        proxy_cache off;
        proxy_set_header Connection '';
        proxy_http_version 1.1;
        chunked_transfer_encoding off;
    }
}

3. Set Resource Limits

docker run -d \
  --name mock-openai-api \
  --restart unless-stopped \
  --memory="256m" \
  --cpus="0.5" \
  -p 3000:3000 \
  zerob13/mock-openai-api:latest

Environment Variables

Variable Description Default
NODE_ENV Node.js environment production
PORT Server port 3000
HOST Bind address 0.0.0.0
VERBOSE Verbose logging false
TZ Timezone setting UTC