shandro/pihole-browser-extension

Browser extension to control your pi-hole

Switch-for-PiHole

Switch-for-PiHole is a small browser extension for Chrome and Firefox. It's written with Vue and Typescript. With this extension you can control your PiHole remotely (e.g. Turning it on/off, black/white listing current tab, etc.).

Features:

• Disable your PiHole easily with one click
• Individual url to your PiHole
• Dark Mode depending on your OS Settings
• Compact UI
• Settable default disable time
• White-/Blacklist your current tabs url with one click (PiHole v5.0+)

How to use:

1. Open the popup by clicking the "Raspberry" Icon in the top navigation of your browser
2. Click on the setting wheel in the top right corner
3. Enter your host address (including http:// or https:// and the directory. You can find more info about that here)
4. Go to your PiHole settings. Click "Api/Web interface" and then on "Show Api token" at the bottom of your screen.
5. Copy the api key into the settings

Using multiple PiHole(s)

If you want to use several PiHoles please read the following information page first:

Multiple PiHoles Documentation

Troubleshooting

Status / Slider are not working

Please check that you used the correct host address. Use the address where you can see your dashboard page (statistics board). For example if your pihole is located at http://192.168.178.2, but you can see your dashboard/admin page at http://192.168.178.2/admin then don't forget to add /admin to the address.

Error after clicking the Slider (was "on" before)

This indicates that your API key is probably wrong. In the version >2.0.6 the options will show you if your key is wrong. Check that you copied the key correctly and that there are no whitespaces, etc. in it.

Black- / Whitelisting domains

The extension is able to black and whitelist the current tabs url. This feature requires PiHole v5+.
Meaning of colors:

• Red: An error occurred
• Orange: The domain wasn't added to any list (skipped)
• Green: The domain was successfully added to the list

Handling in PiHole v5:
It is only possible to add a domain to one of the lists (white and black list). This means that if you have added the domain "example.com" with the extension or manually blacklisted it, you cannot whitelist it with the extension. You will see an orange background.

Handling in PiHole v5.1:
In v5.1 the extension works as you would expect. Adding the current domain to a list will first remove the domain from the other list to keep both lists consistent.

This is not an official PiHole application.

Please use the issue templates in this repository for bugs. The main PiHole project is not responsible for any malfunction that is caused by the use of the extension!