Skip to content

GNOME Shell extension for reporting local Pi Hole status

Notifications You must be signed in to change notification settings

fnxweb/gnome-shell-pi-hole

Repository files navigation

GNOME Shell Pi-Hole

GNOME Shell extension to report Pi-Hole status. Licensed under the GPL V3.

Installation

The easy way

Install it from the GNOME Extensions website.

The difficult way

Download the ZIP file (from the link above), and then install it from the GNOME Advanced Settings application's “Shell Extensions/Install Shell Extension” function.

Alternatively, unpack pi-hole@fnxweb.com as the directory ~/.local/share/gnome-shell/extensions/[email protected] alongside any other extensions you have.

Then simply restart gnome-shell with r. You may have to manually enable the extension via the advanced-settings GUI.

Main functionality

This extension polls your Pi-Hole server periodically (every 20 seconds by default), and shows the current status via its icon:

Icon Meaning
enabled Enabled
enabled Disabled
enabled Unknown / error

Its menu allows you to temporarily pause (default for 20 seconds), disable or enable the Pi-Hole.

Screenshot

This should Just Work™, at least for reporting the current status.

You can specify the pi-hole server's location, the update rate and the pause time in the extension's settings.

Screenshot

For the pause, enable and disable to work, you will need to enter the Pi-Hole API key. This can be found at http://pi.hole/admin/settings.php?tab=api under Show API token.

Diagnostics

If you have problems, edit extension.js and set Debug to true, then see what gets reported to the Errors tab of the GNOME Shell Looking-Glass, or to ~/.xsession-errors (or journalctl /usr/bin/gnome-shell). Don't forget to turn the debug back off later.

ESLint

I'm trying to use ESLint to sanity check the code so will check in some of what I think I need.

To install:

npm init @eslint/config

To run:

npx eslint [email protected]

© Neil Bird [email protected]

About

GNOME Shell extension for reporting local Pi Hole status

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages