From bb79cf8abf6367836851000b7d903476fcfbb064 Mon Sep 17 00:00:00 2001
From: DL6ER <dl6er@dl6er.de>
Date: Sat, 5 May 2018 22:47:50 +0200
Subject: [PATCH] Add configuration description

Signed-off-by: DL6ER <dl6er@dl6er.de>
---
 docs/ftldns/configfile.md | 86 +++++++++++++++++++++++++++++++++++++++
 mkdocs.yml                |  1 +
 2 files changed, 87 insertions(+)
 create mode 100644 docs/ftldns/configfile.md

diff --git a/docs/ftldns/configfile.md b/docs/ftldns/configfile.md
new file mode 100644
index 0000000..baa02da
--- /dev/null
+++ b/docs/ftldns/configfile.md
@@ -0,0 +1,86 @@
+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**):
+
+### SOCKET_LISTENING
+`SOCKET_LISTENING=localonly|all`
+
+Listen only for local socket connections or permit all connections
+
+### QUERY_DISPLAY
+`QUERY_DISPLAY=yes|no`
+
+Display all queries? Set to `no` to hide query display
+
+### AAAA_QUERY_ANALYSIS
+`AAAA_QUERY_ANALYSIS=yes|no`
+
+Allow `FTL` to analyze AAAA queries from pihole.log?
+
+### 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 SQLite 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`
+
+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=IP|NXDOMAIN`
+
+Should `FTL` reply queries to blocked domains with IPs or `NXDOMAIN`?
+
+**[More details](blockingmode.md)**
+
+### BLOCKINGREGEX
+`BLOCKINGREGEX=...`
+
+If defined, `FTL` will block all incoming queries which match this RegEx.
+
+**[More details](regex.md)**
diff --git a/mkdocs.yml b/mkdocs.yml
index dbabb98..a966e5c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -26,6 +26,7 @@ pages:
   - 'Updating': 'main/update.md'
 - 'FTLDNS':
   - 'Overview': "ftldns/index.md"
+  - 'Configuration': "ftldns/configfile.md"
   - 'Blocking mode': "ftldns/blockingmode.md"
   - 'RegEx blocking': "ftldns/regex.md"
 #  - 'Privacy levels': "ftldns/privacy.md"