From 3ee7277d8f1bd7d7f459102c5825fece93c607f3 Mon Sep 17 00:00:00 2001 From: DL6ER Date: Wed, 16 Jan 2019 09:31:11 +0100 Subject: [PATCH 1/2] Restructure FTLDNS->Configuration page to list keys in sections Signed-off-by: DL6ER --- docs/ftldns/configfile.md | 92 ++++++++++++++++++++++----------------- 1 file changed, 51 insertions(+), 41 deletions(-) diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index d1b9f9e..8bca9c4 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -2,10 +2,33 @@ 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` +## DNS settings -Listen only for local socket connections or permit all connections +### BLOCKINGMODE +`BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN` + +How should `FTL` reply to blocked queries? + +**[More details](blockingmode.md)** + +## 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 +40,20 @@ Allow `FTL` to analyze AAAA queries from pihole.log? Should `FTL` only analyze A and AAAA queries? +## Socket settings + +### SOCKET_LISTENING +`SOCKET_LISTENING=localonly|all` + +Listen only for local socket connections or permit all connections + +### FTLPORT +`FTLPORT=4711` + +On which port should FTL be listening? + +## 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,50 +95,14 @@ 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 -``` -REGEX_DEBUGMODE=false|true -``` +`REGEX_DEBUGMODE=false|true` Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`. **[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!} From 280a8bc62d48a717f71e08d445aa4cd3400b840d Mon Sep 17 00:00:00 2001 From: DL6ER Date: Wed, 16 Jan 2019 10:27:26 +0100 Subject: [PATCH 2/2] Condense configuration subpage further. This makes it also more readable Signed-off-by: DL6ER --- docs/ftldns/configfile.md | 117 +++++++++++++------------------------- 1 file changed, 38 insertions(+), 79 deletions(-) diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md index 8bca9c4..932a010 100644 --- a/docs/ftldns/configfile.md +++ b/docs/ftldns/configfile.md @@ -1,108 +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 -## DNS settings - -### BLOCKINGMODE -`BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN` - -How should `FTL` reply to blocked queries? - +- `BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN`
+ How should `FTL` reply to blocked queries?
**[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`
+ 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`
+ Which privacy level is used?
**[More details](privacylevels.md)** -### IGNORE_LOCALHOST -`IGNORE_LOCALHOST=no|yes` +- `IGNORE_LOCALHOST=no|yes`
+ Should `FTL` ignore queries coming from the local machine? -Should `FTL` ignore queries coming from the local machine? +- `AAAA_QUERY_ANALYSIS=yes|no`
+ Allow `FTL` to analyze AAAA queries from pihole.log? -### AAAA_QUERY_ANALYSIS -`AAAA_QUERY_ANALYSIS=yes|no` +- `ANALYZE_ONLY_A_AND_AAAA=false|true`
+ 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`
+ Listen only for local socket connections or permit all connections -Should `FTL` only analyze A and AAAA queries? +- `FTLPORT=4711`
+ On which port should FTL be listening? -## Socket settings +### Host name resolution -### SOCKET_LISTENING -`SOCKET_LISTENING=localonly|all` +- `RESOLVE_IPV6=yes|no`
+ Should `FTL` try to resolve IPv6 addresses to host names? -Listen only for local socket connections or permit all connections +- `RESOLVE_IPV4=yes|no`
+ 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`
+ Should `FTL` load information from the database on startup to be aware of the most recent history? -## Host name resolution +- `MAXDBDAYS=365`
+ 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`
+ 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`
+ Specify path and filename of FTL's SQLite3 long-term database. Setting this to `DBFILE=` disables the database altogether
-### RESOLVE_IPV4 -`RESOLVE_IPV4=yes|no` -Should `FTL` try to resolve IPv4 addresses to host names? +### Debugging options -## 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` - -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)** - -## Debugging options - -### REGEX_DEBUGMODE -`REGEX_DEBUGMODE=false|true` - -Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`. - -**[More details](regex/overview.md)** +- `REGEX_DEBUGMODE=false|true`
+ Controls if *FTL*DNS should print extended details about regex matching into `pihole-FTL.log`.
+ **[More details](regex/overview.md)** {!abbreviations.md!}