部署文档

版本号	修改	修改时间	备注
v1.0.0	王小琱	2024.12.20	首版

1. 项目简介

exchange-push-server-backend 是基于Go语言开发的WebSocket消息推送服务，支持Web、Api、App三种运行模式。

2. 环境要求

• Go 版本：1.21 及以上
• Docker：20.10 及以上
• 消息队列：RabbitMQ

3. 部署方式

3.1 本地部署

3.1.1 下载代码

git clone https://gitlab.atom8.io/hkbitex/exchange-push-server-backend.git
cd exchange-push-server-backend

3.1.2 安装依赖

# 安装 protoc 工具
make init

# 更新依赖
make tidy

3.1.3 编译代码

make build

3.1.4 配置说明

环境变量	类型	是否必填	说明
APP_LOG_LEVEL	string	可选，默认info	日志级别（trace、debug、info、warn、error、fatal）
SERVER_HOST	string	必填	服务监听地址（如 0.0.0.0:8080）
METRICS_SWITCH	string	必填	metrics 开关，on：启用，off：关闭
METRICS_HOST	string	必填	metrics 服务监听地址（如 0.0.0.0:18080）
RABBITMQ_URIS	string	必填	RabbitMQ 连接地址（如 amqp://user:password@host:5672/vhost）
RABBITMQ_DEFAULT_EXCHANGE	string	必填	RabbitMQ 默认交换机（如 exchange-push-server-backend）
RPC_SERVER_CURRENCY	string	必填	货币RPC服务器地址（如 127.0.0.1:50051）
RPC_SERVER_AUTH	string	必填	市场RPC服务器地址（如 127.0.0.1:50052）
WSS_SWITCH	string	必填	WebSocket 开关，on：启用，off：关闭
WSS_MAX_CONNECTIONS	int	必填	WebSocket 最大连接数（如 1000）
SESSION_NAME	string	必填	会话名称（如 hkbitex_id）

3.1.5 启动服务

创建 Systemd 文件 /etc/systemd/system/exchange-push-server-backend.service：

[Unit]
Description=push-server
After=network.target

[Service]
WorkingDirectory=/app/push-server
Type=simple
User=root
ExecStart=/app/push-server/push-server
StandardOutput=append:/app/push-server/logs/output.log
StandardError=append:/app/push-server/logs/error.log
Restart=on-failure
EnvironmentFile=/app/push-server/.env

[Install]
WantedBy=multi-user.target

重载并启动服务：

# 创建必要的目录
mkdir -p /app/push-server/logs

# 复制配置文件
cp .env.default /app/push-server/.env
cp push-server /app/push-server/

# 启动服务
systemctl daemon-reload
systemctl start push-server
systemctl enable push-server

# 检查服务状态
systemctl status push-server

3.2 Docker部署（推荐生产环境）

3.2.1 下载代码

git clone https://gitlab.atom8.io/hkbitex/exchange-push-server-backend.git
cd exchange-push-server-backend

3.2.2 编译代码

make docker

3.2.3 环境变量

在项目根目录创建 .env 文件（内容同上），或直接通过 Docker -e 方式传入。

3.2.4 启动服务

docker run -d \
  --name exchange-push-server-backend \
  --env-file .env \
  -p 8080:8080 \
  registry.atom8.io/exchange-push-server-backend:latest

注意：服务存在运行模式切换，请根据实际情况选择。

1. Web模式：-mode web

2. Api模式：-mode api

3. App模式：-mode app

默认不添加参数为Web模式

4. 数据库配置

无

5. 日志配置

5.1 日志位置

• 默认日志输出：/app/push-server/logs/
• 日志文件：
  • output.log：标准输出日志
  • error.log：错误日志

5.2 日志级别

• 可通过 .env 配置（如 info、debug、error等）
• 建议生产环境使用 info 级别

6. 监控配置

• Metrics 端点（Prometheus 可用）： http://127.0.0.1:18080/metrics

• 建议接入 Grafana 进行可视化监控