mirrors
/
blocky
mirror of https://github.com/0xERR0R/blocky.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Fast and lightweight DNS proxy as ad-blocker for local network with many features
259 Commits 14 Branches 25 Tags 31 MiB
Go 99%
Makefile 0.4%
Dockerfile 0.3%
Shell 0.2%
HTML 0.1%
Go to file
Dimitri Herzog c59c52dc24 removed deprecated linters 2021-04-30 22:45:38 +02:00
.github swithed to golangci-lint GitHub Action 2021-04-30 22:33:59 +02:00
api #111: allow the ability to enable/disable blocking by group 2021-04-28 22:38:23 +02:00
cmd #111: allow the ability to enable/disable blocking by group 2021-04-28 22:38:23 +02:00
config #81: Configuration of different upstream DNS servers for different clients (#193) 2021-04-22 22:37:59 +02:00
docs #111: allow the ability to enable/disable blocking by group 2021-04-28 22:38:23 +02:00
evt Add prefetch hit metrics (#190) 2021-04-24 21:48:08 +02:00
helpertest public API documentation (#146) 2021-02-26 13:45:57 +01:00
lists #182 - added config option for logTimestamp (#184) 2021-04-17 22:23:51 +02:00
log #182 - added config option for logTimestamp (#184) 2021-04-17 22:23:51 +02:00
metrics Add prefetch hit metrics (#190) 2021-04-24 21:48:08 +02:00
resolver #111: allow the ability to enable/disable blocking by group 2021-04-28 22:38:23 +02:00
server #81: Configuration of different upstream DNS servers for different clients (#193) 2021-04-22 22:37:59 +02:00
stats #182 - added config option for logTimestamp (#184) 2021-04-17 22:23:51 +02:00
testdata #81: Configuration of different upstream DNS servers for different clients (#193) 2021-04-22 22:37:59 +02:00
util #81: Configuration of different upstream DNS servers for different clients (#193) 2021-04-22 22:37:59 +02:00
web update golangci-lint, fixint lint errors 2021-03-05 22:52:22 +01:00
.dockerignore replaced swagger-ui with static version to reduce memory footprint 2021-01-08 22:12:55 +01:00
.gitignore #188: Add additional binaries as release artifacts 2021-04-30 22:24:32 +02:00
.golangci.yml removed deprecated linters 2021-04-30 22:45:38 +02:00
.goreleaser.yml #188: Add additional binaries as release artifacts 2021-04-30 22:24:32 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-03-05 10:58:39 +01:00
Dockerfile add tini to Docker image (#180) 2021-04-22 22:58:33 +02:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile #188: Add additional binaries as release artifacts 2021-04-30 22:24:32 +02:00
README.md #81: Configuration of different upstream DNS servers for different clients (#193) 2021-04-22 22:37:59 +02:00
codecov.yml added codecov config 2020-02-13 22:24:47 +01:00
go.mod go mod tidy 2021-04-22 22:51:45 +02:00
go.sum go mod tidy 2021-04-22 22:51:45 +02:00
main.go #27: CLI tool 2020-04-08 23:03:07 +02:00
mkdocs.yml Docs (#158) 2021-03-05 08:02:00 +01:00

README.md

GitHub Workflow Status GitHub Workflow Status GitHub latest version GitHub Release Date GitHub go.mod Go version Docker pulls Docker Image Size (latest) Codecov Codacy grade Go Report Card Total alerts

Blocky

Blocky is a DNS proxy and ad-blocker for the local network written in Go with following features:

Features

  • Blocking - Blocking of DNS queries with external lists (Ad-block, malware) and whitelisting

    • Definition of black and white lists per client group (Kids, Smart home devices, etc.)
    • Periodical reload of external black and white lists
    • Blocking of request domain, response CNAME (deep CNAME inspection) and response IP addresses (against IP lists)

  • Advanced DNS configuration - not just an ad-blocker

    • Custom DNS resolution for certain domain names
    • Conditional forwarding to external DNS server
    • Upstream resolvers can be defined per client group

  • Performance - Improves speed and performance in your network

    • Customizable caching of DNS answers for queries -> improves DNS resolution speed and reduces amount of external DNS queries
    • Prefetching and caching of often used queries
    • Using multiple external resolver simultaneously
    • Low memory footprint

  • Various Protocols - Supports modern DNS protocols

    • DNS over UDP and TCP
    • DNS over HTTPS (aka DoH)
    • DNS over TLS (aka DoT)

  • Security and Privacy - Secure communication

    • 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 you privacy though the distribution of your DNS traffic over multiple provider
    • Blocky does NOT collect any user data, telemetry, statistics etc.

  • Integration - various integration

    • Prometheus metrics
    • Prepared Grafana dashboard
    • Logging of DNS queries per day / per client in CSV format - easy to analyze
    • Statistics report via CLI
    • Various REST API endpoints
    • CLI tool

  • Simple configuration - single configuration file in YAML format

    • Simple to maintain
    • Simple to backup

  • Simple installation/configuration - blocky was designed for simple installation

    • 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

Quick start

You can jump to Installation chapter in the documentation.

Full documentation

You can find full documentation and configuration examples at: https://0xERR0R.github.io/blocky/

Contribution

Issues, feature suggestions and pull requests are welcome!