部署文档

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

1. 项目简介

exchange-currency-service-backend 是一个基于 Go 语言开发的微服务，主要用于币种行情、币对管理等相关业务。系统支持 MySQL 数据库，适用于交易所、金融等对币种服务有需求的业务场景。

2. 环境要求

• Go 版本：1.22 及以上
• Docker：24.04 及以上（推荐生产环境）
• 数据库：MySQL 8.x（或兼容版本）
• 操作系统：Linux/Ubuntu 推荐

3. 部署方式

3.1 本地部署

3.1.1 下载代码

git clone gitlab.atom8.io/hkbitex/exchange-currency-service-backend.git
cd exchange-currency-service-backend

3.1.2 安装依赖

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（同上）

可通过环境变量或 .env 文件配置，具体请参考源码或补充文档。

3.1.5 启动服务

创建 Systemd 文件 /etc/systemd/system/exchange-currency.service：

[Unit]
Description=exchange-currency-service-backend
After=network.target

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

[Install]
WantedBy=multi-user.target

重载并启动服务：

# 创建必要的目录
mkdir -p /app/exchange-currency/logs

# 复制配置文件
cp .env.default /app/exchange-currency/.env
cp exchange-currency-service-backend /app/exchange-currency/

# 启动服务
systemctl daemon-reload
systemctl start exchange-currency
systemctl enable exchange-currency

# 检查服务状态
systemctl status exchange-currency

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

3.2.1 下载代码

git clone gitlab.atom8.io/hkbitex/exchange-currency-service-backend.git
cd exchange-currency-service-backend

3.2.2 编译代码

make docker

3.2.3 环境变量

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

3.2.4 启动服务

docker run -d \
  --name exchange-currency-service-backend \
  --env-file .env \
  -p 8080:8080 \
  registry.example.com/exchange-ip-location-backend:latest

4. 数据库配置

• 初始化数据库结构（如有 docs/migrations/exchange_currency.sql 可直接导入）
• 配置币种、币对等基础数据（可选）

需要根据实际情况修改初始化脚本

5. 日志配置

5.1 日志位置

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

5.2 日志级别

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

6. 监控配置

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

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

7. 其他说明

• 如需自定义部署或环境变量，请参考 Dockerfile、Makefile 及源码注释。
• 如有问题请联系项目负责人。