Skip to content

BloodAkatsuki/InkyPi-AdGuardHome

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

InkyPi AdGuard Home Plugin

An InkyPi plugin that displays live statistics from your AdGuard Home DNS ad blocker on your e-ink display.

Screenshot

Features

  • Protection status badge (enabled / disabled)
  • Total queries, blocked queries and block rate with progress bar
  • Safe Browsing, Safe Search and Parental Control counters
  • Blocklist rule count
  • Top 5 clients by query volume
  • 24-hour query history chart (allowed vs. blocked)
  • Customizable bar colors (blocked queries color, total queries bar background)
  • Each section can be toggled on or off individually

APIs Used

  • AdGuard Home REST API — built-in HTTP API, no external service or API key required.
    • GET /control/status — protection state and version
    • GET /control/stats — query statistics, top clients, 24h history
    • GET /control/filtering/status — blocklist rule count
  • Authentication via HTTP Basic Auth (username + password configured in settings).
  • Works with both IP addresses and domain names (including HTTPS with self-signed certificates, e.g. via Nginx Proxy Manager).

Requirements

  • AdGuard Home v0.107 or later

Installation

Run the following command on your Raspberry Pi:

inkypi plugin install adguard_home https://github.com/BloodAkatsuki/InkyPi-AdGuardHome

Configuration

Setting Description
URL AdGuard Home address, e.g. http://192.168.1.1, http://192.168.1.1:3000 or https://adguard.example.com
Username AdGuard Home login username
Password AdGuard Home login password
Blocked queries color Color for blocked bars, text and progress fill (default: red #c62828)
Total queries bar color Background color of total query bars in the chart (default: gray #cccccc)
Display options Toggle each dashboard section individually

Status

Actively maintained.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published