diff --git a/charts/enterprise/blocky/docs/setup-guide.md b/charts/enterprise/blocky/docs/setup-guide.md index d986aa62627..edf73832b7c 100644 --- a/charts/enterprise/blocky/docs/setup-guide.md +++ b/charts/enterprise/blocky/docs/setup-guide.md @@ -1,18 +1,35 @@ # Blocky Setup Guide -This will guide you through the basic setup of Blocky which is the preferred DNS solution for TrueCharts. This guide will cover basic setup options which will get you up and running and is not all inclusive. +This will guide you through the basic setup of Blocky which is the preferred DNS solution for TrueCharts. This guide will cover basic setup options which will get you up and running and is not all inclusive. Configuring your devices to use Blocky is out of scope of this guide. ## Upstream DNS -Blocky has multiple DNS entries configured by default these can be overridden to your personal preferences or left as default. +Blocky has the following DNS entries configured by default. They can be overridden to your personal preferences or left as default. Here are some common ones: -Blocky supports 3 methods for upstream DNS. +- 1.1.1.1 +- 1.0.0.1 +- 8.8.8.8 +- 8.8.4.4 +- 9.9.9.9 +- 149.112.112.112 +- 208.67.222.222 +- 208.67.220.220 +- 8.26.56.26 +- 8.20.247.20 +- 185.228.168.9 +- 185.228.169.9 +- 76.76.19.19 +- 76.223.122.150 +- 76.76.2.0 +- 76.76.10.0 + +Blocky supports 3 methods for upstream DNS. You can use any combination of the below. - UDP - Basic DNS - DoT - DNS over TLS - DoH - DNS over HTTPS -While UDP provides no security for DNS both DoT and DoH will encrypt DNS request. DoH has the added benefit of privacy since DNS traffic will appear as HTTPS traffic. +While UDP provides no security for DNS both DoT and DoH will encrypt DNS request. DoH has the added benefit of privacy since DNS traffic will appear as HTTPS traffic. ### UDP DNS Setup @@ -37,9 +54,9 @@ While UDP provides no security for DNS both DoT and DoH will encrypt DNS request ## Bootstrap DNS -For DNS providers that do not use an IP address for DoT or DoH a bootstrap DNS provider - is needed to resolve the DoT or DoH address. This provider can be any UDP upstream DNS. - In the below example I am using Google DNS. +If you entered a non-IP address (meaning you used a domain name) for DoT or DoH, then you need to ensure that a bootstrap DNS provider +is configured to resolve the DoT or DoH address. This provider can be any UDP upstream DNS. +In the below example I am using Google DNS. ![blocky-bootstrap-google](./img/blocky-bootstrap-google.png) @@ -59,10 +76,17 @@ certain blocklists if you find legitimate traffic being blocked. 1. Pick a Group Name for your blocklists. 2. Add List entries for each blocklist by URL. - ![blocky-blacklist](./img/blocky-blacklist.png) + ![blocky-blacklist](./img/blocky-blacklist.png) 3. Add a Clients Group Block and set Client Group Name to `default` 4. Under Groups Entry enter the Group name you used above. - ![blocky-blacklist-group](./img/blocky-blacklist-group.png) + ![blocky-blacklist-group](./img/blocky-blacklist-group.png) + +## Networking + +If you want to use Blocky on your local network to take advantage of the filtering above, or the k8s-gateway below, you +need to setup a static ip address and leave the default setting DNS TCP Service and DNS UDP Service as LoadBalancer. + +You need to configure the devices on your network to use the static IP address configured above. This can be done per device or by changing the DHCP or DNS settings on your router. ## k8s-Gateway Configuration @@ -75,4 +99,3 @@ is to add your root domain in the Domain name block. ## Prometheus/Grafana TBD -