qusal/salt/sys-pihole
Ben Grande 224312ed42
feat: enable all optional shellcheck validations
Make shell a little bit safer with:

- add-default-case
- check-extra-masked-returns
- check-set-e-suppressed
- quote-safe-variables
- check-unassigned-uppercase

Although there are some stylistic decisions for uniformity:

- avoid-nullary-conditions
- deprecated-which
- require-variable-braces
2024-07-10 14:36:05 +02:00
..
files feat: enable all optional shellcheck validations 2024-07-10 14:36:05 +02:00
appmenus.sls refactor: initial commit 2023-11-13 14:33:28 +00:00
appmenus.top refactor: initial commit 2023-11-13 14:33:28 +00:00
configure-browser.sls refactor: prefer systemd sockets over socat 2024-06-25 22:16:26 +02:00
configure-browser.top refactor: initial commit 2023-11-13 14:33:28 +00:00
create.sls refactor: prefer systemd sockets over socat 2024-06-25 22:16:26 +02:00
create.top refactor: initial commit 2023-11-13 14:33:28 +00:00
init.top refactor: initial commit 2023-11-13 14:33:28 +00:00
install.sls feat: bump Pi-Hole version 2024-07-07 15:26:52 +02:00
install.top refactor: initial commit 2023-11-13 14:33:28 +00:00
prefs.sls chore: copyright update 2024-01-29 16:49:54 +01:00
prefs.top refactor: initial commit 2023-11-13 14:33:28 +00:00
README.md doc: lint markdown files 2024-07-04 17:27:31 +02:00
version fix: generate RPM Specs for Qubes Builder V2 2024-06-21 17:00:06 +02:00

sys-pihole

Pi-hole DNS Sinkhole in Qubes OS.

Table of Contents

Description

The package will create a standalone qube "sys-pihole". It blocks advertisements and internet trackers by providing a DNS sinkhole. It is a drop in replacement for sys-firewall.

The qube will be attached to the "netvm" of the "default_netvm", in other words, if you are using Qubes OS default setup, it will use "sys-net" as the "netvm", else it will try to figure out what is your upstream link and attach to it.

Installation

Pi-Hole commits and tags are not signed by individuals, but as they are done through the web interface, they have GitHub Web-Flow signature. This is the best verification we can get for Pi-Hole. If you don't trust the hosting provider however, don't install this package.

  • Top:
sudo qubesctl top.enable sys-pihole browser
sudo qubesctl --targets=tpl-browser,sys-pihole-browser,sys-pihole state.apply
sudo qubesctl top.disable sys-pihole browser
sudo qubesctl state.apply sys-pihole.appmenus
  • State:
sudo qubesctl state.apply sys-pihole.create
sudo qubesctl --skip-dom0 --targets=tpl-browser state.apply browser.install
sudo qubesctl --skip-dom0 --targets=sys-pihole state.apply sys-pihole.install
sudo qubesctl --skip-dom0 --targets=sys-pihole-browser state.apply sys-pihole.configure-browser
sudo qubesctl state.apply sys-pihole.appmenus

If you want to change the global preferences updatevm and default_netvm and the per-qube preference netvm of all qubes from sys-firewall to sys-pihole, run:

sudo qubesctl state.apply sys-pihole.prefs

Usage

Web interface

If you want to view statistics or manage the server through a GUI, open sys-pihole or sys-pihole-browser desktop file pihole-browser.desktop from the app menu. Addresses starting with http or https will be redirected to sys-pihole-browser.

Pi-hole will be installed with the following settings:

  • The DNS provider is Quad9 (filtered, DNSSEC)
  • Steven Black's Unified Hosts List is included
  • Query logging is enabled to show everything.

Torified Pi-Hole

If you want to combine Pi-Hole with Tor, then you should reconfigure your netvm chaining (will break tor's client stream isolation) as such:

  • qube -> sys-pihole -> Tor-gateway -> sys-firewall -> sys-net

Local DNS server

If you want sys-pihole to use itself to resolve DNS queries, enable the service local-dns-server from Dom0 to sys-pihole:

qvm-features sys-pihole service.local-dns-server 1

Don't forget to restart sys-pihole after the changes.

Note that if Pi-hole as a problem the host will not not be able to reach the internet for updates, syncing time etc.

DNS issues after netvm restart

If you encounter problems with DNS after having upstream netvm route changes, restart Pi-hole DNS from sys-pihole:

pihole restartdns

Credits