diff --git a/docs/core/pihole-command.md b/docs/core/pihole-command.md index d1d59fd1..a8e714cb 100644 --- a/docs/core/pihole-command.md +++ b/docs/core/pihole-command.md @@ -331,4 +331,4 @@ Help Command | `pihole -a interface --help` Script Location | [`/opt/pihole/webpage.sh`](https://github.com/pi-hole/pi-hole/blob/master/advanced/Scripts/webpage.sh) Example Usage | [`pihole -a interface local`](https://discourse.pi-hole.net/t/the-pihole-command-with-examples/738#interface) -Specify interface listening behavior for `pihole-FTL`. When using `pihole -a interface all`, please ensure you use a firewall to prevent your Pi-hole from becoming an unwitting host to [DNS amplification attackers](https://duckduckgo.com/?q=dns+amplification+attack). You may want to consider running [OpenVPN](../guides/vpn/overview.md) to grant your mobile devices access to the Pi-hole. +Specify interface listening behavior for `pihole-FTL`. When using `pihole -a interface all`, please ensure you use a firewall to prevent your Pi-hole from becoming an unwitting host to [DNS amplification attackers](https://duckduckgo.com/?q=dns+amplification+attack). You may want to consider running [Wireguard](../guides/vpn/wireguard/overview.md) to grant your mobile devices access to the Pi-hole. diff --git a/docs/guides/dns-over-https.md b/docs/guides/dns/cloudflared.md similarity index 99% rename from docs/guides/dns-over-https.md rename to docs/guides/dns/cloudflared.md index f5ee41f2..87782020 100644 --- a/docs/guides/dns-over-https.md +++ b/docs/guides/dns/cloudflared.md @@ -195,7 +195,7 @@ google.com. 191 IN A 172.217.22.14 Finally, configure Pi-hole to use the local `cloudflared` service as the upstream DNS server by specifying `127.0.0.1#5053` as the Custom DNS (IPv4): -![Screenshot of Pi-hole configuration](../images/DoHConfig.png) +![Screenshot of Pi-hole configuration](/images/DoHConfig.png) (don't forget to hit Return or click on `Save`) diff --git a/docs/guides/unbound.md b/docs/guides/dns/unbound.md similarity index 99% rename from docs/guides/unbound.md rename to docs/guides/dns/unbound.md index 6c31a520..019ed1db 100644 --- a/docs/guides/unbound.md +++ b/docs/guides/dns/unbound.md @@ -1,3 +1,5 @@ +## Pi-hole as All-Around DNS Solution + ### The problem: Whom can you trust? Pi-hole includes a caching and *forwarding* DNS server, now known as *FTL*DNS. After applying the blocking lists, it forwards requests made by the clients to configured upstream DNS server(s). However, as has been mentioned by several users in the past, this leads to some privacy concerns as it ultimately raises the question: _Whom can you trust?_ Recently, more and more small (and not so small) DNS upstream providers have appeared on the market, advertising free and private DNS service, but how can you know that they keep their promises? Right, you can't. @@ -156,7 +158,7 @@ The first command should give a status report of `SERVFAIL` and no IP address. T Finally, configure Pi-hole to use your recursive DNS server by specifying `127.0.0.1#5335` as the Custom DNS (IPv4): -![Upstream DNS Servers Configuration](../images/RecursiveResolver.png) +![Upstream DNS Servers Configuration](/images/RecursiveResolver.png) (don't forget to hit Return or click on `Save`) diff --git a/docs/guides/upstream-dns-providers.md b/docs/guides/dns/upstream-dns-providers.md similarity index 100% rename from docs/guides/upstream-dns-providers.md rename to docs/guides/dns/upstream-dns-providers.md diff --git a/docs/guides/benchmark.md b/docs/guides/misc/benchmark.md similarity index 98% rename from docs/guides/benchmark.md rename to docs/guides/misc/benchmark.md index 4560e3fc..c1d4ec17 100644 --- a/docs/guides/benchmark.md +++ b/docs/guides/misc/benchmark.md @@ -29,7 +29,7 @@ The long-term database can be disabled by setting DBFILE= ``` -in `/etc/pihole/pihole-FTL.conf` and running `sudo pihole restartdns` (see also [here](../ftldns/configfile.md#dbfile)). +in `/etc/pihole/pihole-FTL.conf` and running `sudo pihole restartdns` (see also [here](/ftldns/configfile/#dbfile)). ### 2.2 Increase DNS cache size diff --git a/docs/guides/tor/dnssec.md b/docs/guides/misc/tor/dnssec.md similarity index 100% rename from docs/guides/tor/dnssec.md rename to docs/guides/misc/tor/dnssec.md diff --git a/docs/guides/tor/overview.md b/docs/guides/misc/tor/overview.md similarity index 100% rename from docs/guides/tor/overview.md rename to docs/guides/misc/tor/overview.md diff --git a/docs/guides/tor/performance-issues.md b/docs/guides/misc/tor/performance-issues.md similarity index 100% rename from docs/guides/tor/performance-issues.md rename to docs/guides/misc/tor/performance-issues.md diff --git a/docs/guides/tor/setup.md b/docs/guides/misc/tor/setup.md similarity index 100% rename from docs/guides/tor/setup.md rename to docs/guides/misc/tor/setup.md diff --git a/docs/guides/tor/using-tor.md b/docs/guides/misc/tor/using-tor.md similarity index 100% rename from docs/guides/tor/using-tor.md rename to docs/guides/misc/tor/using-tor.md diff --git a/docs/guides/whitelist-blacklist.md b/docs/guides/misc/whitelist-blacklist.md similarity index 100% rename from docs/guides/whitelist-blacklist.md rename to docs/guides/misc/whitelist-blacklist.md diff --git a/docs/guides/vpn/Android-Connected.png b/docs/guides/vpn/openvpn/Android-Connected.png similarity index 100% rename from docs/guides/vpn/Android-Connected.png rename to docs/guides/vpn/openvpn/Android-Connected.png diff --git a/docs/guides/vpn/Android-Import-1.png b/docs/guides/vpn/openvpn/Android-Import-1.png similarity index 100% rename from docs/guides/vpn/Android-Import-1.png rename to docs/guides/vpn/openvpn/Android-Import-1.png diff --git a/docs/guides/vpn/Android-Import-2.png b/docs/guides/vpn/openvpn/Android-Import-2.png similarity index 100% rename from docs/guides/vpn/Android-Import-2.png rename to docs/guides/vpn/openvpn/Android-Import-2.png diff --git a/docs/guides/vpn/Android-Import-3.png b/docs/guides/vpn/openvpn/Android-Import-3.png similarity index 100% rename from docs/guides/vpn/Android-Import-3.png rename to docs/guides/vpn/openvpn/Android-Import-3.png diff --git a/docs/guides/vpn/Android-Import-4.png b/docs/guides/vpn/openvpn/Android-Import-4.png similarity index 100% rename from docs/guides/vpn/Android-Import-4.png rename to docs/guides/vpn/openvpn/Android-Import-4.png diff --git a/docs/guides/vpn/Android-Pi-hole.png b/docs/guides/vpn/openvpn/Android-Pi-hole.png similarity index 100% rename from docs/guides/vpn/Android-Pi-hole.png rename to docs/guides/vpn/openvpn/Android-Pi-hole.png diff --git a/docs/guides/vpn/Android-Transport-Error.png b/docs/guides/vpn/openvpn/Android-Transport-Error.png similarity index 100% rename from docs/guides/vpn/Android-Transport-Error.png rename to docs/guides/vpn/openvpn/Android-Transport-Error.png diff --git a/docs/guides/vpn/NetworkManager1.png b/docs/guides/vpn/openvpn/NetworkManager1.png similarity index 100% rename from docs/guides/vpn/NetworkManager1.png rename to docs/guides/vpn/openvpn/NetworkManager1.png diff --git a/docs/guides/vpn/NetworkManager2.png b/docs/guides/vpn/openvpn/NetworkManager2.png similarity index 100% rename from docs/guides/vpn/NetworkManager2.png rename to docs/guides/vpn/openvpn/NetworkManager2.png diff --git a/docs/guides/vpn/NetworkManager3.png b/docs/guides/vpn/openvpn/NetworkManager3.png similarity index 100% rename from docs/guides/vpn/NetworkManager3.png rename to docs/guides/vpn/openvpn/NetworkManager3.png diff --git a/docs/guides/vpn/NetworkManager4.png b/docs/guides/vpn/openvpn/NetworkManager4.png similarity index 100% rename from docs/guides/vpn/NetworkManager4.png rename to docs/guides/vpn/openvpn/NetworkManager4.png diff --git a/docs/guides/vpn/NetworkManager5.png b/docs/guides/vpn/openvpn/NetworkManager5.png similarity index 100% rename from docs/guides/vpn/NetworkManager5.png rename to docs/guides/vpn/openvpn/NetworkManager5.png diff --git a/docs/guides/vpn/NetworkManager6.png b/docs/guides/vpn/openvpn/NetworkManager6.png similarity index 100% rename from docs/guides/vpn/NetworkManager6.png rename to docs/guides/vpn/openvpn/NetworkManager6.png diff --git a/docs/guides/vpn/NetworkManager7.png b/docs/guides/vpn/openvpn/NetworkManager7.png similarity index 100% rename from docs/guides/vpn/NetworkManager7.png rename to docs/guides/vpn/openvpn/NetworkManager7.png diff --git a/docs/guides/vpn/Strato-DynDNS-Domain.png b/docs/guides/vpn/openvpn/Strato-DynDNS-Domain.png similarity index 100% rename from docs/guides/vpn/Strato-DynDNS-Domain.png rename to docs/guides/vpn/openvpn/Strato-DynDNS-Domain.png diff --git a/docs/guides/vpn/Strato-DynDNS-Enable.png b/docs/guides/vpn/openvpn/Strato-DynDNS-Enable.png similarity index 100% rename from docs/guides/vpn/Strato-DynDNS-Enable.png rename to docs/guides/vpn/openvpn/Strato-DynDNS-Enable.png diff --git a/docs/guides/vpn/Strato-DynDNS-Password.png b/docs/guides/vpn/openvpn/Strato-DynDNS-Password.png similarity index 100% rename from docs/guides/vpn/Strato-DynDNS-Password.png rename to docs/guides/vpn/openvpn/Strato-DynDNS-Password.png diff --git a/docs/guides/vpn/VPNclients.png b/docs/guides/vpn/openvpn/VPNclients.png similarity index 100% rename from docs/guides/vpn/VPNclients.png rename to docs/guides/vpn/openvpn/VPNclients.png diff --git a/docs/guides/vpn/VPNdashboard.png b/docs/guides/vpn/openvpn/VPNdashboard.png similarity index 100% rename from docs/guides/vpn/VPNdashboard.png rename to docs/guides/vpn/openvpn/VPNdashboard.png diff --git a/docs/guides/vpn/android-client.md b/docs/guides/vpn/openvpn/android-client.md similarity index 100% rename from docs/guides/vpn/android-client.md rename to docs/guides/vpn/openvpn/android-client.md diff --git a/docs/guides/vpn/client.ovpn b/docs/guides/vpn/openvpn/client.ovpn similarity index 100% rename from docs/guides/vpn/client.ovpn rename to docs/guides/vpn/openvpn/client.ovpn diff --git a/docs/guides/vpn/clients.md b/docs/guides/vpn/openvpn/clients.md similarity index 100% rename from docs/guides/vpn/clients.md rename to docs/guides/vpn/openvpn/clients.md diff --git a/docs/guides/vpn/dual-VPN.md b/docs/guides/vpn/openvpn/dual-VPN.md similarity index 100% rename from docs/guides/vpn/dual-VPN.md rename to docs/guides/vpn/openvpn/dual-VPN.md diff --git a/docs/guides/vpn/dual-operation.md b/docs/guides/vpn/openvpn/dual-operation.md similarity index 100% rename from docs/guides/vpn/dual-operation.md rename to docs/guides/vpn/openvpn/dual-operation.md diff --git a/docs/guides/vpn/dynDNS.md b/docs/guides/vpn/openvpn/dynDNS.md similarity index 100% rename from docs/guides/vpn/dynDNS.md rename to docs/guides/vpn/openvpn/dynDNS.md diff --git a/docs/guides/vpn/firewall.md b/docs/guides/vpn/openvpn/firewall.md similarity index 100% rename from docs/guides/vpn/firewall.md rename to docs/guides/vpn/openvpn/firewall.md diff --git a/docs/guides/vpn/installation.md b/docs/guides/vpn/openvpn/installation.md similarity index 100% rename from docs/guides/vpn/installation.md rename to docs/guides/vpn/openvpn/installation.md diff --git a/docs/guides/vpn/listening-behavior.png b/docs/guides/vpn/openvpn/listening-behavior.png similarity index 100% rename from docs/guides/vpn/listening-behavior.png rename to docs/guides/vpn/openvpn/listening-behavior.png diff --git a/docs/guides/vpn/only-dns-via-vpn.md b/docs/guides/vpn/openvpn/only-dns-via-vpn.md similarity index 100% rename from docs/guides/vpn/only-dns-via-vpn.md rename to docs/guides/vpn/openvpn/only-dns-via-vpn.md diff --git a/docs/guides/vpn/overview.md b/docs/guides/vpn/openvpn/overview.md similarity index 100% rename from docs/guides/vpn/overview.md rename to docs/guides/vpn/openvpn/overview.md diff --git a/docs/guides/vpn/setup-openvpn-server.md b/docs/guides/vpn/openvpn/setup-openvpn-server.md similarity index 100% rename from docs/guides/vpn/setup-openvpn-server.md rename to docs/guides/vpn/openvpn/setup-openvpn-server.md diff --git a/docs/guides/vpn/troubleshooting.md b/docs/guides/vpn/openvpn/troubleshooting.md similarity index 100% rename from docs/guides/vpn/troubleshooting.md rename to docs/guides/vpn/openvpn/troubleshooting.md diff --git a/docs/guides/wireguard/client.md b/docs/guides/vpn/wireguard/client.md similarity index 98% rename from docs/guides/wireguard/client.md rename to docs/guides/vpn/wireguard/client.md index 66d353bd..20842c80 100644 --- a/docs/guides/wireguard/client.md +++ b/docs/guides/vpn/wireguard/client.md @@ -201,7 +201,7 @@ peer: F+80gbmHVlOrU+es13S18oMEX2g= ⬅ Your peer's public key will be differen ## Test for DNS leaks -You should run a DNS leak test on [www.dnsleaktest.com](https://www.dnsleaktest.com) to ensure your WireGuard tunnel does not leak DNS requests (so all are processed by your Pi-hole). The expected outcome is that you should only see DNS servers belonging to the upstream DNS destination you selected in Pi-hole. If you configured [Pi-hole as All-Around DNS Solution](../unbound.md), you should only see the public IP address of your WireGuard server and no other DNS server. +You should run a DNS leak test on [www.dnsleaktest.com](https://www.dnsleaktest.com) to ensure your WireGuard tunnel does not leak DNS requests (so all are processed by your Pi-hole). The expected outcome is that you should only see DNS servers belonging to the upstream DNS destination you selected in Pi-hole. If you configured [Pi-hole as All-Around DNS Solution](/guides/dns/unbound/), you should only see the public IP address of your WireGuard server and no other DNS server. See also [What is a DNS leak and why should I care?](https://www.dnsleaktest.com/what-is-a-dns-leak.html) (external link). diff --git a/docs/guides/wireguard/concept.md b/docs/guides/vpn/wireguard/concept.md similarity index 100% rename from docs/guides/wireguard/concept.md rename to docs/guides/vpn/wireguard/concept.md diff --git a/docs/guides/wireguard/faq.md b/docs/guides/vpn/wireguard/faq.md similarity index 100% rename from docs/guides/wireguard/faq.md rename to docs/guides/vpn/wireguard/faq.md diff --git a/docs/guides/wireguard/internal.md b/docs/guides/vpn/wireguard/internal.md similarity index 100% rename from docs/guides/wireguard/internal.md rename to docs/guides/vpn/wireguard/internal.md diff --git a/docs/guides/wireguard/overview.md b/docs/guides/vpn/wireguard/overview.md similarity index 100% rename from docs/guides/wireguard/overview.md rename to docs/guides/vpn/wireguard/overview.md diff --git a/docs/guides/wireguard/route-everything.md b/docs/guides/vpn/wireguard/route-everything.md similarity index 100% rename from docs/guides/wireguard/route-everything.md rename to docs/guides/vpn/wireguard/route-everything.md diff --git a/docs/guides/wireguard/server.md b/docs/guides/vpn/wireguard/server.md similarity index 100% rename from docs/guides/wireguard/server.md rename to docs/guides/vpn/wireguard/server.md diff --git a/docs/guides/caddy-configuration.md b/docs/guides/webserver/caddy.md similarity index 100% rename from docs/guides/caddy-configuration.md rename to docs/guides/webserver/caddy.md diff --git a/docs/guides/nginx-configuration.md b/docs/guides/webserver/nginx.md similarity index 100% rename from docs/guides/nginx-configuration.md rename to docs/guides/webserver/nginx.md diff --git a/docs/guides/traefik-configuration-nodocker.md b/docs/guides/webserver/traefik-nodocker.md similarity index 100% rename from docs/guides/traefik-configuration-nodocker.md rename to docs/guides/webserver/traefik-nodocker.md diff --git a/mkdocs.yml b/mkdocs.yml index e3664b1a..ce1f2427 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -94,42 +94,46 @@ nav: - 'Contributing on GitHub': guides/github/contributing.md - 'How to sign-off commits': guides/github/how-to-signoff.md - 'Guides': - - 'Pi-hole as All-Around DNS Solution': guides/unbound.md - - 'WireGuard VPN': - - 'Overview': guides/wireguard/overview.md - - 'Concept': guides/wireguard/concept.md - - 'Install server': guides/wireguard/server.md - - 'Add client(s)': guides/wireguard/client.md - - 'Optional extra features': - - 'Make local devices accessible': guides/wireguard/internal.md - - 'Tunnel all Internet traffic': guides/wireguard/route-everything.md - - 'Troubleshooting': guides/wireguard/faq.md - - 'Configuring DNS-Over-HTTPS on Pi-hole': guides/dns-over-https.md - - 'Upstream DNS Providers': guides/upstream-dns-providers.md - - 'Editing Whitelist and Blacklist': guides/whitelist-blacklist.md - - 'Configuring NGINX for Pi-hole': guides/nginx-configuration.md - - 'Configuring Caddy for Pi-hole': guides/caddy-configuration.md - - 'Configuring Traefik for Pi-hole (not in Docker)': guides/traefik-configuration-nodocker.md - - 'Benchmarking': guides/benchmark.md - - 'Pi-hole and OpenVPN Server': - - 'Overview': guides/vpn/overview.md - - 'Installation': guides/vpn/installation.md - - 'Setup OpenVPN Server': guides/vpn/setup-openvpn-server.md - - 'Firewall Configuration': guides/vpn/firewall.md - - 'Connecting clients': - - 'General': guides/vpn/clients.md - - 'Android': guides/vpn/android-client.md - - 'Optional: Only route DNS via VPN': guides/vpn/only-dns-via-vpn.md - - 'Optional: Dual operation: LAN & VPN at the same time': guides/vpn/dual-operation.md - - 'Optional: Full and DNS-only': guides/vpn/dual-VPN.md - - 'Optional: Dynamic DNS': guides/vpn/dynDNS.md - - 'Troubleshooting': guides/vpn/troubleshooting.md - - 'Tor & Pi-hole': - - 'Overview': guides/tor/overview.md - - 'Basic Setup': guides/tor/setup.md - - 'Using Tor': guides/tor/using-tor.md - - 'Performance and other issues': guides/tor/performance-issues.md - - 'Using DNSSEC': guides/tor/dnssec.md + - 'DNS': + - 'unbound': guides/dns/unbound.md + - 'cloudflared (DoH)': guides/dns/cloudflared.md + - 'Upstream DNS Providers': guides/dns/upstream-dns-providers.md + - 'VPN': + - 'WireGuard': + - 'Overview': guides/vpn/wireguard/overview.md + - 'Concept': guides/vpn/wireguard/concept.md + - 'Install server': guides/vpn/wireguard/server.md + - 'Add client(s)': guides/vpn/wireguard/client.md + - 'Optional extra features': + - 'Make local devices accessible': guides/vpn/wireguard/internal.md + - 'Tunnel all Internet traffic': guides/vpn/wireguard/route-everything.md + - 'Troubleshooting': guides/vpn/wireguard/faq.md + - 'OpenVPN': + - 'Overview': guides/vpn/openvpn/overview.md + - 'Installation': guides/vpn/openvpn/installation.md + - 'Setup OpenVPN Server': guides/vpn/openvpn/setup-openvpn-server.md + - 'Firewall Configuration': guides/vpn/openvpn/firewall.md + - 'Connecting clients': + - 'General': guides/vpn/openvpn/clients.md + - 'Android': guides/vpn/openvpn/android-client.md + - 'Optional: Only route DNS via VPN': guides/vpn/openvpn/only-dns-via-vpn.md + - 'Optional: Dual operation: LAN & VPN at the same time': guides/vpn/openvpn/dual-operation.md + - 'Optional: Full and DNS-only': guides/vpn/openvpn/dual-VPN.md + - 'Optional: Dynamic DNS': guides/vpn/openvpn/dynDNS.md + - 'Troubleshooting': guides/vpn/openvpn/troubleshooting.md + - 'Misc': + - 'Benchmarking': guides/misc/benchmark.md + - 'Tor & Pi-hole': + - 'Overview': guides/misc/tor/overview.md + - 'Basic Setup': guides/misc/tor/setup.md + - 'Using Tor': guides/misc/tor/using-tor.md + - 'Performance and other issues': guides/misc/tor/performance-issues.md + - 'Using DNSSEC': guides/misc/tor/dnssec.md + - 'Whitelist and Blacklist editing': guides/misc/whitelist-blacklist.md + - 'Web server': + - 'NGINX': guides/webserver/nginx.md + - 'Caddy': guides/webserver/caddy.md + - 'Traefik (not in Docker)': guides/webserver/traefik-nodocker.md - 'Router setup': - 'Fritz!Box (EN)': routers/fritzbox.md - 'Fritz!Box (DE)': routers/fritzbox-de.md @@ -156,3 +160,27 @@ plugins: 'ftldns/regex/index.md': ftldns/regex/overview.md 'main/presentations.md': index.md 'main/prerequesites.md': main/prerequisites.md + 'guides/unbound.md': guides/dns/unbound.md + 'guides/upstream-dns-providers.md': guides/dns/upstream-dns-providers.md + 'guides/dns-over-https.md': guides/dns/cloudflared.md + 'guides/vpn/overview.md': guides/vpn/openvpn/overview.md + 'guides/vpn/installation.md': guides/vpn/openvpn/installation.md + 'guides/vpn/setup-openvpn-server.md': guides/vpn/openvpn/setup-openvpn-server.md + 'guides/vpn/firewall.md': guides/vpn/openvpn/firewall.md + 'guides/vpn/clients.md': guides/vpn/openvpn/clients.md + 'guides/vpn/android-client.md': guides/vpn/openvpn/android-client.md + 'guides/vpn/only-dns-via-vpn.md': guides/vpn/openvpn/only-dns-via-vpn.md + 'guides/vpn/dual-operation.md': guides/vpn/openvpn/dual-operation.md + 'guides/vpn/dual-VPN.md': guides/vpn/openvpn/dual-VPN.md + 'guides/vpn/dynDNS.md': guides/vpn/openvpn/dynDNS.md + 'guides/vpn/troubleshooting.md': guides/vpn/openvpn/troubleshooting.md + 'guides/benchmark.md': guides/misc/benchmark.md + 'guides/tor/overview.md': guides/misc/tor/overview.md + 'guides/tor/setup.md': guides/misc/tor/setup.md + 'guides/tor/using-tor.md': guides/misc/tor/using-tor.md + 'guides/tor/performance-issues.md': guides/misc/tor/performance-issues.md + 'guides/tor/dnssec.md': guides/misc/tor/dnssec.md + 'guides/whitelist-blacklist.md': guides/misc/whitelist-blacklist.md + 'guides/nginx-configuration.md': 'guides/webserver/nginx.md' + 'guides/caddy-configuration.md': 'guides/webserver/caddy.md' + 'guides/traefik-configuration-nodocker.md': 'guides/webserver/traefik-nodocker.md'