Please refer to the updated repository

https://github.com/gspannu/OPN-Plugins

---

This is an older repo and not supported.

Install Blocky DNS plugin on OPNsense

1. Login to OPNsense shell.
2. Execute the below two commands in OPNsense shell (either as root user or use sudo)

sudo fetch -o /usr/local/etc/pkg/repos/guru-repo.conf https://raw.githubusercontent.com/gspannu/OPNsense-Plugins/main/guru-repo.conf;
sudo pkg update -f

2. On OPNsense, login to GUI. Go to System> Firmware> Plugins and search for os-blocky

3. Install os-blocky

4. Refresh the browser page to reload OPNsense GUI

5. If Blocky is being used as the 'Primary DNS' then remember to disable Unbound/dnsmasq or setUnbound/dnsmasq listening port to something other than 53, else Blocky DNS will not execute and throw an error.

6. Goto Services, and a new entry for Blocky DNS should be available. Enable/ use as appropriate.

7. Once Blocky is confirmed working, you may configure the Blocky DNS configuration by directly editing blocky-config.yml file in /usr/local/etc/blocky/blocky-config.yml. Use something like nano /usr/local/etc/blocky/blocky-config.yml

8. On OPNsense GUI > Disable and Renable Blocky DNS

9. All errors are logged in '/var/log/blocky/blocky.log'

10. Also check that Blocky DNS is working as the primary dns resolver. In OPNsense shell, execute cat /etc/resolv.conf and it should have a nameserver entry for localhost (e.g. nameserver 127.0.0.1).

[OPNsense] router:~ $ cat /etc/resolv.conf 
domain home
nameserver 127.0.0.1
search home

OPNsense may require a restart for this to work. It is advisable to restart OPNsense and check this.

11. OPNsense made some changes recently where the primary DNS (:53) now needs to be advertised specifically by 3rd party DNS resolvers, like Blocky, AdGuardHome, etc. The plugin has been updated with this property and it shoudl work. However, it is a good idea to define the DNS server (for each affected interface) in the DHCP page of OPNsense. See below.

OPNsense GUI > Services > ISC DHCPv4 > [InterfaceName] > DNS servers. Specify the [interface IP address] address here e.g. 192.168.1.1 or 192.168.10.1. Do this for all DHCPv4 interfaces and it ensures that all clients will obtain the router IP address as DNS resolver (just in case Blocky fails to register on port 53). Read about this issue here for more details: opnsense/core#6513 (comment)

---

12. Removing os-blocky plugin

sudo rm /usr/local/etc/pkg/repos/guru-repo.conf
sudo pkg update -f

---

Happy DNS resolving and Adblocking !