zanix / MMM-pihole-stats

Pi-Hole stats for MagicMirror2

MMM-pihole-stats

Pi-hole stats module for MagicMirror²

Dependencies

• MagicMirror²
• Pi-hole

Installation

1. Clone this repo into ~/MagicMirror/modules directory.
   git clone https://github.com/sheyabernstein/MMM-pihole-stats.git
2. Configure your ~/MagicMirror/config/config.js:

Here is an example entry for config.js.

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

Configuring the Pi-hole server to allow CORS is no longer needed.

Configuration Options

Option	Default	Description
apiURL	http://pi.hole/admin/api.php	URL to Pi-hole admin
apiToken		API Token from Pi-hole (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