diff --git a/.editorconfig b/.editorconfig index f475507..e3bc703 100644 --- a/.editorconfig +++ b/.editorconfig @@ -15,6 +15,9 @@ trim_trailing_whitespace = true [*.yml] tab_width = 2 +[*.toml] +tab_width = 2 + [*.md] tab_width = 4 trim_trailing_whitespace = false diff --git a/docs/database/domain-database/groups.md b/docs/database/domain-database/groups.md index 1368ece..fb635ad 100644 --- a/docs/database/domain-database/groups.md +++ b/docs/database/domain-database/groups.md @@ -1,7 +1,3 @@ ---- -title: Group Management ---- - Groups are defined in the `group` table and can have an optional description in addition to the mandatory name of the group. Label | Type | Uniqueness enforced | Content diff --git a/docs/database/domain-database/index.md b/docs/database/domain-database/index.md index 25888b7..0c67a42 100644 --- a/docs/database/domain-database/index.md +++ b/docs/database/domain-database/index.md @@ -1,7 +1,3 @@ ---- -title: Domain Database ---- - Pi-hole uses the well-known relational database management system SQLite3 for managing the various domains that are used to control the DNS filtering system. The database-based domain management has been added with Pi-hole v5.0. The ability to subscribe to external *allow*lists has been added with Pi-hole v6.0. ## Priorities diff --git a/docs/docker/DHCP.md b/docs/docker/DHCP.md index 366343b..7f5f8e7 100644 --- a/docs/docker/DHCP.md +++ b/docs/docker/DHCP.md @@ -1,9 +1,3 @@ ---- -title: Docker DHCP and Network Modes -description: Setting up DHCP for Docker Pi-hole -last_updated: Sat Feb 09 00:00:00 2019 UTC ---- - # Docker DHCP and Network Modes Docker runs in a separate network by default called a docker bridge network, which makes DHCP want to serve addresses to that network and not your LAN network where you probably want it. This document details why Docker Pi-hole DHCP is different from normal Pi-hole and how to fix the problem. diff --git a/docs/index.md b/docs/index.md index de85e7a..5ea6eac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,3 @@ ---- -title: Overview of Pi-hole -description: Brief overview of Pi-hole ---- -

