pi-hole/docs
1
0
Fork 0
mirror of https://github.com/pi-hole/docs.git synced 2024-12-06 19:27:12 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Condense configuration subpage further. This makes it also more readable

Browse Source 
Signed-off-by: DL6ER <dl6er@dl6er.de>
This commit is contained in:
DL6ER
2019-01-16 10:27:26 +01:00
parent d597a687e9
commit 02f4a885fe
1 changed files with 57 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ftldns/configfile.md
+57 -118
View File
@@ -1,152 +1,91 @@
You can create a file `/etc/pihole/pihole-FTL.conf` that will be read by *FTL*DNS on startup.
Possible settings (**the option shown first is the default**):
### DNS settings
## DNS settings
### BLOCKINGMODE
`BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN`
How should `FTL` reply to blocked queries?
- `BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN`<br>
How should `FTL` reply to blocked queries?<br>
**[More details](blockingmode.md)**
## Statistics settings
### Statistics settings
### MAXLOGAGE
`MAXLOGAGE=24.0`
Up to how many hours of queries should be imported from the database and logs? Maximum is 744 (31 days)
### PRIVACYLEVEL
`PRIVACYLEVEL=0|1|2|3|4`
Which privacy level is used?
- `MAXLOGAGE=24.0`<br>
Up to how many hours of queries should be imported from the database and logs? Maximum is 744 (31 days)
- `PRIVACYLEVEL=0|1|2|3|4`<br>
Which privacy level is used?<br>
**[More details](privacylevels.md)**
### IGNORE_LOCALHOST
`IGNORE_LOCALHOST=no|yes`
- `IGNORE_LOCALHOST=no|yes`<br>
Should `FTL` ignore queries coming from the local machine?
Should `FTL` ignore queries coming from the local machine?
- `AAAA_QUERY_ANALYSIS=yes|no`<br>
Allow `FTL` to analyze AAAA queries from pihole.log?
### AAAA_QUERY_ANALYSIS
`AAAA_QUERY_ANALYSIS=yes|no`
- `ANALYZE_ONLY_A_AND_AAAA=false|true`<br>
Should `FTL` only analyze A and AAAA queries?
Allow `FTL` to analyze AAAA queries from pihole.log?
### Socket settings
### ANALYZE_ONLY_A_AND_AAAA
`ANALYZE_ONLY_A_AND_AAAA=false|true`
- `SOCKET_LISTENING=localonly|all`<br>
Listen only for local socket connections or permit all connections
Should `FTL` only analyze A and AAAA queries?
- `FTLPORT=4711`<br>
On which port should FTL be listening?
## Socket settings
### Host name resolution
### SOCKET_LISTENING
`SOCKET_LISTENING=localonly|all`
- `RESOLVE_IPV6=yes|no`<br>
Should `FTL` try to resolve IPv6 addresses to host names?
Listen only for local socket connections or permit all connections
- `RESOLVE_IPV4=yes|no`<br>
Should `FTL` try to resolve IPv4 addresses to host names?
### FTLPORT
`FTLPORT=4711`
### Database settings
**[Further details concerning the database](database.md)**
On which port should FTL be listening?
- `DBIMPORT=yes|no`<br>
Should `FTL` load information from the database on startup to be aware of the most recent history?
## Host name resolution
- `MAXDBDAYS=365`<br>
How long should queries be stored in the database? Setting this to `0` disables the database
### RESOLVE_IPV6
`RESOLVE_IPV6=yes|no`
- `DBINTERVAL=1.0`<br>
How often do we store queries in FTL's database [minutes]?
Should `FTL` try to resolve IPv6 addresses to host names?
- `DBFILE=/etc/pihole/pihole-FTL.db`<br>
Specify path and filename of FTL's SQLite3 long-term database. Setting `DBFILE=` disables the database altogether
### RESOLVE_IPV4
`RESOLVE_IPV4=yes|no`
### Debugging options
- `DEBUG_DATABASE=false|true`<br>
Print debugging information about database actions. This prints performed SQL statements as well as some general information such as the time it took to store the queries and how many have been saved to the database.
Should `FTL` try to resolve IPv4 addresses to host names?
- `DEBUG_NETWORKING=false|true`<br>
Prints a list of the detected interfaces on startup of `pihole-FTL`. Also prints whether these interfaces are IPv4 or IPv6 interfaces.
## Database settings
- `DEBUG_LOCKS=false|true`<br>
Print information about shared memory locks. Messages will be generated when waiting, obtaining, and releasing a lock.
### DBIMPORT
`DBIMPORT=yes|no`
- `DEBUG_QUERIES=false|true`<br>
Print extensive query information (domains, types, replies, etc.). This has always been part of the legacy `debug` mode of `pihole-FTL`.
Should `FTL` load information from the database on startup to be aware of the most recent history?
- `DEBUG_FLAGS=false|true`<br>
Print flags of queries received by the DNS hooks. Only effective when `DEBUG_QUERIES` is enabled as well.
**[More details](database.md)**
- `DEBUG_SHMEM=false|true`<br>
Print information about shared memory buffers. Messages are either about creating or enlarging shmem objects or string injections.
### MAXDBDAYS
`MAXDBDAYS=365`
- `DEBUG_GC=false|true`<br>
Print information about garbage collection (GC): What is to be removed, how many have been removed and how long did GC take.
How long should queries be stored in the database?
Setting this to `0` disables the database
- `DEBUG_ARP=false|true`<br>
Print information about ARP table processing: How long did parsing take, whether read MAC addresses are valid, and if the `macvendor.db` file exists.
**[More details](database.md)**
### DBINTERVAL
`DBINTERVAL=1.0`
How often do we store queries in FTL's database [minutes]?
**[More details](database.md)**
### DBFILE
`DBFILE=/etc/pihole/pihole-FTL.db`
Specify path and filename of FTL's SQLite3 long-term database. Setting this to `DBFILE=` disables the database altogether
**[More details](database.md)**
## Debugging options
### DEBUG_DATABASE
`DEBUG_DATABASE=false|true`
Print debugging information about database actions. This prints performed SQL statements as well as some general information such as the time it took to store the queries and how many have been saved to the database.
### DEBUG_NETWORKING
`DEBUG_NETWORKING=false|true`
Prints a list of the detected interfaces on startup of `pihole-FTL`. Also prints whether these interfaces are IPv4 or IPv6 interfaces.
### DEBUG_LOCKS
`DEBUG_LOCKS=false|true`
Print information about shared memory locks. Messages will be generated when waiting, obtaining, and releasing a lock.
### DEBUG_QUERIES
`DEBUG_QUERIES=false|true`
Print extensive query information (domains, types, replies, etc.). This has always been part of the legacy `debug` mode of `pihole-FTL`.
### DEBUG_FLAGS
`DEBUG_FLAGS=false|true`
Print flags of queries received by the DNS hooks. Only effective when `DEBUG_QUERIES` is enabled as well.
### DEBUG_SHMEM
`DEBUG_SHMEM=false|true`
Print information about shared memory buffers. Messages are either about creating or enlarging shmem objects or string injections.
### DEBUG_GC
`DEBUG_GC=false|true`
Print information about garbage collection (GC): What is to be removed, how many have been removed and how long did GC take.
### DEBUG_ARP
`DEBUG_ARP=false|true`
Print information about ARP table processing: How long did parsing take, whether read MAC addresses are valid, and if the `macvendor.db` file exists.
### DEBUG_REGEX
`DEBUG_REGEX=false|true`
Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.
**[More details](regex/overview.md)**
Due to legacy reasons, we also support the following setting to be used for enabling the same functionality:
`REGEX_DEBUGMODE=false|true`
Note that if one of them is set to `true`, the other one cannot be used to disable this setting again.
- `DEBUG_REGEX=false|true`<br>
Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.<br>
**[More details](regex/overview.md)**<br>
Due to legacy reasons, we also support the following setting to be used for enabling the same functionality:<br>
`REGEX_DEBUGMODE=false|true`<br>
Note that if one of them is set to `true`, the other one cannot be used to disable this setting again.
{!abbreviations.md!}