Updated README
This commit is contained in:
parent
806c23d4e1
commit
4a0bc16dcb
1 changed files with 15 additions and 9 deletions
24
README.md
24
README.md
|
@ -1,4 +1,6 @@
|
||||||
# Pi-Hole + Unbound on Docker (works on Synology)
|
# Pi-Hole + Unbound on Docker
|
||||||
|
|
||||||
|
#### (Synology-compatible!)
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
|
@ -6,19 +8,19 @@ Running Pi-Hole in Docker can be challenging due to networking requirements by P
|
||||||
|
|
||||||
This project uses a [`macvlan` Docker network](https://docs.docker.com/network/macvlan/) to place your containers on your main network, with their own IP addresses and MAC addresses. Pi-Hole uses Unbound as it's resolver, and Unbound uses Cloudflare (1.1.1.1) upstream in order to support DNSSEC and DNS-over-TLS.
|
This project uses a [`macvlan` Docker network](https://docs.docker.com/network/macvlan/) to place your containers on your main network, with their own IP addresses and MAC addresses. Pi-Hole uses Unbound as it's resolver, and Unbound uses Cloudflare (1.1.1.1) upstream in order to support DNSSEC and DNS-over-TLS.
|
||||||
|
|
||||||
- Uses 2 Containers
|
- This docker-compose runs the following 2 containers
|
||||||
- Pi-Hole ([pihole/pihole](https://hub.docker.com/r/pihole/pihole)) - Official from Pi-Hole
|
- Pi-Hole ([pihole/pihole](https://hub.docker.com/r/pihole/pihole)) - Official from Pi-Hole
|
||||||
- Unbound ([mvance/unbound](https://hub.docker.com/r/mvance/unbound))
|
- Unbound ([mvance/unbound](https://hub.docker.com/r/mvance/unbound)) - There are several choices here but I like this one the best
|
||||||
|
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
|
|
||||||
### Before running...
|
### Hold your horses and configure some stuff first...
|
||||||
|
|
||||||
- Update some things in the docker compose, such as your IP addresses/subnets.
|
- Update docker-compose to match your environment, eg. IP addresses/subnets.
|
||||||
- Add a `.env` file next to the docker-compose.yaml so you can pass in the `${WEBPASSWORD}`
|
- Add a `.env` file next to the docker-compose.yaml so you can pass in the `${WEBPASSWORD}` - this is your Pi-Hole admin password. You can optionally leave this step out and set the password via CLI (`pihole -a -p`) after the Pi-Hole is running
|
||||||
- Update the secondary/backup nameserver in the `resolv.conf` file
|
- Update the secondary/backup nameserver in the `resolv.conf` file, or remove it if you don't have a backup (would recommend having one!)
|
||||||
- Lastly you might want to provide some manual DNS entries in the `dnsmasq.conf` and/or `hosts` files
|
- Lastly, optionally, you can provide some manual DNS entries in the `dnsmasq.conf` and/or `hosts` files
|
||||||
|
|
||||||
### Run it!
|
### Run it!
|
||||||
|
|
||||||
|
@ -28,7 +30,9 @@ sudo docker-compose up -d
|
||||||
|
|
||||||
### Test it!
|
### Test it!
|
||||||
|
|
||||||
Test your configuration with dig:
|
Test your configuration with dig
|
||||||
|
|
||||||
|
> __Note__: change the IP to your new Pi-Hole's IP
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
dig google.com @192.168.1.248
|
dig google.com @192.168.1.248
|
||||||
|
@ -49,6 +53,8 @@ dig sigok.verteiltesysteme.net @192.168.1.248
|
||||||
|
|
||||||
If all looks good, configure your router/DHCP server to serve your new Pi-Hole IP address (`192.168.1.248`) to your clients.
|
If all looks good, configure your router/DHCP server to serve your new Pi-Hole IP address (`192.168.1.248`) to your clients.
|
||||||
|
|
||||||
|
> Note: it may take some time for the current DHCP leases to renew and for clients to get the new DNS service info -- generally the default is 24 hours or less.
|
||||||
|
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue