docs(blocky): update blocky guides (#29797)

**Description**
Update blocky guides with yaml examples.

⚒️ Fixes  # 

**⚙️ 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?**

**📃 Notes:**

**✔️ 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
- [ ] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):` or `chore(chart-name):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🖼️ 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._
This commit is contained in:
kqmaverick
2024-11-29 20:03:17 +01:00
committed by GitHub
parent eda07e3a45
commit 38993aec15
+57 -9
View File
@@ -46,6 +46,17 @@ While UDP provides no security for DNS both DoT and DoH will encrypt DNS request
- Google DNS: `8.8.8.8` `8.8.4.4`
- Cloudflare DNS: `1.1.1.1` `1.0.0.1`
```yaml
// values.yaml
defaultUpstreams:
# Google
- 8.8.8.8
- 8.8.4.4
# Cloudflare
- 1.1.1.1
- 1.0.0.1
```
![blocky-udp-upstream-google](./img/blocky-udp-upstream-google.png)
### DoT DNS Setup
@@ -53,14 +64,30 @@ While UDP provides no security for DNS both DoT and DoH will encrypt DNS request
- Google DNS ([Bootstrap DNS Required](#bootstrap-dns)): `tcp-tls:dns.google:853`
- Cloudflare DNS: `tcp-tls:1.1.1.1:853` `tcp-tls:1.0.0.1:853`
![blocky-dot-upstream-google](./img/blocky-dot-upstream-google.png)
```yaml
// values.yaml
defaultUpstreams:
# Google
- tcp-tls:dns.google:853
# Cloudflare
- tcp-tls:1.1.1.1:853
- tcp-tls:1.0.0.1:853
```
### DoH Upstream
- Google DNS ([Bootstrap DNS Required](#bootstrap-dns)): `https://dns.google/dns-query`
- Cloudflare DNS: `https://1.1.1.1/dns-query` `https://1.0.0.1/dns-query`
![blocky-doh-upstream-google](./img/blocky-doh-upstream-google.png)
```yaml
// values.yaml
defaultUpstreams:
# Google
- https://dns.google/dns-query
# Cloudflare
- https://1.1.1.1/dns-query
- https://1.0.0.1/dns-query
```
## Bootstrap DNS
@@ -68,11 +95,16 @@ If you entered a non-IP address (meaning you used a domain name) for DoT or DoH,
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)
```yaml
// values.yaml
bootstrapDns:
# Google
upstream: "8.8.8.8"
```
## DNS Blacklists and Whitelists
Blocky comes preconfigured with basic Blacklists and Whitelists. DNS Blacklists are used to prevent DNS resolution of advertisement, malware, trackers and adult sites domains. DNS Whitelists are used to always allow DNS resolution of domains regardless of existing blacklists. This is completed with public maintained blocklists. A good source for these is [firebog.net](https://firebog.net).
Blocky comes preconfigured with basic Blacklists and Whitelists (commented out by default). DNS Blacklists are used to prevent DNS resolution of advertisement, malware, trackers and adult sites domains. DNS Whitelists are used to always allow DNS resolution of domains regardless of existing blacklists. This is completed with public maintained blocklists. A good source for these is [firebog.net](https://firebog.net).
:::caution
@@ -82,11 +114,22 @@ certain blocklists if you find legitimate traffic being blocked.
:::
If you wish to customize the default Block Blacklists or Whitelists follow the steps below (replace whitelist as appropriate).
If you wish to enable or customize the default Block Blacklists or Whitelists follow the example below.
1. Set Group Name for your blocklists as `default`.
2. Add List entries for each blocklist by URL (or none if you wish to disable).
![blocky-blacklist](./img/blocky-blacklist.png)
```yaml
// values.yaml
blocking:
whitelist:
- name: default
lists:
- https://raw.githubusercontent.com/anudeepND/whitelist/master/domains/optional-list.txt
- https://raw.githubusercontent.com/anudeepND/whitelist/master/domains/whitelist.txt
- https://raw.githubusercontent.com/rahilpathan/pihole-whitelist/main/1.LowWL.txt
blacklist:
- name: default
lists:
- https://big.oisd.nl/domainswild
```
## Networking
@@ -101,7 +144,12 @@ k8s-Gateway will automatically provide split DNS for your local domain. This wil
you to resolve all ingress configured subdomains locally. All that is required for setup
is to add your root domain in the Domain name block.
![blocky-k8s-gateway](./img/blocky-k8s-gateway.png)
```yaml
// values.yaml
k8sgateway:
domains:
- domain: "domain.tld"
```
## Prometheus/Grafana