feat(blocky): add blocky documentation links to descriptions (#3964)

* add blocky documentation links to descriptions

* run pre-commit on all files

Co-authored-by: Stavros kois <s.kois@outlook.com>
This commit is contained in:
ksimm1
2022-09-30 18:00:41 +02:00
committed by GitHub
co-authored by Stavros kois
parent 267251554f
commit 1888e072b7
5 changed files with 23 additions and 6 deletions
+1 -1
View File
@@ -312,7 +312,7 @@ This project follows the [all-contributors](https://github.com/all-contributors/
--- ---
Truecharts, is primarily based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts. Truecharts, is primarily based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts.
As a lot of Charts are based on upstream Helm Charts, Licences can vary on a per-Chart basis. This can easily be seen by the presence of a "LICENSE" file in said folder. As a lot of Charts are based on upstream Helm Charts, Licences can vary on a per-Chart basis. This can easily be seen by the presence of a "LICENSE" file in said folder.
An exception to this, has been made for every document inside folders labeled as `docs` or `doc` and their subfolders: those folders are not licensed under BSD-3-clause and are considered "all rights reserved". Said content can be modified and changes submitted per PR, in accordance to the github End User License Agreement. An exception to this, has been made for every document inside folders labeled as `docs` or `doc` and their subfolders: those folders are not licensed under BSD-3-clause and are considered "all rights reserved". Said content can be modified and changes submitted per PR, in accordance to the github End User License Agreement.
+1 -1
View File
@@ -48,7 +48,7 @@ excluded-charts:
- charts/dev/cstrike1-6 - charts/dev/cstrike1-6
- charts/dev/cstrikeconditionzero - charts/dev/cstrikeconditionzero
- charts/stable/plex-meta-manager - charts/stable/plex-meta-manager
- charts/incubator/plex-meta-manager - charts/incubator/plex-meta-manager
chart-repos: chart-repos:
- truecharts=https://charts.truecharts.org - truecharts=https://charts.truecharts.org
- truecharts-library=https://library-charts.truecharts.org - truecharts-library=https://library-charts.truecharts.org
+1 -1
View File
@@ -26,7 +26,7 @@ sources:
- https://github.com/0xERR0R/blocky - https://github.com/0xERR0R/blocky
- https://github.com/Mozart409/blocky-frontend - https://github.com/Mozart409/blocky-frontend
- https://hub.docker.com/r/spx01/blocky - https://hub.docker.com/r/spx01/blocky
version: 1.1.0 version: 1.1.1
annotations: annotations:
truecharts.org/catagories: | truecharts.org/catagories: |
- network - network
+18 -1
View File
@@ -55,7 +55,8 @@ questions:
- variable: upstreams - variable: upstreams
group: Container Configuration group: Container Configuration
label: Upstreams Groups label: Upstreams Groups
description: description: Refer to
<br /><a href="https://0xerr0r.github.io/blocky/configuration/#upstream-configuration" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#upstream-configuration</a>
schema: schema:
type: list type: list
default: [] default: []
@@ -88,6 +89,8 @@ questions:
- variable: bootstrapDns - variable: bootstrapDns
group: Container Configuration group: Container Configuration
label: Bootstrap DNS label: Bootstrap DNS
description: Used to resolve upstream DoH and DoT servers that are specified as hostnames.
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#bootstrap-dns-configuration" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#bootstrap-dns-configuration</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -112,6 +115,8 @@ questions:
- variable: filtering - variable: filtering
group: Container Configuration group: Container Configuration
label: Filtering label: Filtering
description: Define one or more DNS query types; all queries with these types will be dropped
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#filtering" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#filtering</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -131,6 +136,8 @@ questions:
- variable: customDNS - variable: customDNS
group: Container Configuration group: Container Configuration
label: Custom DNS label: Custom DNS
description: Define your own domain name to IP mappings.
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#custom-dns" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#custom-dns</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -196,6 +203,8 @@ questions:
- variable: clientLookup - variable: clientLookup
group: Container Configuration group: Container Configuration
label: Client Lookup label: Client Lookup
description: Blocky can try to resolve a user-friendly client name from the IP address or server URL (DoT and DoH)
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#client-name-lookup" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#client-name-lookup</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -250,6 +259,8 @@ questions:
- variable: caching - variable: caching
group: Container Configuration group: Container Configuration
label: Caching label: Caching
description: Refer to
<br /><a href="https://0xerr0r.github.io/blocky/configuration/#caching" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#caching</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -297,6 +308,8 @@ questions:
- variable: conditional - variable: conditional
group: Container Configuration group: Container Configuration
label: Conditional label: Conditional
description: Define which DNS resolver(s) should be used for queries for the particular domain
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#conditional-dns-resolution" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#conditional-dns-resolution</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -352,6 +365,8 @@ questions:
- variable: blocking - variable: blocking
group: Container Configuration group: Container Configuration
label: Blocking label: Blocking
description: Each black or whitelist can be either a path to the local file or a URL to download. All Urls must be grouped to a group name.
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#blocking-and-whitelisting" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#blocking-and-whitelisting</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
@@ -503,6 +518,8 @@ questions:
- variable: hostsFile - variable: hostsFile
group: Container Configuration group: Container Configuration
label: Hosts File label: Hosts File
description: You can enable resolving of entries, located in local hosts file.
<br />Refer to <a href="https://0xerr0r.github.io/blocky/configuration/#hosts-file" target="_blank" rel="noopener noreferrer">https://0xerr0r.github.io/blocky/configuration/#hosts-file</a>
schema: schema:
additional_attrs: true additional_attrs: true
type: dict type: dict
+2 -2
View File
@@ -245,7 +245,7 @@
schema: schema:
show_if: [["type", "=", "LoadBalancer"]] show_if: [["type", "=", "LoadBalancer"]]
type: string type: string
default: "" default: ""
- variable: advancedsvcset - variable: advancedsvcset
label: Show Advanced Service Settings label: Show Advanced Service Settings
schema: schema:
@@ -287,7 +287,7 @@
- variable: ipFamily - variable: ipFamily
label: IP Family label: IP Family
schema: schema:
type: string type: string
- variable: ports - variable: ports
label: "" label: ""
schema: schema: