H-UI 项目安装与使用指南

H-UI 项目安装与使用指南

h-ui Just the panel for Hysteria2 / 仅仅是 Hysteria2 的面板 项目地址: https://gitcode.com/gh_mirrors/hui/h-ui

1. 项目目录结构及介绍

H-UI 是一个为 Hysteria2 提供管理面板的开源项目。以下是项目的目录结构及各部分的功能介绍：

• cmd: 包含项目启动的命令行工具。
• controller: 处理 HTTP 请求的控制器。
• dao: 数据访问层，用于与数据库交互。
• docs: 项目文档。
• frontend: 前端代码，使用 Vue 构建的用户界面。
• middleware: 中间件，用于处理请求和响应。
• model: 数据模型，定义数据库结构。
• proxy: 代理相关的代码。
• router: 路由配置，定义 URL 与处理函数的映射。
• service: 业务逻辑层。
• util: 工具类库。
• .gitattributes: 配置 Git 的一些行为。
• .gitignore: 指定 Git 忽略的文件。
• Dockerfile: 用于构建 Docker 容器的配置文件。
• LICENSE: 项目使用的开源协议。
• README.md: 项目说明文件。
• README_ZH.md: 项目说明文件的中文版本。
• build.bat: 在 Windows 系统上构建项目的批处理文件。
• build.sh: 在 Linux 系统上构建项目的脚本文件。
• docker-build.sh: 构建 Docker 镜像的脚本文件。
• docker-compose.yml: Docker Compose 配置文件。
• go.mod: Go 语言的依赖管理文件。
• go.sum: Go 语言的依赖校验文件。
• h-ui.service: 用于 systemd 系统服务的配置文件。
• install.sh: 安装脚本项目。

2. 项目的启动文件介绍

项目的启动文件是 main.go，它位于项目的根目录。以下是 main.go 的主要功能：

• 初始化配置。
• 设置 HTTP 服务器的路由。
• 启动 HTTP 服务器。

package main

import (
    // 导入必要的包
)

func main() {
    // 初始化配置
    // 设置路由
    // 启动服务器
}

3. 项目的配置文件介绍

项目的配置文件主要用于设置项目运行时的参数。以下是配置文件的相关介绍：

• config.json: 项目的配置文件，包含数据库连接信息、HTTP 服务器端口等配置。
• config.sample.json: 配置文件的示例，用于参考。

配置文件 config.json 示例内容：

{
    "db": {
        "user": "root",
        "password": "password",
        "host": "localhost",
        "port": "3306",
        "dbname": "h_ui"
    },
    "server": {
        "port": "8081"
    }
}

在实际部署时，需要根据实际情况修改配置文件中的数据库连接信息和服务端口等配置。

h-ui Just the panel for Hysteria2 / 仅仅是 Hysteria2 的面板 项目地址: https://gitcode.com/gh_mirrors/hui/h-ui