Giter VIP home page Giter VIP logo

pihole-browser-extension's Introduction

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!

pihole-browser-extension's People

Contributors

badsgahhl avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pihole-browser-extension's Issues

Multi Pihole support, seperated settings

Describe the solution you'd like
At the moment it's possible to have more than 1 Pihole server but when I switch Pihole off (or on) it will switch all the Pihole server configured off. It would be great to be able to switch one off and keep the other one.

Describe alternatives you've considered
Install the Chrome extension 2x. This would be an option as well. But don't know how to do that.

Whitelist as wildcard

Is there a way you can also add the ability to whitelist domain as wildcard like we can through admin panel

No Connection

Used version: Pi-hole v5.8.1 FTL v5.13 Web Interface v5.10.1

Problem:
image

Since the update to the latest version, the switch is always grayed out. However, in the settings it says "connected".
image

Toggle switch dynamically turns on even though pihole remains on.

Describe the bug
This is more a UI bug than anything, it doesn't affect functionality and corrects itself: when Pihole is on, clicking the extension you see the toggle button go from red to green. It happens on every click.

To Reproduce
Firefox: click on icon, you can see the toggle go from red to gree.

Expected behavior
The toggle should remain in the state of the pihole system, on or off. Not dynamically shift when you open the menu item.

Desktop (please complete the following information):

  • OS: [e.g. iOS] MacOS
  • Browser [e.g. chrome, safari] Firefox
  • Version [e.g. 22] 2.1.1

Additional context

It's not a bug per-say, more a visual implementation. A "small-thing" that people would notice.

PiHole Switch zeigt falschen Status an

Describe the bug
Der Status des PiHole ist "active", aber PiHole Switch zeigt "off" an.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: macOS 12.2 beta
  • Browser: Chrome
  • Version 97.0.4692.71
  • Pi-hole v5.8.1 FTL v5.13 Web Interface v5.10.1

Additional context
PiHole Switch hat bis vor wenigen Tagen einwandfrei funktioniert, aber plötzlich wird der falsche Status angezeigt.
Wenn ich in der Erweiterung PiHole aktiviere, wird kurz "on" angezeigt, aber nach 2 Sekunden wechselt er wieder auf "off".

Ich habe Chrome auf Version 97 aktualisiert und PiHole ebenfalls aktualisiert. Ich kann nicht sagen, ob der Fehler bei einem der Updates aufgetreten ist.

pic35
pic36
pic37

No password set means no API key needed but still throws an error

v2.3.3

Describe the bug
If PiHole has no password set it will not generate an API key for the extension to use.

To Reproduce
Steps to reproduce the behaviour:
Disable the PiHole password and try to see the API key, "No password set" will be shown.
Install the extension and try to add PiHole address without providing an API key

Expected behaviour
Allow for configuration with no API key present

Feature request: Adding to whitelist should remove domain from blacklist, and vice versa

If I add a domain to the blacklist then later add it to the whitelist, or the other way round, it gets added to both lists. Then to remove it from the original list you have to open up the Pi-hole's web interface. It would be more intuitive if this extension would remove a domain from the whitelist when adding it to the blacklist, and remove it from the blacklist when adding it to the whitelist.

Support to lists

If the API allows, there might be an option to add the site to the white / black list.

White/Black list not working/appearing on PiHole v5+ behind Nginx reverse proxy

Just reporting it here in the hopes of it being fixed
I am running an older version of chrome
I have no desire to upgrade Chrome for privacy reasons
Which not so ironically is why I have PiHole.
So if it is a user error on my part then I'll live with it until I figure out what I am doing wrong.
If it is a currently unsupported use case then I'll live with it until it is supported (or not)
If all else fails I'll use the hostname or IP address of the PiHole [there's two] which, at the time of this writing I haven't tried yet.
What I am trying to say here is that I am not upgrading chrome.

Request: Set previous disable time as next time

ok, so I like this but the 10s default is too short.
If I set it to 30 or 60 or 300s is there a way for that to be "sticky" for the next time? Or an option to set a default?
thanks!! :D Love it!

Clear Chromne DNS Cache when Temporarily Disabling PiHole

Is your feature request related to a problem? Please describe.
While I can easily disable PiHole with your extension, I've found that I also need to clear DNS in Chrome to get a page to load (chrome://net-internals/#dns). It would be great if I could skip that extra step!

