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
211 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 5f81c142e4
Create CODE_OF_CONDUCT.md 		2021-03-05 10:58:39 +01:00
.github Docs (#158) 2021-03-05 08:02:00 +01:00
api go fmt 2021-02-26 21:39:41 +01:00
cmd #147: Blocky commands do not run without local ./config.yml file 2021-02-26 22:42:00 +01:00
config #147: Blocky commands do not run without local ./config.yml file 2021-02-26 22:42:00 +01:00
docs Docs (#158) 2021-03-05 08:02:00 +01:00
evt public API documentation (#146) 2021-02-26 13:45:57 +01:00
helpertest public API documentation (#146) 2021-02-26 13:45:57 +01:00
lists added/changed some comments 2021-02-26 21:44:53 +01:00
log go fmt 2021-02-26 21:39:41 +01:00
metrics public API documentation (#146) 2021-02-26 13:45:57 +01:00
resolver added/changed some comments 2021-02-26 21:44:53 +01:00
server public API documentation (#146) 2021-02-26 13:45:57 +01:00
stats public API documentation (#146) 2021-02-26 13:45:57 +01:00
testdata #79: Support for multiple conditional forwarders per domain 2020-12-27 23:40:27 +01:00
util public API documentation (#146) 2021-02-26 13:45:57 +01:00
web added/changed some comments 2021-02-26 21:44:53 +01:00
.dockerignore replaced swagger-ui with static version to reduce memory footprint 2021-01-08 22:12:55 +01:00
.gitignore Docs (#158) 2021-03-05 08:02:00 +01:00
.golangci.yml initial commit 2020-01-12 18:23:35 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-03-05 10:58:39 +01:00
Dockerfile removed tools target 2021-01-17 21:57:54 +01:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile Docs (#158) 2021-03-05 08:02:00 +01:00
README.md Docs (#158) 2021-03-05 08:02:00 +01:00
codecov.yml added codecov config 2020-02-13 22:24:47 +01:00
go.mod go fmt 2021-02-26 21:39:41 +01:00
go.sum go fmt 2021-02-26 21:39:41 +01: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 Dependabot Status

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

  • 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

    • 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!