2023-02-12 03:14:47 +01:00
|
|
|
[](https://github.com/0xERR0R/blocky/actions/workflows/makefile.yml)
|
|
|
|
|
[](https://github.com/0xERR0R/blocky/actions/workflows/release.yml)
|
2021-03-05 08:02:00 +01:00
|
|
|
[](https://github.com/0xERR0R/blocky/releases)
|
|
|
|
|
[](https://github.com/0xERR0R/blocky/releases)
|
|
|
|
|
[](#)
|
|
|
|
|
[](https://hub.docker.com/r/spx01/blocky)
|
|
|
|
|
[](https://hub.docker.com/r/spx01/blocky)
|
|
|
|
|
[](https://codecov.io/gh/0xERR0R/blocky)
|
|
|
|
|
[](#)
|
|
|
|
|
[](https://goreportcard.com/report/github.com/0xERR0R/blocky)
|
2021-08-25 22:24:43 +02:00
|
|
|
[](https://ko-fi.com/0xerr0r)
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
<p align="center">
|
2023-03-07 17:25:04 +01:00
|
|
|
<img height="200" src="https://github.com/0xERR0R/blocky/blob/main/docs/blocky.svg">
|
2021-03-05 08:02:00 +01:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
# Blocky
|
|
|
|
|
|
|
|
|
|
Blocky is a DNS proxy and ad-blocker for the local network written in Go with following features:
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
2024-04-08 19:09:51 +02:00
|
|
|
- **Blocking** - Blocking of DNS queries with external lists (Ad-block, malware) and allowlisting
|
2021-03-05 08:02:00 +01:00
|
|
|
|
2024-04-08 19:09:51 +02:00
|
|
|
- Definition of allow/denylists per client group (Kids, Smart home devices, etc.)
|
|
|
|
|
- Periodical reload of external allow/denylists
|
2023-02-12 03:14:47 +01:00
|
|
|
- Regex support
|
|
|
|
|
- Blocking of request domain, response CNAME (deep CNAME inspection) and response IP addresses (against IP lists)
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
- **Advanced DNS configuration** - not just an ad-blocker
|
|
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- Custom DNS resolution for certain domain names
|
|
|
|
|
- Conditional forwarding to external DNS server
|
|
|
|
|
- Upstream resolvers can be defined per client group
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
- **Performance** - Improves speed and performance in your network
|
|
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- Customizable caching of DNS answers for queries -> improves DNS resolution speed and reduces amount of external DNS
|
2021-03-05 08:02:00 +01:00
|
|
|
queries
|
2023-02-12 03:14:47 +01:00
|
|
|
- Prefetching and caching of often used queries
|
|
|
|
|
- Using multiple external resolver simultaneously
|
|
|
|
|
- Low memory footprint
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
- **Various Protocols** - Supports modern DNS protocols
|
|
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- DNS over UDP and TCP
|
|
|
|
|
- DNS over HTTPS (aka DoH)
|
|
|
|
|
- DNS over TLS (aka DoT)
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
- **Security and Privacy** - Secure communication
|
|
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- Supports modern DNS extensions: DNSSEC, eDNS, ...
|
|
|
|
|
- Free configurable blocking lists - no hidden filtering etc.
|
|
|
|
|
- Provides DoH Endpoint
|
|
|
|
|
- Uses random upstream resolvers from the configuration - increases your privacy through the distribution of your DNS
|
2021-03-05 08:02:00 +01:00
|
|
|
traffic over multiple provider
|
2023-02-12 03:14:47 +01:00
|
|
|
- Blocky does **NOT** collect any user data, telemetry, statistics etc.
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
- **Integration** - various integration
|
|
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- [Prometheus](https://prometheus.io/) metrics
|
|
|
|
|
- Prepared [Grafana](https://grafana.com/) dashboards (Prometheus and database)
|
|
|
|
|
- Logging of DNS queries per day / per client in CSV format or MySQL/MariaDB/PostgreSQL database - easy to analyze
|
|
|
|
|
- Various REST API endpoints
|
|
|
|
|
- CLI tool
|
2021-03-05 08:02:00 +01:00
|
|
|
|
2022-05-25 15:13:52 +02:00
|
|
|
- **Simple configuration** - single or multiple configuration files in YAML format
|
2021-03-05 08:02:00 +01:00
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- Simple to maintain
|
|
|
|
|
- Simple to backup
|
2021-03-05 08:02:00 +01:00
|
|
|
|
2021-03-10 14:37:30 +01:00
|
|
|
- **Simple installation/configuration** - blocky was designed for simple installation
|
2021-03-05 08:02:00 +01:00
|
|
|
|
2023-02-12 03:14:47 +01:00
|
|
|
- Stateless (no database, no temporary files)
|
|
|
|
|
- Docker image with Multi-arch support
|
|
|
|
|
- Single binary
|
|
|
|
|
- Supports x86-64 and ARM architectures -> runs fine on Raspberry PI
|
|
|
|
|
- Community supported Helm chart for k8s deployment
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
## Quick start
|
|
|
|
|
|
2023-09-11 13:39:59 +02:00
|
|
|
You can jump to [Installation](https://0xerr0r.github.io/blocky/latest/installation/) chapter in the documentation.
|
2021-03-05 08:02:00 +01:00
|
|
|
|
|
|
|
|
## Full documentation
|
|
|
|
|
|
|
|
|
|
You can find full documentation and configuration examples
|
|
|
|
|
at: [https://0xERR0R.github.io/blocky/](https://0xERR0R.github.io/blocky/)
|
|
|
|
|
|
|
|
|
|
## Contribution
|
|
|
|
|
|
|
|
|
|
Issues, feature suggestions and pull requests are welcome!
|
2021-08-25 22:24:43 +02:00
|
|
|
|
|
|
|
|
[](https://ko-fi.com/G2G25XZQG)
|
