{"id":13830618,"url":"https://github.com/sheyabernstein/MMM-pihole-stats","last_synced_at":"2025-07-09T12:30:42.645Z","repository":{"id":13977269,"uuid":"75659725","full_name":"sheyabernstein/MMM-pihole-stats","owner":"sheyabernstein","description":"Pi-Hole stats for MagicMirror2","archived":false,"fork":false,"pushed_at":"2024-03-11T20:10:25.000Z","size":182,"stargazers_count":72,"open_issues_count":0,"forks_count":16,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-04T10:03:29.989Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sheyabernstein.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-05T19:40:16.000Z","updated_at":"2024-08-04T10:03:34.210Z","dependencies_parsed_at":"2024-01-15T17:39:14.457Z","dependency_job_id":"263ae1b7-8cd2-4837-b383-976eb0fc0f5b","html_url":"https://github.com/sheyabernstein/MMM-pihole-stats","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sheyabernstein%2FMMM-pihole-stats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sheyabernstein%2FMMM-pihole-stats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sheyabernstein%2FMMM-pihole-stats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sheyabernstein%2FMMM-pihole-stats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sheyabernstein","download_url":"https://codeload.github.com/sheyabernstein/MMM-pihole-stats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225539458,"owners_count":17485337,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T10:01:03.163Z","updated_at":"2025-07-09T12:30:42.633Z","avatar_url":"https://github.com/sheyabernstein.png","language":"JavaScript","funding_links":[],"categories":["Hardware"],"sub_categories":[],"readme":"# MMM-pihole-stats\n\nPi-hole stats module for MagicMirror².\n\n\u003e :warning: **Pi-Hole v6 Breaking Changes**: Pi-hole v6 has revamped its API. The module now uses a REST-based authentication flow and updated endpoints to fetch accurate statistics from your Pi-hole instance. Please update your configuration accordingly. Thanks [@ChrisF1976](https://github.com/ChrisF1976).\n\n## Screenshots\n\nWith `config.showSources` enabled:\n\n![Preview-Sources](docs/preview-showSources.png \"Screen Shot (with Sources)\")\n\nWithout `config.showSources` enabled:\n\n![Preview](docs/preview.png \"Screen Shot\")\n\n## Dependencies\n\n- [MagicMirror²](https://github.com/MagicMirrorOrg/MagicMirror)\n- [Pi-hole](https://pi-hole.net)\n\n## Installation\n\n1. Clone this repo into `~/MagicMirror/modules` directory.\n   `git clone https://github.com/sheyabernstein/MMM-pihole-stats`\n2. Obtain your Pi-Hole password or create an app password.\n3. Configure your `~/MagicMirror/config/config.js`.\n\nHere is an example entry for `config.js`:\n\n```js\n{\n    module: \"MMM-pihole-stats\",\n    position: \"top_left\", // Or any valid MagicMirror position.\n    config: {\n      apiURL: \"http://pi.hole/api\",\n      apiKey: \"your pi.hole password or app password\",\n      // See 'Configuration options' for more information.\n    }\n},\n```\n\n## Configuration Options\n\n| **Option**               | **Default**          | **Description**                                                                                                                     |\n| ------------------------ | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `apiURL`                 | `http://pi.hole/api` | Absolute URL to Pi-hole API, including HTTP protocol and port                                                                       |\n| `apiKey`                 |                      | Pi-hole password or app password                                                                                                    |\n| `showSources`            | `true`               | Show request sources (clients)                                                                                                      |\n| `sourcesCount`           | `10`                 | Number of returned entries for `showSources`                                                                                        |\n| `showSourceHostnameOnly` | `true`               | Only show hostname if applicable without showing IP address                                                                         |\n| `updateInterval`         | `600000`             | Time in ms to wait until updating                                                                                                   |\n| `retryDelay`             | `30000`              | Time in ms to wait before retry                                                                                                     |\n| `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 |\n\n## Contributing\n\nThank you for considering contributing to this project! To maintain a consistent and high-quality codebase, we ask contributors to follow these guidelines:\n\n### Development Setup\n\n1. Install dependencies:\n    ```bash\n    npm install --with=dev\n    ```\n2. Install Git hooks:\n    ```bash\n    npm run install-hooks\n    ```\n\n### Making Changes\n\n- Please make sure to create a new branch for your changes:\n    ```bash\n    git checkout -b feature-branch\n    ```\n- All changes should be made in your feature branch, not directly in the `master` branch.\n\n### Submitting Changes\n\n#### Pull Requests (PRs):\n\n- Fork the repository and create a new branch for your changes.\n- Make your changes and test them thoroughly.\n- Submit a pull request to the master branch of the original repository.\n- Ensure your pull request passes all automated checks.\n\n### Important Notes\n\n#### No Direct Pushes:\n\n- Do not push changes directly to the master branch.\n- All changes must be made via a pull request.\n\n#### Continuous Integration (CI):\n\n- Make sure your changes pass all CI checks before submitting a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsheyabernstein%2FMMM-pihole-stats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsheyabernstein%2FMMM-pihole-stats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsheyabernstein%2FMMM-pihole-stats/lists"}