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
967 Commits 8 Branches 25 Tags 30 MiB
Go 99%
Makefile 0.4%
Dockerfile 0.3%
Shell 0.2%
HTML 0.1%
Go to file
Dimitri Herzog 32fe1ebf66 chore: type 2023-03-07 17:37:57 +01:00
.github chore: type 2023-03-07 17:37:57 +01:00
api Added gofumpt (#805) 2022-12-26 22:11:45 +01:00
cache refactor: don't use a regex to check a string cache entry is a regex 2023-02-07 09:35:53 -05:00
cmd feat(bootstrap): support multiple upstreams 2023-01-18 18:57:55 +01:00
config test(bootstrap): add test case 2023-01-18 18:57:55 +01:00
docs chore: change branch name to "main" (#744) 2023-03-07 17:25:04 +01:00
e2e feat: allow hosts file resolver to use a HTTP(S) link or inline block (#884) 2023-03-06 19:32:41 -05:00
evt chore(build): add additional linters (#774) 2022-11-29 21:58:26 +01:00
helpertest Test refactoring (#798) 2022-12-29 14:58:25 +01:00
lists feat: allow hosts file resolver to use a HTTP(S) link or inline block (#884) 2023-03-06 19:32:41 -05:00
log feat: stack log prefixes to differentiate between log emitters 2023-01-18 18:57:55 +01:00
metrics Added gofumpt (#805) 2022-12-26 22:11:45 +01:00
model feat: caching for empty DNS responses (#700) 2022-11-08 21:45:28 +01:00
querylog Added gofumpt (#805) 2022-12-26 22:11:45 +01:00
redis Workflow changes (#857) 2023-02-07 14:00:53 +01:00
resolver fix: wrong prefetch metrics if bootstrap is enabled (#891) (#915) 2023-03-07 16:04:27 +01:00
server chore: change branch name to "main" (#744) 2023-03-07 17:25:04 +01:00
util feat: client name in clientGroupsBlock should not be case-sensitive (#894) (#913) 2023-03-07 14:23:02 +01:00
web chore: update golangci-lint (#631) 2022-08-19 22:04:35 +02:00
.dockerignore build(tests): e2e integration tests with docker and testcontainers (#753) 2022-11-24 21:54:52 +01:00
.gitignore build(tests): e2e integration tests with docker and testcontainers (#753) 2022-11-24 21:54:52 +01:00
.golangci.yml chore: update testcontainers version (#821) 2023-01-05 10:30:53 +01:00
.goreleaser.yml chore(build): fix deprecated configuration (#817) 2023-01-05 08:43:41 +01:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-03-05 10:58:39 +01:00
Dockerfile build(tests): e2e integration tests with docker and testcontainers (#753) 2022-11-24 21:54:52 +01:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile Workflow changes (#857) 2023-02-07 14:00:53 +01:00
README.md chore: change branch name to "main" (#744) 2023-03-07 17:25:04 +01:00
codecov.yml chore(build): exclude e2e dir from codecov report 2022-11-25 07:36:38 +00:00
go.mod build(deps): bump github.com/stretchr/testify from 1.8.1 to 1.8.2 (#899) 2023-03-07 07:55:19 +01:00
go.sum build(deps): bump github.com/stretchr/testify from 1.8.1 to 1.8.2 (#899) 2023-03-07 07:55:19 +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 chore(docs): use docs versioning 2023-03-07 17:36:48 +01:00
tools.go chore: define version of golangci-lint in makefile (#816) 2023-01-05 08:44:04 +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 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