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: diff --git a/docs/database/ftl.md b/docs/database/ftl.md index dd7d102..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 `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 `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 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) 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 ``` diff --git a/docs/guides/vpn/wireguard/client.md b/docs/guides/vpn/wireguard/client.md index 93ee6dc..414d7a3 100644 --- a/docs/guides/vpn/wireguard/client.md +++ b/docs/guides/vpn/wireguard/client.md @@ -9,7 +9,9 @@ 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" ipv6="$2$4" serv4="${1}1" @@ -29,6 +31,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" @@ -48,12 +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 - 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" + /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 ``` diff --git a/docs/guides/webserver/caddy.md b/docs/guides/webserver/caddy.md index 569c5de..0065299 100644 --- a/docs/guides/webserver/caddy.md +++ b/docs/guides/webserver/caddy.md @@ -14,6 +14,14 @@ 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 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: `/etc/lighttpd/external.conf` (note the different syntax!): + +```lighttpd +server.port := 1080 +``` + Next, restart the lighttpd server with either of these commands: ```bash 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 diff --git a/mkdocs.yml b/mkdocs.yml index 41205ba..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 © 2021 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 + +