mirror of
https://github.com/pi-hole/docs.git
synced 2024-12-06 19:27:12 +01:00
Merge branch 'master' into supported_OS
This commit is contained in:
yubiuser
GitHub
@@ -130,6 +130,8 @@ ID | Status | | Details
|
||||
12 | Allowed | ✅ | Retried query
|
||||
13 | Allowed | ✅ | Retried but ignored query (this may happen during ongoing DNSSEC validation)
|
||||
14 | Allowed | ✅ | Already forwarded, not forwarding again
|
||||
15 | Blocked | ❌ | Blocked (database is busy)<br> How these queries are handled can be [configured](../ftldns/configfile.md#reply_when_busy)
|
||||
16 | Blocked | ❌ | Blocked (special domain)<br>*E.g. Mozilla's canary domain and Apple's Private Relay domains* <br> Handling can be [configured](../ftldns/configfile.md)
|
||||
|
||||
### Supported reply types
|
||||
|
||||
|
||||
@@ -156,9 +156,9 @@ Controls whether and how FTL will reply with for address for which a local inter
|
||||
|
||||
Note about `HOSTNAMEFQDN`: If no local suffix has been defined, FTL appends the local domain `.no_fqdn_available`. In this case you should either add `domain=whatever.com` to a custom config file inside `/etc/dnsmasq.d/` (to set `whatever.com` as local domain) or use `domain=#` which will try to derive the local domain from `/etc/resolv.conf` (or whatever is set with `resolv-file`, when multiple `search` directives exist, the first one is used).
|
||||
|
||||
#### `DELAY_STARTUP=0` (PR [#716](https://github.com/pi-hole/FTL/pull/716)) {#delay_startup data-toc-label='Delay resolver startup'}
|
||||
#### `DELAY_STARTUP=0` (PR [#716](https://github.com/pi-hole/FTL/pull/716), PR [1349](https://github.com/pi-hole/FTL/pull/1349)) {#delay_startup data-toc-label='Delay resolver startup'}
|
||||
|
||||
In certain configurations, you may want FTL to wait a given amount of time before trying to start the DNS revolver. This is typically found when network interfaces appear only late during system startup and the interface startup priorities are configured incorrectly. This setting takes any integer value between 0 and 300 seconds.
|
||||
During startup, in some configurations, network interfaces appear only late during system startup and are not ready when FTL tries to bind to them. Therefore, you may want FTL to wait a given amount of time before trying to start the DNS revolver. This setting takes any integer value between 0 and 300 seconds. To prevent delayed startup while the system is already running and FTL is restarted, the delay only takes place within the first 60 seconds (hard-coded) after booting.
|
||||
|
||||
#### `NICE=-10` (PR [#798](https://github.com/pi-hole/FTL/pull/798)) {#nice data-toc-label='Set niceness'}
|
||||
|
||||
|
||||
+204
-134
@@ -1,180 +1,250 @@
|
||||
Connect via e.g. `telnet 127.0.0.1 4711` or use `echo ">command" | nc 127.0.0.1 4711`
|
||||
|
||||
- `>quit`: Closes the connection to the client
|
||||
#### `>quit` {data-toc-label='quit'}
|
||||
|
||||
- `>stats` : Get current statistics
|
||||
Closes the connection to the client
|
||||
|
||||
```text
|
||||
domains_being_blocked 116007
|
||||
dns_queries_today 30163
|
||||
ads_blocked_today 5650
|
||||
ads_percentage_today 18.731558
|
||||
unique_domains 1056
|
||||
queries_forwarded 4275
|
||||
queries_cached 20238
|
||||
clients_ever_seen 11
|
||||
unique_clients 9
|
||||
status enabled
|
||||
```
|
||||
---
|
||||
|
||||
- `>overTime` : over time data (10 min intervals)
|
||||
#### `>stats` {data-toc-label='stats'}
|
||||
|
||||
```text
|
||||
1525546500 163 0
|
||||
1525547100 154 1
|
||||
1525547700 164 0
|
||||
1525548300 167 0
|
||||
1525548900 151 0
|
||||
1525549500 143 0
|
||||
[...]
|
||||
```
|
||||
Get current statistics
|
||||
|
||||
- `>top-domains` : get top domains
|
||||
```text
|
||||
domains_being_blocked 116007
|
||||
dns_queries_today 30163
|
||||
ads_blocked_today 5650
|
||||
ads_percentage_today 18.731558
|
||||
unique_domains 1056
|
||||
queries_forwarded 4275
|
||||
queries_cached 20238
|
||||
clients_ever_seen 11
|
||||
unique_clients 9
|
||||
status enabled
|
||||
```
|
||||
|
||||
```text
|
||||
0 8462 x.y.z.de
|
||||
1 236 safebrowsing-cache.google.com
|
||||
2 116 pi.hole
|
||||
3 109 z.y.x.de
|
||||
4 93 safebrowsing.google.com
|
||||
5 96 plus.google.com
|
||||
[...]
|
||||
```
|
||||
---
|
||||
|
||||
Variant: `>top-domains (15)` to show (up to) 15 entries
|
||||
#### `>overTime` {data-toc-label='overTime'}
|
||||
|
||||
- `>top-ads` : get top ad domains
|
||||
Get over time data (10 min intervals)
|
||||
|
||||
```text
|
||||
0 8 googleads.g.doubleclick.net
|
||||
1 6 www.googleadservices.com
|
||||
2 1 cdn.mxpnl.com
|
||||
3 1 collector.githubapp.com
|
||||
4 1 www.googletagmanager.com
|
||||
5 1 s.zkcdn.net
|
||||
[...]
|
||||
```
|
||||
```text
|
||||
1525546500 163 0
|
||||
1525547100 154 1
|
||||
1525547700 164 0
|
||||
1525548300 167 0
|
||||
1525548900 151 0
|
||||
1525549500 143 0
|
||||
[...]
|
||||
```
|
||||
|
||||
Variant: `>top-ads (14)` to show (up to) 14 entries
|
||||
---
|
||||
|
||||
- `top-clients` : get recently active top clients (IP addresses + hostnames (if available))
|
||||
#### `>top-domains` {data-toc-label='top-domains'}
|
||||
|
||||
```text
|
||||
0 9373 192.168.2.1 router
|
||||
1 484 192.168.2.2 work-machine
|
||||
2 8 127.0.0.1 localhost
|
||||
```
|
||||
Get top domains
|
||||
|
||||
Variant: `>top-clients (9)` to show (up to) 9 client entries or `>top-clients withzero (15)` to show (up to) 15 clients even if they have not been active recently (see PR #124 for further details)
|
||||
```text
|
||||
0 8462 x.y.z.de
|
||||
1 236 safebrowsing-cache.google.com
|
||||
2 116 pi.hole
|
||||
3 109 z.y.x.de
|
||||
4 93 safebrowsing.google.com
|
||||
5 96 plus.google.com
|
||||
[...]
|
||||
```
|
||||
|
||||
- `>forward-dest` : get forward destinations (IP addresses + hostnames (if available)) along with the percentage. The first result (ID -2) will always be the percentage of domains answered from blocklists, whereas the second result (ID -1) will be the queries answered from the cache
|
||||
Variant: `>top-domains (15)` to show (up to) 15 entries
|
||||
|
||||
```text
|
||||
-2 18.70 blocklist blocklist
|
||||
-1 67.10 cache cache
|
||||
0 14.20 127.0.0.1 localhost
|
||||
```
|
||||
---
|
||||
|
||||
Variant: `>forward-dest unsorted` to show forward destinations in unsorted order (equivalent to using `>forward-names`)
|
||||
#### `>top-ads` {data-toc-label='top-ads'}
|
||||
|
||||
- `>querytypes` : get collected query types percentage
|
||||
Get top ad domains
|
||||
|
||||
```text
|
||||
A (IPv4): 53.45
|
||||
AAAA (IPv6): 45.32
|
||||
ANY: 0.00
|
||||
SRV: 0.64
|
||||
SOA: 0.05
|
||||
PTR: 0.54
|
||||
TXT: 0.00
|
||||
```
|
||||
```text
|
||||
0 8 googleads.g.doubleclick.net
|
||||
1 6 www.googleadservices.com
|
||||
2 1 cdn.mxpnl.com
|
||||
3 1 collector.githubapp.com
|
||||
4 1 www.googletagmanager.com
|
||||
5 1 s.zkcdn.net
|
||||
[...]
|
||||
```
|
||||
|
||||
- `>getallqueries` : get all queries that FTL has in memory
|
||||
Variant: `>top-ads (14)` to show (up to) 14 entries
|
||||
|
||||
```text
|
||||
1525554586 A fonts.googleapis.com 192.168.2.100 3 0 4 6
|
||||
1525554586 AAAA fonts.googleapis.com 192.168.2.100 3 0 4 5
|
||||
1525554586 A www.mkdocs.org 192.168.2.100 3 0 4 7
|
||||
1525554586 AAAA www.mkdocs.org 192.168.2.100 2 0 3 21
|
||||
1525554586 A squidfunk.github.io 192.168.2.100 2 0 3 20
|
||||
1525554586 A pi-hole.net 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA squidfunk.github.io 192.168.2.100 3 0 1 6
|
||||
1525554586 AAAA pi-hole.net 192.168.2.100 2 0 1 18
|
||||
1525554586 A github.com 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA github.com 192.168.2.100 2 0 1 18
|
||||
```
|
||||
---
|
||||
|
||||
Variants: `>getallqueries (37)` show (up to) 37 latest entries, `>getallqueries-time 1483964295 1483964312` gets all queries that FTL has in its database in a limited time interval, `>getallqueries-time 1483964295 1483964312 (17)` show matches in the (up to) 17 latest entries, `>getallqueries-domain www.google.com` gets all queries that FTL has in its database for a specific domain name, `>getallqueries-client 2.3.4.5` : gets all queries that FTL has in its database for a specific client name *or* IP
|
||||
#### `>top-clients` {data-toc-label='top-clients'}
|
||||
|
||||
- `>recentBlocked` : get most recently pi-holed domain name
|
||||
Get recently active top clients (IP addresses + hostnames (if available))
|
||||
|
||||
```text
|
||||
www.googleadservices.com
|
||||
```
|
||||
```text
|
||||
0 9373 192.168.2.1 router
|
||||
1 484 192.168.2.2 work-machine
|
||||
2 8 127.0.0.1 localhost
|
||||
```
|
||||
|
||||
Variant: `>recentBlocked (4)` show the four most recent blocked domains
|
||||
Variant: `>top-clients (9)` to show (up to) 9 client entries or `>top-clients withzero (15)` to show (up to) 15 clients even if they have not been active recently (see PR #124 for further details)
|
||||
|
||||
- `>clientID` : Get ID of currently connected client
|
||||
---
|
||||
|
||||
```text
|
||||
6
|
||||
```
|
||||
#### `>forward-dest` {data-toc-label='forward-dest'}
|
||||
|
||||
- `>version` : Get version information of the currently running FTL instance
|
||||
Get forward destinations (IP addresses + hostnames (if available)) along with the percentage. The first result (ID -2) will always be the percentage of domains answered from blocklists, whereas the second result (ID -1) will be the queries answered from the cache
|
||||
|
||||
```text
|
||||
version v1.6-3-g106498d-dirty
|
||||
tag v1.6
|
||||
branch master
|
||||
hash 106498d
|
||||
date 2017-03-26 13:10:43 +0200
|
||||
```
|
||||
```text
|
||||
-2 18.70 blocklist blocklist
|
||||
-1 67.10 cache cache
|
||||
0 14.20 127.0.0.1 localhost
|
||||
```
|
||||
|
||||
- `>dbstats` : Get some statistics about `FTL`'s' long-term storage database (this request may take some time for processing in case of a large database file)
|
||||
Variant: `>forward-dest unsorted` to show forward destinations in unsorted order (equivalent to using `>forward-names`)
|
||||
|
||||
```text
|
||||
queries in database: 2700304
|
||||
database filesize: 199.20 MB
|
||||
SQLite version: 3.23.1
|
||||
```
|
||||
---
|
||||
|
||||
- `>domain pi-hole.net`: Get detailed information about domain (if available)
|
||||
#### `>querytypes` {data-toc-label='querytypes'}
|
||||
|
||||
```text
|
||||
Domain "pi-hole.net", ID: 254
|
||||
Total: 179
|
||||
Blocked: 0
|
||||
Wildcard blocked: false
|
||||
```
|
||||
Get collected query types percentage
|
||||
|
||||
- `>cacheinfo`: Get DNS server cache size and usage information
|
||||
```text
|
||||
A (IPv4): 53.45
|
||||
AAAA (IPv6): 45.32
|
||||
ANY: 0.00
|
||||
SRV: 0.64
|
||||
SOA: 0.05
|
||||
PTR: 0.54
|
||||
TXT: 0.00
|
||||
```
|
||||
|
||||
```text
|
||||
cache-size: 500000
|
||||
cache-live-freed: 0
|
||||
cache-inserted: 15529
|
||||
```
|
||||
---
|
||||
|
||||
- `>dns-port`: Get DNS port FTL is listening on
|
||||
#### `>getallqueries` {data-toc-label='getallqueries'}
|
||||
|
||||
```text
|
||||
53
|
||||
```
|
||||
Get all queries that FTL has in memory
|
||||
|
||||
- `>maxlogage`: Get timespan of the statistics shown on the dashboard (in seconds)
|
||||
```text
|
||||
1525554586 A fonts.googleapis.com 192.168.2.100 3 0 4 6
|
||||
1525554586 AAAA fonts.googleapis.com 192.168.2.100 3 0 4 5
|
||||
1525554586 A www.mkdocs.org 192.168.2.100 3 0 4 7
|
||||
1525554586 AAAA www.mkdocs.org 192.168.2.100 2 0 3 21
|
||||
1525554586 A squidfunk.github.io 192.168.2.100 2 0 3 20
|
||||
1525554586 A pi-hole.net 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA squidfunk.github.io 192.168.2.100 3 0 1 6
|
||||
1525554586 AAAA pi-hole.net 192.168.2.100 2 0 1 18
|
||||
1525554586 A github.com 192.168.2.100 3 0 4 5
|
||||
1525554586 AAAA github.com 192.168.2.100 2 0 1 18
|
||||
```
|
||||
|
||||
```text
|
||||
86400
|
||||
```
|
||||
Variants: `>getallqueries (37)` show (up to) 37 latest entries, `>getallqueries-time 1483964295 1483964312` gets all queries that FTL has in its database in a limited time interval, `>getallqueries-time 1483964295 1483964312 (17)` show matches in the (up to) 17 latest entries, `>getallqueries-domain www.google.com` gets all queries that FTL has in its database for a specific domain name, `>getallqueries-client 2.3.4.5` : gets all queries that FTL has in its database for a specific client name *or* IP
|
||||
|
||||
Note that the port can also be `0` if someone decides to disable the DNS server part of Pi-hole
|
||||
---
|
||||
|
||||
- `>gateway`: Get the IP of the gateway of the default route and the corresponding interface
|
||||
#### `>recentBlocked` {data-toc-label='recentBlocked'}
|
||||
|
||||
```text
|
||||
192.168.0.1 enp2s0
|
||||
```
|
||||
Get most recently pi-holed domain name
|
||||
|
||||
Note that if no non-default route could be found, `0.0.0.0` and an empty interface string is returned
|
||||
```text
|
||||
www.googleadservices.com
|
||||
```
|
||||
|
||||
Variant: `>recentBlocked (4)` show the four most recent blocked domains
|
||||
|
||||
---
|
||||
|
||||
#### `>clientID` {data-toc-label='clientID'}
|
||||
|
||||
Get ID of currently connected client
|
||||
|
||||
```text
|
||||
6
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### `>version` {data-toc-label='version'}
|
||||
|
||||
Get version information of the currently running FTL instance
|
||||
|
||||
```text
|
||||
version v1.6-3-g106498d-dirty
|
||||
tag v1.6
|
||||
branch master
|
||||
hash 106498d
|
||||
date 2017-03-26 13:10:43 +0200
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### `>dbstats` {data-toc-label='dbstats'}
|
||||
|
||||
Get some statistics about `FTL`'s' long-term storage database (this request may take some time for processing in case of a large database file)
|
||||
|
||||
```text
|
||||
queries in database: 2700304
|
||||
database filesize: 199.20 MB
|
||||
SQLite version: 3.23.1
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### `>domain pi-hole.net` {data-toc-label='domain'}
|
||||
|
||||
Get detailed information about domain (if available)
|
||||
|
||||
```text
|
||||
Domain "pi-hole.net", ID: 254
|
||||
Total: 179
|
||||
Blocked: 0
|
||||
Wildcard blocked: false
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### `>cacheinfo` {data-toc-label='cacheinfo'}
|
||||
|
||||
Get DNS server cache size and usage information
|
||||
|
||||
```text
|
||||
cache-size: 500000
|
||||
cache-live-freed: 0
|
||||
cache-inserted: 15529
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### `>dns-port` {data-toc-label='dns-port'}
|
||||
|
||||
Get DNS port FTL is listening on
|
||||
|
||||
```text
|
||||
53
|
||||
```
|
||||
|
||||
Note that the port can also be `0` if someone decides to disable the DNS server part of Pi-hole
|
||||
|
||||
---
|
||||
|
||||
#### `>maxlogage` {data-toc-label='maxlogage'}
|
||||
|
||||
Get timespan of the statistics shown on the dashboard (in seconds)
|
||||
|
||||
```text
|
||||
86400
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
#### `>gateway` {data-toc-label='gateway'}
|
||||
|
||||
Get the IP of the gateway of the default route and the corresponding interface
|
||||
|
||||
```text
|
||||
192.168.0.1 enp2s0
|
||||
```
|
||||
|
||||
Note that if no non-default route could be found, `0.0.0.0` and an empty interface string is returned
|
||||
|
||||
{!abbreviations.md!}
|
||||
|
||||
+1
-1
@@ -61,7 +61,7 @@ If requesting a lot of data from the long-term database you get this error
|
||||
```code
|
||||
An unknown error occurred while loading the data.
|
||||
|
||||
Check the server's log files (/var/log/lighttpd/error.log) for details.
|
||||
Check the server's log files (/var/log/lighttpd/error-pihole.log) for details.
|
||||
|
||||
You may need to increase PHP memory limit.
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ Blocks domains containing only numbers (no letters) and ending in `.com` or `.ed
|
||||
### Block domains without subdomains
|
||||
|
||||
```
|
||||
^[a-z0-9]+([\-]{1}[a-z0-9]+)*\.[a-z]{2,7}$
|
||||
^[a-z0-9]+([-]{1}[a-z0-9]+)*\.[a-z]{2,7}$
|
||||
```
|
||||
|
||||
A domain name shall not start or end with a dash but can contain any number of them. It must be followed by a TLD (we assume a valid TLD length of two to seven characters)
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
markdown-include==0.6.0
|
||||
mkdocs==1.3.0
|
||||
mkdocs-git-revision-date-localized-plugin==1.0.1
|
||||
mkdocs-material==8.3.4
|
||||
mkdocs-material==8.3.8
|
||||
mkdocs-redirects==1.0.4
|
||||
|
||||
Reference in New Issue
Block a user