From c663694b53c7a0e32c299e345d7cd27d46f8e04f Mon Sep 17 00:00:00 2001 From: Chris Crowe Date: Sat, 2 Feb 2019 17:04:08 -0800 Subject: [PATCH] Updating README --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3b7db55..c560089 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,23 @@ This project uses a [`macvlan` Docker network](https://docs.docker.com/network/m - 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)) + ## Instructions -#### Before running +### Before running... - Update some things in the docker compose, such as your IP addresses/subnets. - Add a `.env` file next to the docker-compose.yaml so you can pass in the `${WEBPASSWORD}` - Update the secondary/backup nameserver in the `resolv.conf` file - Lastly you might want to provide some manual DNS entries in the `dnsmasq.conf` and/or `hosts` files -#### Then run it +### Run it! ```bash sudo docker-compose up -d ``` -#### After +### Test it! Test your configuration with dig: @@ -44,11 +45,15 @@ dig sigok.verteiltesysteme.net @192.168.1.248 # Expecting "status: NOERROR" ``` +### Serve it! + If all looks good, configure your router/DHCP server to serve your new Pi-Hole IP address (`192.168.1.248`) to your clients. +## Acknowledgements -### Acknowledgements +- [http://tonylawrence.com/posts/unix/synology/free-your-synology-ports/][link1] +- [https://github.com/MatthewVance/unbound-docker][link2] -- http://tonylawrence.com/posts/unix/synology/free-your-synology-ports/ -- https://github.com/MatthewVance/unbound-docker +[link1]: http://tonylawrence.com/posts/unix/synology/free-your-synology-ports/ +[link2]: https://github.com/MatthewVance/unbound-docker \ No newline at end of file