STUNNER 开源项目使用教程

1. 项目的目录结构及介绍

STUNNER 项目的目录结构如下：

stunner/
├── cmd/
│   └── stunner/
│       └── main.go
├── config/
│   ├── config.go
│   └── example_config.yaml
├── docs/
│   └── README.md
├── pkg/
│   ├── api/
│   ├── stun/
│   └── utils/
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件。
• config/: 包含项目的配置文件和配置相关的代码。
• docs/: 包含项目的文档文件。
• pkg/: 包含项目的核心代码，如 API 处理、STUN 协议实现等。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• README.md: 项目的主文档文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/stunner/main.go。该文件负责初始化配置、启动服务等核心操作。

启动文件主要功能

• 读取配置文件。
• 初始化 STUN 服务。
• 启动 HTTP 服务。
• 处理信号中断，优雅关闭服务。

3. 项目的配置文件介绍

项目的配置文件位于 config/example_config.yaml。该文件定义了 STUNNER 服务的各项配置参数。

配置文件主要内容

• server: 服务器的监听地址和端口。
• logLevel: 日志级别。
• auth: 认证相关的配置，如用户名和密码。
• routes: 路由配置，定义了 STUN 消息的处理规则。

通过以上内容，您可以快速了解 STUNNER 项目的目录结构、启动文件和配置文件，从而更好地使用和配置该项目。