Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/desktopecho/pi-hole-for-wsl1
Ad-blocking DNS server for Windows • Unbound pre-configured • Deployment ready in minutes • Does not require hypervisor/docker
https://github.com/desktopecho/pi-hole-for-wsl1
dns pi-hole pihole privacy unbound-dns wsl wsl1
Last synced: about 22 hours ago
JSON representation
Ad-blocking DNS server for Windows • Unbound pre-configured • Deployment ready in minutes • Does not require hypervisor/docker
- Host: GitHub
- URL: https://github.com/desktopecho/pi-hole-for-wsl1
- Owner: DesktopECHO
- Created: 2020-06-05T04:12:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T08:34:26.000Z (22 days ago)
- Last Synced: 2024-09-26T13:02:12.507Z (about 22 hours ago)
- Topics: dns, pi-hole, pihole, privacy, unbound-dns, wsl, wsl1
- Language: Batchfile
- Homepage:
- Size: 246 MB
- Stars: 350
- Watchers: 13
- Forks: 53
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PH4WSL1.cmd · Pi-hole for Windows
Install script to help [Pi-hole](https://github.com/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.)
- Brief [walk-through video](https://youtu.be/keDtJwK65Dw) of the install process on YouTube
- Jump to [Install Instructions](#INSTALL-INSTRUCTIONS)
## Latest Updates for 2022-06-24
- [**Gravity Sync**](https://github.com/vmstan/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**](https://www.nlnetlabs.nl/projects/unbound/about) 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](https://wiki.debian.org/UnattendedUpgrades)
## Note
There is no endorsement or partnership between this page and [**Pi-hole© LLC**](https://pi-hole.net). They deserve [your support](https://pi-hole.net/donate/) 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](https://en.wikipedia.org/wiki/Upcycling) 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](https://www.microsoft.com/en-us/evalcenter/evaluate-hyper-v-server-2019) from Microsoft.
# INSTALL INSTRUCTIONS
1. **Download** the installer script -> [**PH4WSL1.cmd**](https://github.com/DesktopECHO/Pi-Hole-for-WSL1/raw/master/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](https://github.com/DesktopECHO/Pi-Hole-for-WSL1/issues/14) during installation.
## This script performs the following steps:
1. Enable WSL1 and install a Debian-supplied image from [**salsa.debian.org**](https://salsa.debian.org/debian/WSL/-/raw/master/x64/install.tar.gz)
2. Download the [**LxRunOffline**](https://github.com/DDoSolitary/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](https://github.com/pi-hole/pi-hole/#one-step-automated-install) 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:
- `Pi-hole System Update` 🠞 [_pihole -up_](https://docs.pi-hole.net/core/pihole-command/#update)
- `Pi-hole Configuration` 🠞 [_pihole -r_](https://docs.pi-hole.net/core/pihole-command/#reconfigure)
- `Pi-hole Gravity Update` 🠞 [_pihole updateGravity_](https://docs.pi-hole.net/core/pihole-command/#gravity)
* 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](https://docs.pi-hole.net/core/pihole-command/?h=teleport#teleport) feature located in the web interface.
# Screenshots
## Installer run
## Install Complete
## Install Folder Contents
