• Stars
    star
    348
  • Rank 121,840 (Top 3 %)
  • Language Batchfile
  • Created over 4 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Ad-blocking DNS server for Windows • Unbound pre-configured • Deployment ready in minutes • Does not require hypervisor/docker

PH4WSL1.cmd  ·  Pi-hole for Windows

image

Install script to help Pi-hole run semi-natively under Windows 10/11 and Server 2019/2022 by leveraging the Windows Subsystem for Linux, renamed later to WSL1. Because WSL1 does not require a hypervisor and full Linux kernel it's the most lightweight way to run Pi-hole on Windows. Pi-hole and associated Linux binaries are visible in Task Manager right alongside your Windows apps (See Windows 11 screenshot above.)

Latest Updates for 2022-06-24

  • Gravity Sync lets you easily synchronize multiple Pi-hole instances. Run Gravity Sync.cmd and copy/paste the command into the console of another Debian or Ubuntu-based Pi-hole.
  • Less Pi-hole code is patched since upstream moved from lsof to ss for port and service checking. Now a wrapper for ss on WSL1 reformats the output of netstat.exe into something Pi-hole can work with.
  • Integrated Unbound DNS Resolver and set the default Pi-hole configuration to use encrypted DNS.
  • Updated to Debian 11
  • Fixes for Windows 11 compatibility
  • Added links in the install folder for Pi-hole System Update.cmd, Pi-hole Gravity Update.cmd, and Pi-hole Web Admin.cmd
  • Debian updates regularly with unattended-upgrades

Note

There is no endorsement or partnership between this page and Pi-hole© LLC. They deserve your support if you find this useful.

Pi-hole for Windows can be used to block ads and encrypt DNS queries for your local Windows PC or entire network. If you use it to serve DNS for your entire network, it's highly recommended you install a second Pi-hole instance on your network, and enable Gravity Sync to ensure DNS is constantly available should your Windows PCs need to reboot for any reason.

Pi-hole for Windows is a great way to upcycle old hardware. If you have a Windows PC, tablet, or HDMI stick with 1GB RAM and it can boot Windows 10 x64 you are good to go. If you don't have a Windows license, Hyper-V Server 2019 works and is a free download from Microsoft.

INSTALL INSTRUCTIONS

  1. Download the installer script -> PH4WSL1.cmd
  2. Right click the file and select "Run as Administrator."

Download and configuration steps complete in 2-15 minutes, depending on your hardware and antivirus solution. If Windows Defender is active the installation will take longer. Some users have reported issues with other antivirus products during installation.

This script performs the following steps:

  1. Enable WSL1 and install a Debian-supplied image from salsa.debian.org
  2. Download the LxRunOffline distro manager and install Debian 11 (Bullseye) in WSL1
  3. Perform interface/gateway detection and create a /etc/pihole/setupVars.conf file for automated install
  4. Run the official installer from Pi-hole©
  5. Create shim so Pi-hole gets the expected output from /bin/ss along with other fix-ups for WSL1 compatibility.
  6. Add exceptions to Windows Firewall for DNS and the Pi-hole admin page

NOTE

After the install completes, the Scheduled Task needs to be configured for auto-start at boot (before logon).

  1. Open Windows Task Scheduler (taskschd.msc) and right-click the Pi-hole for Windows task, click edit.
  2. On the General tab, place a checkmark next to both Run whether user is logged on or not and Hidden
  3. On the Conditions tab, un-check the option Start the task only if the computer is on AC power

Additional Info

  • DHCP Server is not supported and is disabled in the Pi-hole Web UI.

  • IPv6 DNS now works in addition to IPv4.

  • Default location for Pi-hole install is C:\Program Files\Pi-hole. This folder contains utilities to update or modify your Pi-hole:

  • To completely uninstall Pi-Hole, open the Pi-hole install folder in Windows Explorer. Right-click Pi-hole Uninstall.cmd and click Run As Administrator. If you are uninstalling or reinstalling and need to retain your Pi-hole's configuration, export it first via the Pi-hole Teleport feature located in the web interface.

Screenshots

Installer run

image

Install Complete

Install Complete

Install Folder Contents

Install Folder