Hyperfox 项目安装与使用教程

Hyperfox 项目安装与使用教程

hyperfox HTTP/HTTPS MITM proxy and recorder. 项目地址: https://gitcode.com/gh_mirrors/hy/hyperfox

1. 项目目录结构及介绍

Hyperfox 项目的目录结构如下：

hyperfox/
├── api_service/
├── database/
├── dockerignore
├── Dockerfile
├── gitignore
├── go.mod
├── go.sum
├── install.sh
├── LICENSE
├── Makefile
├── main.go
├── README.md
├── services/
├── travis.yml
└── websocket_service/

目录结构介绍

• api_service/: 包含 API 服务的相关代码。
• database/: 包含数据库相关的代码。
• dockerignore: Docker 忽略文件列表。
• Dockerfile: Docker 构建文件。
• gitignore: Git 忽略文件列表。
• go.mod: Go 模块文件，定义项目的依赖。
• go.sum: Go 模块文件，记录依赖的校验和。
• install.sh: 安装脚本。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• main.go: 项目的主入口文件。
• README.md: 项目说明文档。
• services/: 包含各种服务的代码。
• travis.yml: Travis CI 配置文件。
• websocket_service/: 包含 WebSocket 服务的相关代码。

2. 项目启动文件介绍

主入口文件：main.go

main.go 是 Hyperfox 项目的主入口文件，负责启动整个应用程序。以下是该文件的主要功能：

• 初始化配置: 读取并解析配置文件。
• 启动 HTTP/HTTPS 代理: 创建并启动 HTTP/HTTPS 代理服务器。
• 记录流量: 记录 HTTP/HTTPS 流量到 SQLite 数据库。
• 启动用户界面: 启动 Web 用户界面（如果配置中启用）。

启动命令

go run main.go

3. 项目配置文件介绍

Hyperfox 项目没有显式的配置文件，但可以通过命令行参数进行配置。以下是一些常用的配置参数：

• -addr: 指定代理服务器的绑定地址，默认是 127.0.0.1。
• -http: 指定 HTTP 代理服务器的端口，默认是 1080。
• -https: 指定 HTTPS 代理服务器的端口，默认是 10443。
• -db: 指定 SQLite 数据库文件的路径。
• -ui: 启用 Web 用户界面。
• -ui-addr: 指定 Web 用户界面的绑定地址和端口。
• -ca-cert: 指定根 CA 证书文件的路径。
• -ca-key: 指定根 CA 私钥文件的路径。

示例配置

hyperfox -addr 127.0.0.1 -http 1080 -https 10443 -db traffic-log.db -ui -ui-addr 127.0.0.1:3000 -ca-cert rootCA.crt -ca-key rootCA.key

以上命令将启动 Hyperfox，并配置 HTTP 和 HTTPS 代理服务器、SQLite 数据库、Web 用户界面以及根 CA 证书和私钥。

hyperfox HTTP/HTTPS MITM proxy and recorder. 项目地址: https://gitcode.com/gh_mirrors/hy/hyperfox