XScan 项目使用指南

XScan 项目使用指南

1. 项目目录结构及介绍

XScan 项目是一个基于用户策略的资产管理平台。以下是项目的目录结构及其说明：

• .idea: 项目配置文件，用于IDE（如PyCharm）管理项目设置。
• config: 包含项目配置文件，如数据库连接信息等。
• images: 存放项目所需的图片文件。
• models: 定义了项目中的数据模型。
• mysql: 数据库相关文件，可能包含数据库迁移脚本等。
• pkg: 存放项目的主要逻辑代码，包括业务处理和工具类等。
• routers: 定义了项目的路由处理函数，即URL与处理函数的映射。
• service: 实现了项目中的业务逻辑。
• web: 包含项目的前端文件，如HTML、CSS、JavaScript等。
• Dockerfile: 用于构建Docker镜像的配置文件。
• docker-compose.yml: 定义了项目所需的多容器Docker部署配置。
• go.mod: Go语言项目的依赖管理文件。
• go.sum: 记录了Go模块的版本信息。
• main.go: 项目的主入口文件。
• xray-license.lic: XRay扫描工具的许可证文件。
• xray_darwin_amd64、xray_linux_amd64: 分别为macOS和Linux系统下的XRay扫描工具。

2. 项目的启动文件介绍

项目的启动文件是main.go，它是Go语言项目的主入口。以下是main.go文件的基本内容：

package main

import (
    "github.com/gin-gonic/gin"
    "github.com/tangxiaofeng7/XScan/pkg/routers"
)

func main() {
    r := gin.Default()
    routers.InitRouter(r)
    r.Run(":8080")
}

这段代码首先导入了必要的包，然后在main函数中创建了一个Gin Web框架的实例，并初始化了路由。最后，它启动了一个监听8080端口的服务器。

3. 项目的配置文件介绍

项目的配置文件通常包括config.yaml和docker-compose.yml。

• config.yaml: 这个文件包含了项目的各种配置信息，如数据库连接字符串、端口号、第三方服务的API密钥等。

server:
  port: 8080

database:
  host: localhost
  port: 3306
  user: root
  password: password
  dbname: xscan

• docker-compose.yml: 这个文件定义了项目运行所需的Docker服务配置，包括Web服务、数据库服务、以及其他可能需要的服务。

version: '3'
services:
  web:
    build: .
    ports:
      - "8080:8080"
  db:
    image: mysql:latest
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: xscan

这个配置文件定义了两个服务：web 和 db。web 服务是通过Dockerfile构建的，映射了主机的8080端口到容器的8080端口。db 服务使用了最新的MySQL镜像，并设置了数据库的root密码和要创建的数据库名称。