GNOME Shell extension for reporting local Pi Hole status

Find a file

Neil Bird 64c0392af7 Use markup for bold instead of customer lables that don't always style nicely, closes #1 (& bump version)		2022-07-16 15:55:46 +01:00
images	Preliminary README	2021-03-01 16:22:41 +00:00
pi-hole@fnxweb.com	Use markup for bold instead of customer lables that don't always style nicely, closes #1 (& bump version)	2022-07-16 15:55:46 +01:00
.gitattributes	Add export ignore attributes	2021-02-23 17:38:04 +00:00
.gitignore	First mainly working with not embedded auth string	2021-02-19 17:43:41 +00:00
export-zip	update to GNOME Shell 40	2021-06-26 17:43:29 +01:00
README.md	Link to GNOME Extensions website, and add legend for the icons	2021-03-11 16:44:51 +00:00

README.md

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/pi-hole@fnxweb.com 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
	Disabled
	Unknown / error

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

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.

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.