updated ftl config file

1 files changed, 84 insertions, 9 deletions

diff --git a/pi-hole-ftl.conf b/pi-hole-ftl.conf
index 8ca077a67305..03f429324cc0 100644
--- a/pi-hole-ftl.conf
+++ b/pi-hole-ftl.conf
@@ -1,9 +1,84 @@
-SOCKET_LISTENING=localonly
-TIMEFRAME=rolling24h
-QUERY_DISPLAY=yes
-AAAA_QUERY_ANALYSIS=yes
-MAXDBDAYS=365
-RESOLVE_IPV6=yes
-RESOLVE_IPV4=yes
-DBINTERVAL=1.0
-DBFILE=/etc/pihole/pihole-FTL.db
\ No newline at end of file
+### This file contains parameters for FTL behavior.
+### At install, all parameters are commented out. The user can select desired options.
+### Options shown are the default configuration. No modification is needed for most
+### installations.
+### Visit https://docs.pi-hole.net/ftldns/configfile/ for more detailed parameter explanations
+
+## Socket Listening
+## Listen only for local socket connections or permit all connections
+## Options: localonly, all
+#SOCKET_LISTENING=localonly
+
+## Query Display
+## Display all queries? Set to no to hide query display
+## Options: yes, no
+#QUERY_DISPLAY=yes
+
+## AAA Query Analysis
+## Allow FTL to analyze AAAA queries from pihole.log?
+## Options: yes, no
+#AAAA_QUERY_ANALYSIS=yes
+
+## Resolve IPv6
+## Should FTL try to resolve IPv6 addresses to host names?
+## Options: yes, no
+#RESOLVE_IPV6=yes
+
+## Resolve IPv4
+## Should FTL try to resolve IPv4 addresses to host names?
+## Options: yes, no
+#RESOLVE_IPV4=yes
+
+## Max Database Days
+## How long should queries be stored in the database (days)?
+## Setting this to 0 disables the database
+## See: https://docs.pi-hole.net/ftldns/database/
+## Options: number of days
+#MAXDBDAYS=365
+
+## Database Interval
+## How often do we store queries in FTL's database (minutes)?
+## See: https://docs.pi-hole.net/ftldns/database/
+## Options: number of minutes
+#DBINTERVAL=1.0
+
+## Database File
+## Specify path and filename of FTL's SQLite3 long-term database.
+## Setting this to DBFILE= disables the database altogether
+## See: https://docs.pi-hole.net/ftldns/database/
+## Option: path to db file
+#DBFILE=/etc/pihole/pihole-FTL.db
+
+## Max Log Age
+## Up to how many hours of queries should be imported from the database and logs (hours)?
+## Maximum is 744 (31 days)
+## Options: number of days
+#MAXLOGAGE=24.0
+
+## FTL Port
+## On which port should FTL be listening?
+## Options: tcp port
+#FTLPORT=4711
+
+## Privacy Level
+## Which privacy level is used?
+## See: https://docs.pi-hole.net/ftldns/privacylevels/
+## Options: 0, 1, 2, 3
+#PRIVACYLEVEL=0
+
+## Ignore Localhost
+## Should FTL ignore queries coming from the local machine?
+## Options: yes, no
+#IGNORE_LOCALHOST=no
+
+## Blocking Mode
+## How should FTL reply to blocked queries?
+## See: https://docs.pi-hole.net/ftldns/blockingmode/
+## Options: NULL, IP-AAAA-NODATA, IP, NXDOMAIN
+#BLOCKINGMODE=NULL
+
+## Regex Debug Mode
+## Controls if FTLDNS should print extended details about regex matching into pihole-FTL.log.
+## See: https://docs.pi-hole.net/ftldns/regex/overview/
+## Options: true, false
+#REGEX_DEBUGMODE=false