Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/foxy999/piholewidgets

PiHole Widgets using JAVAFX
https://github.com/foxy999/piholewidgets

java javafx pi-hole pihole widget widgets

Last synced: 4 months ago
JSON representation

PiHole Widgets using JAVAFX

Host: GitHub
URL: https://github.com/foxy999/piholewidgets
Owner: foxy999
License: gpl-3.0
Created: 2022-01-13T10:55:41.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-06-04T16:57:46.000Z (over 1 year ago)
Last Synced: 2024-10-10T02:21:28.176Z (4 months ago)
Topics: java, javafx, pi-hole, pihole, widget, widgets
Language: Java
Homepage:
Size: 710 KB
Stars: 68
Watchers: 5
Forks: 7
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        

# Table of contents

- [Overview](#overview)

  * [Features](#features)

  * [Upcoming features](#upcoming-features)

- [Support ](#donation)

- [Installation](#installation)

    * [Pre-Requisites](#pre-requisites)

    * [Configuration](#configuration)

      * [Where to find the API TOKEN](#where-to-find-the-api-token)

      * [Personalize your Widget](#personalize-your-widget)

    * [Running the widget](#running-the-widget)

- [Testing ](#testing) 

- [Credits ](#credits)

- [License ](#licence)

# Overview

## Pi-Hole DNS Widget for Desktop

PiHole Widgets is a project I needed to make for my personal needs, and I decided to share it with you.

It is developed with JavaFX, and uses the framework TilesFX.

##### Screen Shots

###### Square

![img_5.png](Readme_imgs/img_5.png)

###### Horizontal

![img_7.png](Readme_imgs/img_7.png)

### Features

- Live stats from controllers servers.

- Modern widgets.

- Comes with a simple install/uninstall for Windows.

- Great summary of your controllers DNS in one place.

- Show the last blocked domain.

- Shows last time gravity was updated.

- Change visual aspects of Widget.

- Change size to your needs.

- Simple configuration.

### Upcoming features

- Support for 2 Pi-Holes.

- Beautiful Themes.

- Hide to tray option.

- Easy to install for macOS and Linux.

- Enable/Disable Pihole from widget.

# Donation

All donations are welcome and any amount of money will help me to maintain this project :)

  

  



# Installation

### Pre-Requisites

- Java 17+

- Last version of Pihole.

### Configuration

The widget automatically sets its configuration to the default pi-hole local address if that doesn't work , open the configuration interface by right clicking on the widget then click on Settings.

![img_8.png](Readme_imgs/img_8.png)

Then input your controllers IP Address/Port and API Token, and click Apply.

###### Where to find the API TOKEN

![img.png](Readme_imgs/img.png)

![img_3.png](Readme_imgs/img_3.png)

![img_4.png](Readme_imgs/img_4.png)

###### Personalize your widget

You can set your Widget size or layout by accessing the Widget configuration panel in Settings (Restart needed).

![img_10.png](Readme_imgs/img_10.png)

### Running the widget

Exe is available for **Windows**, for other OS `Gradle run` the project, or you can package it to your needs using `gradle jpackage` or whatever tool suits you.

If you want to close Widget right-click on the Widget and a contextual menu will appear giving you the option to close it or update manually.

![img_9.png](Readme_imgs/img_9.png)

# Testing

App is still in Beta, not tested enough, only ran on **Windows 10**, **Mint OS** and **Ubuntu**.

if you find any bugs or want to suggest new features please go to : https://github.com/foxy999/PiHoleWidgets/issues

# Credits



Shoutout to :

- hans0l0 for the project TilesFX.

 

- afsalashyana for the helpful Covid Widget and JavaFX Tutorials.



# Licence

Copyright (C) 2022.  Reda ELFARISSI aka foxy999

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .         

Go back to : [Table of Content](#table-of-contents)