Zoraxy 项目安装与使用指南

1. 项目目录结构及介绍

Zoraxy 项目的目录结构如下：

zoraxy/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── docker/
├── docs/
├── example/
├── img/
├── src/
│   ├── main.go
│   └── ...
└── tools/

目录介绍

• CHANGELOG.md: 记录项目的更新日志。
• LICENSE: 项目的开源许可证文件，Zoraxy 使用 AGPL-3.0 许可证。
• README.md: 项目的基本介绍和使用说明。
• docker/: 包含 Docker 相关的文件和配置。
• docs/: 包含项目的文档文件。
• example/: 包含示例配置文件和代码。
• img/: 包含项目相关的图片资源。
• src/: 项目的源代码目录，包含主要的 Go 语言源文件。
• tools/: 包含项目使用的工具和脚本。

2. 项目的启动文件介绍

Zoraxy 项目的主要启动文件位于 src/ 目录下，其中 main.go 是项目的入口文件。

main.go 文件介绍

main.go 文件是 Zoraxy 项目的启动文件，负责初始化配置、启动服务器和加载其他模块。以下是 main.go 文件的主要功能：

• 初始化配置: 读取配置文件并初始化系统配置。
• 启动服务器: 启动 HTTP/HTTPS 服务器，监听指定端口。
• 加载模块: 加载反向代理、虚拟目录、WebSocket 代理等模块。

启动命令

在项目根目录下，可以使用以下命令启动 Zoraxy：

cd src/
go build
./zoraxy -port=:8000

3. 项目的配置文件介绍

Zoraxy 项目的配置文件主要位于 conf/ 目录下，包含反向代理、TLS/SSL 证书、访问控制等配置。

配置文件结构

conf/
├── proxy/
│   ├── proxy_rules.json
│   └── ...
├── ssl/
│   ├── certificates.json
│   └── ...
└── access_control.json

配置文件介绍

• proxy_rules.json: 反向代理规则配置文件，定义了代理的目标地址、虚拟目录、WebSocket 代理等。
• certificates.json: TLS/SSL 证书配置文件，包含证书的存储路径和自动续期配置。
• access_control.json: 访问控制配置文件，定义了 IP 黑名单、白名单、国家/地区访问限制等。

配置示例

以下是一个简单的 proxy_rules.json 配置示例：

{
  "rules": [
    {
      "host": "example.com",
      "target": "http://127.0.0.1:8080",
      "virtual_dir": "/api",
      "websocket": true
    }
  ]
}

配置文件的修改与加载

Zoraxy 在启动时会自动加载 conf/ 目录下的配置文件。如果需要修改配置，可以直接编辑相应的 JSON 文件，然后重启 Zoraxy 服务。

总结

通过本指南，您应该已经了解了 Zoraxy 项目的目录结构、启动文件和配置文件的基本信息。希望这些内容能帮助您顺利安装和使用 Zoraxy 项目。