From e18708941a5867bf655457b16f1c12875b33fcc8 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Wed, 16 Jan 2019 09:31:11 +0100 Subject: [PATCH] Restructure FTLDNS->Configuration page to list keys in sections Signed-off-by: DL6ER --- docs/ftldns/configfile.md | 88 ++++++++++++++++++++++----------------- 1 file changed, 50 insertions(+), 38 deletions(-) diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index d1b9f9e..28b1271 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -2,10 +2,31 @@ You can create a file `/etc/pihole/pihole-FTL.conf` that will be read by *FTL*DN Possible settings (**the option shown first is the default**): -### SOCKET_LISTENING -`SOCKET_LISTENING=localonly|all` +On which port should FTL be listening? -Listen only for local socket connections or permit all connections +## DNS settings + +### BLOCKINGMODE +`BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN` + +## 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? + +**[More details](privacylevels.md)** + +### IGNORE_LOCALHOST +`IGNORE_LOCALHOST=no|yes` + +Should `FTL` ignore queries coming from the local machine? ### AAAA_QUERY_ANALYSIS `AAAA_QUERY_ANALYSIS=yes|no` @@ -17,6 +38,22 @@ Allow `FTL` to analyze AAAA queries from pihole.log? Should `FTL` only analyze A and AAAA queries? +How should `FTL` reply to blocked queries? + +**[More details](blockingmode.md)** + +## Socket settings + +### SOCKET_LISTENING +`SOCKET_LISTENING=localonly|all` + +Listen only for local socket connections or permit all connections + +### FTLPORT +`FTLPORT=4711` + +## Host name resolution + ### RESOLVE_IPV6 `RESOLVE_IPV6=yes|no` @@ -27,6 +64,15 @@ Should `FTL` try to resolve IPv6 addresses to host names? Should `FTL` try to resolve IPv4 addresses to host names? +## Database settings + +### DBIMPORT +`DBIMPORT=yes|no` + +Should `FTL` load information from the database on startup to be aware of the most recent history? + +**[More details](database.md)** + ### MAXDBDAYS `MAXDBDAYS=365` @@ -49,34 +95,7 @@ Specify path and filename of FTL's SQLite3 long-term database. Setting this to ` **[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? - -**[More details](blockingmode.md)** +## Debugging options ### REGEX_DEBUGMODE ``` @@ -87,12 +106,5 @@ Controls if *FTL*DNS should print extended details about regex matching into `pi **[More details](regex/overview.md)** -### DBIMPORT -`DBIMPORT=yes|no` - -Should `FTL` load information from the database on startup to be aware of the most recent history? - -**[More details](database.md)** - {!abbreviations.md!}