docker-pihole-unbound/one-container/README.md

# Pi-Hole + Unbound - 1 Container

## Description

This Docker deployment runs both Pi-Hole and Unbound in a single container. 

The base image for the container is the [official Pi-Hole container](https://hub.docker.com/r/pihole/pihole), with an extra build step added to install the Unbound resolver directly into to the container based on [instructions provided directly by the Pi-Hole team](https://docs.pi-hole.net/guides/unbound/).

## Usage

First create a `.env` file to substitute variables for your deployment. 


### Required environment variables

> Vars and descriptions replicated from the [official pihole container](https://github.com/pi-hole/docker-pi-hole/):

| Docker Environment Var | Description|
| --- | --- |
| `ServerIP: <Host's IP>`<br/> | **--net=host mode requires** Set to your server's LAN IP, used by web block modes and lighttpd bind address
| `TZ: <Timezone>`<br/> | Set your [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) to make sure logs rotate at local midnight instead of at UTC midnight.
| `WEBPASSWORD: <Admin password>`<br/> | http://pi.hole/admin password. Run `docker logs pihole \| grep random` to find your random pass.
| `REV_SERVER: <"true"\|"false">`<br/> | Enable DNS conditional forwarding for device name resolution
| `REV_SERVER_DOMAIN: <Network Domain>`<br/> | If conditional forwarding is enabled, set the domain of the local network router
| `REV_SERVER_TARGET: <Router's IP>`<br/> | If conditional forwarding is enabled, set the IP of the local network router
| `REV_SERVER_CIDR: <Reverse DNS>`<br/>| If conditional forwarding is enabled, set the reverse DNS zone (e.g. `192.168.0.0/24`)

Example `.env` file in the same directory as your `docker-compose.yaml` file:

```
ServerIP=192.168.1.10
TZ=America/Los_Angeles
WEBPASSWORD=QWERTY123456asdfASDF
REV_SERVER=true
REV_SERVER_DOMAIN=local
REV_SERVER_TARGET=192.168.1.1
REV_SERVER_CIDR=192.168.0.0/16
```


### Running the stack

```bash
docker-compose up -d
```

> If using Portainer, just paste the `docker-compose.yaml` contents into the stack config and add your *environment variables* directly in the UI.
Single container support (#11) Adding a 2nd docker-compose config for running both Pi-Hole and Unbound in the same container (following recommended steps in the Pi-Hole docs). Restructuring the project to maintain the old 2-container setup as well. 2020-12-31 21:23:33 +01:00			`# Pi-Hole + Unbound - 1 Container`

			`## Description`

			`This Docker deployment runs both Pi-Hole and Unbound in a single container.`

			`The base image for the container is the [official Pi-Hole container](https://hub.docker.com/r/pihole/pihole), with an extra build step added to install the Unbound resolver directly into to the container based on [instructions provided directly by the Pi-Hole team](https://docs.pi-hole.net/guides/unbound/).`

			`## Usage`

			First create a `.env` file to substitute variables for your deployment.


			`### Required environment variables`

			`> Vars and descriptions replicated from the [official pihole container](https://github.com/pi-hole/docker-pi-hole/):`

			`\| Docker Environment Var \| Description\|`
			`\| --- \| --- \|`
			\| `ServerIP: <Host's IP>`<br/> \| --net=host mode requires Set to your server's LAN IP, used by web block modes and lighttpd bind address
			\| `TZ: <Timezone>`<br/> \| Set your [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) to make sure logs rotate at local midnight instead of at UTC midnight.
			\| `WEBPASSWORD: <Admin password>`<br/> \| http://pi.hole/admin password. Run `docker logs pihole \\| grep random` to find your random pass.
Update README.md (#19) Fix docs 2021-02-02 18:02:32 +01:00			\| `REV_SERVER: <"true"\\|"false">`<br/> \| Enable DNS conditional forwarding for device name resolution
Single container support (#11) Adding a 2nd docker-compose config for running both Pi-Hole and Unbound in the same container (following recommended steps in the Pi-Hole docs). Restructuring the project to maintain the old 2-container setup as well. 2020-12-31 21:23:33 +01:00			\| `REV_SERVER_DOMAIN: <Network Domain>`<br/> \| If conditional forwarding is enabled, set the domain of the local network router
			\| `REV_SERVER_TARGET: <Router's IP>`<br/> \| If conditional forwarding is enabled, set the IP of the local network router
			\| `REV_SERVER_CIDR: <Reverse DNS>`<br/>\| If conditional forwarding is enabled, set the reverse DNS zone (e.g. `192.168.0.0/24`)

			Example `.env` file in the same directory as your `docker-compose.yaml` file:

			```
			`ServerIP=192.168.1.10`
			`TZ=America/Los_Angeles`
			`WEBPASSWORD=QWERTY123456asdfASDF`
			`REV_SERVER=true`
			`REV_SERVER_DOMAIN=local`
			`REV_SERVER_TARGET=192.168.1.1`
			`REV_SERVER_CIDR=192.168.0.0/16`
			```


			`### Running the stack`

			```bash
			`docker-compose up -d`
			```

Update README.md (#19) Fix docs 2021-02-02 18:02:32 +01:00			> If using Portainer, just paste the `docker-compose.yaml` contents into the stack config and add your environment variables directly in the UI.