summarylogtreecommitdiffstats
path: root/pi-hole-ftl.conf
diff options
context:
space:
mode:
Diffstat (limited to 'pi-hole-ftl.conf')
-rw-r--r--pi-hole-ftl.conf154
1 files changed, 77 insertions, 77 deletions
diff --git a/pi-hole-ftl.conf b/pi-hole-ftl.conf
index 368312449ef8..8ea3b38fd287 100644
--- a/pi-hole-ftl.conf
+++ b/pi-hole-ftl.conf
@@ -1,90 +1,90 @@
-### 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
+#; Pi-hole FTL config file
+#; Comments should start with #; to avoid issues with PHP and bash reading this file
+#; https://docs.pi-hole.net/ftldns/configfile/ for details
-## Out of documentation
-#LOGFILE=/run/log/pihole-ftl/pihole-FTL.log
-#PIDFILE=/run/pihole-ftl/pihole-FTL.pid
-#PORTFILE=/run/pihole-ftl/pihole-FTL.port
-#SOCKETFILE=/run/pihole-ftl/FTL.sock
+#; DNS settings
-## Socket Listening
-## Listen only for local socket connections or permit all connections
-## Options: localonly, all
-#SOCKET_LISTENING=localonly
+#; BLOCKINGMODE=NULL|IP-NODATA-AAAA|IP|NXDOMAIN
+#; CNAME_DEEP_INSPECT=true|false (PR #663)
+#; BLOCK_ESNI=true|false (PR #733)
+#; EDNS0_ECS=true|false (PR #851)
+#; RATE_LIMIT=1000/60 (PR #1052)
+#; LOCAL_IPV4= (unset by default, PR #1293)
+#; LOCAL_IPV6= (unset by default, PR #1293)
+#; BLOCK_IPV4= (unset by default, PR #1293)
+#; BLOCK_IPV6= (unset by default, PR #1293)
+#; REPLY_WHEN_BUSY=DROP|ALLOW|BLOCK|REFUSE (PR #1156 & PR #1341)
+#; MOZILLA_CANARY=true|false (PR #1148)
+#; BLOCK_TTL=2 (PR #1173)
+#; BLOCK_ICLOUD_PR=true|false (PR #1171)
-## Query Display
-## Display all queries? Set to no to hide query display
-## Options: yes, no
-#QUERY_DISPLAY=yes
+#; Statistics settings
-## AAA Query Analysis
-## Allow FTL to analyze AAAA queries from pihole.log?
-## Options: yes, no
-#AAAA_QUERY_ANALYSIS=yes
+#; MAXLOGAGE=24.0
+#; PRIVACYLEVEL=0|1|2|3
+#; IGNORE_LOCALHOST=no|yes
+#; AAAA_QUERY_ANALYSIS=yes|no
+#; ANALYZE_ONLY_A_AND_AAAA=false|true
+#; SHOW_DNSSEC=true|false
-## Resolve IPv6
-## Should FTL try to resolve IPv6 addresses to host names?
-## Options: yes, no
-#RESOLVE_IPV6=yes
+#; Other settings
-## Resolve IPv4
-## Should FTL try to resolve IPv4 addresses to host names?
-## Options: yes, no
-#RESOLVE_IPV4=yes
+#; SOCKET_LISTENING=localonly|all
+#; FTLPORT=4711
+#; RESOLVE_IPV6=yes|no
+#; RESOLVE_IPV4=yes|no
+#; PIHOLE_PTR=PI.HOLE|HOSTNAME|HOSTNAMEFQDN|NONE (PR #1111, #1164)
+#; DELAY_STARTUP=0 (PR #716, PR 1349)
+#; NICE=-10 (PR #798)
+#; MAXNETAGE=[MAXDBDAYS] (PR #871)
+#; NAMES_FROM_NETDB=true|false (PR #784)
+#; REFRESH_HOSTNAMES=IPV4|ALL|UNKNOWN|NONE (PR #953)
+#; PARSE_ARP_CACHE=true|false (PR #445)
+#; CHECK_SHMEM=90 (PR #1249)
+#; CHECK_DISK=90 (PR #1249)
-## 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
+#; Long-term database settings
-## 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
+#; DBIMPORT=yes|no
+#; MAXDBDAYS=365
+#; DBINTERVAL=1.0
+#; DBFILE=/etc/pihole/pihole-FTL.db
-## 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
+#; File options
-## 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
+#; LOGFILE=/var/log/pihole/FTL.log
+#; PIDFILE=/run/pihole-FTL.pid
+#; SOCKETFILE=/run/pihole/FTL.sock
+#; SETUPVARSFILE=/etc/pihole/setupVars.conf
+#; MACVENDORDB=/etc/pihole/macvendor.db
+#; GRAVITYDB=/etc/pihole/gravity.db
-## FTL Port
-## On which port should FTL be listening?
-## Options: tcp port
-#FTLPORT=4711
+#; Debugging options
-## Privacy Level
-## Which privacy level is used?
-## See: https://docs.pi-hole.net/ftldns/privacylevels/
-## Options: 0, 1, 2, 3
-#PRIVACYLEVEL=0
+#; DEBUG_ALL=false|true
+#; DEBUG_DATABASE=false|true
+#; DEBUG_NETWORKING=false|true
+#; DEBUG_EDNS0=false|true
+#; DEBUG_LOCKS=false|true
+#; DEBUG_QUERIES=false|true
+#; DEBUG_FLAGS=false|true
+#; DEBUG_SHMEM=false|true
+#; DEBUG_GC=false|true
+#; DEBUG_ARP=false|true
+#; DEBUG_REGEX=false|true
+#; DEBUG_API=false|true
+#; DEBUG_OVERTIME=false|true
+#; DEBUG_STATUS=false|true
+#; DEBUG_CAPS=false|true
+#; DEBUG_CAPS=true and thereafter sending killall -HUP pihole-FTL).
+#; DEBUG_DNSMASQ_LINES=false|true
+#; DEBUG_VECTORS=false|true (PR #725)
+#; DEBUG_RESOLVER=false|true (PR #728)
+#; DEBUG_EDNS0=false|true (PR #851)
+#; DEBUG_CLIENTS=false|true (PR #762)
+#; DEBUG_ALIASCLIENTS=false|true (PR #880)
+#; DEBUG_EVENTS=false|true (PR #881)
+#; DEBUG_HELPER=false|true (PR #914)
+#; ADDR2LINE=true|false (PR #774)
+#; DEBUG_EXTRA=false|true (PR #994)
-## 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-NODATA-AAAA, 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