部署文档
| 版本号 | 修改 | 修改时间 | 备注 |
|---|---|---|---|
| v1.0.0 | 王小琱 | 2024.12.20 | 首版 |
1. 项目简介
exchange-notabene-bridge-backend 是一个基于 Go 语言开发的微服务，主要用于对接 Notabene 平台，实现虚拟资产服务商（VASP）间的合规信息交换。系统支持 gRPC 服务，提供 DID 查询、交易创建、Webhook 注册等功能，适用于数字资产合规、反洗钱等业务场景。
2. 环境要求
- Go 版本：1.21 及以上
- Docker：20.10 及以上
- 数据库：MySQL 8.x（或兼容版本）
- 第三方服务：Notabene 平台（需申请
API Key、Secret、VASP DID）
3. 部署方式
3.1 本地部署
3.1.1 下载代码
bash
git clone https://gitlab.atom8.io/hkbitex/exchange-notabene-bridge-backend .git
cd exchange-notabene-bridge-backend3.1.2 安装依赖
bash
# 安装 protoc 工具
make init
# 更新依赖
make tidy3.1.3 编译代码
bash
make build3.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（同上） |
| NOTABENE_CLIENT_KEY | string | 必填 | Notabene 平台 API Key |
| NOTABENE_CLIENT_SECRET | string | 必填 | Notabene 平台 API Secret |
| NOTABENE_VASP_DID | string | 必填 | Notabene 平台分配的 VASP DID |
| NOTABENE_URL | string | 必填 | Notabene 平台 API 地址（如 <https://api.notabene.id>） |
配置方法：复制
.env.default为.env，并根据实际情况修改上述配置项。
3.1.5 启动服务
创建 Systemd 文件 /etc/systemd/system/exchange-notabene-bridge-backend.service：
bash
[Unit]
Description=exchange-notabene-bridge-backend
After=network.target
[Service]
WorkingDirectory=/app/exchange-notabene-bridge-backend
Type=simple
User=root
ExecStart=/app/exchange-notabene-bridge-backend/exchange-notabene-bridge-backend
StandardOutput=append:/app/exchange-notabene-bridge-backend/logs/output.log
StandardError=append:/app/exchange-notabene-bridge-backend/logs/error.log
Restart=on-failure
EnvironmentFile=/app/exchange-notabene-bridge-backend/.env
[Install]
WantedBy=multi-user.target重载并启动服务：
bash
# 创建必要的目录
mkdir -p /app/exchange-notabene-bridge-backend/logs
# 复制配置文件
cp .env.default /app/exchange-notabene-bridge-backend/.env
cp exchange-notabene-bridge-backend /app/exchange-notabene-bridge-backend/
# 启动服务
systemctl daemon-reload
systemctl start exchange-notabene-bridge-backend
systemctl enable exchange-notabene-bridge-backend
# 检查服务状态
systemctl status exchange-notabene-bridge-backend3.2 Docker部署（推荐生产环境）
3.2.1 下载代码
bash
git clone https://gitlab.atom8.io/hkbitex/exchange-notabene-bridge-backend .git
cd exchange-notabene-bridge-backend3.2.2 编译代码
bash
make docker3.2.3 环境变量
在项目根目录创建 .env 文件（内容同上），或直接通过 Docker -e 方式传入。
3.2.4 启动服务
bash
docker run -d \
--name exchange-notabene-bridge-backend \
--env-file .env \
-p 8080:8080 \
registry.example.com/exchange-notabene-bridge-backend :latest4. 数据库配置
- 将回调地址添加到 Notabene 平台配置中。
5. 日志配置
5.1 日志位置
- 默认日志输出：
/app/exchange-notabene-bridge-backend/logs/ - 日志文件：
output.log：标准输出日志error.log：错误日志
5.2 日志级别
- 可通过 .env 配置（如 info、debug、error等）
- 建议生产环境使用 info 级别
6. 监控配置
Metrics 端点（Prometheus 可用）： http://127.0.0.1:18080/metrics
建议接入 Grafana 进行可视化监控
7. 其他说明
申请 Notabene 的 API Key、Secret、VASP DID 需自行完成（本项目不提供注册支持）。
如有问题，请联系负责人：王小琱（wang746277441@gmail.com）。
致谢：感谢 Notabene 提供的服务。