gamedb/consumers

Global Steam 镜像文档

镜像概述和主要用途

Global Steam是一个采用多进程架构的应用系统，其功能组件（如前端、后端等）通过独立进程分离运行。该系统依赖环境变量进行配置管理，并需要多种第三方服务（如消息队列、数据库、缓存等）协同工作，适用于需要复杂服务架构支持的应用开发与部署场景。

核心功能和特性

• 多进程架构：系统功能按进程划分，位于./cmd目录，可通过脚本独立运行（如前端、后端进程）
• 环境变量配置：所有配置通过环境变量管理，完整配置项可在config.go中查看，运行时会对缺失的必填配置发出警告
• 依赖管理：通过npm安装项目依赖，确保运行环境一致性
• 第三方服务集成：支持RabbitMQ（消息队列）、Memcached（缓存）、MongoDB（文档数据库）、InfluxDB（时序数据库）、MySQL（关系型数据库）、Elasticsearch（搜索引擎）等多种服务
• 资产编译：提供Sass和JS文件的编译能力，通过npm run webpack命令更新资产

使用场景和适用范围

适用于需要多种服务协同工作的复杂应用开发与部署，尤其适合依赖消息队列、多类型数据库、缓存及搜索引擎的业务场景，如大型Web应用、数据处理平台等。

使用方法和配置说明

1. 安装依赖

首次运行前需安装项目依赖：

bash
npm install

2. 运行进程

系统功能按进程划分，通过 helper 脚本运行，位于./cmd目录，支持的进程包括前端（frontend）、后端（backend）等，命令格式：

bash
./run <进程名>

示例：

bash
# 运行前端进程
./run frontend

# 运行后端进程
./run backend

3. 环境变量配置

所有配置通过环境变量管理，完整配置项可在config.go中查看。运行进程时，若缺失必填配置，系统会自动发出警告。建议根据实际需求设置环境变量，确保服务正常运行。

4. 部署第三方服务

Global Steam依赖多种第三方服务，可通过以下两种方式安装：

4.1 通过Brew安装（适用于macOS）

bash
# 添加MongoDB源
brew tap mongodb/brew

# 安装所有依赖服务
brew install rabbitmq memcached mongodb-community@4.2 influxdb mysql elasticsearch

4.2 通过Docker部署（推荐）

使用docker-compose配置部署所有依赖服务，创建docker-compose.yml文件，内容如下：

yaml
version: '3.7'

services:
  rabbit:
    container_name: rabbit
    hostname: rabbit
    image: rabbitmq:latest
    ports:
      - "5672:5672"  # RabbitMQ默认端口
    restart: "unless-stopped"
    volumes:
      - ${DATA_DIR}/rabbitmq:/var/lib/rabbitmq  # 持久化数据目录

  memcache:
    container_name: memcache
    hostname: memcache
    image: memcached:latest
    restart: "unless-stopped"
    ports:
      - "11211:11211"  # Memcached默认端口

  mongo:
    container_name: mongo
    hostname: mongo
    image: mongo:4.2
    restart: "unless-stopped"
    ports:
      - "27017:27017"  # MongoDB默认端口
    volumes:
      - ${DATA_DIR}/mongodb:/data/db  # 持久化数据目录

  influx:
    container_name: influx
    hostname: influx
    image: influxdb:1.7
    restart: "unless-stopped"
    ports:
      - "8086:8086"  # InfluxDB默认端口
    volumes:
      - ${DATA_DIR}/influxdb/data:/root/.influxdb/data  # 数据目录
      - ${DATA_DIR}/influxdb/wal:/root/.influxdb/wal    # WAL目录
      - ${DATA_DIR}/influxdb/meta:/root/.influxdb/meta  # 元数据目录

  mysql:
    container_name: mysql
    hostname: mysql
    image: mysql:8.0
    ports:
      - "3306:3306"  # MySQL默认端口
    restart: "unless-stopped"
    environment:
      - MYSQL_DATABASE  # 数据库名称（需提前设置环境变量）
      - MYSQL_ROOT_PASSWORD  # root密码（需提前设置环境变量）
    volumes:
      - ${DATA_DIR}/mysql:/var/lib/mysql  # 持久化数据目录

  search:
    container_name: search
    hostname: search
    image: elasticsearch:7.6.2
    ports:
      - "9200:9200"  # Elasticsearch默认端口
    restart: "unless-stopped"
    environment:
      - ELASTIC_PASSWORD  # Elasticsearch密码（需提前设置环境变量）
    volumes:
      - ${DATA_DIR}/elasticsearch/:/usr/share/elasticsearch/data/  # 持久化数据目录

部署步骤：

1. 设置环境变量DATA_DIR（指定数据持久化目录）
2. 运行以下命令启动所有服务：

   bash
   docker-compose up -d
   

5. 更新资产

当修改.sass或.js文件后，需编译更新资产：

bash
npm run webpack