mirror of
https://github.com/pi-hole/docs.git
synced 2024-12-06 19:27:12 +01:00
Merge branch 'master' into new/uninstall
This commit is contained in:
Adam Warner
GitHub
@@ -0,0 +1,26 @@
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: npm
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: weekly
|
||||
day: saturday
|
||||
time: "10:00"
|
||||
open-pull-requests-limit: 10
|
||||
versioning-strategy: increase
|
||||
- package-ecosystem: pip
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: weekly
|
||||
day: saturday
|
||||
time: "10:00"
|
||||
open-pull-requests-limit: 10
|
||||
allow:
|
||||
- dependency-type: direct
|
||||
- dependency-type: indirect
|
||||
- package-ecosystem: "github-actions"
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: weekly
|
||||
day: saturday
|
||||
time: "10:00"
|
||||
@@ -22,7 +22,7 @@ jobs:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v1
|
||||
uses: actions/setup-python@v2.2.2
|
||||
with:
|
||||
python-version: "${{ env.PYTHON_VERSION }}"
|
||||
architecture: "x64"
|
||||
|
||||
@@ -46,7 +46,7 @@ Rate-limiting may be disabled altogether by setting `RATE_LIMIT=0/0` (this resul
|
||||
|
||||
#### `MAXLOGAGE=24.0` {#maxlogage data-toc-label='Max Log Age'}
|
||||
|
||||
Up to how many hours of queries should be imported from the database and logs? Maximum is 24.0
|
||||
Up to how many hours of queries should be imported from the database and logs? Values greater than the hard-coded maximum of 24h need a locally compiled `FTL` with a changed compile-time value.
|
||||
|
||||
#### `PRIVACYLEVEL=0|1|2|3` {#privacylevel data-toc-label='Privacy Level'}
|
||||
|
||||
@@ -201,6 +201,10 @@ Print debugging information about database actions. This prints performed SQL st
|
||||
|
||||
Prints a list of the detected interfaces on the startup of `pihole-FTL`. Also, prints whether these interfaces are IPv4 or IPv6 interfaces.
|
||||
|
||||
#### `DEBUG_EDNS0=false|true` {#debug_edns0 data-toc-label='EDNS0'}
|
||||
|
||||
Print debugging information about received EDNS(0) data.
|
||||
|
||||
#### `DEBUG_LOCKS=false|true` {#debug_locks data-toc-label='Locks'}
|
||||
|
||||
Print information about shared memory locks. Messages will be generated when waiting, obtaining, and releasing a lock.
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
# Interface binding behavior
|
||||
|
||||
## Interface listening settings
|
||||
|
||||
Pi-hole offers three choices for interface listening behavior on its dashboard:
|
||||
|
||||
|
||||
|
||||
### Listen on all interfaces
|
||||
|
||||
This setting accepts DNS queries only from hosts whose address is on a local subnet, i.e. a subnet for which an interface exists on the server. It is intended to be set as a default on installation, to allow unconfigured installations to be useful but also safe from being used for DNS amplification attacks if (accidentally) running public.
|
||||
|
||||
The `dnsmasq` option `local-service` is used.
|
||||
|
||||
### Listen only on interface `eth0`
|
||||
|
||||
Listen only on the specified interface. The loopback (`lo`) interface is automatically added to the list of interfaces to use when this option is used. When the optional settings `bind-interfaces` or `bind-dynamic` are in effect, IP alias interface labels (e.g. `eth1:0`) are checked, rather than interface names.
|
||||
|
||||
In the degenerate case when an interface has one address, this amounts to the same thing but when an interface has multiple addresses it allows control over which of those addresses are accepted. The same effect is achievable in default mode by using `listen-address`.
|
||||
|
||||
The `dnsmasq` option `interface=eth0` is used (the interface may be different).
|
||||
|
||||
### Listen on all interfaces, permit all origins
|
||||
|
||||
We intentionally add this option to disable any possible `local-service` settings from other files. This truly allows any traffic to be replied to and a dangerous thing to do. You should always ask yourself if the first option doesn't work for you as well.
|
||||
|
||||
The `dnsmasq` option `except-interface=nonexisting` is used.
|
||||
|
||||
## Technical details
|
||||
|
||||
By default, FTL binds the wildcard address, even when it is listening on only some interfaces. It then discards requests that it shouldn't reply to. This has the big advantage of working even when interfaces come and go and change address (this happens way more often than one would think).
|
||||
|
||||
If this is not what you want, you can add the option
|
||||
|
||||
``` plain
|
||||
bind-interfaces
|
||||
```
|
||||
|
||||
to some file like `/etc/dnsmasq.d/99-user.conf` and see [the comment above](#listen-only-on-interface-eth0). This config forces FTL to really bind only the interfaces it is listening on.
|
||||
About the only time when this is useful is when running another nameserver on the same port on the same machine.
|
||||
|
||||
{!abbreviations.md!}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
@@ -28,4 +28,8 @@ wget -O basic-install.sh https://install.pi-hole.net
|
||||
sudo bash basic-install.sh
|
||||
```
|
||||
|
||||
### Alternative 3: Use Docker to deploy Pi-hole
|
||||
|
||||
Please refer to the [Pi-hole docker repo](https://github.com/pi-hole/docker-pi-hole) to use the Official Docker Images.
|
||||
|
||||
{!abbreviations.md!}
|
||||
|
||||
@@ -27,7 +27,7 @@ The following operating systems are **officially** supported:
|
||||
| Raspberry Pi OS <br>(formerly Raspbian) | Stretch / Buster | ARM |
|
||||
| Ubuntu | 16.x / 18.x / 20.x | ARM / x86_64 |
|
||||
| Debian | 9 / 10 | ARM / x86_64 / i386 |
|
||||
| Fedora | 31 / 32 | ARM / x86_64 |
|
||||
| Fedora | 32 / 33 | ARM / x86_64 |
|
||||
| CentOS | 7 / 8 | x86_64 |
|
||||
|
||||
<!-- markdownlint-disable code-block-style -->
|
||||
|
||||
@@ -2,8 +2,4 @@ Updating is as simple as running the following command:
|
||||
|
||||
`pihole -up`
|
||||
|
||||
### Common issues with updating:
|
||||
|
||||
`[Placeholder for solutions to issues]`
|
||||
|
||||
{!abbreviations.md!}
|
||||
|
||||
@@ -6,7 +6,7 @@ This guide is IPv4 only. You need to adjust for IPv6 accordingly.
|
||||
|
||||
### Enable advanced settings
|
||||
|
||||
Some of the the follwowing 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 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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -98,6 +98,7 @@ nav:
|
||||
- 'FTLDNS':
|
||||
- 'Overview': ftldns/index.md
|
||||
- 'Configuration': ftldns/configfile.md
|
||||
- 'Interfaces': ftldns/interfaces.md
|
||||
- 'DNS resolver': ftldns/dns-resolver.md
|
||||
- 'DNS cache': ftldns/dns-cache.md
|
||||
- 'Blocking mode': ftldns/blockingmode.md
|
||||
|
||||
Generated
+9
-9
@@ -1275,9 +1275,9 @@
|
||||
}
|
||||
},
|
||||
"normalize-url": {
|
||||
"version": "4.5.0",
|
||||
"resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-4.5.0.tgz",
|
||||
"integrity": "sha512-2s47yzUxdexf1OhyRi4Em83iQk0aPvwTddtFz4hnSSw9dCEsLEGf6SwIO8ss/19S9iBb5sJaOuTvTGDeZI00BQ==",
|
||||
"version": "4.5.1",
|
||||
"resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-4.5.1.tgz",
|
||||
"integrity": "sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA==",
|
||||
"dev": true
|
||||
},
|
||||
"nth-check": {
|
||||
@@ -1475,9 +1475,9 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"hosted-git-info": {
|
||||
"version": "2.8.8",
|
||||
"resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.8.tgz",
|
||||
"integrity": "sha512-f/wzC2QaWBs7t9IYqB4T3sR1xviIViXJRJTWBlx2Gf3g0Xi5vI7Yy4koXQ1c9OYDGHN9sBy1DQ2AB8fqZBWhUg==",
|
||||
"version": "2.8.9",
|
||||
"resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.9.tgz",
|
||||
"integrity": "sha512-mxIDAb9Lsm6DoOJ7xH+5+X4y1LU/4Hi50L9C5sIswK3JzULS4bwk1FvjdBgvYR4bzT4tuUQiC15FE2f5HbLvYw==",
|
||||
"dev": true
|
||||
},
|
||||
"normalize-package-data": {
|
||||
@@ -1752,9 +1752,9 @@
|
||||
}
|
||||
},
|
||||
"trim-newlines": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.0.tgz",
|
||||
"integrity": "sha512-C4+gOpvmxaSMKuEf9Qc134F1ZuOHVXKRbtEflf4NTtuuJDEIJ9p5PXsalL8SkeRw+qit1Mo+yuvMPAKwWg/1hA==",
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/trim-newlines/-/trim-newlines-3.0.1.tgz",
|
||||
"integrity": "sha512-c1PTsA3tYrIsLGkJkzHF+w9F2EyxfXGo4UyJc4pFL++FMjnq0HJS69T3M7d//gKrFKwy429bouPescbjecU+Zw==",
|
||||
"dev": true
|
||||
},
|
||||
"type-fest": {
|
||||
|
||||
+2
-2
@@ -1,5 +1,5 @@
|
||||
markdown-include==0.6.0
|
||||
mkdocs==1.1.2
|
||||
mkdocs-git-revision-date-localized-plugin==0.9
|
||||
mkdocs-material==7.1.3
|
||||
mkdocs-git-revision-date-localized-plugin==0.9.2
|
||||
mkdocs-material==7.1.6
|
||||
mkdocs-redirects==1.0.3
|
||||
|
||||
Reference in New Issue
Block a user