oowy/gitleaks repository overview

⁠Quick reference

• Maintained by:
  Oowy team⁠

• Where to get help:
  the Docker Community Slack⁠, Server Fault⁠, Unix & Linux⁠, or Stack Overflow⁠

⁠Supported tags

• latest
• 8.21.2 8.21.1 8.21.0
• 8.20.1 8.20.0
• 8.19.3 8.19.2 8.19.1 8.19.0
• 8.18.4 8.18.3 8.18.2 8.18.1 8.18.0
• 8.17.0
• 8.16.4 8.16.3 8.16.2 8.16.1 8.16.0

⁠Quick reference (cont.)

• Supported architectures: amd64, arm64v8

⁠What is Gitleaks?

Gitleaks⁠ is an open-source secret detection tool designed to help developers and security teams protect their Git repositories from leaking sensitive information. Gitleaks scans your Git repositories for secrets such as passwords, API keys, and access tokens that could compromise your application's security.

What makes Gitleaks unique is its simplicity and ease of integration. It smoothly integrates into your CI/CD pipelines and works autonomously without the need for complex additional dependencies. With its task-driven approach, Gitleaks provides quick and accurate detection of secrets in your source code.

With Gitleaks, you can effortlessly configure your projects to automatically scan new commits and branches, generating detailed reports that allow you to promptly address any secret leaks. It also offers extensive flexibility with customizable configurations to meet your specific needs.

⁠Gitleaks Docker Images

The team publishes a Docker image to this repository for each official release of Gitleaks package.

These images wrap the gitleaks executable, allowing you to run gitleaks subcommands by passing in their names and arguments as part of docker run.

Note that for production use, we recommend specifying a specific version instead of using latest.

⁠Configuration

You will likely need to further configure your container so that Gitleaks can access your configuration files and provider credentials. This could include mounting your configuration into the container, setting the working directory to refer to your configuration, and passing in environment variables and credentials files for the providers you intend to use. The docker run documentation lists the options you can use to customize the container environment.

You could also use these images as a base for your own images. For example, this would be helpful if you wanted to to pre-set CLI Configuration settings as part of your image.

⁠Community

Open issues about Gitleaks binary on the main Gitleaks repository⁠.