docs(Blocky): Add more to Setup-Guide (#12235)
**Description** Update of the original @kqmaverick guide from @depasseg (see -> https://github.com/truecharts/website/pull/286), so I'll have them both review here since filing on the Website one gets overwritten by here ⚒️ Fixes # <!--(issue)--> **⚙️ Type of change** - [ ] ⚙️ Feature/App addition - [ ] 🪛 Bugfix - [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] 🔃 Refactor of current code **🧪 How Has This Been Tested?** <!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration --> **📃 Notes:** <!-- Please enter any other relevant information here --> **✔️ Checklist:** - [ ] ⚖️ My code follows the style guidelines of this project - [ ] 👀 I have performed a self-review of my own code - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made corresponding changes to the documentation - [ ] ⚠️ My changes generate no new warnings - [ ] 🧪 I have added tests to this description that prove my fix is effective or that my feature works - [ ] ⬆️ I increased versions for any altered app according to semantic versioning **➕ App addition** If this PR is an app addition please make sure you have done the following. - [ ] 🪞 I have opened a PR on [truecharts/containers](https://github.com/truecharts/containers) adding the container to TrueCharts mirror repo. - [ ] 🖼️ I have added an icon in the Chart's root directory called `icon.png` --- _Please don't blindly check all the boxes. Read them and only check those that apply. Those checkboxes are there for the reviewer to see what is this all about and the status of this PR with a quick glance._ --------- Signed-off-by: StevenMcElligott <89483932+StevenMcElligott@users.noreply.github.com> Co-authored-by: kqmaverick <121722567+kqmaverick@users.noreply.github.com>
This commit is contained in:
StevenMcElligott
GitHub
parent
4dd88e6aa0
commit
2390dfe5ed
|
|
@ -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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -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.
|
||||
|
||||
|
||||
3. Add a Clients Group Block and set Client Group Name to `default`
|
||||
4. Under Groups Entry enter the Group name you used above.
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue