部署文档

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

1. 项目简介

exchange-world-check-bridge-backend 是一个基于 Go 语言开发的微服务，主要用于对接 World-Check 桥接服务，实现案件创建、查询、更新等风控合规相关功能。系统采用 gRPC 通信协议，支持与外部风控系统集成，适用于交易所、金融等对合规有较高要求的业务场景。

2. 环境要求

• Go 版本：1.21 及以上
• Docker：20.10 及以上
• 数据库：MySQL 8.x（或兼容版本）
• 第三方服务：World-Check（需注册获取 API KEY 和 API SECRET）

3. 部署方式

3.1 本地部署

3.1.1 下载代码

git clone https://gitlab.atom8.io/hkbitex/exchange-world-check-bridge-backend.git
cd exchange-world-check-bridge-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）
MYSQL_READ	string	必填	MySQL 读库 DSN，例如：user:password@tcp(host:3306)/dbname?charset=utf8mb4&parseTime=True&loc=Local
MYSQL_WRITE	string	必填	MySQL 写库 DSN（同上）
WORLD_CHECK_API_KEY	string	必填	World-Check 的 Api Key
WORLD_CHECK_API_SECRET	string	必填	World-Check 的 License Key
WORLD_CHECK_URL	string	必填	World-Check 服务 API 地址

具体环境变量请根据实际代码和部署需求补充。

3.1.5 启动服务

创建 Systemd 文件 /etc/systemd/system/ip-location.service：

[Unit]
Description=world-check-bridge
After=network.target

[Service]
WorkingDirectory=/app/world-check-bridge
Type=simple
User=root
ExecStart=/app/world-check-bridge/exchange-world-check-bridge-backend
StandardOutput=append:/app/world-check-bridge/logs/output.log
StandardError=append:/app/world-check-bridge/logs/error.log
Restart=on-failure
EnvironmentFile=/app/world-check-bridge/.env

[Install]
WantedBy=multi-user.target

重载并启动服务：

# 创建必要的目录
mkdir -p /app/world-check-bridge/logs

# 复制配置文件
cp .env.default /app/world-check-bridge/.env
cp exchange-world-check-bridge-backend /app/world-check-bridge/

# 启动服务
systemctl daemon-reload
systemctl start world-check-bridge
systemctl enable world-check-bridge

# 检查服务状态
systemctl status world-check-bridge

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

3.2.1 下载代码

git clone https://gitlab.atom8.io/hkbitex/exchange-world-check-bridge-backend.git
cd exchange-world-check-bridge-backend

3.2.2 编译代码

make docker

3.2.3 环境变量

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

3.2.4 启动服务

docker run -d \
  --name exchange-world-check-bridge-backend \
  --env-file .env \
  -p 8080:8080 \
  registry.example.com/exchange-world-check-bridge-backend:latest

4. 日志配置

4.1 日志位置

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

4.2 日志级别

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

5. 监控配置

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

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

6. 其他说明

• 申请 World-Check 的 API KEY 及 API SECRET 需自行完成（本项目不提供注册支持）。

• 如有问题，请联系负责人：王小琱（wang746277441@gmail.com）。

• 致谢：感谢 World-Check 提供的风控服务。