Pi-hole diff --git a/docs/main/contact.md b/docs/main/contact.md index a24ad50..03e946e 100644 --- a/docs/main/contact.md +++ b/docs/main/contact.md @@ -1,9 +1,3 @@ ---- -title: Getting in touch -description: Pi-hole contacts and social media -last_updated: Sun Jan 13 18:33:27 2019 UTC ---- - While we are primarily reachable on our [Discourse User Forum](https://discourse.pi-hole.net/), we can also be found on a variety of social media outlets. **Please be sure to check the FAQ's** before starting a new discussion, as we do not have the spare time to reply to every request for assistance. - [Frequently Asked Questions](https://discourse.pi-hole.net/c/faqs) diff --git a/docs/main/coverage.md b/docs/main/coverage.md index bbaa914..a2855f3 100644 --- a/docs/main/coverage.md +++ b/docs/main/coverage.md @@ -1,9 +1,3 @@ ---- -title: Pi-hole News and Blogs -description: Sites and articles about Pi-hole -last_updated: Sun Jan 13 19:20:35 2019 UTC ---- - ## YouTube/Twit/Video - [Security Now Netcast: Pi-hole](https://www.youtube.com/watch?v=p7-osq_y8i8&t=100m26s) _Oct 13, 2015_ diff --git a/docs/main/origins.md b/docs/main/origins.md index b9fd10c..2048ef3 100644 --- a/docs/main/origins.md +++ b/docs/main/origins.md @@ -1,9 +1,3 @@ ---- -title: Pi-hole Origins -description: Software packages used in Pi-hole -last_updated: Sun Jan 13 18:35:14 2019 UTC ---- - Pi-hole being a **advertising-aware DNS/Web server**, makes use of the following technologies: - [`dnsmasq`](https://www.thekelleys.org.uk/dnsmasq/doc.html) - a lightweight DNS and DHCP server diff --git a/docs/main/prerequisites.md b/docs/main/prerequisites.md index 685f8f7..883c019 100644 --- a/docs/main/prerequisites.md +++ b/docs/main/prerequisites.md @@ -1,9 +1,3 @@ ---- -title: Prerequisites -description: Operating system and network requirements -last_updated: May 25 2020 ---- - ## Hardware Pi-hole is very lightweight and does not require much processing power diff --git a/docs/main/projects.md b/docs/main/projects.md index 0b75197..df3097a 100644 --- a/docs/main/projects.md +++ b/docs/main/projects.md @@ -1,9 +1,3 @@ ---- -title: Community Projects -description: Things built with Pi-hole -last_updated: Sun Sep 06 14:28:14 2020 UTC ---- - - [The Big Blocklist Collection](https://firebog.net/) - [Pi-Hole in the cloud](https://blog.codybunch.com/2015/07/28/Pi-Hole-in-the-cloud/) - [Minibian Pi-hole](https://munkjensen.net/wiki/index.php/See_my_Pi-Hole#Minibian_Pi-hole) diff --git a/zensical.toml b/zensical.toml index 48abe9a..7c49734 100644 --- a/zensical.toml +++ b/zensical.toml @@ -20,6 +20,151 @@ copyright = "" extra_css = ["extra.css"] #extra_javascript = ["assets/javascript/extra.js"] +# ---------------------------------------------------------------------------- +# Navigation section +# ---------------------------------------------------------------------------- + + nav = [ + {"About Pi-hole" = [ + {"About Pi-hole" = "index.md"}, + {"Getting in touch" = "main/contact.md"}, + {"Pi-hole Origins" = "main/origins.md"}, + {"On the Web" = "main/coverage.md"} + ]}, + {"Getting Started" = [ + {"Getting Started" = "main/index.md"}, + {"Prerequisites" = "main/prerequisites.md"}, + {"Installation" = "main/basic-install.md"}, + {"Post-Install" = "main/post-install.md"}, + {"Updating" = "main/update.md"}, + {"Uninstalling" = "main/uninstall.md"} + ]}, + {"The  pihole  Command" = "main/pihole-command.md"}, + {"Databases" = [ + {"Databases" = "database/index.md"}, + {"Query Database" = "database/query-database.md"}, + {"Domain Database" = [ + {"Domain Database" = "database/domain-database/index.md"}, + {"Group Management" = "database/domain-database/groups.md"}, + {"Database Recovery" = "database/domain-database/recovery.md"} + ]}, + ]}, + {"Pi-hole API" = [ + {"Pi-hole API" = "api/index.md"}, + {"Authentication" = "api/auth.md"}, + {"TLS/SSL" = "api/tls.md"} + ]}, + {"FTLDNS" = [ + {"FTLDNS" = "ftldns/index.md"}, + {"Configuration" = "ftldns/configfile.md"}, + {"Interfaces" = "ftldns/interfaces.md"}, + {"DNS cache" = "ftldns/dns-cache.md"}, + {"DNS resolver" = "ftldns/dns-resolver.md"}, + {"Blocking mode" = "ftldns/blockingmode.md"}, + {"Privacy levels" = "ftldns/privacylevels.md"}, + {"dnsmasq warnings" = "ftldns/dnsmasq_warn.md"}, + {"Webserver" = "ftldns/webserver.md"}, + {"Advanced" = [ + {"Install from source" = "ftldns/compile.md"}, + {"Signals" = "ftldns/signals.md"}, + {"Cache dump" = "ftldns/cache_dump.md"}, + {"Packet dump" = "ftldns/package_dump.md"}, + {"Debugging" = [ + {"gdb" = "ftldns/gdb.md"}, + {"valgrind" = "ftldns/valgrind.md"}, + ]}, + ]}, + ]}, + {"Group Management" = [ + {"Group Management" = "group_management/index.md"}, + {"Examples" = "group_management/example.md"} + ]}, + {"RegEx Blocking" = [ + {"Regex Blocking" = "regex/index.md"}, + {"Testing" = "regex/testmode.md"}, + {"Tutorial" = "regex/tutorial.md"}, + {"Pi-hole extensions" = "regex/pi-hole.md"}, + {"Approximate matching" = "regex/approximate.md"} + ]}, + {"Docker" = [ + {"Docker" = "docker/index.md"}, + {"Configuration" = "docker/configuration.md"}, + {"Upgrading" = [ + {"Upgrading" = "docker/upgrading/index.md"}, + {"Upgrading from v5.x" = "docker/upgrading/v5-v6.md"} + ]}, + {"Building" = "docker/build-image.md"}, + {"DHCP" = "docker/DHCP.md"}, + {"Tips and Tricks" = "docker/tips-and-tricks.md"}, + ]}, + {"Contributing" = [ + {"Contributing" = "guides/github/index.md"}, + {"Developer Certificate of Origin (DCO)" = "guides/github/dco.md"}, + {"How to sign-off commits" = "guides/github/how-to-signoff.md"}, + {"How to fork and rebase" = "guides/github/how-to-fork-rebase.md"} + ]}, + {"Guides" = [ + {"DNS" = [ + {"unbound" = "guides/dns/unbound.md"}, + {"cloudflared (DoH)" = "guides/dns/cloudflared.md"}, + {"dnscrypt-proxy (DoH)" = "guides/dns/dnscrypt-proxy.md"}, + {"Upstream DNS Providers" = "guides/dns/upstream-dns-providers.md"} + ]}, + {"VPN" = [ + {"WireGuard" = [ + {"Wireguard" = "guides/vpn/wireguard/index.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" = [ + {"OpenVPN" = "guides/vpn/openvpn/index.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" = [ + {"Home Assistant" = "guides/misc/homeassistant.md"}, + {"Benchmarking" = "guides/misc/benchmark.md"}, + {"Tor & Pi-hole" = [ + {"Tor & Pi-hole" = "guides/misc/tor/index.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"}, + ]}, + {"Allowlist and Denylist editing" = "guides/misc/allowlist-denylist.md"}, + {"Network Time Protocol" = "guides/misc/ntp.md"} + ]} + ]}, + {"Router setup" = [ + {"ASUS router" = "routers/asus.md"}, + {"Fritz!Box (EN)" = "routers/fritzbox.md"}, + {"Fritz!Box (DE)" = "routers/fritzbox-de.md"}, + {"Nokia G-240W-B" = "routers/nokia-G240WB.md"}, + {"OPNsense" = "routers/OPNsense.md"}, + {"TP-Link" = "routers/tp-link.md"}, + {"Ubiquiti USG" = "routers/ubiquiti-usg.md"} + ]}, + {"FAQ" = "main/faq.md"}, + {"Community Projects" = "main/projects.md"} + ] + # ---------------------------------------------------------------------------- # Section for configuring theme options # ---------------------------------------------------------------------------- @@ -130,12 +275,3 @@ name = "Website" icon = "fontawesome/brands/github" link = "https://github.com/pi-hole" name = "GitHub" - -# ---------------------------------------------------------------------------- -# Navigation section -# ---------------------------------------------------------------------------- - -# nav = [ -# { "Get started" = "index.md" }, -# { "Markdown in 5min" = "markdown.md" }, -# ]