From da13b9cf3bcd64f7b91a518c74f38760fdebf6f8 Mon Sep 17 00:00:00 2001 From: silversub Date: Fri, 29 Apr 2022 15:08:56 -0400 Subject: [PATCH 01/15] Replace git.io (#697) Signed-off-by: silversub Co-authored-by: silversub --- docs/guides/vpn/openvpn/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/vpn/openvpn/installation.md b/docs/guides/vpn/openvpn/installation.md index deb048d..853e372 100644 --- a/docs/guides/vpn/openvpn/installation.md +++ b/docs/guides/vpn/openvpn/installation.md @@ -15,7 +15,7 @@ This is less convenient, so many users will simply decide to install Pi-hole and First, download the OpenVPN installer; make it executable, and then run it: ```bash -wget https://git.io/vpn -O openvpn-install.sh +wget https://github.com/Nyr/openvpn-install/raw/master/openvpn-install.sh chmod 755 openvpn-install.sh ./openvpn-install.sh ``` From 1132af1fd4e05a34851113cfd9daf8168e1e62ff Mon Sep 17 00:00:00 2001 From: Shreshth Goyal Date: Mon, 2 May 2022 02:14:42 +0530 Subject: [PATCH 02/15] Specifying DNS Server for client config in automatic script as the first one in the chosen subnet. Signed-off-by: Shreshth Goyal --- docs/guides/vpn/wireguard/client.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/guides/vpn/wireguard/client.md b/docs/guides/vpn/wireguard/client.md index 93ee6dc..263e095 100644 --- a/docs/guides/vpn/wireguard/client.md +++ b/docs/guides/vpn/wireguard/client.md @@ -29,6 +29,7 @@ For each new client, the following steps must be taken. For the sake of simplici echo "[Interface]" > "${name}.conf" echo "Address = $ipv4/32, $ipv6/128" >> "${name}.conf" + echo "DNS = ${serv4}, ${serv6}" >> "${name}.conf" #Specifying DNS Server echo "PrivateKey = $(cat "${name}.key")" >> "${name}.conf" echo "" >> "${name}.conf" echo "[Peer]" >> "${name}.conf" From d593b845b044edb4e4303287d6311c594922a8e5 Mon Sep 17 00:00:00 2001 From: abrattic <69515858+abrattic@users.noreply.github.com> Date: Wed, 4 May 2022 00:18:52 +0530 Subject: [PATCH 03/15] Fixing the umask operation by transferring it to the script itself. (#701) Signed-off-by: Shreshth Goyal --- docs/guides/vpn/wireguard/client.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/guides/vpn/wireguard/client.md b/docs/guides/vpn/wireguard/client.md index 263e095..23277c2 100644 --- a/docs/guides/vpn/wireguard/client.md +++ b/docs/guides/vpn/wireguard/client.md @@ -10,6 +10,8 @@ For each new client, the following steps must be taken. For the sake of simplici ```bash #!/bin/bash + umask 077 + ipv4="$1$4" ipv6="$2$4" serv4="${1}1" @@ -51,7 +53,6 @@ For each new client, the following steps must be taken. For the sake of simplici ```bash sudo -i cd /etc/wireguard - umask 077 bash "10.100.0." "fd08:4711::" "my_server_domain:47111" 2 "annas-android" bash "10.100.0." "fd08:4711::" "my_server_domain:47111" 3 "peters-laptop" From a856077aead70d706eaae7c38a16b0067a6f97eb Mon Sep 17 00:00:00 2001 From: Elliot Brandwein Date: Wed, 4 May 2022 21:36:34 -0400 Subject: [PATCH 04/15] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 41205ba..ece6c81 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: 'Pi-hole documentation' site_url: 'https://docs.pi-hole.net/' repo_url: 'https://github.com/pi-hole/pi-hole' edit_uri: '../docs/blob/master/docs/' -copyright: 'Copyright © 2021 Pi-hole LLC' +copyright: 'Copyright © 2022 Pi-hole LLC' remote_branch: gh-pages theme: name: 'material' From 3374eb07496d43da0ac34a463f8c0fcb34ba2ca0 Mon Sep 17 00:00:00 2001 From: Dan Schaper Date: Thu, 5 May 2022 21:34:55 -0700 Subject: [PATCH 05/15] Update copyright attribution line (#705) https://smallbusiness.chron.com/year-copyright-statement-mean-62027.html https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#custom-copyright https://github.com/squidfunk/mkdocs-material/releases/tag/8.0.0 --- mkdocs.yml | 2 +- overrides/main.html | 8 -------- overrides/partials/copyright.html | 7 +++++++ 3 files changed, 8 insertions(+), 9 deletions(-) delete mode 100644 overrides/main.html create mode 100644 overrides/partials/copyright.html diff --git a/mkdocs.yml b/mkdocs.yml index ece6c81..0d8ffdc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: 'Pi-hole documentation' site_url: 'https://docs.pi-hole.net/' repo_url: 'https://github.com/pi-hole/pi-hole' edit_uri: '../docs/blob/master/docs/' -copyright: 'Copyright © 2022 Pi-hole LLC' +copyright: remote_branch: gh-pages theme: name: 'material' diff --git a/overrides/main.html b/overrides/main.html deleted file mode 100644 index 80161fd..0000000 --- a/overrides/main.html +++ /dev/null @@ -1,8 +0,0 @@ -{% extends "base.html" %} - -{% set extracopyright %} -
- - This site is powered by Netlify - -{% endset %} diff --git a/overrides/partials/copyright.html b/overrides/partials/copyright.html new file mode 100644 index 0000000..a6bee8e --- /dev/null +++ b/overrides/partials/copyright.html @@ -0,0 +1,7 @@ +
+Copyright Pi-hole. Licensed under CC BY-SA 4.0 +
+ + This site is powered by Netlify + +
From 549d5e829d2f654f29ca6ce49b165336eb3659be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Cirne?= Date: Wed, 4 May 2022 17:31:44 +0100 Subject: [PATCH 06/15] Update supported versions for CentOS and CentOS Stream MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: André Cirne --- docs/main/prerequisites.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/main/prerequisites.md b/docs/main/prerequisites.md index e58685c..3b2d779 100644 --- a/docs/main/prerequisites.md +++ b/docs/main/prerequisites.md @@ -28,7 +28,8 @@ The following operating systems are **officially** supported: | Ubuntu | 16.x / 18.x / 20.x /21.x | ARM / x86_64 | | Debian | 9 / 10 /11 | ARM / x86_64 / i386 | | Fedora | 33 / 34 | ARM / x86_64 | -| CentOS | 7 / 8 | x86_64 | +| CentOS | 7 | x86_64 | +| CentOS Stream | 8 | x86_64 | !!! info From 3f9cb23fd4b44a5b72fae22d877050bf110acea3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vid=20=C4=8Cufar?= Date: Sat, 7 May 2022 14:52:13 +0200 Subject: [PATCH 07/15] Update query table name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Vid Čufar --- docs/database/ftl.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/database/ftl.md b/docs/database/ftl.md index dd7d102..e5b8c38 100644 --- a/docs/database/ftl.md +++ b/docs/database/ftl.md @@ -54,7 +54,7 @@ Label | Type | Allowed to by empty | Content `reply_time` | real | Yes | Seconds it took until the final reply was received `dnssec` | integer | Yes | Type of the DNSSEC status for this query (see [DNSSEC status](ftl.md#dnssec-status)) -The `queries` `VIEW` is dynamically generated from the data actually stored in the tables `queries_storage` and the linking tables `domain_by_id`, `client_by_id`, `forward_by_id`, and `addinfo_by_id` (see below). The table `queries_storage` will contains integer IDs pointing to the respective entries of the linking tables to save space and make searching the database faster. If you haven't upgraded for some time, the table may still contain strings instead of integer IDs. +The `queries` `VIEW` is dynamically generated from the data actually stored in the tables `query_storage` and the linking tables `domain_by_id`, `client_by_id`, `forward_by_id`, and `addinfo_by_id` (see below). The table `query_storage` will contains integer IDs pointing to the respective entries of the linking tables to save space and make searching the database faster. If you haven't upgraded for some time, the table may still contain strings instead of integer IDs. #### Data-dependent `additional_info` field From 4146635fd1211e066637d1c4af79d5a7b6e5c25d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vid=20=C4=8Cufar?= Date: Sat, 7 May 2022 17:34:40 +0200 Subject: [PATCH 08/15] Update query table name description grammar MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Vid Čufar --- docs/database/ftl.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/database/ftl.md b/docs/database/ftl.md index e5b8c38..e532225 100644 --- a/docs/database/ftl.md +++ b/docs/database/ftl.md @@ -54,7 +54,7 @@ Label | Type | Allowed to by empty | Content `reply_time` | real | Yes | Seconds it took until the final reply was received `dnssec` | integer | Yes | Type of the DNSSEC status for this query (see [DNSSEC status](ftl.md#dnssec-status)) -The `queries` `VIEW` is dynamically generated from the data actually stored in the tables `query_storage` and the linking tables `domain_by_id`, `client_by_id`, `forward_by_id`, and `addinfo_by_id` (see below). The table `query_storage` will contains integer IDs pointing to the respective entries of the linking tables to save space and make searching the database faster. If you haven't upgraded for some time, the table may still contain strings instead of integer IDs. +The `queries` `VIEW` is dynamically generated from the data actually stored in the `query_storage` table and the linking tables `domain_by_id`, `client_by_id`, `forward_by_id`, and `addinfo_by_id` (see below). The table `query_storage` will contains integer IDs pointing to the respective entries of the linking tables to save space and make searching the database faster. If you haven't upgraded for some time, the table may still contain strings instead of integer IDs. #### Data-dependent `additional_info` field From 2f1ab1d67e57e6293e9ccbcf8e386740e2a4cf84 Mon Sep 17 00:00:00 2001 From: xavier skip Date: Sun, 8 May 2022 19:37:51 +0800 Subject: [PATCH 09/15] avoid change config file for the next update. `/etc/lighttpd.lighttpd.conf` show this: # ANY CHANGES MADE TO THIS FILE AFTER INSTALL WILL BE LOST ON THE NEXT UPDATE CHANGES SHOULD BE MADE IN A SEPARATE CONFIG FILE: /etc/lighttpd/external.conf from here: https://raspberrypi.stackexchange.com/questions/52090/how-do-i-change-pi-holes-url-path/117849#117849 --- docs/guides/webserver/caddy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/webserver/caddy.md b/docs/guides/webserver/caddy.md index 569c5de..cedf86d 100644 --- a/docs/guides/webserver/caddy.md +++ b/docs/guides/webserver/caddy.md @@ -6,10 +6,10 @@ If you'd like to use [Caddy](https://caddyserver.com/) as your main web server w ## Modifying lighttpd configuration -First, change the listen port in this file: `/etc/lighttpd/lighttpd.conf:` +First, change the listen port in this file: `/etc/lighttpd/external.conf:` ```lighttpd -server.port = 1080 +server.port := 1080 ``` In this case, port 1080 was chosen at random. You can use a custom port. From 3655afb605b5010b36e7c63d1b0a3cf5a20531e9 Mon Sep 17 00:00:00 2001 From: xavier skip Date: Sun, 8 May 2022 20:50:18 +0800 Subject: [PATCH 10/15] update caddy.md A permanent method of changing the lighttpd port (for lighttpd version 1.4.46 or later) https://discourse.pi-hole.net/t/web-interface-not-working-after-upgrade/53994 --- docs/guides/webserver/caddy.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/guides/webserver/caddy.md b/docs/guides/webserver/caddy.md index cedf86d..d4246b5 100644 --- a/docs/guides/webserver/caddy.md +++ b/docs/guides/webserver/caddy.md @@ -6,14 +6,22 @@ If you'd like to use [Caddy](https://caddyserver.com/) as your main web server w ## Modifying lighttpd configuration -First, change the listen port in this file: `/etc/lighttpd/external.conf:` +First, change the listen port in this file: `/etc/lighttpd/lighttpd.conf:` + +```lighttpd +server.port = 1080 +``` + +In this case, port 1080 was chosen at random. You can use a custom port. + +BUT ANY CHANGES MADE TO THIS FILE WILL BE LOST ON THE NEXT UPDATE. + +So if you want a permanent method of changing the lighttpd port and your lighttpd version >= 1.4.46, you can overwrite the port in file: `/etc/lighttpd/external.conf:` ```lighttpd server.port := 1080 ``` -In this case, port 1080 was chosen at random. You can use a custom port. - Next, restart the lighttpd server with either of these commands: ```bash From 57fbbceeef5f7e7ed1a1e390b2e568ef6a187b66 Mon Sep 17 00:00:00 2001 From: xavier skip Date: Tue, 10 May 2022 10:33:26 +0800 Subject: [PATCH 11/15] Update docs/guides/webserver/caddy.md THE NEXT PI-HOLE UPDATE. Co-authored-by: yubiuser --- docs/guides/webserver/caddy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/webserver/caddy.md b/docs/guides/webserver/caddy.md index d4246b5..798fbe6 100644 --- a/docs/guides/webserver/caddy.md +++ b/docs/guides/webserver/caddy.md @@ -14,7 +14,7 @@ server.port = 1080 In this case, port 1080 was chosen at random. You can use a custom port. -BUT ANY CHANGES MADE TO THIS FILE WILL BE LOST ON THE NEXT UPDATE. +BUT ANY CHANGES MADE TO THIS FILE WILL BE LOST ON THE NEXT PI-HOLE UPDATE. So if you want a permanent method of changing the lighttpd port and your lighttpd version >= 1.4.46, you can overwrite the port in file: `/etc/lighttpd/external.conf:` From a2dd698e2183a738cb5b16faae2ce75b092cd9b3 Mon Sep 17 00:00:00 2001 From: xavier skip Date: Tue, 10 May 2022 10:34:07 +0800 Subject: [PATCH 12/15] Update docs/guides/webserver/caddy.md note the different syntax Co-authored-by: yubiuser --- docs/guides/webserver/caddy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/webserver/caddy.md b/docs/guides/webserver/caddy.md index 798fbe6..0065299 100644 --- a/docs/guides/webserver/caddy.md +++ b/docs/guides/webserver/caddy.md @@ -16,7 +16,7 @@ In this case, port 1080 was chosen at random. You can use a custom port. BUT ANY CHANGES MADE TO THIS FILE WILL BE LOST ON THE NEXT PI-HOLE UPDATE. -So if you want a permanent method of changing the lighttpd port and your lighttpd version >= 1.4.46, you can overwrite the port in file: `/etc/lighttpd/external.conf:` +So if you want a permanent method of changing the lighttpd port and your lighttpd version >= 1.4.46, you can overwrite the port in: `/etc/lighttpd/external.conf` (note the different syntax!): ```lighttpd server.port := 1080 From 5aefabbff97d0a249ada791f19cfcbdcabaaa6bf Mon Sep 17 00:00:00 2001 From: abrattic <69515858+abrattic@users.noreply.github.com> Date: Thu, 12 May 2022 00:16:05 +0530 Subject: [PATCH 13/15] Fix the command to run the Wireguard client generation script (#704) * Fix the instructions to run the Wireguard client generation script * Use the env bash shebang in wireguard client script. Signed-off-by: Shreshth Goyal <69515858+abrattic@users.noreply.github.com> --- docs/guides/vpn/wireguard/client.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/guides/vpn/wireguard/client.md b/docs/guides/vpn/wireguard/client.md index 23277c2..414d7a3 100644 --- a/docs/guides/vpn/wireguard/client.md +++ b/docs/guides/vpn/wireguard/client.md @@ -9,7 +9,7 @@ For each new client, the following steps must be taken. For the sake of simplici Script content: ```bash - #!/bin/bash + #! /usr/bin/env bash umask 077 ipv4="$1$4" @@ -51,11 +51,12 @@ For each new client, the following steps must be taken. For the sake of simplici Run the script like ```bash + chmod +x /path/to/script.sh sudo -i cd /etc/wireguard - bash "10.100.0." "fd08:4711::" "my_server_domain:47111" 2 "annas-android" - bash "10.100.0." "fd08:4711::" "my_server_domain:47111" 3 "peters-laptop" + /path/to/script.sh "10.100.0." "fd08:4711::" "my_server_domain:47111" 2 "annas-android" + /path/to/script.sh "10.100.0." "fd08:4711::" "my_server_domain:47111" 3 "peters-laptop" exit ``` From 93958789896f126931ff9836356444792b15cbe2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20K=C3=B6nig?= Date: Wed, 11 May 2022 21:59:38 +0200 Subject: [PATCH 14/15] Remove workaround link for cloudflared on arm32 devices MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Christian König --- 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 496acd6..fa3d6b4 100644 --- a/docs/guides/dns/cloudflared.md +++ b/docs/guides/dns/cloudflared.md @@ -46,7 +46,7 @@ sudo chmod +x /usr/local/bin/cloudflared cloudflared -v ``` -Note: Users [have reported](https://github.com/cloudflare/cloudflared/issues/38) that the current version of cloudflared produces a segmentation fault error on Raspberry Pi Zero W, Model 1B and 2B. As a workaround you can use an older version provided at instead. +Note: Users [have reported](https://github.com/cloudflare/cloudflared/issues/38) that the current version of cloudflared produces a segmentation fault error on Raspberry Pi Zero W, Model 1B and 2B. Currently, there is [no known workaround](https://github.com/pi-hole/docs/issues/710). #### arm64 architecture (64-bit Raspberry Pi) From c0e1a9966e23462bb3f696c8773b5d80827b1d91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20K=C3=B6nig?= Date: Fri, 20 May 2022 22:40:55 +0200 Subject: [PATCH 15/15] No sudo when installing python requirements MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Christian König --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 11a0083..4ad5090 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Please make sure you fork the repo and change the clone URL in the example below git clone https://github.com/YOUR-USERNAME/docs cd docs sudo apt install python3-pip - sudo pip3 install -r requirements.txt + pip3 install -r requirements.txt ``` - Running the docs server: