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,351 Commits 8 Branches 25 Tags 30 MiB
Go 99%
Makefile 0.4%
Dockerfile 0.3%
Shell 0.2%
HTML 0.1%
Go to file
dependabot[bot] 4ebe1ef21a
build(deps): bump github.com/miekg/dns from 1.1.58 to 1.1.59 (#1452) 
Bumps [github.com/miekg/dns](https://github.com/miekg/dns) from 1.1.58 to 1.1.59.
- [Changelog](https://github.com/miekg/dns/blob/master/Makefile.release)
- [Commits](https://github.com/miekg/dns/compare/v1.1.58...v1.1.59)

---
updated-dependencies:
- dependency-name: github.com/miekg/dns
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 		2024-04-26 12:49:13 +02:00
.devcontainer Bugfix in ECS forward (#1290) 2023-12-03 14:29:31 -05:00
.github Feature: binary build workflow (#1445) 2024-04-12 16:42:17 -04:00
.vscode Refactoring/config struct names (#1315) 2023-12-20 15:38:33 -05:00
api fix: api regression breaking `blocky blocking disable` (#1373) 2024-02-10 13:06:01 -05:00
cache feat: log the rule which is the cause of blocking (#1460) 2024-04-24 12:58:29 -04:00
cmd Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
config Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
docs docs: use relative links for Grafana dashboards 2024-04-11 18:33:09 -04:00
e2e feat: update list config and code to use "allow/deny" language 2024-04-11 18:33:09 -04:00
evt chore(refactor): refactor cache implementation (#1174) 2023-09-30 17:14:59 +02:00
helpertest fix: use proxy env vars via Go default HTTP Transport values 2024-04-10 09:43:57 -04:00
lists Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
log refactor(log): store log in context so it's automatically propagated 2024-03-19 19:10:07 -04:00
metrics Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
model refactor: remove `model.Request.Log` in favor of use `Context` 2024-03-19 19:10:07 -04:00
querylog feat: add `queryLog.ignore.sudn` option to ignore SUDN responses 2024-04-05 15:32:09 -04:00
redis Refactoring Redis (#1271) 2023-11-27 12:08:31 -05:00
resolver Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
server Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
trie feat: log the rule which is the cause of blocking (#1460) 2024-04-24 12:58:29 -04:00
util fix: use proxy env vars via Go default HTTP Transport values 2024-04-10 09:43:57 -04: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: support CNAME records in customDNS mappings (#1352) 2024-01-29 11:22:03 -05:00
.golangci.yml refactor(tests): remove `TmpFile.Error` to centralize error checks 2023-12-01 15:53:11 -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 Build Cache Optimization (#1402) 2024-03-15 17:22:26 -04:00
LICENSE added license text 2020-01-13 21:57:57 +01:00
Makefile Refactoring/linter (#1447) 2024-04-12 16:44:50 -04:00
README.md feat: update list config and code to use "allow/deny" language 2024-04-11 18:33:09 -04: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.58 to 1.1.59 (#1452) 2024-04-26 12:49:13 +02:00
go.sum build(deps): bump github.com/miekg/dns from 1.1.58 to 1.1.59 (#1452) 2024-04-26 12:49:13 +02: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): update material emoji config to non deprecated options 2024-01-12 09:35:41 -05: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 allowlisting

    • Definition of allow/denylists per client group (Kids, Smart home devices, etc.)
    • Periodical reload of external allow/denylists
    • 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