Homebridge Pi-hole
Pi-hole plugin for Homebridge
Requirements
- Homebridge - HomeKit support for the impatient
- Pi-hole - A black hole for Internet advertisements
Installation
- Install this plugin
npm install -g homebridge-pihole
- Update your configuration file. See sample-config.json in this repository for a sample.
See the Pi-hole installation section for more details.
Configuration
There are only three required options:
name
Accessory name, defautl is Pihole.auth
Pi-hole auth token.host
Pi-hole host, default islocalhost
.
See the sample-config.json file to see an example of working accessory config.
How to get a Pi-hole authentication token
- Login into your Pi-hole Admin Console.
- Navigate to the Settings page and then to the API / Web interface tab.
- At the bottom of the page click on the Show API Token button, a popup window will ask for confirmation, go ahead and click on Yes, show API token.
- A new window will open showing a QR code, copy the Raw API Token below the QR code.
- Paste your API token in the homebridge configuration file.
Licence
(The MIT License)
Copyright (c) 2019
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.