GShark 教程：从入门到实践

GShark 教程：从入门到实践

gshark项目地址:https://gitcode.com/gh_mirrors/gsh/gshark

1. 项目介绍

GShark 是一个免费且开源的敏感信息检测管理系统，专为计算设计师和软件开发者在建筑、工程和施工（AEC）行业中设计。基于 Go 和 Vue 构建，它能够轻松有效地扫描并管理公开环境中的敏感信息，但不适用于本地环境。GShark 提供了对多个平台的支持，包括 GitHub、GitLab 和 SearchCode。

2. 项目快速启动

环境准备

确保已安装以下依赖：

• MySQL（当前版本仅支持 MySQL）
• Docker（可选，用于部署）

编译与安装

1. 克隆项目仓库：

   git clone https://github.com/neal1991/gshark.git
   

2. 切换至服务器目录：

   cd gshark/server
   

3. 根据目标平台编译二进制文件： 对于 macOS：

   GOOS=darwin GOARCH=amd64 go build
   

   对于 Windows：

   GOOS=windows GOARCH=amd64 go build -o gshark.exe
   

   对于 Linux：

   GOOS=linux GOARCH=amd64 go build -o gshark
   

4. 创建配置文件 config.yaml，基于提供的模板 config-temp.yaml。

5. 启动服务：

   ./gshark web
   

前端部署

1. 进入前端目录并执行构建：

   cd ../web
   npm install
   npm run build
   

2. 将生成的前端资源复制到您的 Nginx 配置的静态文件目录。

3. 应用案例和最佳实践

• 使用 GShark 定期扫描组织的公开代码库，检查是否有敏感信息如 API 密钥、数据库连接字符串等泄漏。
• 通过 GShark 的 CRUD 功能，管理和更新自定义检测规则，以适应不同的安全策略。
• 结合 Git hooks 或持续集成工具，自动化执行 GShark 检测，确保提交时没有敏感信息暴露。

4. 典型生态项目

GShark 可以与其他工具集成，例如：

• GitHub: 通过 GitHub App 实现自动扫描与报告。
• GitLab: 使用 GitLab CI/CD 调用 GShark 执行敏感信息检查。
• SearchCode: 引入 SearchCode API 以扩大搜索范围，覆盖更多开源项目。

---

本文档提供了 GShark 的基础介绍和快速启动指南，您可以根据需求进一步探索其高级功能和定制化选项。为了获取最新的信息和社区支持，请访问 GShark 的 GitHub 页面：https://github.com/neal1991/gshark。

gshark项目地址:https://gitcode.com/gh_mirrors/gsh/gshark