Epicontinental

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 28)

No description available.

Epicontinental Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Epicontinental

Epicontinental 是一个面向内网穿透、边缘节点管理和用户权限管理的全栈平台。项目采用 Go 微服务架构构建后端能力，通过 API Gateway 对外提供 HTTP、GraphQL 和静态资源入口，并使用 SvelteKit 构建 Web 管理界面。

后端服务之间使用 Kitex RPC 通信，持久化层使用 PostgreSQL，缓存、验证码、验证邮件状态和系统日志流使用 Redis。项目提供 Docker Compose 配置，可快速启动本地开发环境中的核心后端服务。

## Features

- **微服务架构**
  - `api-gateway` 作为统一 HTTP 入口，提供 `/api/graphql`、`/api/healthz`、日志流和开发环境 GraphQL Playground。
  - `account-service` 提供认证、用户、角色、权限、系统设置和邮件发送能力。
  - `tunnel-service` 提供隧道、边缘节点、部署令牌、FRP 配置生成和流量统计能力。

- **认证与用户体系**
  - 支持邮箱注册、登录、退出、密码重置和当前用户信息查询。
  - 使用 HTTP-only Cookie 承载认证状态。
  - 支持注册、登录、邮箱发送等流程中的验证码和邮箱验证码校验。

- **RBAC 权限管理**
  - 支持用户、角色、权限的管理。
  - 支持角色继承、权限状态、权限锁定和权限值配置。
  - 支持按 GraphQL 操作映射权限，统一进行网关层权限校验。

- **平台设置管理**
  - 支持注册策略、邮箱服务、安全策略和指标采集策略配置。
  - 邮件服务支持 SMTP、SendGrid、Mailgun、Amazon SES、Postmark、Brevo、Resend、阿里云 DirectMail、腾讯云 SES 等提供商。
  - 敏感配置在读取时进行脱敏处理。

- **隧道与边缘节点管理**
  - 支持创建、查看、更新、删除隧道。
  - 支持签发隧道令牌和生成 FRP 客户端配置。
  - 支持边缘节点列表、详情、更新、删除和部署令牌签发。
  - 支持边缘节点部署脚本模板配置。

- **流量与指标统计**
  - 支持隧道流量记录、聚合统计、月度用量、仪表盘统计。
  - 支持边缘节点指标采集、排行和详情查询。
  - 支持通过 Redis 缓存最新指标并将统计结果持久化到 PostgreSQL。

- **Web 管理界面**
  - 前端使用 SvelteKit、Svelte 5、Tailwind CSS 和 Chart.js。
  - 包含初始化、登录注册、仪表盘、隧道、节点、流量、用户、角色权限、系统设置和系统日志页面。

- **容器化部署**
  - 提供 `compose.yml` 用于本地启动 PostgreSQL、Redis、账号服务、网关服务和隧道服务。
  - 提供发布版 API Gateway Dockerfile，可在非 `dev` 版本构建时内嵌前端静态资源。

## 快速开始

### 前置要求

- Docker
- Docker Compose v2

### 1. 准备环境变量

```bash
cp .env.example .env
```

建议至少修改 `.env` 中的认证密钥：

```bash
EP_AUTH_SECRET="change-to-a-long-random-secret"
```

默认开发配置会连接 Compose 内部的服务名：

```text
PostgreSQL: postgres:5432
Redis: redis:6379
Account Service: account-service:8081
Tunnel Service RPC: tunnel-service:8083
Tunnel Service HTTP: tunnel-service:8082
API Gateway: :8080
```

### 2. 启动服务

```bash
docker compose up -d --build
```

该命令会启动以下服务：

- **postgres**: PostgreSQL 数据库，初始化 `account_svc` 和 `tunnel_svc` 数据库。
- **redis**: Redis 缓存与日志流存储。
- **account-service**: 账号、认证、用户、角色权限和系统设置服务。
- **tunnel-service**: 隧道、边缘节点和流量统计服务。
- **api-gateway**: 对外 HTTP 和 GraphQL 网关。

### 3. 查看服务状态

```bash
docker compose ps
```

查看日志：

```bash
docker compose logs -f api-gateway account-service tunnel-service
```

### 4. 健康检查

访问 API Gateway 健康检查：

```bash
curl http://localhost:8080/api/healthz
```

预期返回类似：

```json
{
  "service": "api-gateway",
  "status": "ok",
  "time": "2026-01-01T00:00:00Z"
}
```

### 5. GraphQL 入口

GraphQL API 地址：

```text
http://localhost:8080/api/graphql
```

当 `.env` 中 `EP_DEV="true"` 时，可访问 GraphQL Playground：

```text
http://localhost:8080/playground
```

### 6. 前端说明

当前 `compose.yml` 使用通用 Go 服务 Dockerfile 构建 `api-gateway`，开发构建不会内嵌前端静态资源。因此通过 Docker Compose 启动后，默认可直接访问后端 API，但不会由网关提供完整 Web 页面。

如需本地开发前端，可在另一个终端启动 Web 项目：

```bash
cd web
bun install
bun run dev -- --host 0.0.0.0
```

如需发布时由 `api-gateway` 直接托管前端静态资源，应使用 `Dockerfile.api-gateway-release` 构建网关镜像，并传入非 `dev` 的 `VERSION` 构建参数。该构建会先构建 `web`，再将 `web/build` 内嵌到网关二进制中。

## 常用命令

重新构建并启动：

```bash
docker compose up -d --build
```

停止服务：

```bash
docker compose down
```

停止服务并删除数据卷：

```bash
docker compose down -v
```

查看数据库和 Redis 状态：

```bash
docker compose ps postgres redis
```

## 默认端口

| 服务 | 端口 | 说明 |
| --- | --- | --- |
| api-gateway | 8080 | HTTP、GraphQL、健康检查 |
| tunnel-service | 8082 | 边缘节点和插件 HTTP 接口 |
| account-service | 8081 | 内部 Kitex RPC，不对宿主机暴露 |
| tunnel-service RPC | 8083 | 内部 Kitex RPC，不对宿主机暴露 |
| postgres | 5432 | Compose 内部访问 |
| redis | 6379 | Compose 内部访问 |

## 技术栈

- **Backend**: Go 1.25、CloudWeGo Hertz、CloudWeGo Kitex、graphql-go、GORM
- **Frontend**: SvelteKit、Svelte 5、Tailwind CSS、Chart.js、Bun
- **Database**: PostgreSQL
- **Cache / Stream**: Redis
- **Deployment**: Docker、Docker Compose、GitHub Actions Docker Release

## License

本项目使用 Apache License 2.0。详见 `LICENSE`。

Epicontinental

Epicontinental Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Epicontinental

Epicontinental Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README