Merge pull request #79 from pi-hole/tweak/config_page_settings

Restructure FTLDNS->Configuration page to list keys in sections
This commit is contained in:
Dan Schaper
2019-01-16 04:47:18 -08:00
committed by GitHub
+53 -84
View File
@@ -1,98 +1,67 @@
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
### SOCKET_LISTENING
`SOCKET_LISTENING=localonly|all`
Listen only for local socket connections or permit all connections
### AAAA_QUERY_ANALYSIS
`AAAA_QUERY_ANALYSIS=yes|no`
Allow `FTL` to analyze AAAA queries from pihole.log?
### ANALYZE_ONLY_A_AND_AAAA
`ANALYZE_ONLY_A_AND_AAAA=false|true`
Should `FTL` only analyze A and AAAA queries?
### RESOLVE_IPV6
`RESOLVE_IPV6=yes|no`
Should `FTL` try to resolve IPv6 addresses to host names?
### RESOLVE_IPV4
`RESOLVE_IPV4=yes|no`
Should `FTL` try to resolve IPv4 addresses to host names?
### MAXDBDAYS
`MAXDBDAYS=365`
How long should queries be stored in the database?
Setting this to `0` disables the database
**[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)**
### MAXLOGAGE
`MAXLOGAGE=24.0`
Up to how many hours of queries should be imported from the database and logs? Maximum is 744 (31 days)
### FTLPORT
`FTLPORT=4711`
On which port should FTL be listening?
### PRIVACYLEVEL
`PRIVACYLEVEL=0|1|2|3|4`
Which privacy level is used?
**[More details](privacylevels.md)**
### IGNORE_LOCALHOST
`IGNORE_LOCALHOST=no|yes`
Should `FTL` ignore queries coming from the local machine?
### 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)**
### REGEX_DEBUGMODE
```
REGEX_DEBUGMODE=false|true
```
### Statistics settings
Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.
- `MAXLOGAGE=24.0`<br>
Up to how many hours of queries should be imported from the database and logs? Maximum is 744 (31 days)
**[More details](regex/overview.md)**
- `PRIVACYLEVEL=0|1|2|3|4`<br>
Which privacy level is used?<br>
**[More details](privacylevels.md)**
### DBIMPORT
`DBIMPORT=yes|no`
- `IGNORE_LOCALHOST=no|yes`<br>
Should `FTL` ignore queries coming from the local machine?
Should `FTL` load information from the database on startup to be aware of the most recent history?
- `AAAA_QUERY_ANALYSIS=yes|no`<br>
Allow `FTL` to analyze AAAA queries from pihole.log?
**[More details](database.md)**
- `ANALYZE_ONLY_A_AND_AAAA=false|true`<br>
Should `FTL` only analyze A and AAAA queries?
### Socket settings
- `SOCKET_LISTENING=localonly|all`<br>
Listen only for local socket connections or permit all connections
- `FTLPORT=4711`<br>
On which port should FTL be listening?
### Host name resolution
- `RESOLVE_IPV6=yes|no`<br>
Should `FTL` try to resolve IPv6 addresses to host names?
- `RESOLVE_IPV4=yes|no`<br>
Should `FTL` try to resolve IPv4 addresses to host names?
### Database settings
**[Further details concerning the database](database.md)**
- `DBIMPORT=yes|no`<br>
Should `FTL` load information from the database on startup to be aware of the most recent history?
- `MAXDBDAYS=365`<br>
How long should queries be stored in the database? Setting this to `0` disables the database
- `DBINTERVAL=1.0`<br>
How often do we store queries in FTL's database [minutes]?
- `DBFILE=/etc/pihole/pihole-FTL.db`<br>
Specify path and filename of FTL's SQLite3 long-term database. Setting this to `DBFILE=` disables the database altogether<br>
### Debugging options
- `REGEX_DEBUGMODE=false|true`<br>
Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.<br>
**[More details](regex/overview.md)**
{!abbreviations.md!}