andyaugustin/git-secrets

git-secrets

镜像概述和主要用途

本镜像包含https://github.com/awslabs/git-secrets工具，用于检测Git仓库中的敏感信息（如API密钥、密码、访问令牌等），防止这些信息被意外提交到版本控制中。有关为何应在Git仓库中使用git-secrets的详细说明，请查看dev.to/andreasaugustin。

核心功能和特性

• 集成git-secrets工具，可扫描Git仓库中的敏感信息模式
• 支持自定义敏感信息规则，适应不同项目需求
• 轻量级设计，易于集成到开发流程和CI/CD管道
• 无需在本地系统直接安装git-secrets，通过容器化方式使用

使用场景和适用范围

• 本地开发环境：在提交代码前检测敏感信息，避免意外提交
• CI/CD流程：作为自动化检查步骤，确保敏感信息不进入代码库
• 团队协作：统一敏感信息检测标准，保障代码库安全
• 适用于所有使用Git进行版本控制的项目，尤其是处理敏感配置的应用

使用方法和配置说明

Docker Compose配置

使用docker-compose是最简便的方式，创建以下配置文件：

yaml
# docker-compose.yaml
version: '3.7'

services:
  git-secrets:
    # 镜像来源：GitHub Packages
    # image: ghcr.io/andreasaugustin/git-secrets:main
    # 镜像来源：Docker Hub
    image: andyaugustin/git-secrets:main
    volumes:
      # 将本地代码目录（当前目录）挂载到容器内的/app目录
      - .:/app/
    working_dir: /app/

运行方式

1. 交互式终端模式

如需使用终端执行多个git-secrets命令，运行：

bash
docker-compose run git-secrets

这将打开一个包含git-secrets工具的终端，可在其中执行各种git-secrets命令。

2. 非交互式模式（适用于CI/CD）

如需直接执行特定命令（如在CI/CD流程中），运行：

bash
docker-compose run git-secrets git-secrets <command>

其中<command>为git-secrets支持的具体命令（如--install、--scan等）。