Describe the solution you'd like
If possible, clear the DNS cache [like I'm manually doing at chrome://net-internals/#dns] before trying to reload the page (not sure if the extension API allows you to do this or not!).

Describe alternatives you've considered
n/a

Additional context
n/a

Thanks for your consideration!

Block domain via right click menu

Is your feature request related to a problem? Please describe.
Allow blocking of domains by right clicks - e.g right clicking an ad will show a block option

Describe the solution you'd like
Right clicking content in websites will show a block domain button, to add to pihole blacklist

Describe alternatives you've considered
None

Additional context
N/A

Please add basic access authentication

Im running my pihole instance behind an basic access authentication with nginx.
With this configuration I am not able to use your plugin.

It would be nice to add the user credentials for basic access authentication.

Support for multiple Pihole's

Hi,

This extension is what I was looking for.
However I have to Pi-hole's running, and whith the plugin I can only disable 1.
So would it be possible to implement this?

Thx!

Hide PiHole Update reminder

Is your feature request related to a problem? Please describe.
People get confused by update reminder, its a very nice feature to have for the owner but not users :)

Describe the solution you'd like
Give the option to hide the reminder thing, thanks!

Disable Black/Whitelist Current URL Option

Is your feature request related to a problem? Please describe.
I want to use this for my parents, and to make sure that they can't destroy everything, i would like to have the option to disable the Black/Whitelist Current URL section.

Describe the solution you'd like
An option to disable the Black/Whitelist Current URL section. Thanks!

Plugin shows OFF

Plugin was working fine

I added Unbound to my install and now it shows as PIhole is off. If turn it on in a tab, it stays on, but all new tabs are off.

Plugin still not working

I refer here to this issue:

#54

Since unfortunately no reaction was to be noted in the last days, I open hereby a new one.

I can gladly provide any log to analyze the problem.
I have the problem on two independent PiHole instances.

Doesn't work at all

Describe the bug
Complete failure to do anything.

To Reproduce
Steps to reproduce the behavior:

  1. Fill Pi-hole's address http://pi.hole:8888/admin
  2. Fill api token correctly
  3. Try to click on the addon's red button on a random webpage
  4. Nothing happens

Expected behavior
Turn off PI-hole for a bit

Desktop (please complete the following information):
Switch for PiHole: 2.3.3
Operating System: Win32
Browser: Mozilla Firefox 92.0

Additional context
I think the error comes from the custom port 8888.

Firefox - Err on disable

On Firefox, when I click the button to disable, the icon changes from "On" to "ERR". I've configured a number of ways from the server name to the IP address of the server. I've made sure I have /admin after the server address. Still always "ERR".

Cannot change duration

Describe the bug
I cannot change the default of 10s. Whatver duration is already set (on some boxes I have previously configured 600s) I cannot change the duration anymore. Whatever duration is used, the enabling of Pihole happens after just a few seconds again.

To Reproduce
Steps to reproduce the behavior:
Try to to change the duration by entering numbers or using the up and down arrows.
If I close the popup it defaults back to 10s (or the previous value) only.
Disabling PiHole by clicking the icon => slider only lasts a few seconds, even if a much bigger time is set.

Expected behavior
Accept any time (my default is usually 600s)

Desktop (please complete the following information):

  • OS: Win 11
  • Browser: Chrome 97.0.4692.71
  • Extension: 3.0.1
  • Pihole v5.8.1

Additional context
This issue is not related to Win 11, it also happens on my Win 10 boxes.

Add-on not working when there's no web password/API key

Describe the bug
Add-on not working when there's no web password/API key

To Reproduce
Steps to reproduce the behavior:

  1. Remove the web password from the pihole config
  2. Use the add-on to disable PiHole

Expected behavior
Switch to work, instead shows "Err"

Desktop (please complete the following information):

  • OS: Win10
  • Browser Firefox
  • Version 85.0b7

Additional context
Seems to work just fine if I add a web password to the admin panel and supply the API key to the add-on. And it seems this recently broke, was working a few days ago.

Thanks for this great add-on!

Extension broken after last update

Since the Jan.9 update the extension is broken on all my chrome browsers.
I can connect to the pihole and after entering the correct API key the extension icon shows the status "Off", although the pihole webinterface indicates that the pihole is active.
Triggering the extension slider to "On" results in an on-state for about 5 seconds before going back to "Off" again.
There is no state change on the pihole itself while triggering the extension.
Alternative extensions in Firefox as well as the iOS app "Pi-hole Remote" still work without any problems.

