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
1,206 Commits 14 Branches 25 Tags 31 MiB
Go 99%
Makefile 0.4%
Dockerfile 0.3%
Shell 0.2%
HTML 0.1%
Go to file
Kwitsch fda2dbe9df
Refactoring Redis (#1271) 
* RedisConfig -> Redis

* moved redis config to seperate file

* bugfix in config test during parallel processing

* implement config.Configurable in Redis config

* use Context in GetRedisCache

* use Context in New

* caching resolver test fix

* use Context in PublishEnabled

* use Context in getResponse

* remove ctx field

* bugfix in api interface test

* propperly close channels

* set ruler for go files from 80 to 111

* line break because function length is to long

* only execute redis.New if it is enabled in config

* stabilized flaky tests

* Update config/redis.go

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>

* Update config/redis_test.go

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>

* Update config/redis_test.go

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>

* Update config/redis_test.go

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>

* Update config/redis.go

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>

* Update config/redis_test.go

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>

* fix ruler

* redis test refactoring

* vscode setting cleanup

* removed else if chain

* Update redis_test.go

* context race fix

* test fail on missing seintinel servers

* cleanup context usage

* cleanup2

* context fixes

* added context util

* disabled nil context rule for tests

* copy paste error ctxSend -> CtxSend

* use util.CtxSend

* fixed comment

* fixed flaky test

* failsafe and tests

---------

Co-authored-by: ThinkChaos <ThinkChaos@users.noreply.github.com>
 		2023-11-27 12:08:31 -05:00
.devcontainer Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
.github Bugfix/GitHub workflows (#1234) 2023-11-14 17:22:27 -05:00
.vscode Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
api Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
cache refactor: make use of contexts in more places 2023-11-21 12:21:35 -05:00
cmd ginkgolinter: enable all checks and fix findings (#1274) 2023-11-26 16:10:38 +01:00
config Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
docs refactor(config): move `dohUserAgent` to `upstreams.userAgent` 2023-11-23 08:45:18 -05:00
e2e refactor: embed `Upstreams` in `UpstreamGroup` to make values accessible 2023-11-23 08:45:18 -05:00
evt chore(refactor): refactor cache implementation (#1174) 2023-09-30 17:14:59 +02:00
helpertest EDNS: Client Subnet (#1007) 2023-11-20 16:56:56 +01:00
lists fix(tests): properly silence log output (#1259) 2023-11-19 17:51:49 -05:00
log fix(util): make `FatalOnError` override `log.Silence` 2023-11-23 08:45:18 -05:00
metrics refactor: configuration rework (usage and printing) (#920) 2023-03-12 22:14:10 +01:00
model feat: add upstream strategy `strict` (#1093) 2023-08-21 09:50:23 +02:00
querylog fix(tests): properly silence log output (#1259) 2023-11-19 17:51:49 -05:00
redis Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
resolver Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
server Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
trie fix(tests): properly silence log output (#1259) 2023-11-19 17:51:49 -05:00
util Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
web feat: API-first approach for REST interface (#1129) 2023-09-09 19:30:55 +02:00
.dockerignore Unit test refactoring & devcontainer enhancement(#1245) 2023-11-15 16:42:53 +01:00
.gitattributes Feature/devcontainer (#1179) 2023-10-02 22:08:05 +02:00
.gitignore feat(lists): add support for wildcard lists using a custom Trie (#1233) 2023-11-17 15:58:35 +01:00
.golangci.yml Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
.goreleaser.yml Goreleaser fix (#1003) 2023-04-26 08:57:22 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-03-05 10:58:39 +01:00
Dockerfile Fix/opencontainer labels (#1192) 2023-10-08 23:34:54 +02:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile feat(lists): add support for wildcard lists using a custom Trie (#1233) 2023-11-17 15:58:35 +01:00
README.md fix(docs): fix documentation link in README.md (#1133) (#1134) 2023-09-11 13:39:59 +02:00
codecov.yml feat: API-first approach for REST interface (#1129) 2023-09-09 19:30:55 +02:00
go.mod build(deps): bump github.com/miekg/dns from 1.1.56 to 1.1.57 (#1253) 2023-11-16 10:41:53 +01:00
go.sum build(deps): bump github.com/miekg/dns from 1.1.56 to 1.1.57 (#1253) 2023-11-16 10:41:53 +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: mirror git repo to codeberg 2023-03-13 14:04:18 +01:00
tools.go feat: API-first approach for REST interface (#1129) 2023-09-09 19:30:55 +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 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