Merge branch 'main' of https://github.com/tillson/git-hound

Dockerfile

@@ -0,0 +1,22 @@
+# Use the official Golang image as a parent image
+FROM golang:latest
+
+# Set the working directory
+WORKDIR /app
+
+# Install git-hound
+RUN git clone https://github.com/tillson/git-hound.git
+RUN cd git-hound && go build -o /usr/local/bin/git-hound
+
+# Copy the locally required files to the container
+COPY . .
+
+# Set up a directory for .githound
+RUN mkdir -p /root/.githound
+
+# Set up volume for input files
+VOLUME /data
+VOLUME /root/.githound
+
+# Set the default command for the container
+ENTRYPOINT ["git-hound"]

README.md

@@ -107,13 +107,60 @@ On launch.json send the needed flags as args
 
 From the main folder: `go build .`
 
+---
+
+## Building the Docker Image
+To build the Docker image for Git-Hound, use the following command:
+
+```bash
+docker build -t my-githound-container .
+```
+
+This command builds the Docker image with the tag `my-githound-container`. You can change the tag name to your preference.
+
+#### Running the Container
+To run the Git-Hound Docker container, you'll need to provide your `config.yaml` file and any input files (like `subdomains.txt`) via Docker volumes.
+
+#### Mounting `config.yaml`
+Place your `config.yaml` file at a known location on your host machine. This file should contain your Git-Hound configuration, including GitHub credentials.
+
+Example `config.yaml`:
+
+```yaml
+# config.yaml
+github_username: "your_username"
+github_password: "your_password"
+# Optional: GitHub TOTP seed
+# github_totp_seed: "ABCDEF1234567890"
+```
+
+#### Mounting Input Files
+If you have a file like `subdomains.txt`, place it in a directory on your host machine.
+
+#### Running the Command
+Use the following command to run the container with your configuration and input files:
+
+```bash
+docker run -v /path/to/config.yaml:/root/.githound/config.yaml -v $(pwd)/data:/data my-githound-container --subdomain-file /data/subdomains.txt
+```
+
+Replace `/path/to/config.yaml` with the actual path to your `config.yaml` file. The `-v $(pwd)/data:/data` part mounts a directory containing your input files (`subdomains.txt`) into the container.
+
+#### Notes
+- Ensure your `config.yaml` and input files' paths are correct when running the Docker container.
+- This setup assumes `git-hound` is compatible with the provided configuration and command-line arguments.
+- For any updates or changes to `git-hound`, rebuild the Docker image.
+
+---
+
+
 ## User feedback
 
 These are discussions about how people use GitHound in their workflows and how we can GitHound to fufill those needs. If you use GitHound, consider leaving a note in one of the active issues.
 [List of issues requesting user feedback](https://github.com/tillson/git-hound/issues?q=is%3Aissue+is%3Aopen+label%3A%22user+feedback+requested%22)
 
 ## 💰 Premium Monitoring & Engagements
-Would you like to gain greater visibility into your company's GitHub presence? We use GitHound as one small part of a larger system that can find credential leaks, and sensitive/proprietary information across open-source websites like GitHub and DockerHub. We offer continuous monitoring services of *all of GitHub* (not just accounts you know are held by employees!) and red-team engagements/consulting services.
+Would you like to gain greater visibility into your company's GitHub presence? We use GitHound as one small part of a larger system that can find credential leaks and sensitive/proprietary information across open-source websites like GitHub and DockerHub. We offer continuous monitoring services of *all of GitHub* (not just accounts you know are held by employees!) and red-team engagements/consulting services.
 
 Reach out here to learn more: https://secretsurfer.xyz.
 

config.example.yml

@@ -1,6 +1,9 @@
+# Instructions: rename this file to config.yml. 
+# DO NOT CHECK YOUR USERNAME AND PASSWORD INTO GIT!
+
 # Required
 github_username: "username"
 github_password: "your_password"
 
 # Optional (comment out if not using)
-# github_totp_seed: "ABCDEF1234567890" # Obtained via https://github.com/settings/security
+# github_totp_seed: "ABCDEF1234567890" # Obtained via https://github.com/settings/security