Skip to content

Commit

Permalink
Fb badge fix (#874)
Browse files Browse the repository at this point in the history
* fix linter errors

* lgtm is no longer suported

* fixed make badge

* added link to release link to badge

* markdown linter: correct lists
  • Loading branch information
kwitsch committed Feb 12, 2023
1 parent 7f5f98d commit 641cf3d
Showing 1 changed file with 33 additions and 34 deletions.
67 changes: 33 additions & 34 deletions README.md
@@ -1,5 +1,5 @@
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/0xERR0R/blocky/ci-build.yml "CI Build")](#)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/0xERR0R/blocky/release.yml "Release")](#)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/0xERR0R/blocky/makefile.yml "Make")](https://github.com/0xERR0R/blocky/actions/workflows/makefile.yml)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/0xERR0R/blocky/release.yml "Release")](https://github.com/0xERR0R/blocky/actions/workflows/release.yml)
[![GitHub latest version](https://img.shields.io/github/v/release/0xERR0R/blocky "Latest version")](https://github.com/0xERR0R/blocky/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/0xERR0R/blocky "Latest release date")](https://github.com/0xERR0R/blocky/releases)
[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/0xERR0R/blocky "Go version")](#)
Expand All @@ -8,7 +8,6 @@
[![Codecov](https://img.shields.io/codecov/c/gh/0xERR0R/blocky "Code coverage")](https://codecov.io/gh/0xERR0R/blocky)
[![Codacy grade](https://img.shields.io/codacy/grade/8fcd8f8420b8419c808c47af58ed9282 "Codacy grade")](#)
[![Go Report Card](https://goreportcard.com/badge/github.com/0xERR0R/blocky)](https://goreportcard.com/report/github.com/0xERR0R/blocky)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/0xERR0R/blocky.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/0xERR0R/blocky/alerts/)
[![Donation](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-blueviolet.svg)](https://ko-fi.com/0xerr0r)

<p align="center">
Expand All @@ -23,60 +22,60 @@ Blocky is a DNS proxy and ad-blocker for the local network written in Go with fo

- **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)
- 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
- 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
- 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
- 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)
- 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
- 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.
- Blocky does **NOT** collect any user data, telemetry, statistics etc.

- **Integration** - various integration

* [Prometheus](https://prometheus.io/) metrics
* Prepared [Grafana](https://grafana.com/) 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
- [Prometheus](https://prometheus.io/) metrics
- Prepared [Grafana](https://grafana.com/) 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 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
- 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

Expand Down

0 comments on commit 641cf3d

Please sign in to comment.