https://github.com/workdone0/pi-gate
pi-gate is a lightweight DNS sinkhole for blocking ads, trackers, and malware. Optimized for Raspberry Pi Zero, it runs as a background service with configurable blocklists and a simple CLI for control.
https://github.com/workdone0/pi-gate
Last synced: 27 days ago
JSON representation
pi-gate is a lightweight DNS sinkhole for blocking ads, trackers, and malware. Optimized for Raspberry Pi Zero, it runs as a background service with configurable blocklists and a simple CLI for control.
- Host: GitHub
- URL: https://github.com/workdone0/pi-gate
- Owner: workdone0
- License: mit
- Created: 2025-02-16T07:53:27.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-15T19:57:19.000Z (over 1 year ago)
- Last Synced: 2025-03-15T20:19:16.736Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pi-gate: A Lightweight DNS Sinkhole
**pi-gate** is a lightweight DNS sinkhole designed to block unwanted URLs, such as advertisements, malware sites, and trackers. It operates as a DNS server, filtering traffic at the network level to enhance privacy and security. Built for efficiency, it is optimized for low-resource devices like the Raspberry Pi Zero.
---
## Features
### ✅ Current Features
- **DNS Sinkhole Functionality**: Blocks unwanted domains by intercepting DNS queries.
- **Lightweight & Fast**: Designed to run efficiently on minimal hardware.
- **Logging System**: Logs DNS queries to track blocked and allowed domains.
- **Configurable Blocklists**: Supports loading custom blocklists for domain filtering.
- **Command-Line Interface (CLI)**: `pi-gate start` and `pi-gate stop` commands for easy control.
- **Background Execution**: Runs as a background service using Poetry.
### 🚀 Upcoming Features
- **Optimized AsyncIO Handling**: Improve efficiency in DNS request processing.
- **Dashboard Enhancements**:
- View DNS logs in real-time.
- Whitelist management: Allow specific domains.
- IP Management: Block/allow specific IPs if required.
- **Multiprocessing Support**: Enhance performance for handling multiple requests simultaneously.
- **Better Deployment Support**: Simplified installation and setup.
---
## How It Works
A DNS sinkhole intercepts DNS queries and returns a null response (or a specific IP) for blocked domains. Instead of reaching the actual malicious or ad-serving server, the request is stopped at the DNS level, preventing unwanted content from loading.
## DNS Sinkhole Diagram
### 📌 DNS Sinkhole Workflow
1. Device requests a domain (e.g., `example.com`).
2. `pi-gate` checks its blocklist.
- If blocked, returns a null IP (`0.0.0.0` or `127.0.0.1`).
- If allowed, forwards the request to the upstream DNS (e.g., Google DNS, Cloudflare).
3. The response is logged and returned to the client.
4. Blocked domains do not load, improving security and privacy.
---
## Installation & Usage
### 📥 Prerequisites
- Python 3.8+
- Poetry (for dependency management)
### 🔧 Installation
```bash
# Clone the repository
git clone https://github.com/workdone0/pi-gate.git
cd pi-gate
# Install dependencies
poetry install
```
### ▶️ Running pi-gate
```bash
# Start the DNS sinkhole
poetry run pi-gate start
# Stop the service
poetry run pi-gate stop
```
---
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to enhance `pi-gate`.
---
## License
[MIT License](LICENSE)