Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/origamiofficial/docker-pihole-unbound

A supercharged Pi-Hole docker container with Unbound built-in. [Auto Updates 🚀]
https://github.com/origamiofficial/docker-pihole-unbound

dns dns-server docker docker-image docker-pihole-unbound pi-hole pi-hole-client pi-hole-ftl pi-hole-private-dns pi-hole-unbound pihole pihole-dashboard pihole-docker pihole-unbound unbound unbound-dns unbound-dns-server unbound-docker unbound-mod unbound-server

Last synced: about 21 hours ago
JSON representation

A supercharged Pi-Hole docker container with Unbound built-in. [Auto Updates 🚀]

Host: GitHub
URL: https://github.com/origamiofficial/docker-pihole-unbound
Owner: origamiofficial
License: mit
Created: 2022-08-23T08:00:07.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-08-16T07:16:31.000Z (about 1 month ago)
Last Synced: 2024-09-22T19:32:33.363Z (5 days ago)
Topics: dns, dns-server, docker, docker-image, docker-pihole-unbound, pi-hole, pi-hole-client, pi-hole-ftl, pi-hole-private-dns, pi-hole-unbound, pihole, pihole-dashboard, pihole-docker, pihole-unbound, unbound, unbound-dns, unbound-dns-server, unbound-docker, unbound-mod, unbound-server
Language: Shell
Homepage: https://hub.docker.com/r/rlabinc/pihole-unbound
Size: 2.96 MB
Stars: 56
Watchers: 1
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # pihole-unbound 

