MMM-pihole-stats

Pi-hole stats module for MagicMirror².

Screenshots

With config.showSources enabled:

Preview-Sources

Without config.showSources enabled:

Preview

Dependencies

Installation

Clone this repo into ~/MagicMirror/modules directory. git clone https://github.com/sheyabernstein/MMM-pihole-stats
Obtain an API token from your PiHole installation by navigating to http://pi.hole/admin/settings.php?tab=api and clicking Show API token
Configure your ~/MagicMirror/config/config.js

Feb 28, 2024: The port config option has been removed. The apiURL should now be an absolute URL, including the port and protocol.

Here is an example entry for config.js with Pi-hole at 192.168.0.10 and port 8000:

{
    module: "MMM-pihole-stats",
    position: "top_left", // Or any valid MagicMirror position.
    config: {
      apiURL: "http://192.168.0.10:8000/admin/api.php",
      apiToken: "0123456789abcdef",
      // See 'Configuration options' for more information.
    }
},

Configuration Options

Option	Default	Description
`apiURL`	`http://pi.hole/admin/api.php`	Absolute URL to Pi-hole admin API, including HTTP protocol and port
`apiToken`		Pi-hole API Token (required for `showSources`)
`showSources`	`true`	Show request sources (clients)
`sourcesCount`	`10`	Number of returned entries for `showSources`
`showSourceHostnameOnly`	`true`	Only show hostname if applicable without showing IP address
`updateInterval`	`600000`	Time in ms to wait until updating
`retryDelay`	`30000`	Time in ms to wait before retry
`floatingPoints`	`2`	Format floating point numbers to decimal points, e.g. `2` to format to 5.55. Setting this to `0` will show unlimited decimal points

Contributing

Thank you for considering contributing to this project! To maintain a consistent and high-quality codebase, we ask contributors to follow these guidelines:

Development Setup

Install dependencies:
```
npm install --with=dev
```
Install Git hooks:
```
npm run install-hooks
```

Making Changes

Please make sure to create a new branch for your changes:
```
git checkout -b feature-branch
```
All changes should be made in your feature branch, not directly in the master branch.

Submitting Changes

Pull Requests (PRs):

Fork the repository and create a new branch for your changes.
Make your changes and test them thoroughly.
Submit a pull request to the master branch of the original repository.
Ensure your pull request passes all automated checks.

Important Notes

No Direct Pushes:

Do not push changes directly to the master branch.
All changes must be made via a pull request.

Continuous Integration (CI):

Make sure your changes pass all CI checks before submitting a pull request.

sheyabernstein / MMM-pihole-stats

readme