Last Updated:

Easily Toggle Pi-hole Service On/Off

S.C.O.R.E.ConvenienceDevice Control

Overview

The new feature in Pi-hole allows users to quickly enable or disable the ad-blocking service with a simple switch. This enhances user control over network settings, particularly for troubleshooting or when certain sites need to be accessed without filtering.

Convenience icon

Benefits

  • Quickly troubleshoot network issues by disabling ad-blocking temporarily.
  • Easily allow access to specific websites that may be blocked without removing them from the blocklist.
  • Provide convenience for guests who may need unrestricted internet access.

Intent

This capability aims to provide users with a straightforward method to manage their Pi-hole service. It allows for immediate changes in service status, improving the overall user experience and flexibility in network management.

Preconditions

  • Pi-hole software installed and configured on a compatible device.
  • Access to the Pi-hole admin dashboard through a web browser.
  • Home network is operational with internet access.
  • Home Assistant installed and configured.
  • Integration available and authenticated: UniFi.
  • Device installed and reachable: Synology 1621+ Network Attached Storage (NAS).

Actors

  • Homeowner
  • Family member
  • Guest

Trigger

User interacts with the Pi-hole admin dashboard to toggle the service switch.

Workflow Diagram

flowchart TD
    A[User toggles switch] -->|check status| B{{Is Pi-hole running?}}
    B -->|Yes| C[Disable Pi-hole service]
    C --> D[Service is now OFF]
    B -->|No| E[Enable Pi-hole service]
    E --> D[Service is now ON]

Workflow Description

1. Access Pi-hole Dashboard

User navigates to the Pi-hole admin interface through a web browser.

2. Locate Service Switch

User finds the toggle switch that controls the Pi-hole service status.

3. Toggle Service

User clicks the switch to either enable or disable the Pi-hole service.

4. Confirm Status Change

The interface updates to reflect the current status of the Pi-hole service.

5. Test Network Access

User can now verify if the network behavior has changed based on the new service status.

Postconditions

The Pi-hole service is either enabled or disabled based on user action, allowing for immediate effects on network traffic.

Optional Enhancements

  • Add a notification feature to alert users when the service status changes.
  • Implement a scheduled capability to toggle the service based on time or usage patterns.
  • Provide detailed logs of service status changes for troubleshooting.

Recommended Components

Recommended ApplicationsRecommended IntegrationsRecommended Devices
Home AssistantUniFi, Zigbee2MQTTSynology 1621+ Network Attached Storage (NAS), Smart Switch Lights

Source Examples