From d99ceec4014a77a3bcc12ed36c16dbeb6306439f Mon Sep 17 00:00:00 2001
From: kqmaverick <121722567+kqmaverick@users.noreply.github.com>
Date: Sun, 18 Jun 2023 05:27:40 -0700
Subject: [PATCH] docs(blocky): fix lines breaks (#9736)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
**Description**
3rd attempt at line break fix.
⚒️ 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
**➕ 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: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>
---
.github/scripts/tc-lint.sh | 13 ++++--
charts/enterprise/blocky/docs/setup-guide.md | 43 +++++++++++---------
2 files changed, 33 insertions(+), 23 deletions(-)
diff --git a/.github/scripts/tc-lint.sh b/.github/scripts/tc-lint.sh
index 86fefffabbe..61cd4b5de99 100755
--- a/.github/scripts/tc-lint.sh
+++ b/.github/scripts/tc-lint.sh
@@ -4,13 +4,15 @@ function check_version() {
chart_path=${1:?"No chart path provided to [Version Check]"}
target_branch=${2:?"No target branch provided to [Version Check]"}
- chart_dir=$(dirname "$chart_path")
# If only docs changed, skip version check
- chart_changes=$(git diff "$target_branch" -- "$chart_dir" :^docs)
+ # git diff target_branch, filter only on $chart_path and invert match for $chart_path/docs
+ # note that it requires branches to be up to date for this to work.
+ chart_changes=$(git diff --name-status "$target_branch" -- "$chart_path" | grep -v "$chart_path/docs")
if [[ -z "$chart_changes" ]]; then
- echo "Looks like only docs changed. Skipping chart version check"
+ echo -e "\tLooks like only docs changed. Skipping chart version check"
echo -e "\t✅ Chart version: No bump required"
+ echo ''
return
fi
@@ -33,6 +35,7 @@ function check_version() {
curr_result=1
fi
fi
+ echo ''
}
export -f check_version
@@ -53,6 +56,7 @@ function check_chart_schema(){
else
echo -e "\t✅ Chart Schema: Passed"
fi
+ echo ''
}
export -f check_chart_schema
@@ -74,6 +78,7 @@ function helm_lint(){
else
echo -e "\t✅ Helm Lint: Passed"
fi
+ echo ''
}
export -f helm_lint
@@ -100,6 +105,7 @@ function helm_template(){
else
echo -e "\t✅ Helm template: Passed"
fi
+ echo ''
}
export -f helm_template
@@ -120,6 +126,7 @@ function yaml_lint(){
else
echo -e "\t✅ YAML Lint: Passed [$file_path]"
fi
+ echo ''
}
export -f yaml_lint
diff --git a/charts/enterprise/blocky/docs/setup-guide.md b/charts/enterprise/blocky/docs/setup-guide.md
index fa24b6bee17..d986aa62627 100644
--- a/charts/enterprise/blocky/docs/setup-guide.md
+++ b/charts/enterprise/blocky/docs/setup-guide.md
@@ -8,64 +8,67 @@ Blocky has multiple DNS entries configured by default these can be overridden to
Blocky supports 3 methods for upstream DNS.
-UDP - Basic DNS
-DoT - DNS over TLS
-DoH - DNS over HTTPS
+- 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.
### UDP DNS Setup
-Google DNS: `8.8.8.8` `8.8.4.4`
-Cloudflare DNS: `1.1.1.1` `1.0.0.1`
+- Google DNS: `8.8.8.8` `8.8.4.4`
+- Cloudflare DNS: `1.1.1.1` `1.0.0.1`
### DoT DNS Setup
-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`
+- 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`
### 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`
+- 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`
## 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.
+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.
## DNS Blacklists
-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).
+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).
:::warning Warning
-While publicly maintained blocklists usually do a good job of allowing legitimate traffic they can sometimes be too broad and catch traffic that you wish to allow. You may need to disable certain blocklists if you find legitimate traffic being blocked.
+While publicly maintained blocklists usually do a good job of allowing legitimate traffic they
+can sometimes be too broad and catch traffic that you wish to allow. You may need to disable
+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.
-
-
+ 
## k8s-Gateway Configuration
-k8s-Gateway will automatically provide split DNS for your local domain. This will allow 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.
+k8s-Gateway will automatically provide split DNS for your local domain. This will allow
+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.
