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
862 Commits 9 Branches 26 Tags 32 MiB
Go 99%
Makefile 0.4%
Dockerfile 0.3%
Shell 0.2%
HTML 0.1%
Go to file
Kwitsch d4813a6448
feat(queryLog): log instance hostname to distinguish log entries in multi-instance installation(#319) (#756) 
* added hostname to util

* added HostnameString

* some leftover debug output?

* added hostname to querylog

* add optional volume mounts to documentation

* changed documentation
 		2022-11-24 21:39:58 +01:00
.github build(deps): bump actions/checkout from 2 to 3 2022-11-08 11:34:57 +01:00
api set content-type header for HTTP endpoints (#581) 2022-06-29 22:36:54 +02:00
cache update: github.com/onsi/gomega 2022-09-03 23:43:26 +02:00
cmd Merge pull request #651 from kwitsch/fb-workflow_rework 2022-11-04 20:43:24 +01:00
config feat: Support for redis sentinel(#632) 2022-11-24 14:37:48 +01:00
docs feat(queryLog): log instance hostname to distinguish log entries in multi-instance installation(#319) (#756) 2022-11-24 21:39:58 +01:00
evt Add failed_download_count prometheus metric (#309) (#395) 2022-01-04 21:24:49 +01:00
helpertest chore: update golangci-lint (#631) 2022-08-19 22:04:35 +02:00
lists feat: caching for empty DNS responses (#700) 2022-11-08 21:45:28 +01:00
log feat: caching for empty DNS responses (#700) 2022-11-08 21:45:28 +01:00
metrics Add failed_download_count prometheus metric (#309) (#395) 2022-01-04 21:24:49 +01:00
model feat: caching for empty DNS responses (#700) 2022-11-08 21:45:28 +01:00
querylog feat(queryLog): log instance hostname to distinguish log entries in multi-instance installation(#319) (#756) 2022-11-24 21:39:58 +01:00
redis test: small refactoring changes, small improvements in redis test 2022-11-24 14:46:34 +01:00
resolver feat: caching for empty DNS responses (#700) 2022-11-08 21:45:28 +01:00
server Merge branch 'development' into fb-635 2022-09-09 21:11:15 +02:00
util feat(queryLog): log instance hostname to distinguish log entries in multi-instance installation(#319) (#756) 2022-11-24 21:39:58 +01:00
web chore: update golangci-lint (#631) 2022-08-19 22:04:35 +02:00
.dockerignore makefile rework 2022-10-21 20:56:26 +02:00
.gitignore vendor test 2022-09-14 16:07:38 +02:00
.golangci.yml Enable nosprintfhostport linter 2022-11-04 08:29:16 +01: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 added comments to Dockerfile 2022-10-28 21:42:36 +02:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile chore(build): install mkdocs-material 2022-11-23 20:47:59 +01:00
README.md Support for multiple configuration files (#534) 2022-05-25 15:13:52 +02:00
codecov.yml chore: customize codecov project status, disable threshold for PRs (#622) 2022-08-04 08:42:38 +02:00
go.mod build(deps): bump github.com/swaggo/swag from 1.8.7 to 1.8.8 2022-11-24 07:56:58 +01:00
go.sum build(deps): bump github.com/swaggo/swag from 1.8.7 to 1.8.8 2022-11-24 07:56:58 +01:00
main.go use full-qualified name as module 2021-08-27 13:41:36 +02:00
main_static.go added setLocaltime 2022-11-12 21:37:01 +01:00
mkdocs.yml Change configuration format for duration (#263) 2021-09-12 21:29:03 +02:00
tools.go chore: move golangci-lint from tools.go to Makefile (#709) 2022-11-05 22:46:43 +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 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