{"id":19972743,"url":"https://github.com/thkl/homebridge-piholeoff","last_synced_at":"2025-08-03T19:39:56.246Z","repository":{"id":57265840,"uuid":"246647046","full_name":"thkl/homebridge-piholeOff","owner":"thkl","description":"Turn Your Pi-Hole off for some time using homekit","archived":false,"fork":false,"pushed_at":"2020-05-08T13:46:28.000Z","size":21,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-30T20:32:01.705Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/thkl.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}},"created_at":"2020-03-11T18:15:13.000Z","updated_at":"2022-10-02T18:11:27.000Z","dependencies_parsed_at":"2022-08-25T03:40:48.054Z","dependency_job_id":null,"html_url":"https://github.com/thkl/homebridge-piholeOff","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thkl/homebridge-piholeOff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-piholeOff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-piholeOff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-piholeOff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-piholeOff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thkl","download_url":"https://codeload.github.com/thkl/homebridge-piholeOff/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-piholeOff/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268603641,"owners_count":24276970,"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","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-11-13T03:09:05.577Z","updated_at":"2025-08-03T19:39:56.192Z","avatar_url":"https://github.com/thkl.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Homebridge Pi-hole (off Version)\n\n[Pi-hole](https://github.com/pi-hole/pi-hole) plugin for Homebridge\n\n## Requirements\n\n-   [Homebridge](https://github.com/nfarina/homebridge) - *HomeKit support for the impatient*\n-   [Pi-hole](https://github.com/pi-hole/pi-hole) - *A black hole for Internet advertisements*\n\n## Installation\n\n1.  Install this plugin `npm install -g homebridge-piholeOff`\n2.  Update your configuration file. See sample-config.json in this repository for a sample.\n\nSee the Pi-hole [installation section](https://github.com/pi-hole/pi-hole#one-step-automated-install) for more details.\n\n## Configuration\n\nThere are four options:\n\n-   `name` Required. Accessory name, default is *PiholeOff*.\n-   `auth` Pi-hole auth token.\n-   `host` Pi-hole host, default is `localhost`.\n-   `port` Pi-hole port, default is `80`.\n-   `time` Default Off time, you are able to change this in Homekit\n-   `logLevel` Logging level, three different levels: 0: logging disabled, 1: logs only HTTP errors, 2: logs each HTTP response. Default is set to 1.\n\nSee the [sample-config.json](sample-config.json) file to see an example of how to configure the accessory. \nThis plugin will do the same as the original [homebridge-pihole](https://github.com/arendruni/homebridge-pihole). It will setup a Homekit Switch. \nBut this switch has optional characteristics for the duration time.\nYou are able to set this time as a default or every time you turn on the switch (and turn off pihole). Note: the duration set time and the time the switch remains off (and the pi-hole off) is only visible in the eve app. The Apple Home App will not show you this settings. But it will turn on the switch (and turn on pi-hole) as well.\n\n## How to get a Pi-hole authentication token\n\n1.  Login into your Pi-hole Admin Console.\n2.  Navigate to the *Settings* page and then to the *API / Web interface* tab.\n3.  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*.\n4.  A new window will open showing a QR code, copy the *Raw API Token* below the QR code.\n5.  Paste your API token in the homebridge configuration file.\n\n## Licence\n\n(The MIT License)\n\nCopyright (c) 2020\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthkl%2Fhomebridge-piholeoff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthkl%2Fhomebridge-piholeoff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthkl%2Fhomebridge-piholeoff/lists"}