@@ -53,16 +53,19 @@ Array of IP addresses and/or hostnames, optionally with a port (#...)
5353=== "TOML"
5454 ```toml
5555 [ dns]
56- upstreams = [ ]
56+ upstreams = [ "8.8.8.8", "127.0.0.1#5335", "docker-resolver" ]
5757 ```
5858=== "CLI"
5959 ```shell
60- sudo pihole-FTL --config dns.upstreams [ ]
60+ sudo pihole-FTL --config dns.upstreams " [ \" 8.8.8.8 \" , \" 127.0.0.1#5335 \" , \" docker-resolver \" ] "
6161 ```
6262=== "Environment (Docker Compose)"
6363 ```yaml
6464 environment:
65- FTLCONF_dns_upstreams: [ ]
65+ FTLCONF_dns_upstreams: |-
66+ 8.8.8.8
67+ 127.0.0.1#5335
68+ docker-resolver
6669 ```
6770
6871### ` CNAMEdeepInspect `
@@ -353,16 +356,18 @@ Array of custom DNS records each one in HOSTS form: `"IP HOSTNAME [HOSTNAME ...]
353356=== "TOML"
354357 ```toml
355358 [ dns]
356- hosts = [ ]
359+ hosts = [ "127.0.0.1 mylocal", "192.168.0.1 therouter" ]
357360 ```
358361=== "CLI"
359362 ```shell
360- sudo pihole-FTL --config dns.hosts [ ]
363+ sudo pihole-FTL --config dns.hosts " [ \" 127.0.0.1 mylocal \" , \" 192.168.0.1 therouter \" ] "
361364 ```
362365=== "Environment (Docker Compose)"
363366 ```yaml
364367 environment:
365- FTLCONF_dns_hosts: [ ]
368+ FTLCONF_dns_hosts: |-
369+ 127.0.0.1 mylocal
370+ 192.168.0.1 therouter
366371 ```
367372
368373### ` domainNeeded `
@@ -506,16 +511,16 @@ A string in the format
506511=== "TOML"
507512 ```toml
508513 [ dns]
509- hostRecord = ""
514+ hostRecord = "laptop,laptop.lan,192.168.0.1,1234::100 "
510515 ```
511516=== "CLI"
512517 ```shell
513- sudo pihole-FTL --config dns.hostRecord ""
518+ sudo pihole-FTL --config dns.hostRecord "laptop,laptop.lan,192.168.0.1,1234::100 "
514519 ```
515520=== "Environment (Docker Compose)"
516521 ```yaml
517522 environment:
518- FTLCONF_dns_hostRecord: ''
523+ FTLCONF_dns_hostRecord: 'laptop,laptop.lan,192.168.0.1,1234::100 '
519524 ```
520525
521526### ` listeningMode `
@@ -617,7 +622,7 @@ Array of CNAMEs, each one in the following form: `"<cname>,<target>[,<TTL>]"`
617622 ```
618623=== "CLI"
619624 ```shell
620- sudo pihole-FTL --config dns.cnameRecords [ ]
625+ sudo pihole-FTL --config dns.cnameRecords " [ ] "
621626 ```
622627=== "Environment (Docker Compose)"
623628 ```yaml
@@ -715,16 +720,17 @@ want here.
715720=== "TOML"
716721 ```toml
717722 [ dns]
718- revServers = [ ]
723+ revServers = [ "true,192.168.0.0/24,192.168.0.1,fritz.box" ]
719724 ```
720725=== "CLI"
721726 ```shell
722- sudo pihole-FTL --config dns.revServers [ ]
727+ sudo pihole-FTL --config dns.revServers " [ \" true,192.168.0.0/24,192.168.0.1,fritz.box \" ] "
723728 ```
724729=== "Environment (Docker Compose)"
725730 ```yaml
726731 environment:
727- FTLCONF_dns_revServers: [ ]
732+ FTLCONF_dns_revServers: |-
733+ true,192.168.0.0/24,192.168.0.1,fritz.box
728734 ```
729735
730736
@@ -1436,16 +1442,16 @@ A valid IPv4 address, or empty string (`""`)
14361442=== "TOML"
14371443 ```toml
14381444 [ dhcp]
1439- start = ""
1445+ start = "192.168.0.10 "
14401446 ```
14411447=== "CLI"
14421448 ```shell
1443- sudo pihole-FTL --config dhcp.start ""
1449+ sudo pihole-FTL --config dhcp.start "192.168.0.10 "
14441450 ```
14451451=== "Environment (Docker Compose)"
14461452 ```yaml
14471453 environment:
1448- FTLCONF_dhcp_start: ''
1454+ FTLCONF_dhcp_start: '192.168.0.10 '
14491455 ```
14501456
14511457### ` end `
@@ -1462,16 +1468,16 @@ A valid IPv4 address, or empty string (`""`)
14621468=== "TOML"
14631469 ```toml
14641470 [ dhcp]
1465- end = ""
1471+ end = "192.168.0.250 "
14661472 ```
14671473=== "CLI"
14681474 ```shell
1469- sudo pihole-FTL --config dhcp.end ""
1475+ sudo pihole-FTL --config dhcp.end "192.168.0.250 "
14701476 ```
14711477=== "Environment (Docker Compose)"
14721478 ```yaml
14731479 environment:
1474- FTLCONF_dhcp_end: ''
1480+ FTLCONF_dhcp_end: '192.168.0.250 '
14751481 ```
14761482
14771483### ` router `
@@ -1489,16 +1495,16 @@ A valid IPv4 address, or empty string (`""`)
14891495=== "TOML"
14901496 ```toml
14911497 [ dhcp]
1492- router = ""
1498+ router = "192.168.0.1 "
14931499 ```
14941500=== "CLI"
14951501 ```shell
1496- sudo pihole-FTL --config dhcp.router ""
1502+ sudo pihole-FTL --config dhcp.router "192.168.0.1 "
14971503 ```
14981504=== "Environment (Docker Compose)"
14991505 ```yaml
15001506 environment:
1501- FTLCONF_dhcp_router: ''
1507+ FTLCONF_dhcp_router: '192.168.0.1 '
15021508 ```
15031509
15041510### ` netmask `
@@ -1522,16 +1528,16 @@ Any valid netmask, or an empty string (`""`) for auto-discovery
15221528=== "TOML"
15231529 ```toml
15241530 [ dhcp]
1525- netmask = ""
1531+ netmask = "255.255.255.0 "
15261532 ```
15271533=== "CLI"
15281534 ```shell
1529- sudo pihole-FTL --config dhcp.netmask ""
1535+ sudo pihole-FTL --config dhcp.netmask "255.255.255.0 "
15301536 ```
15311537=== "Environment (Docker Compose)"
15321538 ```yaml
15331539 environment:
1534- FTLCONF_dhcp_netmask: ''
1540+ FTLCONF_dhcp_netmask: '255.255.255.0 '
15351541 ```
15361542
15371543### ` leaseTime `
@@ -1718,16 +1724,19 @@ Array of static leases each one in the following form:
17181724=== "TOML"
17191725 ```toml
17201726 [ dhcp]
1721- hosts = [ ]
1727+ hosts = [ "00:20:e0:3b:13: af ,192.168.0.123,laptop,24h",
1728+ "00:20:e0:ab : cd: ef ,192.168.0.124,desktop,24h"]
17221729 ```
17231730=== "CLI"
17241731 ```shell
1725- sudo pihole-FTL --config dhcp.hosts [ ]
1732+ 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 \" ] "
17261733 ```
17271734=== "Environment (Docker Compose)"
17281735 ```yaml
17291736 environment:
1730- FTLCONF_dhcp_hosts: [ ]
1737+ FTLCONF_dhcp_hosts: |-
1738+ 00:20:e0:3b:13: af ,192.168.0.123,laptop,24h
1739+ 00:20:e0:ab : cd: ef ,192.168.0.124,desktop,24h
17311740 ```
17321741
17331742
@@ -1974,16 +1983,16 @@ A valid RTC device path, or empty string (`""`) for auto-discovery
19741983=== "TOML"
19751984 ```toml
19761985 [ ntp.sync.rtc]
1977- device = ""
1986+ device = "/dev/rtc0 "
19781987 ```
19791988=== "CLI"
19801989 ```shell
1981- sudo pihole-FTL --config ntp.sync.rtc.device ""
1990+ sudo pihole-FTL --config ntp.sync.rtc.device "/dev/rtc0 "
19821991 ```
19831992=== "Environment (Docker Compose)"
19841993 ```yaml
19851994 environment:
1986- FTLCONF_ntp_sync_rtc_device: ''
1995+ FTLCONF_ntp_sync_rtc_device: '/dev/rtc0 '
19871996 ```
19881997
19891998### ` utc `
@@ -2520,20 +2529,18 @@ An array of HTTP headers
25202529 ```
25212530=== "CLI"
25222531 ```shell
2523- sudo pihole-FTL --config 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 " ] '
2532+ sudo pihole-FTL --config 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 \" ] "
25242533 ```
25252534=== "Environment (Docker Compose)"
25262535 ```yaml
25272536 environment:
2528- FTLCONF_webserver_headers: |
2529- [
2530- 'X-DNS-Prefetch-Control: off',
2531- 'Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:;',
2532- 'X-Frame-Options: DENY',
2533- 'X-XSS-Protection: 0',
2534- 'X-Content-Type-Options: nosniff',
2535- 'Referrer-Policy: strict-origin-when-cross-origin'
2536- ]
2537+ FTLCONF_webserver_headers: |-
2538+ X-DNS-Prefetch-Control: off
2539+ Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:;
2540+ X-Frame-Options: DENY
2541+ X-XSS-Protection: 0
2542+ X-Content-Type-Options: nosniff
2543+ Referrer-Policy: strict-origin-when-cross-origin
25372544 ```
25382545
25392546### ` serve_all `
@@ -2587,16 +2594,18 @@ An array of valid CivetWeb options
25872594=== "TOML"
25882595 ```toml
25892596 [ webserver]
2590- advancedOpts = [ ]
2597+ advancedOpts = [ "ssl_protocol_version=4", "ssl_cipher_list=AES128:!MD5" ]
25912598 ```
25922599=== "CLI"
25932600 ```shell
2594- sudo pihole-FTL --config webserver.advancedOpts [ ]
2601+ sudo pihole-FTL --config webserver.advancedOpts " [ \" ssl_protocol_version=4 \" , \" ssl_cipher_list=AES128:!MD5 \" ] "
25952602 ```
25962603=== "Environment (Docker Compose)"
25972604 ```yaml
25982605 environment:
2599- FTLCONF_webserver_advancedOpts: [ ]
2606+ FTLCONF_webserver_advancedOpts: |-
2607+ ssl_protocol_version=4
2608+ ssl_cipher_list=AES128:!MD5
26002609 ```
26012610
26022611
@@ -3109,16 +3118,19 @@ An array of regular expressions describing clients
31093118=== "TOML"
31103119 ```toml
31113120 [ webserver.api]
3112- excludeClients = [ ]
3121+ excludeClients = [ "^192 \\ .168 \\ .2 \\ .56$", "^fe80::341: [ 0-9a-f ] * $", "^localhost$" ]
31133122 ```
31143123=== "CLI"
31153124 ```shell
3116- sudo pihole-FTL --config webserver.api.excludeClients [ ]
3125+ sudo pihole-FTL --config webserver.api.excludeClients " [ \" ^192 \\ .168 \\ .2 \\ .56$ \" , \" ^fe80::341: [ 0-9a-f ] * $ \" , \" ^localhost$ \" ] "
31173126 ```
31183127=== "Environment (Docker Compose)"
31193128 ```yaml
31203129 environment:
3121- FTLCONF_webserver_api_excludeClients: [ ]
3130+ FTLCONF_webserver_api_excludeClients: |-
3131+ ^192\\ .168\\ .2\\ .56$
3132+ ^fe80::341:[ 0-9a-f] * $
3133+ ^localhost$
31223134 ```
31233135
31243136### ` excludeDomains `
@@ -3139,16 +3151,18 @@ An array of regular expressions describing domains
31393151=== "TOML"
31403152 ```toml
31413153 [ webserver.api]
3142- excludeDomains = [ ]
3154+ excludeDomains = [ "(^| \\ .) \\ .google \\ .de$", " \\ .pi-hole \\ .net$" ]
31433155 ```
31443156=== "CLI"
31453157 ```shell
3146- sudo pihole-FTL --config webserver.api.excludeDomains [ ]
3158+ sudo pihole-FTL --config webserver.api.excludeDomains " [ \" (^| \\ .) \\ .google \\ .de$ \" , \"\\ .pi-hole \\ .net$ \" ] "
31473159 ```
31483160=== "Environment (Docker Compose)"
31493161 ```yaml
31503162 environment:
3151- FTLCONF_webserver_api_excludeDomains: [ ]
3163+ FTLCONF_webserver_api_excludeDomains: |-
3164+ (^|\\ .)\\ .google\\ .de$
3165+ \\ .pi-hole\\ .net$
31523166 ```
31533167
31543168### ` maxHistory `
@@ -3715,6 +3729,9 @@ from working.
37153729
37163730Use this option with extra care.
37173731
3732+ ** Example:** `[ "address=/example.com/192.168.0.1", "address=/example.org/192.168.0.2",
3733+ "address=/example.net/192.168.0.3" ] `
3734+
37183735** Allowed values are:**
37193736Array of valid dnsmasq config line options
37203737
@@ -3723,16 +3740,20 @@ Array of valid dnsmasq config line options
37233740=== "TOML"
37243741 ```toml
37253742 [ misc]
3726- dnsmasq_lines = [ ]
3743+ dnsmasq_lines = [ "address=/example.com/192.168.0.1", "address=/example.org/192.168.0.2",
3744+ "address=/example.net/192.168.0.3" ]
37273745 ```
37283746=== "CLI"
37293747 ```shell
3730- sudo pihole-FTL --config misc.dnsmasq_lines [ ]
3748+ 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 \" ] "
37313749 ```
37323750=== "Environment (Docker Compose)"
37333751 ```yaml
37343752 environment:
3735- FTLCONF_misc_dnsmasq_lines: [ ]
3753+ FTLCONF_misc_dnsmasq_lines: |-
3754+ address=/example.com/192.168.0.1
3755+ address=/example.org/192.168.0.2
3756+ address=/example.net/192.168.0.3
37363757 ```
37373758
37383759### ` extraLogging `
@@ -4066,7 +4087,7 @@ true or false
40664087 ```
40674088=== "CLI"
40684089 ```shell
4069- sudo pihole-FTL --config debug.flags alse
4090+ sudo pihole-FTL --config debug.flags false
40704091 ```
40714092=== "Environment (Docker Compose)"
40724093 ```yaml
0 commit comments