![Docker Pulls](https://img.shields.io/docker/pulls/rlabinc/pihole-unbound.svg?style=flat&label=pulls&logo=docker) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/rlabinc/pihole-unbound/latest?style=flat&logo=docker&label=pihole-unbound) ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/pihole/pihole/latest?style=flat&logo=docker&label=pihole-official) ![GitHub Repo stars](https://img.shields.io/github/stars/origamiofficial/docker-pihole-unbound?style=social) [![Telegram Support](https://img.shields.io/endpoint?label=Support&style=flat&url=https%3A%2F%2Fmogyo.ro%2Fquart-apis%2Ftgmembercount%3Fchat_id%3Dpihole_unbound)](https://t.me/pihole_unbound) ![We Support](https://img.shields.io/badge/we%20stand%20with-%F0%9F%87%B5%F0%9F%87%B8%20palestine-white.svg)

Level up your network with cutting-edge tech. This Docker container effortlessly combines [Pi-Hole](https://github.com/pi-hole/pi-hole) and [Unbound](https://github.com/NLnetLabs/unbound), giving you the ultimate privacy and performance combo in a single package. It's the future of network management, available today.

![alt text](https://raw.githubusercontent.com/origamiofficial/docker-pihole-unbound/main/banner.png)

> [!NOTE]

> Development for the `development-v6` tag is currently on hold. The `development-v6` tag uses Alpine Linux. If you're familiar with Alpine, we encourage you to check out the [Dockerfile-Dev-V6](https://github.com/origamiofficial/docker-pihole-unbound/blob/main/Dockerfile-Dev-V6) file. Your contributions are highly appreciated!

## Supported Architectures

We utilise the docker buildx for multi-platform awareness. More information is available from docker [here](https://docs.docker.com/buildx/working-with-buildx/).

Simply pulling `rlabinc/pihole-unbound:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via `--platform`.

The architectures supported by this image are:

| Architecture | Available | Platform |

| :----: | :----: | :----: |

| amd64 | ✅ | linux/amd64 |

| arm64 | ✅ | linux/arm64 |

| armhf | ✅ | linux/arm/v7 |

| armel | ✅ | linux/arm/v6 |

## Usage

Here are the commands you'll need:

```bash

docker run -d --name pihole-unbound \

  --name=pihole-unbound \

  -e TZ=Europe/London `#optional` \

  -p 53:53/tcp -p 53:53/udp \

  -p 80:80/tcp `#Pi-hole web interface port` \

  -e WEBPASSWORD='qwerty123' `#better to use single quotes` \

  --restart=always \

  rlabinc/pihole-unbound:latest

```

### Docker Tags

The Docker tags supported by this image are:

| Tag | Type | Status | Development | Description |

| :-----: | :-----: | :-----: | :-----: | :-----: |

| `latest` | Stable | [![latest Build](https://img.shields.io/github/actions/workflow/status/origamiofficial/docker-pihole-unbound/build-and-push-latest.yaml)](https://github.com/origamiofficial/docker-pihole-unbound/actions/workflows/build-and-push-latest.yaml) | ✅ | Always latest release |

| `2024.02.2-1.19.3` | Stable | [![date Build](https://img.shields.io/github/actions/workflow/status/origamiofficial/docker-pihole-unbound/build-and-push-latest.yaml)](https://github.com/origamiofficial/docker-pihole-unbound/actions/workflows/build-and-push-latest.yaml) | ✅ | Date-based release [Pi-hole Version-Unbound Version] |

| `dev` | Beta | [![dev Build](https://img.shields.io/github/actions/workflow/status/origamiofficial/docker-pihole-unbound/build-and-push-dev.yaml)](https://github.com/origamiofficial/docker-pihole-unbound/actions/workflows/build-and-push-dev.yaml) | ✅ | Similar to `latest`, but for the development branch (pushed occasionally) |

| `development-v6` | Beta | [![development-v6 Build](https://img.shields.io/github/actions/workflow/status/origamiofficial/docker-pihole-unbound/build-and-push-dev-v6.yaml)](https://github.com/origamiofficial/docker-pihole-unbound/actions/workflows/build-and-push-dev-v6.yaml) | ⏳ | Upcoming `development-v6` release |

| `test` | Test | ❌ | 🔬 | Testing purpose only |

> Note: The `development-v6` has been entirely redesigned from the ground up and contains many [breaking changes](https://github.com/pi-hole/docker-pi-hole/blob/development-v6/README.md), for more info regarding `development-v6` visit [here](https://pi-hole.net/blog/2023/10/09/pi-hole-v6-beta-testing/).

### Installing on Ubuntu

Modern releases of Ubuntu (17.10+) include [`systemd-resolved`](http://manpages.ubuntu.com/manpages/bionic/man8/systemd-resolved.service.8.html) which is configured by default to implement a caching DNS stub resolver. This will prevent pi-hole from listening on port 53.

The stub resolver should be disabled with: `sudo sed -r -i.orig 's/#?DNSStubListener=yes/DNSStubListener=no/g' /etc/systemd/resolved.conf`

This will not change the nameserver settings, which point to the stub resolver thus preventing DNS resolution. Change the `/etc/resolv.conf` symlink to point to `/run/systemd/resolve/resolv.conf`, which is automatically updated to follow the system's [`netplan`](https://netplan.io/):

`sudo sh -c 'rm /etc/resolv.conf && ln -s /run/systemd/resolve/resolv.conf /etc/resolv.conf'`

After making these changes, you should restart systemd-resolved using `systemctl restart systemd-resolved`

Once pi-hole is installed, you'll want to configure your clients to use it ([see here](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245)). If you used the symlink above, your docker host will either use whatever is served by DHCP, or whatever static setting you've configured. If you want to explicitly set your docker host's nameservers you can edit the netplan(s) found at `/etc/netplan`, then run `sudo netplan apply`.

Example netplan:

```yaml

network:

    ethernets:

        ens160:

            dhcp4: true

            dhcp4-overrides:

                use-dns: false

            nameservers:

                addresses: [127.0.0.1]

    version: 2

```

Note that it is also possible to disable `systemd-resolved` entirely. However, this can cause problems with name resolution in vpns ([see bug report](https://bugs.launchpad.net/network-manager/+bug/1624317)). It also disables the functionality of netplan since systemd-resolved is used as the default renderer ([see `man netplan`](http://manpages.ubuntu.com/manpages/bionic/man5/netplan.5.html#description)). If you choose to disable the service, you will need to manually set the nameservers, for example by creating a new `/etc/resolv.conf`.

Users of older Ubuntu releases (circa 17.04) will need to disable dnsmasq.

## Parameters

Container images are configured using parameters passed at runtime (such as those above).

| Parameter | Function | `development-v6` Only |

| :----: | :----: | :----: |

| `-e TZ=Europe/London` | Specify a timezone to use ex Europe/London. | `-e TZ=Europe/London` |

| `-p 53:53/tcp -p 53:53/udp` | Default DNS port to use. | `-p 53:53/tcp -p 53:53/udp` |

| `-p 80:80/tcp` | Specify Pi-hole web interface port. | `-p 80:80/tcp` |

| `-e WEBPASSWORD='qwerty123'` | Specify Pi-hole web interface password. It is better to use single quotes. | `-e FTLCONF_webserver_api_password='qwerty123'` |

| `--restart=always` | To make sure "It's Always DNS" does not happen. | `--restart=always` |

| `-v /opt/unbound/etc/unbound` | Your customized Unbound configuration `unbound.conf` location. | `-v /opt/unbound/etc/unbound` |

This Docker container supports all Pi-hole official Docker container environment variables available [here](https://github.com/pi-hole/docker-pi-hole/#environment-variables).

## Quick Links

* [Telegram Support](https://t.me/pihole_unbound)

* [Pihole Docker Github Repository](https://github.com/pi-hole/docker-pi-hole)

* [Unbound Github Repository](https://github.com/NLnetLabs/unbound)

* [Pi-hole Unbound Github Repository](https://github.com/origamiofficial/docker-pihole-unbound)

* [Pi-hole Unbound Docker Hub](https://hub.docker.com/r/rlabinc/pihole-unbound)

## Acknowledgements

The code in this image is heavily influenced by MatthewVance's unbound-docker with the help of chriscrowe's docker-pihole-unbound server Docker image configs,

However, the upstream projects most certainly also deserve credit for making this all possible.

- [pi-hole](https://github.com/pi-hole).

- [NLnetLabs](https://github.com/NLnetLabs).

- [MatthewVance](https://github.com/MatthewVance).

- [chriscrowe](https://github.com/chriscrowe).

## Warning

I'm not responsible if your internet goes down using this Docker container. Use at your own risk.

[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/origamiofficial/docker-pihole-unbound&icon=github.svg&icon_color=%23FFFFFF&title=hits&edge_flat=false)](https://github.com/origamiofficial/docker-pihole-unbound)