https://github.com/brandawg93/pi-hole-monitoring

Monitoring Pi-Hole statistics with Grafana
https://github.com/brandawg93/pi-hole-monitoring

docker docker-compose grafana influxdb pi-hole telegraf

Last synced: 6 days ago
JSON representation

Monitoring Pi-Hole statistics with Grafana

• Host: GitHub
• URL: https://github.com/brandawg93/pi-hole-monitoring
• Owner: Brandawg93
• License: mit
• Created: 2019-12-18T17:59:22.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-04T17:26:54.000Z (over 2 years ago)
• Last Synced: 2025-01-08T07:08:17.684Z (13 days ago)
• Topics: docker, docker-compose, grafana, influxdb, pi-hole, telegraf
• Language: Python
• Size: 104 KB
• Stars: 268
• Watchers: 9
• Forks: 29
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pi-Hole Monitoring with Grafana #

[![PayPal](https://img.shields.io/badge/paypal-donate-blue?logo=paypal)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=CEYYGVB7ZZ764&item_name=pi-hole-monitoring&currency_code=USD&source=url)

## 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](https://github.com/Brandawg93/Pi-Hole-Monitoring/blob/master/docker-compose.yml#L11) 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](https://github.com/Brandawg93/Pi-Hole-Monitoring/issues/6) 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`

2. Add permission to Pi User to run Docker Commands

  `sudo usermod -aG docker pi`

  

3. Reboot!

4. Test Docker installation

  `docker run hello-world`

  

5. Install dependencies

  `sudo apt-get install libffi-dev libssl-dev`

  `sudo apt-get install -y python python-pip`

  `sudo apt-get remove python-configparser`

6. Install Docker Compose

  `sudo pip install docker-compose`

  

7. Clone this repo

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

  

8. Change directory into cloned repo

  `cd Pi-Hole-Monitoring`

9. Start the stack

  `docker-compose up -d`

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

11. Type `admin` for the username and `admin` for the password

12. Set your new password

13. 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`