SHHGit 安装与配置指南

SHHGit 安装与配置指南

shhgit Ah shhgit! Find secrets in your code. Secrets detection for your GitHub, GitLab and Bitbucket repositories. 项目地址: https://gitcode.com/gh_mirrors/sh/shhgit

1. 项目基础介绍

SHHGit 是一个开源项目，旨在帮助开发者和管理员在代码库中查找潜在泄露的秘密信息，例如用户名、密码、API 令牌或私钥等。这类信息如果意外泄露到公共代码仓库中，可能会造成安全风险。SHHGit 可以持续扫描代码库，以发现并提醒用户这些秘密信息。

该项目主要使用 Go 语言开发。

2. 项目使用的关键技术和框架

SHHGit 使用以下关键技术和框架：

• Go 语言：项目的主要编程语言。
• Docker：容器化技术，用于简化部署和运行环境。
• GitHub API：与 GitHub 仓库进行交互。
• 正则表达式：用于匹配和检测潜在的敏感信息。

3. 项目安装和配置的准备工作

在安装 SHHGit 之前，请确保您的系统满足以下要求：

• Go 语言环境：安装 Go 语言环境，可以从 Go 官方网站 下载并安装。
• Docker：安装 Docker 环境，可以从 Docker 官方网站 下载并安装。
• Git：安装 Git，可以从 Git 官方网站 下载并安装。

安装步骤

通过 Docker 安装

1. 克隆项目仓库

   打开命令行窗口，执行以下命令克隆 SHHGit 仓库：

   git clone https://github.com/eth0izzle/shhgit.git
   

2. 构建 Docker 容器

   进入项目目录，执行以下命令构建 Docker 容器：

   cd shhgit
   docker-compose build
   

3. 配置项目

   编辑 config.yaml 文件，添加您的 GitHub 访问令牌：

   github_access_tokens:
     - 'your_github_token_here'
   

4. 启动服务

   执行以下命令启动 SHHGit 服务：

   docker-compose up
   

5. 访问 Web 界面

   在浏览器中访问 http://localhost:8080/，即可看到 SHHGit 的 Web 界面。

通过 Go 编译安装

1. 获取项目源码

   使用 go get 命令获取项目源码：

   go get github.com/eth0izzle/shhgit
   

   或者克隆项目仓库：

   git clone https://github.com/eth0izzle/shhgit.git
   cd shhgit
   

2. 编译项目

   执行以下命令编译项目：

   go build -v -i
   

3. 配置项目

   编辑 config.yaml 文件，添加您的 GitHub 访问令牌：

   github_access_tokens:
     - 'your_github_token_here'
   

4. 运行项目

   执行编译后的二进制文件，开始扫描：

   ./shhgit
   

以上是 SHHGit 的详细安装和配置指南，按照以上步骤，您应该能够成功安装并运行该项目。

shhgit Ah shhgit! Find secrets in your code. Secrets detection for your GitHub, GitLab and Bitbucket repositories. 项目地址: https://gitcode.com/gh_mirrors/sh/shhgit