Merge pull request #1268 from rrobgill/typos

Typo corrections

Author: yubiuser

docs/api/auth.md

@@ -1,6 +1,6 @@
 Authentication is required for most API endpoints. The Pi-hole API uses a session-based authentication system. This means that you will not be able to use a static token to authenticate your requests. Instead, you will be given a session ID (SID) that you will have to use. If you didn't set a password for your Pi-hole, you don't have to authenticate your requests.
 
-To get a session ID, you will have to send a `POST` request to the `/api/auth` endpoint with a payload containing your password. Note that is also possible to use an application password instead of your regular password, e.g., if you don't want to put your password in your scripts or if you have 2FA enabled for your regular password. One application password can be generated in the web interface on the settings page.
+To get a session ID, you will have to send a `POST` request to the `/api/auth` endpoint with a payload containing your password. Note that it is also possible to use an application password instead of your regular password, e.g., if you don't want to put your password in your scripts or if you have 2FA enabled for your regular password. One application password can be generated in the web interface on the settings page.
 
 <!-- markdownlint-disable code-block-style -->
 ???+ example "Authentication with password"
@@ -138,7 +138,7 @@ Once you have a valid SID, you can use it to authenticate your requests. You can
 3. In the `X-FTL-SID` header: `X-FTL-SID: vFA+EP4MQ5JJvJg+3Q2Jnw=`
 4. In the `sid` cookie: `Cookie: sid=vFA+EP4MQ5JJvJg+3Q2Jnw=`
 
-Note that when using cookie-based authentication, you will also need to send a `X-FTL-CSRF` header with the CSRF token that was returned when you authenticated. This is to prevent a certain kind of identify theft attack the Pi-hole API is immune against.
+Note that when using cookie-based authentication, you will also need to send a `X-FTL-CSRF` header with the CSRF token that was returned when you authenticated. This is to prevent a certain kind of identity theft attack the Pi-hole API is immune against.
 
 ???+ example "Authentication with SID"
 

docs/api/index.md

@@ -4,7 +4,7 @@ Most (but not all) endpoints require authentication. API endpoints requiring aut
 
 ## Accessing the API documentation
 
-The entire API is documented at http://pi.hole/api/docs and self-hosted by your Pi-hole to match 100% the API versions your local Pi-hole has. Using this locally served API documentation is preferred. In case you don't have Pi-hole installed yet, you can also check out the documentation for all branches online, e.g., [Pi-hole API documentation](https://ftl.pi-hole.net/master/docs/) (branch `master`). Similarly, you can check out the documentation for a specific other branches by replacing `master` with the corresponding branch name. <!-- markdownlint-disable-line no-bare-urls -->
+The entire API is documented at http://pi.hole/api/docs and self-hosted by your Pi-hole to match 100% the API version your local Pi-hole has. Using this locally served API documentation is preferred. In case you don't have Pi-hole installed yet, you can also check out the documentation for all branches online, e.g., [Pi-hole API documentation](https://ftl.pi-hole.net/master/docs/) (branch `master`). Similarly, you can check out the documentation for a specific other branches by replacing `master` with the corresponding branch name. <!-- markdownlint-disable-line no-bare-urls -->
 
 ## API endpoints
 
@@ -118,7 +118,7 @@ In contrast, errors have a uniform, predictable style to ease their programmatic
 
 ## HTTP methods used by this API
 
