Gotaxy

🚀 Gotaxy 是一款基于 Go 语言开发的轻量级内网穿透工具，帮助开发者将内网服务安全、便捷地暴露到公网。

"Go beyond NAT, with style."

---

🚀 快速开始

服务端启动

go run cmd/server/server.go

使用指南

1. 快速开始

服务端启动

go run cmd/server/server.go

客户端连接

go run cmd/client/client.go -h <server_ip> -p <port>

2. 核心功能

• 内网穿透：支持TCP协议穿透，多端口映射管理
• 安全管理：TLS加密传输，客户端Token验证
• 配置管理：通过命令行或Web界面管理，支持热重载

3. 命令行工具

常用命令

gen-ca      生成CA证书
gen-certs   生成服务端和客户端证书
start       启动服务端
stop        停止服务端
show-config 显示当前配置

配置管理

set-ip <ip>       设置服务端IP
set-port <port>   设置监听端口
add-mapping       添加端口映射
del-mapping       删除端口映射

4. Web管理界面

启动服务端后，访问 http://localhost:<port> 可进入Web管理界面

5. 高级功能

证书管理

# 生成CA证书(有效期10年)
gen-ca 10

# 生成服务端和客户端证书(有效期30天)
gen-certs 30

日志查看

日志默认存储在 ./logs/ 目录下

6. 常见问题

1. 连接失败：检查服务端是否启动，验证客户端Token
2. 证书错误：确保证书文件存在，检查证书有效期

7. 更多帮助

查看项目文档：

• 设计文档
• 需求文档
• 开发日志

---

需求文档

详细需求分析请参阅 REQUIREMENTS.md 文件。

---

提交贡献

欢迎提交 Issue 和 Pull Request。

如果要贡献代码，请查阅 CONTRIBUTING.md.md 文件

提交代码请阅读 COMMIT_CONVENTION.md，我们遵循 Conventional Commits 规范