Merge pull request #1038 from pi-hole/master

sync: master to dev
This commit is contained in:
Adam Warner 2022-04-02 09:46:27 +01:00 committed by GitHub
commit 658658ebc9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 6 deletions

View File

@ -5,6 +5,17 @@
</p>
<!-- Delete above HTML and insert markdown for dockerhub : ![Pi-hole](https://pi-hole.github.io/graphics/Vortex/Vortex_with_text.png) -->
## Upgrade Notes
For `2022.04`: This release seeks to address some issues brought about by changes made to Docker in version 20.10.14
Please note, for now at least, that NET_ADMIN is a required capability
See: https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
In `2022.01` and later, the default `DNSMASQ_USER` has been changed to `pihole`, however this may cause issues on some systems such as Synology, see Issue [#963](https://github.com/pi-hole/docker-pi-hole/issues/963) for more information.
If the container wont start due to issues setting capabilities, set `DNSMASQ_USER` to `root` in your environment.
## Quick Start
1. Copy docker-compose.yml.example to docker-compose.yml and update as needed. See example below:
@ -33,7 +44,7 @@ services:
- './etc-dnsmasq.d:/etc/dnsmasq.d'
# https://github.com/pi-hole/docker-pi-hole#note-on-capabilities
cap_add:
- NET_ADMIN # Recommended but not required (DHCP needs NET_ADMIN)
- NET_ADMIN # Currently required for 2022.04 due to changes introduced in Docker 20.10.14
restart: unless-stopped
```
2. Run `docker-compose up -d` to build and start pi-hole
@ -41,11 +52,6 @@ services:
[Here is an equivalent docker run script](https://github.com/pi-hole/docker-pi-hole/blob/master/docker_run.sh).
## Upgrade Notes
In `2022.01` and later, the default `DNSMASQ_USER` has been changed to `pihole`, however this may cause issues on some systems such as Synology, see Issue [#963](https://github.com/pi-hole/docker-pi-hole/issues/963) for more information.
If the container wont start due to issues setting capabilities, set `DNSMASQ_USER` to `root` in your environment.
## Overview
A [Docker](https://www.docker.com/what-docker) project to make a lightweight x86 and ARM container with [Pi-hole](https://pi-hole.net) functionality.