convmind/soco-training-studio

Soco Training Studio 镜像文档

镜像概述和主要用途

Soco Training Studio注解模式镜像用于部署和运行注解功能模块，需依赖MongoDB数据库存储数据。通过配置环境变量可自定义后端服务URL、管理员注册密钥等关键参数，支持前端资源构建与后端服务启动，适用于数据注解场景的开发与运行环境。

核心功能和特性

• 注解模式支持：通过设置ANNOTATION_ONLY=True启用纯注解功能模式
• 数据库依赖：需连接MongoDB数据库，数据存储路径通过环境变量配置
• 环境变量配置：支持自定义数据库连接URL、后端服务地址、管理员注册密钥等参数
• 开发与生产模式：提供开发模式（实时监控文件变化）和生产模式（资源优化打包）
• 前后端集成：包含前端资源构建（webpack-dev-server）和后端服务（node server）启动能力

使用场景和适用范围

适用于需要使用Soco Training Studio进行数据注解的开发环境，尤其适合仅需启用注解功能的场景，支持开发阶段的实时调试和生产环境的资源优化部署。

详细使用方法和配置说明

前提条件

• 已安装并运行MongoDB服务器
• 已准备环境变量配置文件（推荐.env文件）

环境变量配置

需配置以下环境变量，可通过.env文件管理：

示例.env文件：

env
TRAINER_MONGODB_URL=mongodb://localhost:6005/trainer
BACKEND_URL=http://localhost:3031
SECRET_CODE=secret_code
ANNOTATION_ONLY=True

启动步骤

1. 启动MongoDB服务器

确保MongoDB服务器已运行，且TRAINER_MONGODB_URL指向正确的数据库端点。

2. 构建前端资源（开发模式）

执行以下命令打包前端文件并监控变化：

bash
npm run build

3. 启动后端服务

执行以下命令启动Node.js服务器：

bash
npm run start

开发注意事项

• 前端修改：修改前端文件后，刷新页面即可查看更新
• 后端修改：修改后端文件后，需重新执行npm run start以应用更新
• 生产模式准备：推送代码前，停止开发模式的build进程，执行以下命令进行生产环境资源打包：

  bash
  npm run prepublishOnly
  

Docker部署示例

docker run命令

bash
docker run -d \
  --name soco-annotation \
  -p 3031:3031 \
  --env-file .env \
  --link mongodb:mongodb \
  docker.xuanyuan.run/soco-training-studio \
  sh -c "npm run build && npm run start"

说明：需先启动MongoDB容器（名称为mongodb），并将.env文件中的TRAINER_MONGODB_URL调整为容器内地址（如mongodb://mongodb:27017/trainer）

docker-compose配置示例

yaml
version: '3'
services:
  mongodb:
    image: mongo:latest
    ports:
      - "6005:27017"
    volumes:
      - mongodb_data:/data/db

  soco-annotation:
    image: soco-training-studio
    depends_on:
      - mongodb
    ports:
      - "3031:3031"
    env_file: .env
    command: sh -c "npm run build && npm run start"

volumes:
  mongodb_data: