/pihole-browser-extension

Browser extension to control your pi-hole

Primary LanguageTypeScriptMIT LicenseMIT

PiHole Browser Extension t

Chrome Web Store Mozilla Add-on Chrome Web Store Mozilla Add-on GitHub

The PiHole Browser Extension 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.) .


chrome Firefox Logo

Features:

  • Disable your PiHole(s) easily with one click
  • Individual configuration for multiple PiHoles
  • White-/Blacklist your current tabs url with one click
  • Shortcuts - Use features quickly with a hotkey shortcut or pages context menu
  • Connection checker within the settings

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.
  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

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. The connection checker will show you if your given address is valid.

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.1+.

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!