I'm using pihole in a docker, updated to lastest version Core: v5.8.1 FTL: v5.13 Web: v5.10.1.

Auto-refresh after whitelisting

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

After adding a URL to the white list via the extension, I need to manually refresh the page. This is cumbersome when links use multiple intermediary links to get to the final URL (e.g. Slickdeals.net).

Describe the solution you'd like
A clear and concise description of what you want to happen.

After adding a URL to the whitelist via the chrome extension, it would be nice for the page to automatically reload.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Manually refreshing the page.

Additional context
Add any other context or screenshots about the feature request here.

Thanks for the extension! It's extremely useful!

Plugin Err on Firefox - Pihole Admin Panel behind Traefik and with SSO Boreale for traefik

Describe the bug
Plugin still red with Err

Expected behavior
I have my pi-hole Admin panel behind Traefik v1 Reverse Proxy and SSO Boreale (https://github.com/lewazo/boreale). I remembered during the first version of the plugin I was able to use it and one day it stopped working.

I correctly setuped the API token (no space etc..) I have the good URL with the one I access to my Pihole Admin.

Screenshots
Capture

Desktop (please complete the following information):

  • Switch for PiHole: 2.2.8
  • Operating System: Win32
  • Browser: Mozilla Firefox 78.0

Additional context
Add any other context about the problem here.

0 seconds for indefinitely dosen't work anymore

Hello there -
it seems that something was changed, because I can't temp. disable pi hole blocking with 0 seconds - every other value works.

Is there something I should check or can do to provide additional info?
Pi Hole version is the latest up to date.

Adding 2. pi.hole instance does not allow to edit URL

Describe the bug
I have a Docker instance running a pi.hole. I now added am instance running on a real Pi. When I try to add this as second instance in the browser extension by pressing (+) the URL is already populated with "http:/pi.hole/admin". In my case this is wrong as the it used by the (offline) Docker instance. Instead I must use either the IPv4 address or "pi-hole".
Here is the bug: There is no way to edit this URL field.

To Reproduce
as described above

Expected behavior
URL field for second entry should be editable, but the field is locked.

Screenshots
Browser Extension Setup

Desktop (please complete the following information):

  • OS: Windows 10 Pro x64, latest version 21H1 Build 19043.985
  • Browser: Firefox, latest version 88.0.1 x64

Thanks for your attention to this (minor) problem and BIG THANKS for the extension.
Jpp909

no longer reports "ON" only displays off

Describe the bug
The Plugin No longer works it always displays off when when in settings it says connection to PiHole Server was succesful
Not sure if a recent chrome update or Pihole update broke the connection but its affecting my chrome on all my systems, ChromeOS, Windows 10, Fedora Linux, MacOS

To Reproduce
Steps to reproduce the behavior:

  1. Pi icon shows off '...'
  2. Click on enable switch and it satys on until page refresh or change of web pages

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):
Chrome OS using Chrome Browser, Windows 10 Chrome Browser

PiHole Browser Extension: 3.0.2
Operating System: Linux x86_64
Browser: Chrome/Chromium 97.0.4692.77
Pi-hole v5.8.1 FTL v5.13 Web Interface v5.10.
Screenshot 2022-01-09 22 02 44
1

Adding Domains as wildcard

It would be usefull to add the current tabs domain to the whitelist with a wildcard for each subdomain.

Maybe this can be handles by a third button or a key combination (Strg+Click on the button etc.)

Disabled with Err

Not sure if this is a but or a problem with my system.
PiHole extension displays Err on the task bar icon.
The popup to turn it on/off is off and gray, cannot click and turn it on.
Configuration is correct. IP and API Key is entered correctly and "Connection successful Core: v5.15.3 FTL: v5.20.1 Web: v5.18.3" is displayed.

To Reproduce
See above description

Expected behavior
Expected to click and be able to turn on/off

Screenshots
image
image

Desktop (please complete the following information):

  • OS: Windows V11
  • Browser: Chrome V109
  • Pi OS: Proxmox LCX (Debian)

Additional context
I tried deleting the extension and re-adding but the problem remains.

Whitelisting crashes Pi-hole 5.2 DNS resolver

Hey,