-Each HTTP request consists of a method that indicates the action to be performed on the identified resource. The relevant standards is [RFC 2616](https://tools.ietf.org/html/rfc2616). Though, RFC 2616 has been very clear in differentiating between the methods, complex wordings are a source of confusion for many users.
+Each HTTP request consists of a method that indicates the action to be performed on the identified resource. The relevant standard is [RFC 2616](https://tools.ietf.org/html/rfc2616). Though, RFC 2616 has been very clear in differentiating between the methods, complex wordings are a source of confusion for many users.
 
 Pi-hole's API uses the methods like this:
 
@@ -168,7 +168,7 @@ Method   | Description
     `DELETE` operations are **idempotent**. If you `DELETE` a resource, it’s removed from the collection of resources. Repeatedly calling `DELETE` on that resource will not change the outcome – however, calling `DELETE` on a resource a second time *may* return a 404 (NOT FOUND) since it was already removed.
 
 ???+ info "Example"
-    Let’s list down few URIs and their purpose to get better understanding when to use which method:
+    Let’s list down a few URIs and their purpose to get better understanding when to use which method:
 
     Method + URI | Interpretation
     ---------------------|--------------------

docs/api/tls.md

@@ -69,7 +69,7 @@ Before | After
 ![Android Firefox Untrusted](../images/api/android-pihole-untrusted.png) | ![Android Firefox Trusted](../images/api/android-pihole-trusted.png)
 ![Android Chrome Untrusted](../images/api/android-chrome-untrusted.png) | ![Android Chrome Trusted](../images/api/android-chrome-trusted.png)
 
-1. Go to you device's settings
+1. Go to your device's settings
 2. Navigate to "System Security" or "Security & location" (depending on your device)
 3. Navigate to "Credential storage" or similar (depending on your device)
 

docs/database/query-database.md

@@ -40,7 +40,7 @@ The long-term database contains several tables:
 
 ### Query Table
 
-Label | Type | Allowed to by empty | Content
+Label | Type | Allowed to be empty | Content
 --- | --- | ---- | -----
 `id` | integer | No | autoincrement ID for the table, only used by SQLite3, not by *FTL*DNS
 `timestamp` | integer | No | Unix timestamp when this query arrived at *FTL*DNS (used as index)
@@ -73,7 +73,7 @@ If a query was influenced by a deny or allowlist entry, this field contains the
 
 This table contains counter values integrated over the entire lifetime of the table
 
-Label | Type | Allowed to by empty | Content
+Label | Type | Allowed to be empty | Content
 --- | --- | ---- | -----
 `id` | integer | No | ID for the table used to select a counter (see below)
 `value` | integer | No | Value of a given counter
@@ -170,29 +170,29 @@ The `queries` `VIEW` reads repeating properties from linked tables to reduce bot
 
 #### `domain_by_id`
 
-Label | Type | Allowed to by empty | Content
+Label | Type | Allowed to be empty | Content
 --- | --- | --- | ---
 `id` | integer | No | ID of the entry. Used by `query_storage`
 `domain` | text | No | Domain name
 
 #### `client_by_id`
 
-Label | Type | Allowed to by empty | Content
+Label | Type | Allowed to be empty | Content
 --- | --- | --- | ---
 `id` | integer | No | ID of the entry. Used by `query_storage`
 `ip` | text | No | Client IP address
 `name` | text | Yes | Client host name
 
 #### `forward_by_id`
 
-Label | Type | Allowed to by empty | Content
+Label | Type | Allowed to be empty | Content
 --- | --- | --- | ---
 `id` | integer | No | ID of the entry. Used by `query_storage`
 `forward` | text | No | Upstream server identifier (`<ipaddr>#<port>`)
 
 #### `addinfo_by_id`
 
-Label | Type | Allowed to by empty | Content
+Label | Type | Allowed to be empty | Content
 --- | --- | --- | ---
 `id` | integer | No | ID of the entry. Used by `query_storage`
 `type` | integer | No | Type of the `content` field
@@ -205,7 +205,7 @@ Valid `type` IDs are currently
 
 ### Example for interaction with the long-term query database
 
-In addition to the interactions the Pi-hole database API offers, you can also run your own SQL commands against the database. If you want to obtain the three most queries domains for all time, you could use
+In addition to the interactions the Pi-hole database API offers, you can also run your own SQL commands against the database. If you want to obtain the three most queried domains for all time, you could use
 
 ```bash
 sqlite3 "/etc/pihole/pihole-FTL.db" "SELECT domain,count(domain) FROM queries WHERE (STATUS == 2 OR STATUS == 3) GROUP BY domain ORDER BY count(domain) DESC LIMIT 3"

docs/ftldns/dns-cache.md

@@ -15,7 +15,7 @@
 
 If a DNS name exists in the cache, but its time-to-live (TTL) has expired only recently, the data will be used anyway (a refreshing from upstream is triggered). This can improve DNS query delays especially over unreliable or slow Internet connections. This feature comes at the expense of possibly sometimes returning out-of-date data and less efficient cache utilization, since old data cannot be flushed when its TTL expires, so the cache becomes mostly least-recently-used. To mitigate issues caused by massively outdated DNS replies, the maximum overaging of cached records is limited. We strongly recommend staying below 86400 (1 day) with this option. The default value of `dns.cache.optimizer` is one hour (`3600` seconds) which was carefully tested to provide a good balance between cache efficiency and query performance without having otherwise adverse effects. Our investigations revealed, that there has always been a grace time larger than an hour in addition to the TTL of DNS records, so this value should be safe for any practical use cases.
 
-## Cacheing of queries blocked upstream (`dns.cache.upstreamBlockedTTL`)
+## Caching of queries blocked upstream (`dns.cache.upstreamBlockedTTL`)
 
 This setting allows you to specify the TTL used for queries blocked upstream. Once the TTL expires, the query will be forwarded to the upstream server again to check if the block is still valid. Defaults to caching for one day (86400 seconds). Setting `dns.cache.upstreamBlockedTTL` to zero disables caching of queries blocked upstream.
 

docs/ftldns/dns-resolver.md

@@ -20,7 +20,7 @@ Users can configure the size of the resolver's name cache. The default is 150 na
 
 #### Improve detection algorithm for determining the "best" forward destination
 
-The DNS forward destination determination algorithm in *FTL*DNS's is modified to be much less restrictive than the original algorithm in `dnsmasq`. We keep using the fastest responding server now for 1000 queries or 10 minutes (whatever happens earlier) instead of 50 queries or 10 seconds (default values in `dnsmasq`).
+The DNS forward destination determination algorithm in *FTL*DNS is modified to be much less restrictive than the original algorithm in `dnsmasq`. We keep using the fastest responding server now for 1000 queries or 10 minutes (whatever happens earlier) instead of 50 queries or 10 seconds (default values in `dnsmasq`).
 We keep the exceptions, i.e., we try all possible forward destinations if `SERVFAIL` or `REFUSED` is received or if a timeout occurs.
 Overall, this change has proven to greatly reduce the number of actually performed queries in typical Pi-hole environments. It may even be understood as being preferential in terms of privacy (as we send queries much less often to all servers).
 This has been implemented in commit [d1c163e](https://github.com/pi-hole/FTL/commit/d1c163e499a5cd9f311610e9da1e9365bbf81e89).

docs/ftldns/dnsmasq_warn.md

@@ -167,7 +167,7 @@ Warnings commonly seen in `dnsmasq`'s log file (`/var/log/pihole/pihole.log`) an
 
 !!! warning "overflow: `NUMBER` log entries lost"
 
-    When using asynchronous logging and the disk is too slow, we can loose log lines during busy times. This can be avoided by decreasing the system load or switching to synchronous logging. Note that synchronous logging has the disadvantage of blocking DNS resolution when waiting for the log to be written to disk.
+    When using asynchronous logging and the disk is too slow, we can lose log lines during busy times. This can be avoided by decreasing the system load or switching to synchronous logging. Note that synchronous logging has the disadvantage of blocking DNS resolution when waiting for the log to be written to disk.
 
 !!! warning "failed to create listening socket for `ADDRESS`: `MSG`"
 

docs/guides/misc/all_settings.png

@@ -20,7 +20,7 @@ In a normal setup this results in a “No such name” response from your DNS se
 
 Link to [Chromium's source code](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/chrome/browser/intranet_redirect_detector.cc#132) explaining the function.
 
-### Pi-hole update fails due to repository changed it's 'Suite' value
+### Pi-hole update fails due to repository changed its 'Suite' value
 
 This happens after a manual OS upgrade to the next major version on deb based systems. A typical message is
 

docs/main/faq.md

@@ -117,7 +117,7 @@ Gravity is one of the most important scripts of Pi-hole. Its main purpose is to
 * It will determine Internet connectivity, and give time for `pihole-FTL` to be resolvable on low-end systems if has just been restarted
 * It extracts all URLs and domains from the `adlists` table in [`/etc/pihole/gravity.db`](../database/domain-database/index.md)
 * It runs through each URL, downloading it if necessary
-    * `curl` checks the servers `Last-Modified` header to ensure it is getting a newer version
+    * `curl` checks the server's `Last-Modified` header to ensure it is getting a newer version
 * It will attempt to parse the file into a domains-only format if necessary
 * Lists are merged, comments removed, sorted uniquely and stored in the `gravity` table of [`/etc/pihole/gravity.db`](../database/domain-database/index.md)
 * Gravity cleans up temporary content and reloads the DNS server