QUICKSTART.md

Midgard Gateway 快速启动指南

方式一：使用启动脚本（推荐）

Linux/macOS

chmod +x start.sh
./start.sh

Windows

start.bat

方式二：使用 Makefile

开发环境（包含 Redis）

make dev

构建并运行

make build
make run

查看所有可用命令

make help

方式三：手动启动

1. 安装依赖

# Go 依赖
go mod download

# 前端依赖（如果需要）
cd web && npm install

2. 配置环境（可选）

# 复制配置文件示例
cp config/config.example.yaml config/config.yaml
cp env.example .env

# 根据需要修改配置文件

3. 启动 Redis（可选，如果使用缓存）

# 使用 Docker
docker-compose -f docker-compose.dev.yml up -d redis

# 或使用本地安装的 Redis
redis-server

4. 运行应用

# 开发模式
go run main.go

# 或构建后运行
go build -o midgard main.go
./midgard

方式四：使用 Docker Compose

完整部署（包含前端）

docker-compose up -d

仅启动依赖服务（Redis、PostgreSQL）

docker-compose -f docker-compose.dev.yml up -d

默认配置

• 端口: 8080
• 数据库: SQLite (midgard.db)
• Redis: localhost:6379
• 前端: 启用

环境变量

可以通过环境变量覆盖配置：

export PORT=8080
export DATABASE_TYPE=sqlite
export DATABASE_DSN=midgard.db
export REDIS_HOST=localhost
export REDIS_PORT=6379
export REDIS_PASSWORD=
export REDIS_DB=0
export ENABLE_FRONTEND=true

访问应用

• 前端界面: http://localhost:8080
• API 端点: http://localhost:8080/api
• 健康检查: http://localhost:8080/health

常见问题

端口被占用

修改 config/config.yaml 中的 server.port 或设置环境变量 PORT

Redis 连接失败

确保 Redis 服务正在运行，或设置 REDIS_HOST="" 禁用缓存

数据库锁定错误

SQLite 在高并发下可能出现锁定，建议：

1. 使用 PostgreSQL
2. 或减少并发请求