Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework networking logic and some miscellaneous code changes #5

Merged
merged 4 commits into from
Feb 17, 2021
Merged

Rework networking logic and some miscellaneous code changes #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
813a0ec
Update syno_pihole.sh (#1)
Kieren Jan 11, 2021
ac7f0ea
Fix bug in define_pihole_versions which detects wrong version.
Kieren Jan 12, 2021
cc5dfe2
Merge branch 'master' of github.com:Kieren/synology-pihole
Kieren Jan 12, 2021
e8d55cc
Update README.md inline with patch
Kieren Jan 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ cd synology-pihole
## Usage
*Synology-pihole* requires `sudo` rights. Use the following command to invoke *synology-pihole* from the command line.

```console
```
sudo ./syno_pihole.sh [OPTIONS] [PARAMETERS] COMMAND
```

Expand Down Expand Up @@ -101,7 +101,7 @@ sudo ./syno_pihole.sh update
| **`network`** | Creates or recreates virtual network |
| **`update`** | Updates an existing Pi-hole Docker container |

In the addition, the following options are available.
In addition, the following options are available.

| Option | Alias | Parameter | Description |
|--------|------------|------------|-------------|
Expand All @@ -114,19 +114,20 @@ In the addition, the following options are available.
| Variable | Parameter | Required | Example | Description |
|-------------------|-----------------|----------|----------------------|-------------|
| `PIHOLE_IP` | -i, --ip | `Yes` | `192.168.0.250` | Static IP address of Pi-hole, ensure this IP address is available |
| `SUBNET` | -s, --subnet | `No` | `192.168.0.0/24` | Subnet of the virtual network for Pi-hole (auto-detected if omitted) |
| `GATEWAY` | -g, --gateway | `No` | `192.168.0.1` | Gateway of the virtual network for Pi-hole (auto-detected if omitted) |
| `IP_RANGE` | -r, --range | `No` | `192.168.0.250/30` | IP range with CIDR notation of the virtual network for Pi-hole (defaults to `PIHOLE_IP/30`) |
| `VLAN_NAME` | -v, --vlan | `No` | `macvlan0` | Name of the virtual network for Pi-hole (defaults to `macvlan0`) |
| `INTERFACE` | -n, --interface | `No` | `eth0` | Physical interface of the virtual network for Pi-hole (auto-detected if omitted) |
| `MAC_ADDRESS` | -m, --mac | `No` | `70:d9:5a:70:99:cd` | Unicast MAC address of Pi-hole (randomized if omitted) |
| `DOMAIN_NAME` | -d, --domain | `No` | `pihole.example.com` | Fully qualified domain name for Pi-hole |
| `PIHOLE_HOSTNAME` | -H, --host | `No` | `pihole` | Hostname of Pi-hole (defaults to `pihole`) |
| `TIMEZONE` | -t, --timezone | `No` | `Europe/Amsterdam` | Timezone for Pi-hole (see [Wikipedia][timezone_list] for an overview, auto-detected if omitted) |
| `INTERFACE` | -n, --interface | `No` | `eth0` | Host network interface to the subnet, auto-detected if omitted |
| `SUBNET` | -s, --subnet | `No` | `192.168.0.0/24` | CIDR notated subnet the Pi-Hole will join, auto-detected if omitted |
| `GATEWAY` | -g, --gateway | `No` | `192.168.0.1` | Subnet gateway router address (see --subnet), auto-detected if omitted |
| `HOST_IP` | --host-ip | `No` | `192.168.0.3` | New host address for communicating with Pi-hole via macvlan bridge interface. By default the lowest address starting at the first (not the Pi-hole address) of the Docker network range (see --range) is used |
| `IP_RANGE` | -r, --range | `No` | `192.168.0.250/30` | CIDR notated address range for Docker to assign to containers attached to the created 'Docker macvlan Network', defaults to `PIHOLE_IP/32` |
| `VLAN_NAME` | -v, --vlan | `No` | `macvlan0` | Name assigned to the generated macvlan interface on the host to enable container <-> host communication (defaults to `macvlan0`) |
| `MAC_ADDRESS` | -m, --mac | `No` | `70:d9:5a:70:99:cd` | Unicast MAC to assign Pi-hole, randomized if omitted |
| `DOMAIN_NAME` | -d, --domain | `No` | `example.com` | Fully qualified domain of the subnet |
| `PIHOLE_HOSTNAME` | -H, --host | `No` | `pihole` | Hostname of Pi-hole, defaults to `pihole` |
| `TIMEZONE` | -t, --timezone | `No` | `Europe/Amsterdam` | Local Timezone (see [Wikipedia][timezone_list] for an overview, auto-detected if omitted) |
| `DNS1` | --DNS1 | `No` | `1.1.1.1` | Primary DNS provider to be used by Pi-hole (see this [list][upstream_dns] for typical providers) |
| `DNS2` | --DNS2 | `No` | `1.0.0.1` | Alternative DNS provider to be used by Pi-hole |
| `DATA_PATH` | --path | `No` | `./data` | Path where to store your Pi-hole data (defaults to `./data`) |
| `WEBPASSWORD` | -p, --password | `No` | `password` | Password for the Pi-hole admin (prompted for when omitted) |
| `DATA_PATH` | --path | `No` | `./data` | Host data location path for Pi-hole, defaults to `./data` |
| `WEBPASSWORD` | -p, --password | `No` | `password` | Password for the Pi-hole administrative web interface (prompted for when omitted) |

### Scheduled Tasks
#### Updating Pi-Hole to the Latest Version
Expand All @@ -139,18 +140,18 @@ It is recommended to schedule a task to ensure Pi-hole uses the latest version
/bin/sh /path/to/your/script/syno_pihole.sh update -l /var/log/syno_pihole.log
```

#### Ensuring the Virtual Network is Available After Reboot
By default, Docker containers are automatically restarted after a system reboot. However, the virtual network setup by `synology-pihole` is lost after a system reboot and/or update. Similar to the instructions in the previous paragraph, you can setup a task to automatically recreate the virtual network during the boot process of your Synology NAS. Follow these steps to do so.
#### Ensuring the Host <-> Container Bridge Interface is Available After Reboot
By default, Docker containers are automatically restarted after a system reboot. However, the macvlan bridge interface setup by `synology-pihole` is lost after a system reboot and/or update. Similar to the instructions in the previous paragraph, you can setup a task to automatically recreate it during the boot process of your Synology NAS. Follow these steps to do so.
1. Access `Task Scheduler` via `Control Panel ➡ Task Scheduler` in DSM.
2. Now click on `Create ➡ Triggered Task ➡ User-defined script` to create a custom script. Give the task a familiar name in the tab `General`, such as `Recreate Pi-hole network`.
2. Now click on `Create ➡ Triggered Task ➡ User-defined script` to create a custom script. Give the task a familiar name in the tab `General`, such as `Recreate Pi-hole Bridge Interface`.
3. In the same screen, select `root` as user and `Boot-up` as event.
4. Finally, enter the following script in the user-defined script section of the `Task Settings` tab. Be sure to update `/path/to/your/script/`. The optional instruction `-l /var/log/syno_pihole.log` copies all messages to a log file. The option `--force` is required to avoid the script asking for user confirmation.
```console
/bin/sh /path/to/your/script/syno_pihole.sh network --ip 192.168.0.250 --log /var/log/syno_pihole.log --force
```

### Configuration
The Pi-hole [FAQ][pihole_dns] describes various options on how to configure Pi-hole as DNS server. The portal of Pi-hole is available by navigating to `http://ip_address/admin/` (replacing `ip_address` with the correct IP address).
The Pi-hole [FAQ][pihole_dns] describes various options on how to configure the Pi-hole DNS server. The Pi-hole administor web interface is available by navigating to `http://ip_address/admin/` (replacing `ip_address` with the correct IP address).


## Contributing
Expand Down Expand Up @@ -203,4 +204,4 @@ Copyright © [Mark Dumay][blog]
[blog]: https://markdumay.com
-->
[blog]: https://github.com/markdumay
[repository]: https://github.com/markdumay/synology-pihole.git
[repository]: https://github.com/markdumay/synology-pihole.git
5 changes: 3 additions & 2 deletions sample.env
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Required network settings
PIHOLE_IP=192.168.0.250 # Static IP address of Pi-hole, ensure this IP is available and within your subnet
PIHOLE_IP=192.168.0.250 # Static IP address of Pi-hole, ensure this IP is available and within your network subnet

# Optional network settings
SUBNET=192.168.0.0/24 # Auto-detected on your Synology NAS if omitted
GATEWAY=192.168.0.1 # Auto-detected on your Synology NAS if omitted
IP_RANGE=192.168.0.248/30 # Defaults to PIHOLE_IP/30 if omitted (four IPs is the minimum)
HOST_IP=192.168.0.249 # Defaults to first address not PIHOLE_IP starting at lowest address of IP_RANGE
IP_RANGE=192.168.0.248/30 # Defaults to PIHOLE_IP/32 if omitted
VLAN_NAME=macvlan0 # Defaults to 'macvlan0' if omitted
INTERFACE=eth0 # Auto-detected on your Synology NAS if omitted
MAC_ADDRESS=70:d9:5a:70:99:cd # Unicast MAC address of Pi-hole, randomized if omitted
Expand Down
Loading