diff --git a/README.md b/README.md index 08961bd..84de9ee 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ _Sync custom DNS entries in Pi-hole to OPNsense Unbound._ +This little service watches Pi-hole's `/etc/pihole/custom.list` file and when a change is made, it syncs it with your +OPNsense router's Unbound host overrides. This is useful because if your Pi-hole goes offline then you will still be +able to resolve your custom domains. + ## Install 1. Install pip requirements: @@ -22,8 +26,10 @@ _Sync custom DNS entries in Pi-hole to OPNsense Unbound._ ```shell sudo cp pihole-opnsense-sync.service /etc/systemd/system/pihole-opnsense-sync.service ``` + The service runs as the `pihole:pihole` user. 5. Enable and start the service: ```shell sudo systemctl enable --now pihole-opnsense-sync + sleep 2 sudo systemctl status pihole-opnsense-sync ``` \ No newline at end of file