From 67530323b2bef1df4de13f489df26a38490fcb9c Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 30 Jun 2024 13:39:18 -0700 Subject: [PATCH 01/49] Update cloudflared.md Changed DoH IP addresses to DNS lookups and added new information. Signed-off-by: Mike --- docs/guides/dns/cloudflared.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index 7ec07ac..6adf3b3 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -9,12 +9,12 @@ It is worth noting, however, that the upstream DNS-Over-HTTPS provider will stil ## Configuring DNS-Over-HTTPS -Along with releasing their DNS service [1.1.1.1](https://blog.cloudflare.com/announcing-1111/), Cloudflare implemented DNS-Over-HTTPS proxy functionality into one of their tools: [`cloudflared`](https://github.com/cloudflare/cloudflared). +Along with releasing their DNS service [1.1.1.1](https://blog.cloudflare.com/announcing-1111/) (and later [1.1.1.1 for Families](https://blog.cloudflare.com/introducing-1-1-1-1-for-families)) Cloudflare implemented DNS-Over-HTTPS proxy functionality into one of their tools: [`cloudflared`](https://github.com/cloudflare/cloudflared). In the following sections, we will be covering how to install and configure this tool on `Pi-hole`. !!! info - The `cloudflared` binary will work with other DoH providers (for example, you could use `https://8.8.8.8/dns-query` for Google's DNS-Over-HTTPS service). + The `cloudflared` binary will also work with other DoH providers (for example, you could use `https://dns.google/dns-query` for [Google's DoH service](https://developers.google.com/speed/public-dns/docs/doh) or `https://dns.quad9.net/dns-query` for [Quad9's DoH service](https://quad9.net/service/service-addresses-and-features)). ### Installing `cloudflared` @@ -81,8 +81,10 @@ Edit configuration file by copying the following in to `/etc/default/cloudflared ```bash # Commandline args for cloudflared, using Cloudflare DNS -CLOUDFLARED_OPTS=--port 5053 --upstream https://1.1.1.1/dns-query --upstream https://1.0.0.1/dns-query +CLOUDFLARED_OPTS=--port 5053 --upstream https://cloudflare-dns.com/dns-query ``` +!!! info + See the other available [Cloudflare endpoints](https://developers.cloudflare.com/1.1.1.1/infrastructure/network-operators/#available-endpoints). Update the permissions for the configuration file and `cloudflared` binary to allow access for the cloudflared user: @@ -160,7 +162,7 @@ Finally, configure Pi-hole to use the local `cloudflared` service as the upstrea ### Updating `cloudflared` -The `cloudflared` tool will not receive updates through the package manager. However, you should keep the program update to date. You can either do this manually, or via a cron script. +The `cloudflared` tool will not receive updates through the package manager. However, you should keep the program update to date. You can either do this manually (e.g. by watching their [repo](https://github.com/cloudflare/cloudflared)), or via a cron script. The procedure for updating depends on how you configured the `cloudflared` binary. From 72825d8d389e56385062ce7c74a9e229b759c0c7 Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 30 Jun 2024 13:57:33 -0700 Subject: [PATCH 02/49] Update cloudflared.md Fixed MD error. Signed-off-by: Mike --- docs/guides/dns/cloudflared.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index 6adf3b3..91a7082 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -83,6 +83,7 @@ Edit configuration file by copying the following in to `/etc/default/cloudflared # Commandline args for cloudflared, using Cloudflare DNS CLOUDFLARED_OPTS=--port 5053 --upstream https://cloudflare-dns.com/dns-query ``` + !!! info See the other available [Cloudflare endpoints](https://developers.cloudflare.com/1.1.1.1/infrastructure/network-operators/#available-endpoints). @@ -162,7 +163,7 @@ Finally, configure Pi-hole to use the local `cloudflared` service as the upstrea ### Updating `cloudflared` -The `cloudflared` tool will not receive updates through the package manager. However, you should keep the program update to date. You can either do this manually (e.g. by watching their [repo](https://github.com/cloudflare/cloudflared)), or via a cron script. +The `cloudflared` tool will not receive updates through the package manager. However, you should keep the program update to date. You can either do this manually (e.g. by watching their [repo](https://github.com/cloudflare/cloudflared) for new releases), or via a cron script. The procedure for updating depends on how you configured the `cloudflared` binary. From bcf754c59416a4ff46aa41f81b50178c5b8e9b43 Mon Sep 17 00:00:00 2001 From: voltagex Date: Sat, 24 Aug 2024 22:23:14 +1000 Subject: [PATCH 03/49] Typo - tine -> tune Signed-off-by: voltagex --- docs/regex/pi-hole.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/regex/pi-hole.md b/docs/regex/pi-hole.md index e2a37ae..f079b80 100644 --- a/docs/regex/pi-hole.md +++ b/docs/regex/pi-hole.md @@ -2,7 +2,7 @@ ## Only match specific query types -You can amend the regular expressions by special keywords added at the end to fine-tine regular expressions to match only specific [query types](../database/ftl.md#supported-query-types). In contrast to the description of `OTHER` as being deprecated for storing queries in the database, it is still supported for regular expressions and will match all queries that are not *explicitly* covered by the other query types (see also example below). +You can amend the regular expressions by special keywords added at the end to fine-tune regular expressions to match only specific [query types](../database/ftl.md#supported-query-types). In contrast to the description of `OTHER` as being deprecated for storing queries in the database, it is still supported for regular expressions and will match all queries that are not *explicitly* covered by the other query types (see also example below). Example: From bca6b35d00a3074a974f4138d18c3f1779c8e527 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 24 Aug 2024 12:48:37 +0000 Subject: [PATCH 04/49] Bump the pip-dependencies group with 2 updates Bumps the pip-dependencies group with 2 updates: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.6 to 1.2.7 - [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases) - [Commits](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.6...v1.2.7) Updates `mkdocs-material` from 9.5.31 to 9.5.33 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.31...9.5.33) --- updated-dependencies: - dependency-name: mkdocs-git-revision-date-localized-plugin dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 68fe7c9..a161d2b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.0 -mkdocs-git-revision-date-localized-plugin==1.2.6 -mkdocs-material==9.5.31 +mkdocs-git-revision-date-localized-plugin==1.2.7 +mkdocs-material==9.5.33 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From f145a99a073de888cb645938581c35bbfcb6d131 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 31 Aug 2024 10:50:06 +0000 Subject: [PATCH 05/49] Bump mkdocs from 1.6.0 to 1.6.1 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs](https://github.com/mkdocs/mkdocs). Updates `mkdocs` from 1.6.0 to 1.6.1 - [Release notes](https://github.com/mkdocs/mkdocs/releases) - [Commits](https://github.com/mkdocs/mkdocs/compare/1.6.0...1.6.1) --- updated-dependencies: - dependency-name: mkdocs dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index a161d2b..96f6c75 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -mkdocs==1.6.0 +mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.7 mkdocs-material==9.5.33 mkdocs-redirects==1.2.1 From 30f19f8335863cb0ca82246f79fb75a32eaafa0f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 31 Aug 2024 10:05:00 +0000 Subject: [PATCH 06/49] Bump actions/setup-python in the github_action-dependencies group Bumps the github_action-dependencies group with 1 update: [actions/setup-python](https://github.com/actions/setup-python). Updates `actions/setup-python` from 5.1.1 to 5.2.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v5.1.1...v5.2.0) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2ee0f50..515abc1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: fetch-depth: 0 - name: Set up Python - uses: actions/setup-python@v5.1.1 + uses: actions/setup-python@v5.2.0 with: python-version: "${{ env.PYTHON_VERSION }}" architecture: "x64" From 2a6cb98a5173ae6a7586ed76b1f2c360f72c8014 Mon Sep 17 00:00:00 2001 From: jahway603 Date: Thu, 25 Jul 2024 09:40:08 -0400 Subject: [PATCH 07/49] Remove Debian 10 from supported OS as it has not had Debian Security Support since 10 Sep 2022 --- docs/main/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/main/prerequisites.md b/docs/main/prerequisites.md index b2cb8e8..1c05897 100644 --- a/docs/main/prerequisites.md +++ b/docs/main/prerequisites.md @@ -30,7 +30,7 @@ The following operating systems are **officially** supported: | Raspberry Pi OS
(formerly Raspbian) | Buster / Bullseye | ARM | | Armbian OS | Any | ARM / x86_64 / riscv64 | | Ubuntu | 20.x / 22.x / 23.x / 24.x | ARM / x86_64 | -| Debian | 10 / 11 / 12 | ARM / x86_64 / i386 | +| Debian | 11 / 12 | ARM / x86_64 / i386 | | Fedora | 39 / 40 | ARM / x86_64 | | CentOS Stream | 9 | x86_64 | From 156fe5e71bd5bb71d06906eb2c0e50bbd9706ebd Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 7 Sep 2024 10:44:20 +0000 Subject: [PATCH 08/49] Bump mkdocs-material from 9.5.33 to 9.5.34 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.33 to 9.5.34 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.33...9.5.34) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 96f6c75..5a4811d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.7 -mkdocs-material==9.5.33 +mkdocs-material==9.5.34 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From ffe09cac8469c09dd6fcef473602a4df248a71a3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 7 Sep 2024 11:14:34 +0000 Subject: [PATCH 09/49] Bump markdownlint-cli2 in the npm-dependencies group Bumps the npm-dependencies group with 1 update: [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2). Updates `markdownlint-cli2` from 0.13.0 to 0.14.0 - [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md) - [Commits](https://github.com/DavidAnson/markdownlint-cli2/compare/v0.13.0...v0.14.0) --- updated-dependencies: - dependency-name: markdownlint-cli2 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-dependencies ... Signed-off-by: dependabot[bot] --- package-lock.json | 129 ++++++++++++++++++++++++---------------------- package.json | 2 +- 2 files changed, 67 insertions(+), 64 deletions(-) diff --git a/package-lock.json b/package-lock.json index b0f871c..3933187 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "CC-BY-SA-4.0", "devDependencies": { "linkinator": "^6.1.1", - "markdownlint-cli2": "0.13.0" + "markdownlint-cli2": "0.14.0" } }, "node_modules/@isaacs/cliui": { @@ -411,9 +411,9 @@ } }, "node_modules/globby": { - "version": "14.0.1", - "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.1.tgz", - "integrity": "sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ==", + "version": "14.0.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.2.tgz", + "integrity": "sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw==", "dev": true, "dependencies": { "@sindresorhus/merge-streams": "^2.1.0", @@ -463,9 +463,9 @@ } }, "node_modules/ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true, "engines": { "node": ">= 4" @@ -559,9 +559,9 @@ } }, "node_modules/jsonc-parser": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", - "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", "dev": true }, "node_modules/linkify-it": { @@ -624,13 +624,13 @@ } }, "node_modules/markdownlint": { - "version": "0.34.0", - "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.34.0.tgz", - "integrity": "sha512-qwGyuyKwjkEMOJ10XN6OTKNOVYvOIi35RNvDLNxTof5s8UmyGHlCdpngRHoRGNvQVGuxO3BJ7uNSgdeX166WXw==", + "version": "0.35.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.35.0.tgz", + "integrity": "sha512-wgp8yesWjFBL7bycA3hxwHRdsZGJhjhyP1dSxKVKrza0EPFYtn+mHtkVy6dvP1kGSjovyG5B8yNP6Frj0UFUJg==", "dev": true, "dependencies": { "markdown-it": "14.1.0", - "markdownlint-micromark": "0.1.9" + "markdownlint-micromark": "0.1.10" }, "engines": { "node": ">=18" @@ -640,17 +640,17 @@ } }, "node_modules/markdownlint-cli2": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.13.0.tgz", - "integrity": "sha512-Pg4nF7HlopU97ZXtrcVISWp3bdsuc5M0zXyLp2/sJv2zEMlInrau0ZKK482fQURzVezJzWBpNmu4u6vGAhij+g==", + "version": "0.14.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.14.0.tgz", + "integrity": "sha512-2cqdWy56frU2FTpbuGb83mEWWYuUIYv6xS8RVEoUAuKNw/hXPar2UYGpuzUhlFMngE8Omaz4RBH52MzfRbGshw==", "dev": true, "dependencies": { - "globby": "14.0.1", + "globby": "14.0.2", "js-yaml": "4.1.0", - "jsonc-parser": "3.2.1", - "markdownlint": "0.34.0", - "markdownlint-cli2-formatter-default": "0.0.4", - "micromatch": "4.0.5" + "jsonc-parser": "3.3.1", + "markdownlint": "0.35.0", + "markdownlint-cli2-formatter-default": "0.0.5", + "micromatch": "4.0.8" }, "bin": { "markdownlint-cli2": "markdownlint-cli2.js" @@ -663,18 +663,21 @@ } }, "node_modules/markdownlint-cli2-formatter-default": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.4.tgz", - "integrity": "sha512-xm2rM0E+sWgjpPn1EesPXx5hIyrN2ddUnUwnbCsD/ONxYtw3PX6LydvdH6dciWAoFDpwzbHM1TO7uHfcMd6IYg==", + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.5.tgz", + "integrity": "sha512-4XKTwQ5m1+Txo2kuQ3Jgpo/KmnG+X90dWt4acufg6HVGadTUG5hzHF/wssp9b5MBYOMCnZ9RMPaU//uHsszF8Q==", "dev": true, + "funding": { + "url": "https://github.com/sponsors/DavidAnson" + }, "peerDependencies": { "markdownlint-cli2": ">=0.0.4" } }, "node_modules/markdownlint-micromark": { - "version": "0.1.9", - "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.9.tgz", - "integrity": "sha512-5hVs/DzAFa8XqYosbEAEg6ok6MF2smDj89ztn9pKkCtdKHVdPQuGMH7frFfYL9mLkvfFe4pTyAMffLbjf3/EyA==", + "version": "0.1.10", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.10.tgz", + "integrity": "sha512-no5ZfdqAdWGxftCLlySHSgddEjyW4kui4z7amQcGsSKfYC5v/ou+8mIQVyg9KQMeEZLNtz9OPDTj7nnTnoR4FQ==", "dev": true, "engines": { "node": ">=18" @@ -723,12 +726,12 @@ } }, "node_modules/micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, "dependencies": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" }, "engines": { @@ -1518,9 +1521,9 @@ } }, "globby": { - "version": "14.0.1", - "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.1.tgz", - "integrity": "sha512-jOMLD2Z7MAhyG8aJpNOpmziMOP4rPLcc95oQPKXBazW82z+CEgPFBQvEpRUa1KeIMUJo4Wsm+q6uzO/Q/4BksQ==", + "version": "14.0.2", + "resolved": "https://registry.npmjs.org/globby/-/globby-14.0.2.tgz", + "integrity": "sha512-s3Fq41ZVh7vbbe2PN3nrW7yC7U7MFVc5c98/iTl9c2GawNMKx/J648KQRW6WKkuU8GIbbh2IXfIRQjOZnXcTnw==", "dev": true, "requires": { "@sindresorhus/merge-streams": "^2.1.0", @@ -1554,9 +1557,9 @@ } }, "ignore": { - "version": "5.3.1", - "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", - "integrity": "sha512-5Fytz/IraMjqpwfd34ke28PTVMjZjJG2MPn5t7OE4eUCUNf8BAa7b5WUS9/Qvr6mwOQS7Mk6vdsMno5he+T8Xw==", + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.2.tgz", + "integrity": "sha512-hsBTNUqQTDwkWtcdYI2i06Y/nUBEsNEDJKjWdigLvegy8kDuJAS8uRlpkkcQpyEXL0Z/pjDy5HBmMjRCJ2gq+g==", "dev": true }, "is-extglob": { @@ -1618,9 +1621,9 @@ } }, "jsonc-parser": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", - "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", + "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", "dev": true }, "linkify-it": { @@ -1671,40 +1674,40 @@ } }, "markdownlint": { - "version": "0.34.0", - "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.34.0.tgz", - "integrity": "sha512-qwGyuyKwjkEMOJ10XN6OTKNOVYvOIi35RNvDLNxTof5s8UmyGHlCdpngRHoRGNvQVGuxO3BJ7uNSgdeX166WXw==", + "version": "0.35.0", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.35.0.tgz", + "integrity": "sha512-wgp8yesWjFBL7bycA3hxwHRdsZGJhjhyP1dSxKVKrza0EPFYtn+mHtkVy6dvP1kGSjovyG5B8yNP6Frj0UFUJg==", "dev": true, "requires": { "markdown-it": "14.1.0", - "markdownlint-micromark": "0.1.9" + "markdownlint-micromark": "0.1.10" } }, "markdownlint-cli2": { - "version": "0.13.0", - "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.13.0.tgz", - "integrity": "sha512-Pg4nF7HlopU97ZXtrcVISWp3bdsuc5M0zXyLp2/sJv2zEMlInrau0ZKK482fQURzVezJzWBpNmu4u6vGAhij+g==", + "version": "0.14.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.14.0.tgz", + "integrity": "sha512-2cqdWy56frU2FTpbuGb83mEWWYuUIYv6xS8RVEoUAuKNw/hXPar2UYGpuzUhlFMngE8Omaz4RBH52MzfRbGshw==", "dev": true, "requires": { - "globby": "14.0.1", + "globby": "14.0.2", "js-yaml": "4.1.0", - "jsonc-parser": "3.2.1", - "markdownlint": "0.34.0", - "markdownlint-cli2-formatter-default": "0.0.4", - "micromatch": "4.0.5" + "jsonc-parser": "3.3.1", + "markdownlint": "0.35.0", + "markdownlint-cli2-formatter-default": "0.0.5", + "micromatch": "4.0.8" } }, "markdownlint-cli2-formatter-default": { - "version": "0.0.4", - "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.4.tgz", - "integrity": "sha512-xm2rM0E+sWgjpPn1EesPXx5hIyrN2ddUnUwnbCsD/ONxYtw3PX6LydvdH6dciWAoFDpwzbHM1TO7uHfcMd6IYg==", + "version": "0.0.5", + "resolved": "https://registry.npmjs.org/markdownlint-cli2-formatter-default/-/markdownlint-cli2-formatter-default-0.0.5.tgz", + "integrity": "sha512-4XKTwQ5m1+Txo2kuQ3Jgpo/KmnG+X90dWt4acufg6HVGadTUG5hzHF/wssp9b5MBYOMCnZ9RMPaU//uHsszF8Q==", "dev": true, "requires": {} }, "markdownlint-micromark": { - "version": "0.1.9", - "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.9.tgz", - "integrity": "sha512-5hVs/DzAFa8XqYosbEAEg6ok6MF2smDj89ztn9pKkCtdKHVdPQuGMH7frFfYL9mLkvfFe4pTyAMffLbjf3/EyA==", + "version": "0.1.10", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.10.tgz", + "integrity": "sha512-no5ZfdqAdWGxftCLlySHSgddEjyW4kui4z7amQcGsSKfYC5v/ou+8mIQVyg9KQMeEZLNtz9OPDTj7nnTnoR4FQ==", "dev": true }, "marked": { @@ -1732,12 +1735,12 @@ "dev": true }, "micromatch": { - "version": "4.0.5", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", - "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.8.tgz", + "integrity": "sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==", "dev": true, "requires": { - "braces": "^3.0.2", + "braces": "^3.0.3", "picomatch": "^2.3.1" } }, diff --git a/package.json b/package.json index 0eeff7e..6042073 100644 --- a/package.json +++ b/package.json @@ -23,6 +23,6 @@ }, "devDependencies": { "linkinator": "^6.1.1", - "markdownlint-cli2": "0.13.0" + "markdownlint-cli2": "0.14.0" } } From 8e680072bb250115e1d962539cd6c8b13bbdeded Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 14 Sep 2024 10:05:50 +0000 Subject: [PATCH 10/49] Bump mkdocs-git-revision-date-localized-plugin Bumps the pip-dependencies group with 1 update: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin). Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.7 to 1.2.9 - [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases) - [Commits](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.7...v1.2.9) --- updated-dependencies: - dependency-name: mkdocs-git-revision-date-localized-plugin dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 5a4811d..c83f4bc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 -mkdocs-git-revision-date-localized-plugin==1.2.7 +mkdocs-git-revision-date-localized-plugin==1.2.9 mkdocs-material==9.5.34 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From 7a9e440d336660bdede8f50778280a21c32882d9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 21 Sep 2024 10:02:44 +0000 Subject: [PATCH 11/49] Bump actions/setup-node in the github_action-dependencies group Bumps the github_action-dependencies group with 1 update: [actions/setup-node](https://github.com/actions/setup-node). Updates `actions/setup-node` from 4.0.3 to 4.0.4 - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v4.0.3...v4.0.4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 515abc1..7b58ae9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -29,7 +29,7 @@ jobs: cache: pip - name: Set up Node.js - uses: actions/setup-node@v4.0.3 + uses: actions/setup-node@v4.0.4 with: node-version: "${{ env.NODE }}" cache: npm From f117763c635ab77023009221d64411f69423234c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 21 Sep 2024 10:38:00 +0000 Subject: [PATCH 12/49] Bump mkdocs-material from 9.5.34 to 9.5.36 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.34 to 9.5.36 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.34...9.5.36) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index c83f4bc..5b300dd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.34 +mkdocs-material==9.5.36 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From 8b5c53c83fb1de7aaa42e92a9a66d8bfd60bab62 Mon Sep 17 00:00:00 2001 From: Stephen Glass Date: Tue, 24 Sep 2024 21:47:44 -0400 Subject: [PATCH 13/49] Fix typo in cloudflared docs Signed-off-by: Stephen Glass --- docs/guides/dns/cloudflared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index 7ec07ac..67f90d2 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -200,7 +200,7 @@ sudo chown root:root /etc/cron.weekly/cloudflared-updater !!! warning Make sure to add shebang `#!/bin/bash` in the beginning of `/etc/cron.weekly/cloudflared-updater`. - Otherwise, the command would not executed. + Otherwise, the command will not be executed. The system will now attempt to update the cloudflared binary automatically, once per week. From efa0f876e9971feedf4f9d7d30f5ad3de19960f3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 28 Sep 2024 10:21:57 +0000 Subject: [PATCH 14/49] Bump mkdocs-material from 9.5.36 to 9.5.38 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.36 to 9.5.38 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.36...9.5.38) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 5b300dd..8027aa6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.36 +mkdocs-material==9.5.38 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From e7722dfb0015344d9dd867e26bf234985ac407a1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 28 Sep 2024 10:50:01 +0000 Subject: [PATCH 15/49] Bump actions/checkout in the github_action-dependencies group Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout). Updates `actions/checkout` from 4.1.7 to 4.2.0 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.1.7...v4.2.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/calibreapp-image-actions.yml | 2 +- .github/workflows/ci.yml | 2 +- .github/workflows/codespell.yml | 2 +- .github/workflows/editorconfig-checker.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml index f37b63b..0a1cc95 100644 --- a/.github/workflows/calibreapp-image-actions.yml +++ b/.github/workflows/calibreapp-image-actions.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repo - uses: actions/checkout@v4.1.7 + uses: actions/checkout@v4.2.0 - name: Compress Images uses: calibreapp/image-actions@1.1.0 # TODO: if they start using a tag like v1, switch to that diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7b58ae9..6e2a838 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,7 +17,7 @@ jobs: test: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 with: fetch-depth: 0 diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 405fb1a..2ebd053 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -10,7 +10,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.1.7 + uses: actions/checkout@v4.2.0 - name: Spell-Checking uses: codespell-project/actions-codespell@master diff --git a/.github/workflows/editorconfig-checker.yml b/.github/workflows/editorconfig-checker.yml index f02afe2..b43aa45 100644 --- a/.github/workflows/editorconfig-checker.yml +++ b/.github/workflows/editorconfig-checker.yml @@ -9,6 +9,6 @@ jobs: name: editorconfig-checker runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.1.7 + - uses: actions/checkout@v4.2.0 - uses: editorconfig-checker/action-editorconfig-checker@main - run: editorconfig-checker From 8d1dfba7727051421819bd1a421315e395c6e7ea Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 5 Oct 2024 10:06:43 +0000 Subject: [PATCH 16/49] Bump mkdocs-material from 9.5.38 to 9.5.39 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.38 to 9.5.39 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.38...9.5.39) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 8027aa6..437205a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.38 +mkdocs-material==9.5.39 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From ee02c850236bcc856fbfeed6f0e83966fc4fd71c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 5 Oct 2024 11:00:46 +0000 Subject: [PATCH 17/49] Bump mkdocs-material from 9.5.38 to 9.5.39 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.38 to 9.5.39 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.38...9.5.39) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 8027aa6..437205a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.38 +mkdocs-material==9.5.39 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From b0ab9741816d3c0041ff704c26f57dc74564ccaa Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sat, 5 Oct 2024 23:23:20 +0200 Subject: [PATCH 18/49] Remove version and architecture info from supported OS list Signed-off-by: yubiuser --- docs/main/prerequisites.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/main/prerequisites.md b/docs/main/prerequisites.md index 1c05897..0ea91c6 100644 --- a/docs/main/prerequisites.md +++ b/docs/main/prerequisites.md @@ -25,14 +25,14 @@ Pi-hole is supported on distributions utilizing [systemd](https://systemd.io/) o The following operating systems are **officially** supported: -| Distribution | Release | Architecture | -| ------------ | ---------------- | ------------------- | -| Raspberry Pi OS
(formerly Raspbian) | Buster / Bullseye | ARM | -| Armbian OS | Any | ARM / x86_64 / riscv64 | -| Ubuntu | 20.x / 22.x / 23.x / 24.x | ARM / x86_64 | -| Debian | 11 / 12 | ARM / x86_64 / i386 | -| Fedora | 39 / 40 | ARM / x86_64 | -| CentOS Stream | 9 | x86_64 | +- Raspberry Pi OS (formerly Raspbian) +- Armbian OS +- Ubuntu +- Debian +- Fedora +- CentOS Stream + +Pi-hole only supports actively maintained versions of these systems. !!! info From f2024549c22f0ba0a4fa0e9fc4543f455b81ead9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 12 Oct 2024 10:05:44 +0000 Subject: [PATCH 19/49] Bump actions/checkout in the github_action-dependencies group Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout). Updates `actions/checkout` from 4.2.0 to 4.2.1 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.2.0...v4.2.1) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/calibreapp-image-actions.yml | 2 +- .github/workflows/ci.yml | 2 +- .github/workflows/codespell.yml | 2 +- .github/workflows/editorconfig-checker.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml index 0a1cc95..966b967 100644 --- a/.github/workflows/calibreapp-image-actions.yml +++ b/.github/workflows/calibreapp-image-actions.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repo - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.1 - name: Compress Images uses: calibreapp/image-actions@1.1.0 # TODO: if they start using a tag like v1, switch to that diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6e2a838..64f20dc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,7 +17,7 @@ jobs: test: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.0 + - uses: actions/checkout@v4.2.1 with: fetch-depth: 0 diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 2ebd053..93144f2 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -10,7 +10,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.1 - name: Spell-Checking uses: codespell-project/actions-codespell@master diff --git a/.github/workflows/editorconfig-checker.yml b/.github/workflows/editorconfig-checker.yml index b43aa45..60d2a3c 100644 --- a/.github/workflows/editorconfig-checker.yml +++ b/.github/workflows/editorconfig-checker.yml @@ -9,6 +9,6 @@ jobs: name: editorconfig-checker runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.0 + - uses: actions/checkout@v4.2.1 - uses: editorconfig-checker/action-editorconfig-checker@main - run: editorconfig-checker From 86ae7a30540be370e41542d44a3cf22467d781f7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 12 Oct 2024 10:16:08 +0000 Subject: [PATCH 20/49] Bump mkdocs-material from 9.5.39 to 9.5.40 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.39 to 9.5.40 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.39...9.5.40) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 437205a..c8c31e9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.39 +mkdocs-material==9.5.40 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From 36915de8d51677afa790717c8a84ab91a1516d1e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 12 Oct 2024 10:25:52 +0000 Subject: [PATCH 21/49] Bump actions/checkout in the github_action-dependencies group Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout). Updates `actions/checkout` from 4.2.0 to 4.2.1 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.2.0...v4.2.1) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/calibreapp-image-actions.yml | 2 +- .github/workflows/ci.yml | 2 +- .github/workflows/codespell.yml | 2 +- .github/workflows/editorconfig-checker.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml index 0a1cc95..966b967 100644 --- a/.github/workflows/calibreapp-image-actions.yml +++ b/.github/workflows/calibreapp-image-actions.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repo - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.1 - name: Compress Images uses: calibreapp/image-actions@1.1.0 # TODO: if they start using a tag like v1, switch to that diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6e2a838..64f20dc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,7 +17,7 @@ jobs: test: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.0 + - uses: actions/checkout@v4.2.1 with: fetch-depth: 0 diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 3069e08..64bad6b 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -10,7 +10,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.2.0 + uses: actions/checkout@v4.2.1 - name: Spell-Checking uses: codespell-project/actions-codespell@master diff --git a/.github/workflows/editorconfig-checker.yml b/.github/workflows/editorconfig-checker.yml index b43aa45..60d2a3c 100644 --- a/.github/workflows/editorconfig-checker.yml +++ b/.github/workflows/editorconfig-checker.yml @@ -9,6 +9,6 @@ jobs: name: editorconfig-checker runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.0 + - uses: actions/checkout@v4.2.1 - uses: editorconfig-checker/action-editorconfig-checker@main - run: editorconfig-checker From d04d4bc0dc8fcd4caee22f424c7cbdb95fec5bd6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 12 Oct 2024 10:50:22 +0000 Subject: [PATCH 22/49] Bump linkinator from 6.1.1 to 6.1.2 in the npm-dependencies group Bumps the npm-dependencies group with 1 update: [linkinator](https://github.com/JustinBeckwith/linkinator). Updates `linkinator` from 6.1.1 to 6.1.2 - [Release notes](https://github.com/JustinBeckwith/linkinator/releases) - [Commits](https://github.com/JustinBeckwith/linkinator/compare/v6.1.1...v6.1.2) --- updated-dependencies: - dependency-name: linkinator dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-dependencies ... Signed-off-by: dependabot[bot] --- package-lock.json | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3933187..07f969e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "license": "CC-BY-SA-4.0", "devDependencies": { - "linkinator": "^6.1.1", + "linkinator": "^6.1.2", "markdownlint-cli2": "0.14.0" } }, @@ -574,9 +574,9 @@ } }, "node_modules/linkinator": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.1.tgz", - "integrity": "sha512-VNFhw71A8ORQKdNdUz6MqcdmoCK2SKWI+22dmcN/7KuERTxv9yfezh5MqwetH66DmRPvj9FMtATk+ck2P5XJjw==", + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.2.tgz", + "integrity": "sha512-PndSrQe21Hf4sn2vZldEzJmD0EUJbIsEy4jcZLcHd6IZfQ6rC6iv+Fwo666TWM9DcXjbCrHpxnVX6xaGrcJ/eA==", "dev": true, "dependencies": { "chalk": "^5.0.0", @@ -1636,9 +1636,9 @@ } }, "linkinator": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.1.tgz", - "integrity": "sha512-VNFhw71A8ORQKdNdUz6MqcdmoCK2SKWI+22dmcN/7KuERTxv9yfezh5MqwetH66DmRPvj9FMtATk+ck2P5XJjw==", + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.2.tgz", + "integrity": "sha512-PndSrQe21Hf4sn2vZldEzJmD0EUJbIsEy4jcZLcHd6IZfQ6rC6iv+Fwo666TWM9DcXjbCrHpxnVX6xaGrcJ/eA==", "dev": true, "requires": { "chalk": "^5.0.0", diff --git a/package.json b/package.json index ad55f6b..fddf890 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ "serve": "mkdocs serve --dev-addr 0.0.0.0:8000" }, "devDependencies": { - "linkinator": "^6.1.1", + "linkinator": "^6.1.2", "markdownlint-cli2": "0.14.0" } } From 4090db47b61619f20236ae348209bfc4dc6cae86 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 12 Oct 2024 12:39:29 +0000 Subject: [PATCH 23/49] Bump linkinator from 6.1.1 to 6.1.2 in the npm-dependencies group Bumps the npm-dependencies group with 1 update: [linkinator](https://github.com/JustinBeckwith/linkinator). Updates `linkinator` from 6.1.1 to 6.1.2 - [Release notes](https://github.com/JustinBeckwith/linkinator/releases) - [Commits](https://github.com/JustinBeckwith/linkinator/compare/v6.1.1...v6.1.2) --- updated-dependencies: - dependency-name: linkinator dependency-type: direct:development update-type: version-update:semver-patch dependency-group: npm-dependencies ... Signed-off-by: dependabot[bot] --- package-lock.json | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3933187..07f969e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "license": "CC-BY-SA-4.0", "devDependencies": { - "linkinator": "^6.1.1", + "linkinator": "^6.1.2", "markdownlint-cli2": "0.14.0" } }, @@ -574,9 +574,9 @@ } }, "node_modules/linkinator": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.1.tgz", - "integrity": "sha512-VNFhw71A8ORQKdNdUz6MqcdmoCK2SKWI+22dmcN/7KuERTxv9yfezh5MqwetH66DmRPvj9FMtATk+ck2P5XJjw==", + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.2.tgz", + "integrity": "sha512-PndSrQe21Hf4sn2vZldEzJmD0EUJbIsEy4jcZLcHd6IZfQ6rC6iv+Fwo666TWM9DcXjbCrHpxnVX6xaGrcJ/eA==", "dev": true, "dependencies": { "chalk": "^5.0.0", @@ -1636,9 +1636,9 @@ } }, "linkinator": { - "version": "6.1.1", - "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.1.tgz", - "integrity": "sha512-VNFhw71A8ORQKdNdUz6MqcdmoCK2SKWI+22dmcN/7KuERTxv9yfezh5MqwetH66DmRPvj9FMtATk+ck2P5XJjw==", + "version": "6.1.2", + "resolved": "https://registry.npmjs.org/linkinator/-/linkinator-6.1.2.tgz", + "integrity": "sha512-PndSrQe21Hf4sn2vZldEzJmD0EUJbIsEy4jcZLcHd6IZfQ6rC6iv+Fwo666TWM9DcXjbCrHpxnVX6xaGrcJ/eA==", "dev": true, "requires": { "chalk": "^5.0.0", diff --git a/package.json b/package.json index 6042073..85e56fe 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ "test": "npm run markdownlint && npm run linkinator" }, "devDependencies": { - "linkinator": "^6.1.1", + "linkinator": "^6.1.2", "markdownlint-cli2": "0.14.0" } } From b69b4c6f5a9884b39016e68485893a436136fb8a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 12 Oct 2024 14:15:28 +0000 Subject: [PATCH 24/49] Bump mkdocs-material from 9.5.39 to 9.5.40 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.39 to 9.5.40 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.39...9.5.40) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 437205a..c8c31e9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.39 +mkdocs-material==9.5.40 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From a8bed10dc19c58f65fb1a788e674549f2a287a4d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 19 Oct 2024 10:10:16 +0000 Subject: [PATCH 25/49] Bump mkdocs-material from 9.5.40 to 9.5.41 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.40 to 9.5.41 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.40...9.5.41) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index c8c31e9..656e1ca 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.40 +mkdocs-material==9.5.41 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From d14f2cc9c7e5db5e962cc6682aa4ab610b98eda6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 19 Oct 2024 10:42:17 +0000 Subject: [PATCH 26/49] Bump mkdocs-material from 9.5.40 to 9.5.41 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.40 to 9.5.41 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.40...9.5.41) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index c8c31e9..656e1ca 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.40 +mkdocs-material==9.5.41 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From adc8b15f06e716d368bb63633973f5224c5d45ed Mon Sep 17 00:00:00 2001 From: ChristophorusReyhan <39609246+ChristophorusReyhan@users.noreply.github.com> Date: Sat, 19 Oct 2024 21:05:35 +0700 Subject: [PATCH 27/49] Update cloudflared.md Add a step if cloudflared runs on different machine Signed-off-by: ChristophorusReyhan <39609246+ChristophorusReyhan@users.noreply.github.com> --- docs/guides/dns/cloudflared.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index 67f90d2..c9e167d 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -84,6 +84,13 @@ Edit configuration file by copying the following in to `/etc/default/cloudflared CLOUDFLARED_OPTS=--port 5053 --upstream https://1.1.1.1/dns-query --upstream https://1.0.0.1/dns-query ``` +If you're running cloudflared on different host than pi-hole, you can add listening address to all IPs: + +```bash +# Commandline args for cloudflared, using Cloudflare DNS +CLOUDFLARED_OPTS=--port 5053 --upstream https://1.1.1.1/dns-query --upstream https://1.0.0.1/dns-query --address 0.0.0.0 +``` + Update the permissions for the configuration file and `cloudflared` binary to allow access for the cloudflared user: ```bash From cfe105e84f176a8b007f17f8b564a122335ce468 Mon Sep 17 00:00:00 2001 From: ChristophorusReyhan <39609246+ChristophorusReyhan@users.noreply.github.com> Date: Sat, 19 Oct 2024 22:42:37 +0700 Subject: [PATCH 28/49] Update cloudflared.md Add waning Signed-off-by: ChristophorusReyhan <39609246+ChristophorusReyhan@users.noreply.github.com> --- docs/guides/dns/cloudflared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index c9e167d..8fdc07d 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -84,7 +84,7 @@ Edit configuration file by copying the following in to `/etc/default/cloudflared CLOUDFLARED_OPTS=--port 5053 --upstream https://1.1.1.1/dns-query --upstream https://1.0.0.1/dns-query ``` -If you're running cloudflared on different host than pi-hole, you can add listening address to all IPs: +If you're running cloudflared on different host than pi-hole, you can add listening address to all IPs (for security, change 0.0.0.0 to your machine's IP, e.g. 192.168.1.1): ```bash # Commandline args for cloudflared, using Cloudflare DNS From 79974f9e1030b2ac37d96c9b26e4a324c0dc33f9 Mon Sep 17 00:00:00 2001 From: Mike Date: Sun, 20 Oct 2024 12:53:51 -0700 Subject: [PATCH 29/49] Update docs/guides/dns/cloudflared.md Co-authored-by: yubiuser Signed-off-by: Mike --- docs/guides/dns/cloudflared.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index 91a7082..1d3e512 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -14,7 +14,7 @@ Along with releasing their DNS service [1.1.1.1](https://blog.cloudflare.com/ann In the following sections, we will be covering how to install and configure this tool on `Pi-hole`. !!! info - The `cloudflared` binary will also work with other DoH providers (for example, you could use `https://dns.google/dns-query` for [Google's DoH service](https://developers.google.com/speed/public-dns/docs/doh) or `https://dns.quad9.net/dns-query` for [Quad9's DoH service](https://quad9.net/service/service-addresses-and-features)). + The `cloudflared` binary will also work with other DoH providers (for example, [Google's DoH service](https://developers.google.com/speed/public-dns/docs/doh) or [Quad9's DoH service](https://quad9.net/service/service-addresses-and-features)). ### Installing `cloudflared` From 762f4c1516777b95f7cccb354d4ab1906918ec52 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Mon, 21 Oct 2024 18:01:28 +0200 Subject: [PATCH 30/49] Add SIGRT6 and SIGRT7 descriptions Signed-off-by: DL6ER --- docs/ftldns/signals.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/ftldns/signals.md b/docs/ftldns/signals.md index 65331ac..b7f7f24 100644 --- a/docs/ftldns/signals.md +++ b/docs/ftldns/signals.md @@ -74,3 +74,11 @@ Re-resolve all clients and forward destination hostnames. This forces refreshing ## Real-time signal 5 (SIG39) Re-parse ARP/neighbour-cache now to update the Network table now + +## Real-time signal 6 (SIG40) + +Signal used internally to terminate the embedded `dnsmasq`. Please do not use this signal to prevent misbehaviour. + +## Real-time signal 7 (SIG41) + +Scan binary search lookup tables for hash collisions and report if any are found. This is a debugging signal and not meaningful production. Scanning the lookup tables is a time-consuming operation and may stall DNS resolution for a while on low-end devices. From 116835ba3b191203d306172f6934accaf19122c6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 26 Oct 2024 10:03:29 +0000 Subject: [PATCH 31/49] Bump the github_action-dependencies group with 3 updates Bumps the github_action-dependencies group with 3 updates: [actions/checkout](https://github.com/actions/checkout), [actions/setup-python](https://github.com/actions/setup-python) and [actions/setup-node](https://github.com/actions/setup-node). Updates `actions/checkout` from 4.2.1 to 4.2.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.2.1...v4.2.2) Updates `actions/setup-python` from 5.2.0 to 5.3.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v5.2.0...v5.3.0) Updates `actions/setup-node` from 4.0.4 to 4.1.0 - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v4.0.4...v4.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_action-dependencies - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_action-dependencies - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/calibreapp-image-actions.yml | 2 +- .github/workflows/ci.yml | 6 +++--- .github/workflows/codespell.yml | 2 +- .github/workflows/editorconfig-checker.yml | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml index 966b967..b02224a 100644 --- a/.github/workflows/calibreapp-image-actions.yml +++ b/.github/workflows/calibreapp-image-actions.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repo - uses: actions/checkout@v4.2.1 + uses: actions/checkout@v4.2.2 - name: Compress Images uses: calibreapp/image-actions@1.1.0 # TODO: if they start using a tag like v1, switch to that diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 64f20dc..710abc2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,19 +17,19 @@ jobs: test: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.1 + - uses: actions/checkout@v4.2.2 with: fetch-depth: 0 - name: Set up Python - uses: actions/setup-python@v5.2.0 + uses: actions/setup-python@v5.3.0 with: python-version: "${{ env.PYTHON_VERSION }}" architecture: "x64" cache: pip - name: Set up Node.js - uses: actions/setup-node@v4.0.4 + uses: actions/setup-node@v4.1.0 with: node-version: "${{ env.NODE }}" cache: npm diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 64bad6b..9726936 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -10,7 +10,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.2.1 + uses: actions/checkout@v4.2.2 - name: Spell-Checking uses: codespell-project/actions-codespell@master diff --git a/.github/workflows/editorconfig-checker.yml b/.github/workflows/editorconfig-checker.yml index 60d2a3c..c67463b 100644 --- a/.github/workflows/editorconfig-checker.yml +++ b/.github/workflows/editorconfig-checker.yml @@ -9,6 +9,6 @@ jobs: name: editorconfig-checker runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.1 + - uses: actions/checkout@v4.2.2 - uses: editorconfig-checker/action-editorconfig-checker@main - run: editorconfig-checker From 9fc0867578d4c98eb3fa6551081c357566780958 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 26 Oct 2024 10:21:12 +0000 Subject: [PATCH 32/49] Bump the pip-dependencies group with 2 updates Bumps the pip-dependencies group with 2 updates: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.9 to 1.3.0 - [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases) - [Commits](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.9...v1.3.0) Updates `mkdocs-material` from 9.5.41 to 9.5.42 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.41...9.5.42) --- updated-dependencies: - dependency-name: mkdocs-git-revision-date-localized-plugin dependency-type: direct:production update-type: version-update:semver-minor dependency-group: pip-dependencies - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 656e1ca..b4f72b4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 -mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.41 +mkdocs-git-revision-date-localized-plugin==1.3.0 +mkdocs-material==9.5.42 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From bd6a760ca54e7253c1704f26a15b63dd0a0d1180 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 26 Oct 2024 10:28:06 +0000 Subject: [PATCH 33/49] Bump the pip-dependencies group with 2 updates Bumps the pip-dependencies group with 2 updates: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.9 to 1.3.0 - [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases) - [Commits](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/compare/v1.2.9...v1.3.0) Updates `mkdocs-material` from 9.5.41 to 9.5.42 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.41...9.5.42) --- updated-dependencies: - dependency-name: mkdocs-git-revision-date-localized-plugin dependency-type: direct:production update-type: version-update:semver-minor dependency-group: pip-dependencies - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 656e1ca..b4f72b4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 -mkdocs-git-revision-date-localized-plugin==1.2.9 -mkdocs-material==9.5.41 +mkdocs-git-revision-date-localized-plugin==1.3.0 +mkdocs-material==9.5.42 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From f33142cfb2d5a800edb072f5d3471ad7d0ab009e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 26 Oct 2024 10:30:23 +0000 Subject: [PATCH 34/49] Bump the github_action-dependencies group with 3 updates Bumps the github_action-dependencies group with 3 updates: [actions/checkout](https://github.com/actions/checkout), [actions/setup-python](https://github.com/actions/setup-python) and [actions/setup-node](https://github.com/actions/setup-node). Updates `actions/checkout` from 4.2.1 to 4.2.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4.2.1...v4.2.2) Updates `actions/setup-python` from 5.2.0 to 5.3.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v5.2.0...v5.3.0) Updates `actions/setup-node` from 4.0.4 to 4.1.0 - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](https://github.com/actions/setup-node/compare/v4.0.4...v4.1.0) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch dependency-group: github_action-dependencies - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_action-dependencies - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor dependency-group: github_action-dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/calibreapp-image-actions.yml | 2 +- .github/workflows/ci.yml | 6 +++--- .github/workflows/codespell.yml | 2 +- .github/workflows/editorconfig-checker.yml | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/calibreapp-image-actions.yml b/.github/workflows/calibreapp-image-actions.yml index 966b967..b02224a 100644 --- a/.github/workflows/calibreapp-image-actions.yml +++ b/.github/workflows/calibreapp-image-actions.yml @@ -16,7 +16,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Repo - uses: actions/checkout@v4.2.1 + uses: actions/checkout@v4.2.2 - name: Compress Images uses: calibreapp/image-actions@1.1.0 # TODO: if they start using a tag like v1, switch to that diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 64f20dc..710abc2 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,19 +17,19 @@ jobs: test: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.1 + - uses: actions/checkout@v4.2.2 with: fetch-depth: 0 - name: Set up Python - uses: actions/setup-python@v5.2.0 + uses: actions/setup-python@v5.3.0 with: python-version: "${{ env.PYTHON_VERSION }}" architecture: "x64" cache: pip - name: Set up Node.js - uses: actions/setup-node@v4.0.4 + uses: actions/setup-node@v4.1.0 with: node-version: "${{ env.NODE }}" cache: npm diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 93144f2..5103428 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -10,7 +10,7 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4.2.1 + uses: actions/checkout@v4.2.2 - name: Spell-Checking uses: codespell-project/actions-codespell@master diff --git a/.github/workflows/editorconfig-checker.yml b/.github/workflows/editorconfig-checker.yml index 60d2a3c..c67463b 100644 --- a/.github/workflows/editorconfig-checker.yml +++ b/.github/workflows/editorconfig-checker.yml @@ -9,6 +9,6 @@ jobs: name: editorconfig-checker runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4.2.1 + - uses: actions/checkout@v4.2.2 - uses: editorconfig-checker/action-editorconfig-checker@main - run: editorconfig-checker From bfddfe5cc600a492b1e4b274e313d3dcb0e26ef2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 2 Nov 2024 10:02:28 +0000 Subject: [PATCH 35/49] Bump mkdocs-material from 9.5.42 to 9.5.43 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.42 to 9.5.43 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.42...9.5.43) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index b4f72b4..879a761 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.3.0 -mkdocs-material==9.5.42 +mkdocs-material==9.5.43 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From babbea871de55d8911863b04bcb9334159c4097e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 2 Nov 2024 10:35:40 +0000 Subject: [PATCH 36/49] Bump mkdocs-material from 9.5.42 to 9.5.43 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.42 to 9.5.43 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.42...9.5.43) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index b4f72b4..879a761 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.3.0 -mkdocs-material==9.5.42 +mkdocs-material==9.5.43 mkdocs-redirects==1.2.1 markdown-include==0.8.1 From b027938949de1c00a55de95775e1f7423018036b Mon Sep 17 00:00:00 2001 From: DL6ER Date: Sat, 9 Nov 2024 08:49:43 +0100 Subject: [PATCH 37/49] Add gdb section introduction Signed-off-by: DL6ER --- docs/ftldns/debugging.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/ftldns/debugging.md b/docs/ftldns/debugging.md index d904354..756cbfd 100644 --- a/docs/ftldns/debugging.md +++ b/docs/ftldns/debugging.md @@ -1,5 +1,8 @@ # Debugging FTLDNS using `gdb` +`gdb` is a powerful debugger that can be used to analyze and help fixing issues in software. It is a command-line tool that can be used to inspect the state of a running process, set breakpoints, and step through the code. Furthermore, it can be used to investigate crashes and give access to the state of the program (e.g. precise locations and variable contents) at the time of the crash. +This guide will show you how to use `gdb` to debug `pihole-FTL`. + Once you are used to it, you can skip most of the steps. Debugging *FTL*DNS is quite easy. `pihole-FTL` has been designed so that a debugger can be attached to an already running process. This will give you insights into how software (not limited to `pihole-FTL`) works. From bd877ca91257fb2b16dab011f764f9823cca19ab Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 9 Nov 2024 10:58:45 +0000 Subject: [PATCH 38/49] Bump the pip-dependencies group with 2 updates Bumps the pip-dependencies group with 2 updates: [mkdocs-material](https://github.com/squidfunk/mkdocs-material) and [mkdocs-redirects](https://github.com/mkdocs/mkdocs-redirects). Updates `mkdocs-material` from 9.5.43 to 9.5.44 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.43...9.5.44) Updates `mkdocs-redirects` from 1.2.1 to 1.2.2 - [Release notes](https://github.com/mkdocs/mkdocs-redirects/releases) - [Commits](https://github.com/mkdocs/mkdocs-redirects/compare/v1.2.1...v1.2.2) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies - dependency-name: mkdocs-redirects dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 879a761..c341d1f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.3.0 -mkdocs-material==9.5.43 -mkdocs-redirects==1.2.1 +mkdocs-material==9.5.44 +mkdocs-redirects==1.2.2 markdown-include==0.8.1 From 1f77aba6f2d6fde31a25e1dc7a046e29969dad33 Mon Sep 17 00:00:00 2001 From: yubiuser Date: Sat, 9 Nov 2024 17:27:40 +0100 Subject: [PATCH 39/49] Add missing word Co-authored-by: RD WebDesign Signed-off-by: yubiuser --- docs/ftldns/debugging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ftldns/debugging.md b/docs/ftldns/debugging.md index 756cbfd..4ffb9cf 100644 --- a/docs/ftldns/debugging.md +++ b/docs/ftldns/debugging.md @@ -7,7 +7,7 @@ Once you are used to it, you can skip most of the steps. Debugging *FTL*DNS is q !!! info "When running Pi-hole in a Docker container" - If you are running Pi-hole in a Docker container, you will to perform all the steps described here *inside* the Docker container. You can use, e.g., `docker exec -it /bin/bash` to get a shell inside the container. + If you are running Pi-hole in a Docker container, you will need to perform all the steps described here *inside* the Docker container. You can use, e.g., `docker exec -it /bin/bash` to get a shell inside the container. You will also need to (temporarily!) add the `SYS_PTRACE` capability. This is required to allow `gdb` to attach to the `pihole-FTL` process inside the container. You can do this by starting the container with the `--cap-add=SYS_PTRACE` option. Furthermore, you need to disable the Linux kernel's secure computing mode for the container. Add `--security-opt seccomp:unconfined` in order to allow `gdb` to disable address space randomization. From eb98c6cd656189d3cb2a937a32d436bc48bcc419 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Mon, 11 Nov 2024 14:10:26 +0100 Subject: [PATCH 40/49] Add further real-time signals to ignore - we never really want to break on real-time signals. We add more signals than we actually use as the start of the real-time signals (the value of SIGRTMIN) varies between systems. Typically, they start at 32 on Linux, however, POSIX threads (which we are using) may shift RTMIN to 34 (NPTL) or 35 (LinuxThreads) instead, see man signal(7) for further details Signed-off-by: DL6ER --- docs/ftldns/debugging.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ftldns/debugging.md b/docs/ftldns/debugging.md index 4ffb9cf..a13b2b0 100644 --- a/docs/ftldns/debugging.md +++ b/docs/ftldns/debugging.md @@ -41,7 +41,7 @@ Once you are used to it, you can skip most of the steps. Debugging *FTL*DNS is q 4. Configure `gdb` by installing a globally valid initialization file: ```bash - echo "handle SIGHUP nostop SIGPIPE nostop SIGTERM nostop SIG32 nostop SIG34 nostop SIG35 nostop SIG41 nostop" | sudo tee /root/.gdbinit + echo "handle SIGHUP nostop SIGPIPE nostop SIGTERM nostop SIG32 nostop SIG33 nostop SIG34 nostop SIG35 nostop SIG36 nostop SIG37 nostop SIG38 nostop SIG39 nostop SIG40 nostop SIG41 nostop" | sudo tee /root/.gdbinit ``` You can omit this step, however, you will have to remember to run the quoted line on *every start* of `gdb` in order to properly debug FTL. From 8e155e36888360b014fcf9de4a6fb67dab60e663 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Mon, 11 Nov 2024 14:16:49 +0100 Subject: [PATCH 41/49] Add note about not being able to debug forks using gdb Signed-off-by: DL6ER --- docs/ftldns/debugging.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/ftldns/debugging.md b/docs/ftldns/debugging.md index a13b2b0..393c406 100644 --- a/docs/ftldns/debugging.md +++ b/docs/ftldns/debugging.md @@ -5,6 +5,9 @@ This guide will show you how to use `gdb` to debug `pihole-FTL`. Once you are used to it, you can skip most of the steps. Debugging *FTL*DNS is quite easy. `pihole-FTL` has been designed so that a debugger can be attached to an already running process. This will give you insights into how software (not limited to `pihole-FTL`) works. +!!! note "Debugging parallelized applications" + There is one fundamental drawback when it comes to using `gdb` for debugging parallelized applications: `pihole-FTL` uses both threads and forks. When DNS queries are processed on dedicated (long-lived) TCP connections, `pihole-FTL` forks a new process to handle the query but `gdb` does not follow the forked process. This means that you will not be able to capture crashes that occur in forked processes. However, most crashes occur in the main process, so this limitation is not as severe as it might sound. + !!! info "When running Pi-hole in a Docker container" If you are running Pi-hole in a Docker container, you will need to perform all the steps described here *inside* the Docker container. You can use, e.g., `docker exec -it /bin/bash` to get a shell inside the container. From 883f0429652c20055e3604c9411bb43925031d20 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 12 Nov 2024 09:22:19 +0100 Subject: [PATCH 42/49] Add instrutions how to combine valgrind with gdb debugging Signed-off-by: DL6ER --- docs/ftldns/valgrind.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/docs/ftldns/valgrind.md b/docs/ftldns/valgrind.md index bde9b05..9d2aabd 100644 --- a/docs/ftldns/valgrind.md +++ b/docs/ftldns/valgrind.md @@ -45,14 +45,14 @@ We suggest the following one-liner to run `pihole-FTL` in `memcheck`: ``` sudo service pihole-FTL stop && sudo setcap -r /usr/bin/pihole-FTL -sudo valgrind --trace-children=yes --leak-check=full --track-origins=yes --log-file=valgrind.log -s /usr/bin/pihole-FTL +sudo valgrind --trace-children=yes --leak-check=full --track-origins=yes --vgdb=full --log-file=valgrind.log -s /usr/bin/pihole-FTL ``` If you compile FTL from source, use ``` -sudo service pihole-FTL stop && sudo setcap -r /usr/bin/pihole-FTL -./build.sh && sudo valgrind --trace-children=yes --leak-check=full --track-origins=yes --log-file=valgrind.log -s ./pihole-FTL +sudo service pihole-FTL stop +./build.sh && sudo valgrind --trace-children=yes --leak-check=full --track-origins=yes --vgdb=full --log-file=valgrind.log -s ./pihole-FTL ``` The most useful information (about which memory is *possibly* and which is *definitely* lost) is written to `valgrind.log` at the end of the analysis. Terminate FTL by running: @@ -73,6 +73,29 @@ The used options are: 2. `leak-check=full` - When enabled, search for memory leaks when the client program finishes. Each individual leak will be shown in detail and/or counted as an error. 3. `track-origins=yes` - Memcheck tracks the origin of uninitialised values. By default, it does not, which means that although it can tell you that an uninitialised value is being used in a dangerous way, it cannot tell you where the uninitialised value came from. This often makes it difficult to track down the root problem. When set to `yes`, Memcheck keeps track of the origins of all uninitialised values. Then, when an uninitialised value error is reported, Memcheck will try to show the origin of the value. +4. `vgdb=full` - The Valgrind core provides a built-in gdbserver implementation. This is useful when you want to investigate a crash that is not easily reproducible and memory errors are suspected to be the cause. This gdbserver allows the process running on Valgrind's synthetic CPU to be debugged remotely. GDB sends protocol query packets (such as "get register contents") to the Valgrind embedded gdbserver. The gdbserver executes the queries (for example, it will get the register values of the synthetic CPU) and gives the results back to GDB. + +### Combining `valgrind` with `gdb` + +You can also combine `valgrind` with `gdb` to get both the memory error detection and the ability to step through the code after a crash (or other unexpected behaviour). + +1. Prepare `gdb` as described in [the `gdb` guide](debugging.md). +2. Start `pihole-FTL` in `valgrind` as described above. The `--vgdb=full` option tells `valgrind` to start a GDB server. +3. Once FTL has started, you can attach `gdb` to the running process using + + ``` bash + sudo gdb /usr/bin/pihole-FTL + ``` + + and then at the `(gdb)` prompt, + + ``` plain + target remote | vgdb + ``` + + to connect `gdb` to the "remote" `valgrind` process +4. Don't forget to enter `continue` to continue the execution of `pihole-FTL` in `valgrind` +5. At the time of a crash, you can step through the code, and investigate the state of the program as usual with `gdb`. Note that variables and functions may have different names than in the source code, as `valgrind` modifies the program with additional instrumentation code. ### False-positive memory issues From 51543da180a6db860a56a1abb86f063af40b3918 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Tue, 12 Nov 2024 09:33:28 +0100 Subject: [PATCH 43/49] Rename ftldns/debugging -> ftldns/gdb for clarity Signed-off-by: DL6ER --- docs/ftldns/{debugging.md => gdb.md} | 0 docs/ftldns/valgrind.md | 2 +- mkdocs.yml | 3 ++- 3 files changed, 3 insertions(+), 2 deletions(-) rename docs/ftldns/{debugging.md => gdb.md} (100%) diff --git a/docs/ftldns/debugging.md b/docs/ftldns/gdb.md similarity index 100% rename from docs/ftldns/debugging.md rename to docs/ftldns/gdb.md diff --git a/docs/ftldns/valgrind.md b/docs/ftldns/valgrind.md index 9d2aabd..0dbeda3 100644 --- a/docs/ftldns/valgrind.md +++ b/docs/ftldns/valgrind.md @@ -79,7 +79,7 @@ When set to `yes`, Memcheck keeps track of the origins of all uninitialised valu You can also combine `valgrind` with `gdb` to get both the memory error detection and the ability to step through the code after a crash (or other unexpected behaviour). -1. Prepare `gdb` as described in [the `gdb` guide](debugging.md). +1. Prepare `gdb` as described in [the `gdb` guide](gdb.md). 2. Start `pihole-FTL` in `valgrind` as described above. The `--vgdb=full` option tells `valgrind` to start a GDB server. 3. Once FTL has started, you can attach `gdb` to the running process using diff --git a/mkdocs.yml b/mkdocs.yml index c8eea4e..5382c12 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -147,7 +147,7 @@ nav: - 'Cache dump': ftldns/cache_dump.md - 'Packet dump': ftldns/package_dump.md - 'Debugging': - - 'gdb': ftldns/debugging.md + - 'gdb': ftldns/gdb.md - 'valgrind': ftldns/valgrind.md - 'Group Management': - 'Group Management': group_management/index.md @@ -283,3 +283,4 @@ plugins: 'guides/vpn/openvpn/overview.md': guides/vpn/openvpn/index.md 'guides/misc/tor/overview.md': guides/misc/tor/index.md 'guides/github/contributing.md': guides/github/index.md + 'ftldns/debugging.md': ftldns/gdb.md From 24477e30e3dfb6b187f67729a3a5a3f2cea57285 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 15 Nov 2024 18:37:16 +0100 Subject: [PATCH 44/49] Add docker-specific instructions for running pihole-FTL supervised by valgrind in the container Signed-off-by: DL6ER --- docs/ftldns/valgrind.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/ftldns/valgrind.md b/docs/ftldns/valgrind.md index 0dbeda3..94c1e75 100644 --- a/docs/ftldns/valgrind.md +++ b/docs/ftldns/valgrind.md @@ -75,6 +75,28 @@ The used options are: When set to `yes`, Memcheck keeps track of the origins of all uninitialised values. Then, when an uninitialised value error is reported, Memcheck will try to show the origin of the value. 4. `vgdb=full` - The Valgrind core provides a built-in gdbserver implementation. This is useful when you want to investigate a crash that is not easily reproducible and memory errors are suspected to be the cause. This gdbserver allows the process running on Valgrind's synthetic CPU to be debugged remotely. GDB sends protocol query packets (such as "get register contents") to the Valgrind embedded gdbserver. The gdbserver executes the queries (for example, it will get the register values of the synthetic CPU) and gives the results back to GDB. + +!!! info "When running Pi-hole in a Docker container" + If you are running Pi-hole in a Docker container, you will need to perform all the steps described here *inside* the Docker container. As the Docker container is dependent on the `pihole-FTL` process, you need to modify your `Dockerfile` to spawn shell inside the container instead of starting the `pihole-FTL` process directly. We also add a few extra settings here, see [the `gdb` guide](gdb.md) for more information about this: + + ```yaml + services: + pihole: + + # your other options ... + + cap_add: + - # your other added capabilities ... + - SYS_PTRACE + + security_opt: + - seccomp:unconfined + + entrypoint: /bin/bash + tty: true + ``` + + ### Combining `valgrind` with `gdb` You can also combine `valgrind` with `gdb` to get both the memory error detection and the ability to step through the code after a crash (or other unexpected behaviour). From ef32afca0934a1c5c00a21b0be36ca499d263e58 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Fri, 15 Nov 2024 18:41:06 +0100 Subject: [PATCH 45/49] Add note that FTL will run much slower in valgrind Signed-off-by: DL6ER --- docs/ftldns/valgrind.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ftldns/valgrind.md b/docs/ftldns/valgrind.md index 94c1e75..42b5972 100644 --- a/docs/ftldns/valgrind.md +++ b/docs/ftldns/valgrind.md @@ -2,7 +2,7 @@ Occasionally, debugging may require us to run `pihole-FTL` in `valgrind`. We also use it to measure performance and check that our memory layout is optimal (= minimal footprint). -`Valgrind` is a flexible program for debugging and profiling Linux executables. It consists of a core, which provides a synthetic CPU in software, and a series of debugging and profiling tools. +`Valgrind` is a flexible program for debugging and profiling Linux executables. It consists of a core, which provides a synthetic CPU in software, and a series of debugging and profiling tools. The use of a synthetic CPU allows Valgrind to run the client program in a completely controlled environment and, hence, track the behaviour of the program in a very detailed way. Unfortunately, this also means that the program runs *much* slower than usual. ## `memcheck` From 20e630f6822782ce024d01940c178ef1ac01cb2f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 16 Nov 2024 10:27:10 +0000 Subject: [PATCH 46/49] Bump markdownlint-cli2 in the npm-dependencies group Bumps the npm-dependencies group with 1 update: [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2). Updates `markdownlint-cli2` from 0.14.0 to 0.15.0 - [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md) - [Commits](https://github.com/DavidAnson/markdownlint-cli2/compare/v0.14.0...v0.15.0) --- updated-dependencies: - dependency-name: markdownlint-cli2 dependency-type: direct:development update-type: version-update:semver-minor dependency-group: npm-dependencies ... Signed-off-by: dependabot[bot] --- package-lock.json | 46 +++++++++++++++++++++++----------------------- package.json | 2 +- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/package-lock.json b/package-lock.json index 07f969e..2b86462 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "CC-BY-SA-4.0", "devDependencies": { "linkinator": "^6.1.2", - "markdownlint-cli2": "0.14.0" + "markdownlint-cli2": "0.15.0" } }, "node_modules/@isaacs/cliui": { @@ -624,13 +624,13 @@ } }, "node_modules/markdownlint": { - "version": "0.35.0", - "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.35.0.tgz", - "integrity": "sha512-wgp8yesWjFBL7bycA3hxwHRdsZGJhjhyP1dSxKVKrza0EPFYtn+mHtkVy6dvP1kGSjovyG5B8yNP6Frj0UFUJg==", + "version": "0.36.1", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.36.1.tgz", + "integrity": "sha512-s73fU2CQN7WCgjhaQUQ8wYESQNzGRNOKDd+3xgVqu8kuTEhmwepd/mxOv1LR2oV046ONrTLBFsM7IoKWNvmy5g==", "dev": true, "dependencies": { "markdown-it": "14.1.0", - "markdownlint-micromark": "0.1.10" + "markdownlint-micromark": "0.1.12" }, "engines": { "node": ">=18" @@ -640,15 +640,15 @@ } }, "node_modules/markdownlint-cli2": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.14.0.tgz", - "integrity": "sha512-2cqdWy56frU2FTpbuGb83mEWWYuUIYv6xS8RVEoUAuKNw/hXPar2UYGpuzUhlFMngE8Omaz4RBH52MzfRbGshw==", + "version": "0.15.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.15.0.tgz", + "integrity": "sha512-4P/lnxQxU2R5lywRJs4b2ajm8z65CW8qqR1bTIcdQ5EG+nZpC6HJlJUnmIR5ee+uecUkoMroazxWcLB7etSmrg==", "dev": true, "dependencies": { "globby": "14.0.2", "js-yaml": "4.1.0", "jsonc-parser": "3.3.1", - "markdownlint": "0.35.0", + "markdownlint": "0.36.1", "markdownlint-cli2-formatter-default": "0.0.5", "micromatch": "4.0.8" }, @@ -675,9 +675,9 @@ } }, "node_modules/markdownlint-micromark": { - "version": "0.1.10", - "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.10.tgz", - "integrity": "sha512-no5ZfdqAdWGxftCLlySHSgddEjyW4kui4z7amQcGsSKfYC5v/ou+8mIQVyg9KQMeEZLNtz9OPDTj7nnTnoR4FQ==", + "version": "0.1.12", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.12.tgz", + "integrity": "sha512-RlB6EwMGgc0sxcIhOQ2+aq7Zw1V2fBnzbXKGgYK/mVWdT7cz34fteKSwfYeo4rL6+L/q2tyC9QtD/PgZbkdyJQ==", "dev": true, "engines": { "node": ">=18" @@ -1674,25 +1674,25 @@ } }, "markdownlint": { - "version": "0.35.0", - "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.35.0.tgz", - "integrity": "sha512-wgp8yesWjFBL7bycA3hxwHRdsZGJhjhyP1dSxKVKrza0EPFYtn+mHtkVy6dvP1kGSjovyG5B8yNP6Frj0UFUJg==", + "version": "0.36.1", + "resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.36.1.tgz", + "integrity": "sha512-s73fU2CQN7WCgjhaQUQ8wYESQNzGRNOKDd+3xgVqu8kuTEhmwepd/mxOv1LR2oV046ONrTLBFsM7IoKWNvmy5g==", "dev": true, "requires": { "markdown-it": "14.1.0", - "markdownlint-micromark": "0.1.10" + "markdownlint-micromark": "0.1.12" } }, "markdownlint-cli2": { - "version": "0.14.0", - "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.14.0.tgz", - "integrity": "sha512-2cqdWy56frU2FTpbuGb83mEWWYuUIYv6xS8RVEoUAuKNw/hXPar2UYGpuzUhlFMngE8Omaz4RBH52MzfRbGshw==", + "version": "0.15.0", + "resolved": "https://registry.npmjs.org/markdownlint-cli2/-/markdownlint-cli2-0.15.0.tgz", + "integrity": "sha512-4P/lnxQxU2R5lywRJs4b2ajm8z65CW8qqR1bTIcdQ5EG+nZpC6HJlJUnmIR5ee+uecUkoMroazxWcLB7etSmrg==", "dev": true, "requires": { "globby": "14.0.2", "js-yaml": "4.1.0", "jsonc-parser": "3.3.1", - "markdownlint": "0.35.0", + "markdownlint": "0.36.1", "markdownlint-cli2-formatter-default": "0.0.5", "micromatch": "4.0.8" } @@ -1705,9 +1705,9 @@ "requires": {} }, "markdownlint-micromark": { - "version": "0.1.10", - "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.10.tgz", - "integrity": "sha512-no5ZfdqAdWGxftCLlySHSgddEjyW4kui4z7amQcGsSKfYC5v/ou+8mIQVyg9KQMeEZLNtz9OPDTj7nnTnoR4FQ==", + "version": "0.1.12", + "resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.12.tgz", + "integrity": "sha512-RlB6EwMGgc0sxcIhOQ2+aq7Zw1V2fBnzbXKGgYK/mVWdT7cz34fteKSwfYeo4rL6+L/q2tyC9QtD/PgZbkdyJQ==", "dev": true }, "marked": { diff --git a/package.json b/package.json index fddf890..a64a03b 100644 --- a/package.json +++ b/package.json @@ -24,6 +24,6 @@ }, "devDependencies": { "linkinator": "^6.1.2", - "markdownlint-cli2": "0.14.0" + "markdownlint-cli2": "0.15.0" } } From dc87197edf0551d929d687c59c0747a912ab0216 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 23 Nov 2024 10:30:29 +0000 Subject: [PATCH 47/49] Bump mkdocs-material from 9.5.44 to 9.5.45 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.44 to 9.5.45 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.44...9.5.45) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index c341d1f..9ac70a0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.3.0 -mkdocs-material==9.5.44 +mkdocs-material==9.5.45 mkdocs-redirects==1.2.2 markdown-include==0.8.1 From 6720aa57efc4175781310f87f4ced5f53121598a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 30 Nov 2024 10:43:40 +0000 Subject: [PATCH 48/49] Bump mkdocs-material from 9.5.45 to 9.5.46 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.45 to 9.5.46 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.45...9.5.46) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 9ac70a0..23d64a1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.3.0 -mkdocs-material==9.5.45 +mkdocs-material==9.5.46 mkdocs-redirects==1.2.2 markdown-include==0.8.1 From 4772f432401d9a11b8104fc2111f6ba796e74329 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 7 Dec 2024 10:27:06 +0000 Subject: [PATCH 49/49] Bump mkdocs-material from 9.5.46 to 9.5.47 in the pip-dependencies group Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material). Updates `mkdocs-material` from 9.5.46 to 9.5.47 - [Release notes](https://github.com/squidfunk/mkdocs-material/releases) - [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG) - [Commits](https://github.com/squidfunk/mkdocs-material/compare/9.5.46...9.5.47) --- updated-dependencies: - dependency-name: mkdocs-material dependency-type: direct:production update-type: version-update:semver-patch dependency-group: pip-dependencies ... Signed-off-by: dependabot[bot] --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 23d64a1..343f973 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ mkdocs==1.6.1 mkdocs-git-revision-date-localized-plugin==1.3.0 -mkdocs-material==9.5.46 +mkdocs-material==9.5.47 mkdocs-redirects==1.2.2 markdown-include==0.8.1