【亲测免费】 GShark 安装与使用教程

1. 项目目录结构及介绍

GShark 的目录结构如下：

.
├── build.sh          // 构建脚本
├── docker-compose.yaml  // Docker 集成部署配置文件
├── server             // 后端服务代码
│   ├── config-temp.yaml  // 示例配置文件
│   ├── gshark         // Linux 平台上的可执行文件（编译后）
│   └── resource       // 资源文件
└── web                // 前端管理界面代码
    ├── dist           // 编译后的前端静态资源
    ├── package.json   // npm 包依赖
    └── src            // 前端源代码

• build.sh: 编译和打包项目到不同平台的脚本。
• docker-compose.yaml: 使用 Docker 集成部署的配置文件。
• server: 包含后端服务的所有代码，包括可执行文件和配置文件。
• web: 前端管理界面的源码，包括构建后的资源。

2. 项目的启动文件介绍

• 后端：在 server 目录下，gshark 或 gshark.exe(Windows) 文件是主服务的可执行程序。

  • 在 Linux 或 macOS 上，可以直接运行 ./server/gshark 来启动服务。
  • 在 Windows 上，需先给 gshark.exe 添加执行权限，然后运行 .\server\gshark.exe web。

• 前端：前端应用通常由 Docker 部署的 Nginx 服务器分发，或者手动将 web/dist 目录的内容发布到已有的 Nginx 根目录下。

3. 项目的配置文件介绍

配置文件位于 server/config-temp.yaml，示例内容可能如下：

server:
  port: 8080

database:
  host: localhost
  user: root
  password: example
  database: gshark
  dialect: mysql

logging:
  level: info

scanning:
  sources:
    - type: github
      token: <your_github_token>
    - type: gitlab
      token: <your_gitlab_token>

# ...其他配置项...

• server.port: 服务监听的端口。
• database: 数据库配置，包括主机、用户名、密码、数据库名称和数据库类型。
• logging.level: 日志级别（如 info, warn, error 等）。
• scanning.sources: 敏感信息扫描来源，此处应填入 API 访问令牌。

请注意，实际部署时，需要将 config-temp.yaml 重命名为 config.yaml 并替换为实际的环境变量值，特别是敏感数据如 API 令牌等。在启动服务前，确保配置正确无误。

通过以上步骤，您就可以成功地安装和初始化 GShark 项目了。为了更详细的了解和使用 GShark，建议参考项目的官方文档和 Wiki 页面。