Coder Social home page Coder Social logo

piholelcdstat's Introduction

piHoleLCDStat

A Pi-Hole + System Info dash for Raspberry Pi

Screenshots

Built with JavaFX, Java

This program uses the Pi-Hole Telnet API and NOT THE JSON API

How to install?

  1. Download the latest zip from releases.
  2. Run unzip piHoleLCDStat.zip (Make sure you're in the same director)
  3. Then cd piHoleLCDStat
  4. Run ./install, to install necessary fonts and run config.

How to use?

  1. cd into the same directory where piHoleLCDStat.zip was extracted
  2. Run ./piHoleLCDStat

How to change Settings

  1. cd into the same directory where piHoleLCDStat.zip was extracted
  2. Run ./piHoleLCDStat_edit_config

Currently the following settings/preferences can be changed :

  • Debug Mode - Just prints some debug output to the console. Use if you encounter some issues, and then create an issue if you cant get rid of the problem
  • Pane Changer Mode - Changes the current screen after certain interval. Recommended for non-touch screens.
  • Screen Height, Screen Width
  • PiHole Telnet IP and Port
  • Font Size
  • goodColour - Colour of gauges when Pi-Hole blocking is enabled.
  • badColour - Colour of gauges when Pi-Hole blocking is disabled.
  • piHoleStatsFetcherSleep - Change sleep terminal between Pi-Hole data fetched.
  • systemStatsFetcherSleep - Change sleep terminal between System info fetched.
  • paneChangerTaskSleep - Change sleep terminal between change of Pane (Works only if Pane Changer mode is enabled).
  • Top Domains List Limit - No of Top Allowed Domains to be shown
  • Top Clients List Limit - No of Top Clients to be shown
  • Top Ads List Limit - No of Top Blocked Advertisements to be shown

Run at Startup

rc.local method

  1. Open /etc/rc.local as root.
  2. Just before exit 0 add the following lines
cd <piHoleLCDStat extracted Directory>
./piHoleLCDStat

bashrc method

  1. Open ~/.bashrc.
  2. Add the following lines at the end of file
cd <piHoleLCDStat extracted Directory>
./piHoleLCDStat

This method is not recommeneded as ~/.bashrc runs every time an SSH connection is made to the Pi. You can use Ctrl+C to always quit when a new piHoleLCDStat instance is made.

Libraries Used

License

GNU GPL v3

piholelcdstat's People

Contributors

rnayabed avatar

Watchers

James Cloos avatar

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.