/Pi-Hole-Monitoring

Monitoring Pi-Hole statistics with Grafana

Primary LanguagePythonMIT LicenseMIT

Pi-Hole Monitoring with Grafana

PayPal

Overview

This package was built for the sole purpose of making the installation of grafana, telegraf, and influxdb to monitor a Pi-Hole instance as painless as possible. Typically, a user would need lots of setup on each package in order to correctly monitor Pi-Hole. This package does as much as possible for you. No installing each package, no exposing ports on your machine, and no searching for hours on how to build and copy grafana dashboards. It's all already included here. Just follow the instructions below and enjoy!

Example Dashboards

Prerequisites

  • You need a working copy of Pi-Hole with its pihole-FTL.db file located at /etc/pihole/ (i.e. this doesn't work out-of-the-box with Pi-Hole Docker containers or special installations). If your Pi-Hole instance is not located there, simply edit this line of code to point to the pihole-FTL.db.

  • You need to be able to view the Pi-Hole admin page at http://pi.hole/admin.

Known Issues

  • This project will not work on any lite versions of raspbian. The lite versions do not come with all the necessary files to run the stack. See this issue for more details.

Instructions

(If you have already installed docker-compose skip to step 7.)

  1. Install Docker

curl -sSL https://get.docker.com | sh

  1. Add permission to Pi User to run Docker Commands

sudo usermod -aG docker pi

  1. Reboot!

  2. Test Docker installation

docker run hello-world

  1. Install dependencies

sudo apt-get install libffi-dev libssl-dev

sudo apt-get install -y python python-pip

sudo apt-get remove python-configparser

  1. Install Docker Compose

sudo pip install docker-compose

  1. Clone this repo

git clone https://github.com/Brandawg93/Pi-Hole-Monitoring.git

  1. Change directory into cloned repo

cd Pi-Hole-Monitoring

  1. Start the stack

docker-compose up -d

  1. Go to http://host_ip:3000 (where host_ip is the ip of the machine running the stack)

  2. Type admin for the username and admin for the password

  3. Set your new password

  4. Done!

Updating

This is an ongoing project that may be updated frequently. If you would like the update your instance of Pi-Hole Monitoring, simply run the following commands:

docker-compose down

git pull origin master

docker-compose up -d