diff --git a/README.md b/README.md index a382583..2112e8e 100644 --- a/README.md +++ b/README.md @@ -19,9 +19,9 @@ To add a new link on the navigation panel you need to edit the `mkdocs.yml` file To add a new document or guide. - Navigate to the directory where it will be hosted. - EG. guides are in `docs/guides` + E.g. guides are in `docs/guides` - Create the file using a URL friendly filename. - EG. `docs/guides/url-friendly.md` + E.g. `docs/guides/url-friendly.md` - Edit your document using Markdown, there are loads of resources available for the correct syntax. ### Testing your changes diff --git a/docs/ftldns/compile.md b/docs/ftldns/compile.md index e4c33d8..0ede0ec 100644 --- a/docs/ftldns/compile.md +++ b/docs/ftldns/compile.md @@ -63,7 +63,7 @@ cmake .. cmake --build . -- -j $(nproc) ``` -Note that both ways are exactly equivalent and that you do not need `root` priviledges here. +Note that both ways are exactly equivalent and that you do not need `root` privileges here. ## Install the new binary system-wide diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index aacb71b..96341eb 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -83,7 +83,7 @@ Should `FTL` ignore queries coming from the local machine? #### `AAAA_QUERY_ANALYSIS=yes|no` {#aaaa_query_analysis data-toc-label='AAAA Query Analysis'} -Should FTL analyze `AAAA` queries? The DNS server will handle `AAAA` queries the same way, reglardless of this setting. All this does is ignoring `AAAA` queries when computing the statistics of Pi-hole. This setting is considered obsolete and will be removed in a future version. +Should FTL analyze `AAAA` queries? The DNS server will handle `AAAA` queries the same way, regardless of this setting. All this does is ignoring `AAAA` queries when computing the statistics of Pi-hole. This setting is considered obsolete and will be removed in a future version. #### `ANALYZE_ONLY_A_AND_AAAA=false|true` {#analyze_only_a_and_aaaa data-toc-label='Analyze A and AAAA Only'} @@ -160,7 +160,7 @@ With this option, you can change how (and if) hourly PTR requests are made to ch - `REFRESH_HOSTNAMES=ALL` - Do the hourly PTR lookups for all addresses This is the same as what we're doing with FTL v5.3(.1). This can create a lot of PTR queries for those with many IPv6 addresses in their networks. - `REFRESH_HOSTNAMES=UNKNOWN` - Only resolve unknown hostnames - Already existing hostnames are never refreshedi, i.e., there will be no PTR queries made for clients where hostnames are known. This also means that known hostnames will not be updated once known. + Already existing hostnames are never refreshed, i.e., there will be no PTR queries made for clients where hostnames are known. This also means that known hostnames will not be updated once known. - `REFRESH_HOSTNAMES=NONE` - Don't do any hourly PTR lookups This means we look host names up exactly once (when we first see a client) and never again. You may miss future changes of host names. diff --git a/docs/ftldns/valgrind.md b/docs/ftldns/valgrind.md index f1bcb81..0696381 100644 --- a/docs/ftldns/valgrind.md +++ b/docs/ftldns/valgrind.md @@ -1,6 +1,6 @@ # Debugging FTLDNS using `valgrind` -Ocassionally, 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). +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. @@ -165,7 +165,7 @@ Usually the GNU C library (`libc.so`) doesn't bother to free that memory when th This, and similar, loss record can safely be ignored. -For performance reasons, we keep a few prepared SQL statement always ready for execution in the main thread. However, this has the disadvatage that forks will inherit them. As [it is not safe](https://www.sqlite.org/howtocorrupt.html) to use a database connection across forks, we discard the open connection and open a new one. This will inevitably lead to a memory loss, however, the SQLite3 engine is not able to handle this any better. +For performance reasons, we keep a few prepared SQL statement always ready for execution in the main thread. However, this has the disadvantage that forks will inherit them. As [it is not safe](https://www.sqlite.org/howtocorrupt.html) to use a database connection across forks, we discard the open connection and open a new one. This will inevitably lead to a memory loss, however, the SQLite3 engine is not able to handle this any better. As forking relies on [copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write), this does not *actually* lead to a memory wasting as the resource will be shared between the fork and the original process. Furthermore, TCP workers are typically rare and short-lived so this leak isn't anything we are too worried about. diff --git a/docs/guides/dns/cloudflared.md b/docs/guides/dns/cloudflared.md index 0ffae44..496acd6 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 segementation 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. As a workaround you can use an older version provided at instead. #### arm64 architecture (64-bit Raspberry Pi) @@ -218,7 +218,7 @@ cloudflared -v sudo systemctl status cloudflared ``` -#### If you configued cloudflared via `service install` +#### If you configured cloudflared via `service install` If you configured `cloudflared` using their `service install` command, then you can use the built in update command. diff --git a/docs/guides/dns/unbound.md b/docs/guides/dns/unbound.md index 9c0ebfa..276836d 100644 --- a/docs/guides/dns/unbound.md +++ b/docs/guides/dns/unbound.md @@ -169,7 +169,7 @@ It instructs `resolvconf` to write `unbound`'s own DNS service at `nameserver 12 That `/etc/resolv.conf` file is used by local services/processes to determine DNS servers configured. If you configured `/etc/dhcpcd.conf` with a `static domain_name_servers=` line, these DNS server(s) will be ignored/overruled by this service. -To check if this service is enabled for your distribution, run below one and take note of the the `Active` line. +To check if this service is enabled for your distribution, run below one and take note of the `Active` line. It will show either `active` or `inactive` or it might not even be installed resulting in a `could not be found` message: ```bash diff --git a/docs/guides/vpn/openvpn/client.ovpn b/docs/guides/vpn/openvpn/client.ovpn index 627c487..2279653 100644 --- a/docs/guides/vpn/openvpn/client.ovpn +++ b/docs/guides/vpn/openvpn/client.ovpn @@ -50,7 +50,7 @@ cert /home/dl6er/openvpn/client.crt key /home/dl6er/openvpn/client.key # Verify server certificate by checking that the -# certicate has the correct key usage set. +# certificate has the correct key usage set. # This is an important precaution to protect against # a potential attack discussed here: # http://openvpn.net/howto.html#mitm diff --git a/docs/guides/vpn/wireguard/client.md b/docs/guides/vpn/wireguard/client.md index 20842c8..70116c7 100644 --- a/docs/guides/vpn/wireguard/client.md +++ b/docs/guides/vpn/wireguard/client.md @@ -157,7 +157,7 @@ That's it. When this option is enabled, a keepalive packet is sent to the server endpoint once every interval seconds. A sensible interval that works with a wide variety of firewalls is `25` seconds. Setting it to 0 turns the feature off, which is the default. - Handshakes are not the same as keep-alives. A handshake establishes a limited-time session of about 3 minutes. So, for about 3 minutes your client is able to send its keep-alive packets without requireing a new session. Then, when the session expires, sending a new keep-alive requires a new session for which you should see a new handshake. In practice, the client initiates a handshake earlier. + Handshakes are not the same as keep-alives. A handshake establishes a limited-time session of about 3 minutes. So, for about 3 minutes your client is able to send its keep-alive packets without requiring a new session. Then, when the session expires, sending a new keep-alive requires a new session for which you should see a new handshake. In practice, the client initiates a handshake earlier. **TL;DR** If you're behind NAT or a firewall and you want to receive incoming connections long after network traffic has gone silent, this option will keep the "connection" open in the eyes of NAT. diff --git a/docs/guides/webserver/caddy.md b/docs/guides/webserver/caddy.md index 9f49317..569c5de 100644 --- a/docs/guides/webserver/caddy.md +++ b/docs/guides/webserver/caddy.md @@ -53,7 +53,7 @@ myawesomesite.com { } ``` -Additionally you can make pihole reacheable via a subdomain and optionally can you enable Zstandard and Gzip compression as follows: +Additionally you can make pihole reachable via a subdomain and optionally can you enable Zstandard and Gzip compression as follows: ``` pihole.myawesomesite.com { diff --git a/docs/regex/approximate.md b/docs/regex/approximate.md index 097d906..b0485b0 100644 --- a/docs/regex/approximate.md +++ b/docs/regex/approximate.md @@ -91,7 +91,7 @@ This sets the cost of an insertion to two, a deletion to one, a substitution to Example 2: `{+2-5#6, 2i + 1d + 2s < 5 }` -This sets the cost of an insertion to two, a deletion to one, a substitution to two, and the maximum cost to five. Furthermore, it allows only up to 2 insertions (coming at a total cost of 4), five deletions and up to 6 substitutions. As six substitutions would come at a cost of `6*2 = 12`, exeeding the total allowed costs of 5, they cannot all be realized. +This sets the cost of an insertion to two, a deletion to one, a substitution to two, and the maximum cost to five. Furthermore, it allows only up to 2 insertions (coming at a total cost of 4), five deletions and up to 6 substitutions. As six substitutions would come at a cost of `6*2 = 12`, exceeding the total allowed costs of 5, they cannot all be realized. {!abbreviations.md!} diff --git a/docs/regex/pi-hole.md b/docs/regex/pi-hole.md index 8fd4349..b15f9e8 100644 --- a/docs/regex/pi-hole.md +++ b/docs/regex/pi-hole.md @@ -96,7 +96,7 @@ Only one option should be specified. An exception to this rule are the last two ## Comments -You can specify comments withing your regex using the syntax +You can specify comments within your regex using the syntax ``` plain (?#some comment here) @@ -176,7 +176,7 @@ A bracket expression specifies a set of characters by enclosing a nonempty list - `[:upper:]` upper case letters (FTL matches case-insensitive by default) - `[:xdigit:]` hexadecimal digits -Furthermore, there are two shortcurts for some character classes: +Furthermore, there are two shortcuts for some character classes: - `\d` - Digit character (equivalent to `[[:digit:]]`) - `\D` - Non-digit character (equivalent to `[^[:digit:]]`) diff --git a/docs/routers/fritzbox.md b/docs/routers/fritzbox.md index 7e10abc..e44d8d7 100644 --- a/docs/routers/fritzbox.md +++ b/docs/routers/fritzbox.md @@ -6,7 +6,7 @@ This guide is IPv4 only. You need to adjust for IPv6 accordingly. ### Enable advanced settings -Some of the the following settings might be visible only if advanced settings are enabled. Therefore, "View" has to be changed to advanced by clicking on "Standard" in the lower left corner. +Some of the following settings might be visible only if advanced settings are enabled. Therefore, "View" has to be changed to advanced by clicking on "Standard" in the lower left corner. ![Screenshot der Fritz!Box DHCP Einstellungen](../images/fritzbox-advanced.png) @@ -70,7 +70,7 @@ The Fritz!Box always sets its own IP as DNS server for the guest network. To fil ## Hostnames instead of IP addresses in Pi-hole's web interface - Conditional forwarding -In case the Fritz!Box is used as DHCP server, client's hostames are registered only there. By default, Pi-hole tries to resolve the IP addresses of the clients back into host names. Therefore, the requests must reach the Fritz!Box. +In case the Fritz!Box is used as DHCP server, client's hostnames are registered only there. By default, Pi-hole tries to resolve the IP addresses of the clients back into host names. Therefore, the requests must reach the Fritz!Box. There are two ways to do this: * The Fritz!Box is the upstream DNS server of the Pi-hole. This means that all queries end up with the Fritz!Box anyway, which can send the host names back to Pi-hole. diff --git a/mkdocs.yml b/mkdocs.yml index 28960a3..69eef52 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -190,7 +190,7 @@ plugins: redirect_maps: 'ftldns/database.md': database/index.md 'main/presentations.md': index.md - 'main/prerequesites.md': main/prerequisites.md + 'main/prerequisites.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