I updated Pi-hole to version 5.2 (FTL 5.3.1 // Web Interface 5.2)
When I whitelist a website via the edge plugin, the Pi-Hole DNS resolver crashes.
I have to login via IP to Pi-Hole (pi.hole don't work) and restart the DNS resolver in the settings dialog.

API key should shown as dots, when pasted into input field

Is your feature request related to a problem? Please describe.
When I paste my piHole API key in the extension settings the key stays visible in plaintext for all other users who might using my browser and visiting the extension setting section. And everybody is able to copy/paste the key. I think this is a big security concern.

Describe the solution you'd like
I think the solution to the issue is, to change the type of the input field to "password", so that the api key is shown as dots and to stop the possibility to paste the key out of the form.

Firefox-addon-link-box: Redirects to 'de' site.

Describe the bug
When pressing the Firefox addon box in the readme.md, you will be directed to the 'de' site.

To Reproduce
Steps to reproduce the behavior:

  1. Click on it.

Expected behavior
You should be redirected to the global site, which then picks the locale.

How to fix
You can easily fix this by removing /de from the url part.

Was working properly, now isn't

I found this extension and thought it would be an easy way for my wife to disable the Pi-Hole when needed. I installed it on my laptop to test and loved it. I then installed on her laptop as well with identical settings and assumed everything was good to go. Just tried to disable now from my laptop, a couple days later, and it is not working at all. Is there a conflict when installed on multiple computers? Both computers running Chrome browsers in Windows 10.

EDIT:
I wasn't 100% accurate in my writing before I accidentally hit submit. The Pi-Hole does in fact disable, but the extension quickly reverts to on, giving the appearance that it is not disabled.

Whitelist temporarily

How hard would it be to implement third button that whitelist the current URL for the x amount of seconds specified in the time field?

Sometimes you end up clicking a link that is a redirect through some kind of tracking/ad site and you just have no other choice but go through it just this time without permanently whitelisting it.

It could simply add record to whitelist and remove it after x seconds or use the clients & groups to whitelist it only for the current device IP (this would be probably preferred). I have no idea if required API methods are available to do it the second way.

Different colours for badge

Hi! Excellent addon! Would it be possible to change the colour of the badge on the icon to e.g. "On" = green, "Off" = grey, "Err" = red?

Err with Firefox HTTPS-Only Mode

Describe the bug
Err on extension when using firefox's builtin HTTPS-Only Mode
if you disable HTTPS-Only Mode extension will function normally

To Reproduce
Steps to reproduce the behavior:

  1. Go to 'Firefox settings'
  2. Click on 'Privacy & Security on left side'
  3. Scroll down to 'HTTPS-Only Mode'
  4. Choose 'Enable HTTPS-Only Mode in all windows'
  5. Extension will then err out after some time or upon reopen

Expected behavior
Extension should function normally

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS] Windows 10
  • Browser [e.g. chrome, safari] Firefox
  • Version [e.g. 22] 84.0.2 (64-bit)

Additional context
https://support.mozilla.org/en-US/kb/https-only-prefs?as=u&utm_source=inproduct

Updating List Feature to upcoming PiHole Api Changes v5.1

In an upcoming PiHole Update the return type of adding a domain to the list of the api changes. Those changes need to be implemented to show the correct user feedback in the extension.

Also the list is now available again. This may bring the feature to only show the button in the extension depending on the current state of the list. (Maybe impossible bcs its missing the static lists added to the pihole)

Extension always displaying off (disabled)

Pi-hole v5.8.1
FTL v5.13
Web Interface v5.10.1

basically i think the call to /admin/api.php has changed, such that this extension no longer correctly see pihole as running.

Change label defaut disable time

Is your feature request related to a problem? Please describe.
It took me times to understand that the default disable time can not be lower than 10 seconds

Describe the solution you'd like
Just change the label to default disable time ( minimum value is 10 )

Two suggestions: - Context menu alternative to top bar icon / - Keyboard shortcuts

Hi,

Thanks for this extension, it's very nice!

It would be cool to have the possibility to get it in the context menu rather than in the top bar, I think it looks cleaner without any colored icons always there :)

Also, keyboard shortcuts for toggling PiHole and Adding to blacklist / whitelist would be amazing. For instance, this could even be used by a macOS touchbar custom button (with help of the amazing BetterTouchTool app)

Cheers

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.