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
549 Commits 11 Branches 26 Tags 34 MiB
Go 99%
Makefile 0.4%
Dockerfile 0.3%
Shell 0.2%
HTML 0.1%
Go to file
Dimitri Herzog 0ce5002560 chore: use github changelog for release 2022-08-03 14:36:27 +00:00
.github chore: update golangci-lint to v1.47.3 2022-08-01 23:19:35 +02:00
api set content-type header for HTTP endpoints (#581) 2022-06-29 22:36:54 +02:00
cache improved LRU cache operations (avoid expensive iteration in TotalCount) 2022-06-03 22:29:41 +02:00
cmd test: fix flaky test(537) - second hunt (#610) 2022-08-01 22:27:11 +02:00
config test: fix flaky test(537) - second hunt (#610) 2022-08-01 22:27:11 +02:00
docs Add fallbackUpstream for conditional mapping (#593) 2022-07-11 08:06:42 +02:00
evt Add failed_download_count prometheus metric (#309) (#395) 2022-01-04 21:24:49 +01:00
helpertest set content-type header for HTTP endpoints (#581) 2022-06-29 22:36:54 +02:00
lists chore: update golangci-lint to v1.47.3 2022-08-01 23:19:35 +02:00
log Disable colors when not in interactive terminal (#602) (#603) 2022-08-01 22:36:54 +02:00
metrics Add failed_download_count prometheus metric (#309) (#395) 2022-01-04 21:24:49 +01:00
model Option to handle FQDN only requests (#561) 2022-06-20 13:02:51 +02:00
querylog test: fix flaky test(537) - second hunt (#610) 2022-08-01 22:27:11 +02:00
redis update golangci-lint (#510) 2022-05-10 09:09:50 +02:00
resolver test: fix flaky test(537) - second hunt (#610) 2022-08-01 22:27:11 +02:00
server chore: update golangci-lint to v1.47.3 2022-08-01 23:19:35 +02:00
testdata Make DoH/DoT server mininum TLS version configurable (#546) 2022-06-04 08:23:40 +02:00
util Memory optimization internal blacklist/whitelist cache (#513) (#514) 2022-05-12 12:05:05 +02:00
web Moved index.go to go:embed (#392) 2022-01-01 22:32:22 +01:00
.dockerignore added "dist" to dockerignore 2021-12-13 22:54:55 +01:00
.gitignore Extract client name from the URL (DoH and DoT) (#317) 2021-10-13 22:47:14 +02:00
.golangci.yml update golangci-lint (#510) 2022-05-10 09:09:50 +02:00
.goreleaser.yml chore: use github changelog for release 2022-08-03 14:36:27 +00:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-03-05 10:58:39 +01:00
Dockerfile Update to Go 1.18 (#540) 2022-05-27 22:41:11 +02:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile chore: update golangci-lint to v1.47.3 2022-08-01 23:19:35 +02:00
README.md Support for multiple configuration files (#534) 2022-05-25 15:13:52 +02:00
codecov.yml refactoring: generate enums 2021-09-11 21:31:03 +02:00
go.mod test: fix flaky test(537) - second hunt (#610) 2022-08-01 22:27:11 +02:00
go.sum test: fix flaky test(537) - second hunt (#610) 2022-08-01 22:27:11 +02:00
main.go use full-qualified name as module 2021-08-27 13:41:36 +02:00
mkdocs.yml Change configuration format for duration (#263) 2021-09-12 21:29:03 +02: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 Donation

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
    • Regex support
    • 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 your privacy through 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 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

  • Simple configuration - single or multiple configuration files 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!

ko-fi