Web Analytics

karpov-gateway

⭐ 153 stars Simplified Chinese by MiChongs

Karpov Gateway

一体化 API 网关 + 控制台。Go 后端(Gin + gRPC)+ Next.js 前端(App Router + shadcn/ui),自带凭据池、邮件验证、Linux.do OAuth2 SSO、配额计费、TOTP 二步验证。

License: MIT Go Next.js

✨ 功能特性

🏗 仓库结构

karpov-gateway/
├── gateway/             # Go 后端 (Gin + gRPC)
│   ├── cmd/             # 各 service 入口 (gateway/auth/music/pool/...)
│   ├── internal/        # 业务实现 (private)
│   ├── api/             # protobuf 定义
│   ├── migrations/      # PostgreSQL schema
│   ├── go.mod           # Go 模块 (go 1.24+)
│   └── Dockerfile
├── web/                 # Next.js 16 前端控制台
│   ├── src/             # App Router pages + components
│   ├── middleware.ts    # CSRF / session / CSP nonce
│   ├── package.json     # pnpm workspace
│   └── Dockerfile
├── deploy/
│   ├── compose/         # 本地开发 (PG + Redis + pgAdmin)
│   └── compose-prod/    # 生产单机 (gateway + web + PG + Redis 全栈)
└── .github/workflows/   # GitHub Actions CI (lint / test / build / govulncheck / gosec)

🚀 快速开始

1. 前置要求

| 工具 | 版本 | | ---------- | ------- | | Go | 1.24+ | | Node.js | 20.11+ | | pnpm | 9+ | | Docker | 24+ | | PostgreSQL | 14+ | | Redis | 7+ |

2. 启动依赖(Postgres + Redis + pgAdmin)

cd deploy/compose
cp .env.example .env       # 改强密码!
docker compose up -d

3. 启动 Gateway 后端

cd gateway
cp .env.example .env       # 与 deploy/compose/.env 的 PG/Redis 密码保持一致
go mod download
go run ./cmd/qqmusic-gateway

默认 :8080 (HTTP) + :9000 (gRPC)

首次启动会在 stderr 打印一个 superadmin 账号 + 临时密码

4. 启动 Web 控制台

cd web
cp .env.example .env.local
pnpm install
pnpm dev

http://localhost:3000

🐳 生产部署 (Docker Compose 单机)

cd deploy/compose-prod
cp .env.example .env

编辑 .env:填入真域名 / 强密码 / SMTP 凭据 / OAuth client

nano .env

生成 KEK

openssl rand -hex 32 # → 写到 POOL_KEK_HEX=

docker compose up -d --build docker compose logs -f gateway

注意事项:

🔐 OAuth2 (Linux.do) 接入

   OAUTH_LINUXDO_ENABLED=true
   OAUTH_LINUXDO_CLIENT_ID=...
   OAUTH_LINUXDO_CLIENT_SECRET=...
   OAUTH_LINUXDO_MIN_TRUST_LEVEL=1
   OAUTH_PUBLIC_BASE=https://your-domain
   OAUTH_FRONTEND_BASE=https://your-domain
   ``
  • 重启 gateway,登录页 / 注册页会自动出现 "Linux.do 一键登录"

🧪 测试 / Lint

bash

Go

cd gateway go vet ./... go test -race ./... golangci-lint run --timeout=5m

Web

cd web pnpm lint pnpm typecheck
`

📦 关键依赖

后端

前端

📜 许可证

MIT — 见 LICENSE

🤝 贡献

欢迎 PR / Issue。提 PR 前请:

🔒 安全

发现安全问题请直接联系维护者,不要开公开 issue。


MiChongs ❤️ 构建

--- Tranlated By Open Ai Tx | Last indexed: 2026-06-04 ---