From 8b700222d8861c0edb65fe4fd0782b145177fbf5 Mon Sep 17 00:00:00 2001 From: kqmaverick <121722567+kqmaverick@users.noreply.github.com> Date: Sat, 23 Mar 2024 01:12:04 -0700 Subject: [PATCH] docs(blocky): update setup guide (#19658) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit **Description** Update Blocky setup guide with recent changes. ⚒️ 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 - [X] 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._ --- charts/premium/blocky/docs/setup-guide.md | 32 +++++++++++------------ 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/charts/premium/blocky/docs/setup-guide.md b/charts/premium/blocky/docs/setup-guide.md index f2e231f9574..7264dce27e8 100644 --- a/charts/premium/blocky/docs/setup-guide.md +++ b/charts/premium/blocky/docs/setup-guide.md @@ -8,22 +8,25 @@ This will guide you through the basic setup of Blocky which is the preferred DNS 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: +Cloudflare - 1.1.1.1 - 1.0.0.1 + +Google - 8.8.8.8 - 8.8.4.4 + +Quad9 - 9.9.9.9 - 149.112.112.112 + +OpenDNS - 208.67.222.222 - 208.67.220.220 + +ComodoSecure DNS - 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. @@ -62,11 +65,9 @@ In the below example I am using Google DNS. ![blocky-bootstrap-google](./img/blocky-bootstrap-google.png) -## DNS Blacklists +## DNS Blacklists and Whitelists -DNS Blacklists are used to prevent DNS resolution of advertisement, malware, trackers -and adult sites domains. 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. 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). :::warning Warning @@ -76,12 +77,11 @@ 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. +If you wish to customize the default Block Blacklists or Whitelists follow the steps below (replace whitelist as appropriate). + +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) -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) ## Networking @@ -100,4 +100,4 @@ is to add your root domain in the Domain name block. ## Prometheus/Grafana -TBD +Prometheus and Grafana are configured by default.