Skip to content

Commit

Permalink
Merge branch 'master' into release/v6.0
Browse files Browse the repository at this point in the history
Signed-off-by: DL6ER <[email protected]>
  • Loading branch information
DL6ER committed Nov 9, 2024
2 parents d16a433 + 77d4108 commit 3836980
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 14 deletions.
21 changes: 16 additions & 5 deletions docs/guides/dns/cloudflared.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ It is worth noting, however, that the upstream DNS-Over-HTTPS provider will stil

## Configuring DNS-Over-HTTPS

Along with releasing their DNS service [1.1.1.1](https://blog.cloudflare.com/announcing-1111/), Cloudflare implemented DNS-Over-HTTPS proxy functionality into one of their tools: [`cloudflared`](https://github.com/cloudflare/cloudflared).
Along with releasing their DNS service [1.1.1.1](https://blog.cloudflare.com/announcing-1111/) (and later [1.1.1.1 for Families](https://blog.cloudflare.com/introducing-1-1-1-1-for-families)) Cloudflare implemented DNS-Over-HTTPS proxy functionality into one of their tools: [`cloudflared`](https://github.com/cloudflare/cloudflared).

In the following sections, we will be covering how to install and configure this tool on `Pi-hole`.

!!! info
The `cloudflared` binary will work with other DoH providers (for example, you could use `https://8.8.8.8/dns-query` for Google's DNS-Over-HTTPS service).
The `cloudflared` binary will also work with other DoH providers (for example, [Google's DoH service](https://developers.google.com/speed/public-dns/docs/doh) or [Quad9's DoH service](https://quad9.net/service/service-addresses-and-features)).

### Installing `cloudflared`

Expand Down Expand Up @@ -81,7 +81,18 @@ Edit configuration file by copying the following in to `/etc/default/cloudflared

```bash
# Commandline args for cloudflared, using Cloudflare DNS
CLOUDFLARED_OPTS=--port 5053 --upstream https://1.1.1.1/dns-query --upstream https://1.0.0.1/dns-query
CLOUDFLARED_OPTS=--port 5053 --upstream https://cloudflare-dns.com/dns-query
```


!!! info
See the other available [Cloudflare endpoints](https://developers.cloudflare.com/1.1.1.1/infrastructure/network-operators/#available-endpoints).

If you're running cloudflared on different host than pi-hole, you can add listening address to all IPs (for security, change 0.0.0.0 to your machine's IP, e.g. 192.168.1.1):

```bash
# Commandline args for cloudflared, using Cloudflare DNS
CLOUDFLARED_OPTS=--port 5053 --upstream https://1.1.1.1/dns-query --upstream https://1.0.0.1/dns-query --address 0.0.0.0
```

Update the permissions for the configuration file and `cloudflared` binary to allow access for the cloudflared user:
Expand Down Expand Up @@ -160,7 +171,7 @@ Finally, configure Pi-hole to use the local `cloudflared` service as the upstrea

### Updating `cloudflared`

The `cloudflared` tool will not receive updates through the package manager. However, you should keep the program update to date. You can either do this manually, or via a cron script.
The `cloudflared` tool will not receive updates through the package manager. However, you should keep the program update to date. You can either do this manually (e.g. by watching their [repo](https://github.com/cloudflare/cloudflared) for new releases), or via a cron script.

The procedure for updating depends on how you configured the `cloudflared` binary.

Expand Down Expand Up @@ -200,7 +211,7 @@ sudo chown root:root /etc/cron.weekly/cloudflared-updater
<!-- markdownlint-disable code-block-style -->
!!! warning
Make sure to add shebang `#!/bin/bash` in the beginning of `/etc/cron.weekly/cloudflared-updater`.
Otherwise, the command would not executed.
Otherwise, the command will not be executed.
<!-- markdownlint-enable code-block-style -->

The system will now attempt to update the cloudflared binary automatically, once per week.
Expand Down
16 changes: 8 additions & 8 deletions docs/main/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ Pi-hole is supported on distributions utilizing [systemd](https://systemd.io/) o

The following operating systems are **officially** supported:

| Distribution | Release | Architecture |
| ------------ | ---------------- | ------------------- |
| Raspberry Pi OS <br>(formerly Raspbian) | Buster / Bullseye | ARM |
| Armbian OS | Any | ARM / x86_64 / riscv64 |
| Ubuntu | 20.x / 22.x / 23.x / 24.x | ARM / x86_64 |
| Debian | 10 / 11 / 12 | ARM / x86_64 / i386 |
| Fedora | 39 / 40 | ARM / x86_64 |
| CentOS Stream | 9 | x86_64 |
- Raspberry Pi OS (formerly Raspbian)
- Armbian OS
- Ubuntu
- Debian
- Fedora
- CentOS Stream

Pi-hole only supports actively maintained versions of these systems.

<!-- markdownlint-disable code-block-style -->
!!! info
Expand Down
2 changes: 1 addition & 1 deletion docs/regex/pi-hole.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Only match specific query types

You can amend the regular expressions by special keywords added at the end to fine-tine regular expressions to match only specific [query types](../database/query-database.md#supported-query-types). In contrast to the description of `OTHER` as being deprecated for storing queries in the database, it is still supported for regular expressions and will match all queries that are not *explicitly* covered by the other query types (see also example below).
You can amend the regular expressions by special keywords added at the end to fine-tune regular expressions to match only specific [query types](../database/query-database.md#supported-query-types). In contrast to the description of `OTHER` as being deprecated for storing queries in the database, it is still supported for regular expressions and will match all queries that are not *explicitly* covered by the other query types (see also example below).

Example:

Expand Down

0 comments on commit 3836980

Please sign in to comment.