Merge pull request #61 from szTheory/feature/dockerfile

Feature/dockerfile

Author: techgaun

.github/workflows/docker-build.yml

@@ -0,0 +1,34 @@
+name: Docker Build & Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          load: true
+          tags: github-dorks:test
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Test Docker image
+        run: |
+          # Test the version flag with version flag
+          docker run github-dorks:test -v
+
+      - name: Verify image size
+        run: docker image ls github-dorks:test

Dockerfile

@@ -0,0 +1,31 @@
+# Use Python 3.8 as base - this version has good compatibility with older packages
+FROM python:3.8-slim
+
+# Set working directory
+WORKDIR /app
+
+# Install git (needed for pip install from git repos)
+RUN apt-get update && \
+    apt-get install -y git && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
+
+# Copy only the necessary files
+COPY github-dork.py /app/
+COPY github-dorks.txt /app/
+COPY setup.py /app/
+COPY README.md /app/
+COPY requirements.txt /app/
+
+# Install dependencies
+# Using the specific version of github3.py that's known to work
+RUN pip install --no-cache-dir github3.py==1.0.0a2 feedparser==6.0.2
+
+# Set environment variables
+ENV PYTHONUNBUFFERED=1
+ENV PYTHONIOENCODING=UTF-8
+
+# Create volume for potential output files
+VOLUME ["/app/output"]
+
+ENTRYPOINT ["python", "github-dork.py"] 

README.md

@@ -1,3 +1,5 @@
+[![Docker Build & Test](https://github.com/techgaun/github-dorks/actions/workflows/docker-build.yml/badge.svg)](https://github.com/techgaun/github-dorks/actions/workflows/docker-build.yml)
+
 # Github Dorks
 
 [Github Search](https://github.com/search) is a quite powerful and useful feature that can be used to search for sensitive data on repositories. Collection of Github dorks can reveal sensitive personal and/or organizational information such as private keys, credentials, authentication tokens, etc. This list is supposed to be useful for assessing security and performing pen-testing of systems.
@@ -16,6 +18,24 @@ Clone this repository and run:
 pip install .
 ```
 
+### Docker Installation
+
+You can also run github-dorks using Docker for a consistent environment:
+
+```shell
+# Build the Docker image
+docker build -t github-dorks .
+
+# Run with a GitHub token (recommended)
+docker run -e GH_TOKEN=your_github_token github-dorks -u someuser
+
+# Run with username/password
+docker run -e GH_USER=your_username -e GH_PWD=your_password github-dorks -u someuser
+
+# Save results to a CSV file
+docker run -v $(pwd)/output:/app/output -e GH_TOKEN=your_github_token github-dorks -u someuser -o /app/output/results.csv
+```
+
 ### Usage
 
 ```