Merge pull request #1702 from pi-hole/master

Sync master back into development

Author: PromoFaux

README.md

@@ -25,7 +25,7 @@
 
 > [!CAUTION]
 >
-> ## !!! THIS VERSION CONTAINS BREAKING CHANGES
+> ## !!! THE LATEST VERSION CONTAINS BREAKING CHANGES
 >
 > **Pi-hole v6 has been entirely redesigned from the ground up and contains many breaking changes.**
 >
@@ -34,6 +34,8 @@
 > If you are using volumes to persist your configuration, be careful.<br>Replacing any `v5` image *(`2024.07.0` and earlier)* with a `v6` image will result in updated configuration files. **These changes are irreversible**.
 >
 > Please read the README carefully before proceeding.
+>
+> https://docs.pi-hole.net/docker/
 
 ---
 
@@ -76,12 +78,16 @@ services:
     volumes:
       # For persisting Pi-hole's databases and common configuration file
       - './etc-pihole:/etc/pihole'
-      # Uncomment the below if you have custom dnsmasq config files that you want to persist. Not needed for most starting fresh with Pi-hole v6. If you're upgrading from v5 you and have used this directory before, you should keep it enabled for the first v6 container start to allow for a complete migration. It can be removed afterwards
+      # Uncomment the below if you have custom dnsmasq config files that you want to persist. Not needed for most starting fresh with Pi-hole v6. If you're upgrading from v5 you and have used this directory before, you should keep it enabled for the first v6 container start to allow for a complete migration. It can be removed afterwards. Needs environment variable FTLCONF_misc_etc_dnsmasq_d: 'true'
       #- './etc-dnsmasq.d:/etc/dnsmasq.d'
     cap_add:
       # See https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
       # Required if you are using Pi-hole as your DHCP server, else not needed
       - NET_ADMIN
+      # Required if you are using Pi-hole as your NTP client to be able to set the host's system time
+      - SYS_TIME
+      # Optional, if Pi-hole should get some more processing time
+      - SYS_NICE
     restart: unless-stopped
 ```
 
@@ -140,6 +146,7 @@ To explicitly set no password, set `FTLCONF_webserver_api_password: ''`.
 | `FTL_CMD` | `no-daemon` | `no-daemon -- <dnsmasq option>` | Customize dnsmasq startup options. e.g. `no-daemon -- --dns-forward-max 300` to increase max. number of concurrent dns queries on high load setups. |
 | `DNSMASQ_USER` | unset | `<pihole\|root>` | Allows changing the user that FTLDNS runs as. Default: `pihole`, some systems such as Synology NAS may require you to change this to `root`.<br><br>(See [#963](https://github.com/pi-hole/docker-pi-hole/issues/963)) |
 | `ADDITIONAL_PACKAGES`| unset | Space separated list of APKs | HERE BE DRAGONS. Mostly for development purposes, this just makes it easier for those of us that always like to have whatever additional tools we need inside the container for debugging. |
+| `FTLCONF_misc_etc_dnsmasq_d`| false | `true\|false` | Load custom user configuration files from `/etc/dnsmasq.d/` |
 
 Here is a rundown of other arguments for your docker-compose / docker run.
 
@@ -250,14 +257,15 @@ The preferred method is to clone this repository and build the image locally wit
 
 #### Usage:
 ```
-./build.sh [-l] [-f <ftl_branch>] [-c <core_branch>] [-w <web_branch>] [-t <tag>] [use_cache]
+./build.sh [-l] [-f <ftl_branch>] [-c <core_branch>] [-w <web_branch>] [-p <padd_branch>] [-t <tag>] [use_cache]
 ```
 
 #### Options:
 
 - `-f <branch>` /  `--ftlbranch <branch>`: Specify FTL branch (cannot be used in conjunction with `-l`)
 - `-c <branch>` / `--corebranch <branch>`: Specify Core branch
 - `-w <branch>` / `--webbranch <branch>`: Specify Web branch
+- `-p <branch>` / `--paddbranch <branch>`: Specify PADD branch
 - `-t <tag>` / `--tag <tag>`: Specify Docker image tag (default: `pihole:local`)
 - `-l` / `--local`: Use locally built FTL binary (requires `src/pihole-FTL` file)
 - `use_cache`: Enable caching (by default `--no-cache` is used)
@@ -284,7 +292,7 @@ The webserver and DNS service inside the container can be customized if necessar
 
 ## Note on Capabilities
 
-[FTLDNS](https://docs.pi-hole.net/ftldns/in-depth/#linux-capabilities) expects to have the following capabilities available:
+Pi-hole's DNS core (FTL) expects to have the following capabilities available:
 
 - `CAP_NET_BIND_SERVICE`: Allows FTLDNS binding to TCP/UDP sockets below 1024 (specifically DNS service on port 53)
 - `CAP_NET_RAW`: use raw and packet sockets (needed for handling DHCPv6 requests, and verifying that an IP is not in use before leasing it)