Pi-Hole/docs
1
0
Fork 0
mirror of https://github.com/pi-hole/docs.git synced 2025-12-19 18:58:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1327 from pi-hole/tweak/docsgen-companion

Browse Source 
Update configfile.md
This commit is contained in:
Adam Warner
2025-12-18 09:10:58 +00:00
committed by GitHub
parent 5b460f463f 3a7ca609ee
commit 3ba07e3758
1 changed files with 74 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

127
docs/ftldns/configfile.md
View File

@@ -53,16 +53,19 @@ Array of IP addresses and/or hostnames, optionally with a port (#...)
=== "TOML"
```toml
[dns]
upstreams = []
upstreams = [ "8.8.8.8", "127.0.0.1#5335", "docker-resolver" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config dns.upstreams []
sudo pihole-FTL --config dns.upstreams '[ "8.8.8.8", "127.0.0.1#5335", "docker-resolver" ]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dns_upstreams: []
FTLCONF_dns_upstreams: |-
8.8.8.8
127.0.0.1#5335
docker-resolver
```
### `CNAMEdeepInspect`
@@ -353,16 +356,18 @@ Array of custom DNS records each one in HOSTS form: `"IP HOSTNAME [HOSTNAME ...]
=== "TOML"
```toml
[dns]
hosts = []
hosts = [ "127.0.0.1 mylocal", "192.168.0.1 therouter" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config dns.hosts []
sudo pihole-FTL --config dns.hosts '[ "127.0.0.1 mylocal", "192.168.0.1 therouter" ]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dns_hosts: []
FTLCONF_dns_hosts: |-
127.0.0.1 mylocal
192.168.0.1 therouter
```
### `domainNeeded`
@@ -506,16 +511,16 @@ A string in the format
=== "TOML"
```toml
[dns]
hostRecord = ""
hostRecord = "laptop,laptop.lan,192.168.0.1,1234::100"
```
=== "CLI"
```shell
sudo pihole-FTL --config dns.hostRecord ""
sudo pihole-FTL --config dns.hostRecord "laptop,laptop.lan,192.168.0.1,1234::100"
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dns_hostRecord: ''
FTLCONF_dns_hostRecord: 'laptop,laptop.lan,192.168.0.1,1234::100'
```
### `listeningMode`
@@ -617,7 +622,7 @@ Array of CNAMEs, each one in the following form: `"<cname>,<target>[,<TTL>]"`
```
=== "CLI"
```shell
sudo pihole-FTL --config dns.cnameRecords []
sudo pihole-FTL --config dns.cnameRecords '[]'
```
=== "Environment (Docker Compose)"
```yaml
@@ -715,16 +720,17 @@ want here.
=== "TOML"
```toml
[dns]
revServers = []
revServers = [ "true,192.168.0.0/24,192.168.0.1,fritz.box" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config dns.revServers []
sudo pihole-FTL --config dns.revServers '[ "true,192.168.0.0/24,192.168.0.1,fritz.box" ]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dns_revServers: []
FTLCONF_dns_revServers: |-
true,192.168.0.0/24,192.168.0.1,fritz.box
```
@@ -1436,16 +1442,16 @@ A valid IPv4 address, or empty string (`""`)
=== "TOML"
```toml
[dhcp]
start = ""
start = "192.168.0.10"
```
=== "CLI"
```shell
sudo pihole-FTL --config dhcp.start ""
sudo pihole-FTL --config dhcp.start "192.168.0.10"
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dhcp_start: ''
FTLCONF_dhcp_start: '192.168.0.10'
```
### `end`
@@ -1462,16 +1468,16 @@ A valid IPv4 address, or empty string (`""`)
=== "TOML"
```toml
[dhcp]
end = ""
end = "192.168.0.250"
```
=== "CLI"
```shell
sudo pihole-FTL --config dhcp.end ""
sudo pihole-FTL --config dhcp.end "192.168.0.250"
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dhcp_end: ''
FTLCONF_dhcp_end: '192.168.0.250'
```
### `router`
@@ -1489,16 +1495,16 @@ A valid IPv4 address, or empty string (`""`)
=== "TOML"
```toml
[dhcp]
router = ""
router = "192.168.0.1"
```
=== "CLI"
```shell
sudo pihole-FTL --config dhcp.router ""
sudo pihole-FTL --config dhcp.router "192.168.0.1"
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dhcp_router: ''
FTLCONF_dhcp_router: '192.168.0.1'
```
### `netmask`
@@ -1522,16 +1528,16 @@ Any valid netmask, or an empty string (`""`) for auto-discovery
=== "TOML"
```toml
[dhcp]
netmask = ""
netmask = "255.255.255.0"
```
=== "CLI"
```shell
sudo pihole-FTL --config dhcp.netmask ""
sudo pihole-FTL --config dhcp.netmask "255.255.255.0"
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dhcp_netmask: ''
FTLCONF_dhcp_netmask: '255.255.255.0'
```
### `leaseTime`
@@ -1718,16 +1724,19 @@ Array of static leases each one in the following form:
=== "TOML"
```toml
[dhcp]
hosts = []
hosts = [ "00:20:e0:3b:13:af,192.168.0.123,laptop,24h",
"00:20:e0:ab:cd:ef,192.168.0.124,desktop,24h"]
```
=== "CLI"
```shell
sudo pihole-FTL --config dhcp.hosts []
sudo pihole-FTL --config dhcp.hosts '["00:20:e0:3b:13:af,192.168.0.123,laptop,24h","00:20:e0:ab:cd:ef,192.168.0.124,desktop,24h"]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_dhcp_hosts: []
FTLCONF_dhcp_hosts: |-
00:20:e0:3b:13:af,192.168.0.123,laptop,24h
00:20:e0:ab:cd:ef,192.168.0.124,desktop,24h
```
@@ -1974,16 +1983,16 @@ A valid RTC device path, or empty string (`""`) for auto-discovery
=== "TOML"
```toml
[ntp.sync.rtc]
device = ""
device = "/dev/rtc0"
```
=== "CLI"
```shell
sudo pihole-FTL --config ntp.sync.rtc.device ""
sudo pihole-FTL --config ntp.sync.rtc.device "/dev/rtc0"
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_ntp_sync_rtc_device: ''
FTLCONF_ntp_sync_rtc_device: '/dev/rtc0'
```
### `utc`
@@ -2525,15 +2534,13 @@ An array of HTTP headers
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_webserver_headers: |
[
'X-DNS-Prefetch-Control: off',
'Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:;',
'X-Frame-Options: DENY',
'X-XSS-Protection: 0',
'X-Content-Type-Options: nosniff',
'Referrer-Policy: strict-origin-when-cross-origin'
]
FTLCONF_webserver_headers: |-
X-DNS-Prefetch-Control: off
Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:;
X-Frame-Options: DENY
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
Referrer-Policy: strict-origin-when-cross-origin
```
### `serve_all`
@@ -2587,16 +2594,18 @@ An array of valid CivetWeb options
=== "TOML"
```toml
[webserver]
advancedOpts = []
advancedOpts = [ "ssl_protocol_version=4", "ssl_cipher_list=AES128:!MD5" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config webserver.advancedOpts []
sudo pihole-FTL --config webserver.advancedOpts '[ "ssl_protocol_version=4", "ssl_cipher_list=AES128:!MD5" ]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_webserver_advancedOpts: []
FTLCONF_webserver_advancedOpts: |-
ssl_protocol_version=4
ssl_cipher_list=AES128:!MD5
```
@@ -3109,16 +3118,19 @@ An array of regular expressions describing clients
=== "TOML"
```toml
[webserver.api]
excludeClients = []
excludeClients = [ "^192\\.168\\.2\\.56$", "^fe80::341:[0-9a-f]*$", "^localhost$" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config webserver.api.excludeClients []
sudo pihole-FTL --config webserver.api.excludeClients '[ "^192\\.168\\.2\\.56$", "^fe80::341:[0-9a-f]*$", "^localhost$" ]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_webserver_api_excludeClients: []
FTLCONF_webserver_api_excludeClients: |-
^192\\.168\\.2\\.56$
^fe80::341:[0-9a-f]*$
^localhost$
```
### `excludeDomains`
@@ -3139,16 +3151,18 @@ An array of regular expressions describing domains
=== "TOML"
```toml
[webserver.api]
excludeDomains = []
excludeDomains = [ "(^|\\.)\\.google\\.de$", "\\.pi-hole\\.net$" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config webserver.api.excludeDomains []
sudo pihole-FTL --config webserver.api.excludeDomains '[ "(^|\\.)\\.google\\.de$", "\\.pi-hole\\.net$" ]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_webserver_api_excludeDomains: []
FTLCONF_webserver_api_excludeDomains: |-
(^|\\.)\\.google\\.de$
\\.pi-hole\\.net$
```
### `maxHistory`
@@ -3715,6 +3729,9 @@ from working.
Use this option with extra care.
**Example:** `[ "address=/example.com/192.168.0.1", "address=/example.org/192.168.0.2",
"address=/example.net/192.168.0.3" ]`
**Allowed values are:**
Array of valid dnsmasq config line options
@@ -3723,16 +3740,20 @@ Array of valid dnsmasq config line options
=== "TOML"
```toml
[misc]
dnsmasq_lines = []
dnsmasq_lines = [ "address=/example.com/192.168.0.1", "address=/example.org/192.168.0.2",
"address=/example.net/192.168.0.3" ]
```
=== "CLI"
```shell
sudo pihole-FTL --config misc.dnsmasq_lines []
sudo pihole-FTL --config misc.dnsmasq_lines '["address=/example.com/192.168.0.1","address=/example.org/192.168.0.2","address=/example.net/192.168.0.3"]'
```
=== "Environment (Docker Compose)"
```yaml
environment:
FTLCONF_misc_dnsmasq_lines: []
FTLCONF_misc_dnsmasq_lines: |-
address=/example.com/192.168.0.1
address=/example.org/192.168.0.2
address=/example.net/192.168.0.3
```
### `extraLogging`
@@ -4066,7 +4087,7 @@ true or false
```
=== "CLI"
```shell
sudo pihole-FTL --config debug.flags alse
sudo pihole-FTL --config debug.flags false
```
=== "Environment (Docker Compose)"
```yaml