Merge pull request #13 from Satvik-Singh192/feat/docker-learn-implement

feat: dockerized the firewall

Author: utkarshkgithub

.dockerignore

@@ -0,0 +1,10 @@
+venv/
+*.venv/
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.vscode/
+.idea/
+
+.git/

Dockerfile

@@ -0,0 +1,17 @@
+FROM python:3.10-slim
+WORKDIR /app
+COPY requirements_docker.txt .
+
+RUN apt-get update && \
+    apt-get install -y gcc build-essential python3-dev && \
+    pip install -r requirements_docker.txt && \
+    apt-get purge -y gcc build-essential python3-dev && \
+    apt-get autoremove -y && \
+    apt-get clean
+
+
+COPY . .
+RUN chmod +x /app/entrypoint.sh
+ENTRYPOINT ["/app/entrypoint.sh"]
+
+CMD ["python", "main.py"]

README.md

@@ -125,6 +125,49 @@ python3 main.py --create-config
 sudo python3 main.py -v
 ```
 
+# 🐳 Running with Docker
+
+Using Docker is the recommended way to run the firewall, as it automatically manages all dependencies and network permissions.
+
+---
+
+## ✅ Prerequisites
+
+Make sure you have the following installed:
+
+- **Docker**
+- **Docker Compose**  
+  *(Docker Desktop for Windows/macOS includes both.)*
+
+---
+
+
+### **1. Build and Run**
+
+Open your terminal in the project’s root directory and run:
+
+```bash
+docker-compose run --rm firewall
+```
+
+The image will build the **first time** you run this command.
+
+`--rm` ensures the container is automatically removed when it stops.
+
+---
+
+## 2. Select Network Interface
+
+After the container starts, you will be prompted to choose the interface:
+
+Select an interface (0–2): 2
+
+
+---
+
+## ✅ To Stop
+
+Press: Ctrl + C
 
 
 ## Configuration

docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  firewall:
+    build: .
+    container_name: firewall
+    
+    cap_add:
+      - NET_ADMIN
+    network_mode: "host"
+    
+    restart: unless-stopped

entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# This script runs inside the container
+# It checks if a config file exists. If not, it creates one.
+
+CONFIG_FILE="firewall_config.json"
+
+if [ ! -f "$CONFIG_FILE" ]; then
+  echo "--- No $CONFIG_FILE found, creating one... ---"
+  python main.py --create-config
+  echo "--- Default config file created. ---"
+else
+  echo "--- Using existing $CONFIG_FILE. ---"
+fi
+echo "--- Starting firewall... ---"
+exec "$@"

requirements_dev.txt

@@ -0,0 +1,5 @@
+pytest>=7.0.0
+pytest-cov>=4.0.0
+black>=22.0.0
+flake8>=5.0.0
+isort>=5.10.0

requirements_docker.txt

@@ -0,0 +1,4 @@
+scapy>=2.4.0
+psutil>=5.8.0
+colorama>=0.4.0
+netifaces>=0.11.0