Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker Support for Git-Hound #64

Merged
merged 3 commits into from
Nov 17, 2023
Merged

Add Docker Support for Git-Hound #64

merged 3 commits into from
Nov 17, 2023

Conversation

ErdemOzgen
Copy link
Contributor

Description

This PR introduces Docker support for running Git-Hound, a tool for discovering exposed Git repositories and other sensitive information. The addition of Dockerfile and related documentation (README) makes it easier and more secure for users to deploy Git-Hound in various environments.

Changes

  • Dockerfile: A new Dockerfile has been added to build a Docker image for Git-Hound. This file includes instructions for setting up a Go environment, cloning and building Git-Hound, and configuring necessary volumes for configuration and input files.

  • README Update: The README has been updated with comprehensive instructions on how to build and use the Docker container. It includes guidance on mounting the config.yaml and input files, ensuring users can easily set up and run Git-Hound with their configurations.

Benefits

  • Portability: With Docker, users can run Git-Hound in any environment that supports Docker, which enhances the tool's portability and ease of use.
  • Ease of Setup: The Docker container abstracts the setup process, reducing the steps required to get Git-Hound up and running.
  • Consistency: Docker ensures a consistent environment for every user, mitigating the "it works on my machine" problem.
  • Security: By using Docker volumes, sensitive information like GitHub credentials in config.yaml is handled more securely, as it remains outside the Docker image and can be managed independently.

Testing

  • The Docker image has been built and tested locally, confirming that Git-Hound runs successfully with the provided configuration.
  • Instructions in the README have been followed to ensure they are clear and accurate.

Request

I request a review of these changes and welcome any feedback or suggestions. Upon approval, this enhancement will allow Git-Hound users to leverage the benefits of Docker for a more streamlined and secure experience.


@tillson tillson merged commit 0e0157e into tillson:main Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants