Skip to content
Pi-hole Dashboard for stats and more
Branch: master
Clone or download
Latest commit 347994d Feb 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update PULL_REQUEST_TEMPLATE.md Sep 27, 2017
img Removed dark logo Dec 15, 2016
scripts Merge branch 'release/v4.2' into fix/long-term-stats-datetime Jan 28, 2019
style Merge pull request #522 from Th3M3/clean_up_style-rules May 29, 2018
.gitignore
.pullapprove.yml
.user.php.ini Add ini file to modify PHP settings for this folder Dec 28, 2016
CONTRIBUTING.md Update CONTRIBUTING.md Sep 27, 2017
LICENSE [Staging] 3.1 (#514) Jun 20, 2017
README.md update broken referral link Oct 25, 2018
api.php
api_FTL.php Merge pull request #830 from pi-hole/new/cacheinfo Aug 30, 2018
api_db.php Change spaces to tabs in bugfix Nov 7, 2018
auditlog.php Move script tags inside html tag Nov 10, 2018
db_graph.php Move script tags inside html tag Nov 10, 2018
db_lists.php Move script tags inside html tag Nov 10, 2018
db_queries.php Move script tags inside html tag Nov 10, 2018
debug.php Move script tags inside html tag Nov 10, 2018
gravity.php Move script tags inside html tag Nov 10, 2018
help.php
index.php Move script tags inside html tag Nov 10, 2018
list.php Merge pull request #865 from pi-hole/fix/script-outside-html Dec 10, 2018
queries.php
queryads.php Move script tags inside html tag Nov 10, 2018
settings.php
taillog-FTL.php Move script tags inside html tag Nov 10, 2018
taillog.php Move script tags inside html tag Nov 10, 2018

README.md

Pi-hole

Network-wide ad blocking via your own Linux hardware

Pi-hole Web interface

Pi-hole®'s Web interface (based off of AdminLTE) provides a central location to manage your Pi-hole and review the statistics generated by FTLDNS.

  • Easy-to-interpret: simple graphs and beautiful colors make Pi-hole's stats easy to understand
  • Responsive: looks great on desktop, tablets, and mobile devices
  • Useful: control and configure your Pi-hole with our settings
  • Insightful: use the query log, audit log, or long-term stats to gain insight into your networks activity


Installation

The Web interface is enabled by default when you install Pi-hole.

Post-installation: access the Web interface and gain insight into your network's activity

There are several ways to access the dashboard:

  1. http://<IP_ADDPRESS_OF_YOUR_PI_HOLE>/admin/
  2. http:/pi.hole/admin/ (when using Pi-hole as your DNS server)
  3. http://pi.hole/ (when using Pi-hole as your DNS server)

Once logged in (forgot your password?), you can view your network stats to see things like:

  • the domains being queried on your network
  • the time the queries were initiated
  • the amount of domains that were blocked
  • the upstream server queries were sent to
  • the type of queries (A, AAAA, CNAME, SRV, TXT, etc.)

Pi-hole is free, but powered by your support

There are many reoccurring costs involved with maintaining free, open source, and privacy respecting software; expenses which our volunteer developers pitch in to cover out-of-pocket. This is just one example of how strongly we feel about our software, as well as the importance of keeping it maintained.

Make no mistake: your support is absolutely vital to help keep us innovating!

Donations

Sending a donation using our links below is extremely helpful in offsetting a portion of our monthly expenses:

Alternative support

If you'd rather not donate (which is okay!), there are other ways you can help support us:

Contributing via GitHub

We welcome everyone to contribute to issue reports, suggest new features, and create pull requests.

If you have something to add - anything from a typo through to a whole new feature, we're happy to check it out! Just make sure to fill out our template when submitting your request; the questions that it asks will help the volunteers quickly understand what you're aiming to achieve.

Presentations about Pi-hole

Word-of-mouth continues to help our project grow immensely, and so we are helping make this easier for people.

If you are going to be presenting Pi-hole at a conference, meetup or even a school project, get in touch with us so we can hook you up with free swag to hand out to your audience!


Getting in touch with us

While we are primarily reachable on our Discourse User Forum, we can also be found on a variety of social media outlets. Please be sure to check the FAQ's before starting a new discussion, as we do not have the spare time to reply to every request for assistance.

Features

Mobile friendly interface

Mobile friendly

Password protection

Password protection

Detailed graphs and doughnut charts

Pie charts

Top lists of domains and clients

Top domains/top clients

A filterable and sortable query log

Query log

An audit log

Pi-hole Web interface

Long Term Statistics to view data over user defined time ranges

Long-term stats

A built-in debugger

Debugger

Black and white lists

Blacklist

Whitelist

The ability to easily manage and configure Pi-hole features

Settings

... and all the main features of the Command Line Interface!

Tail the log

Query ad lists

API

Full usage available here. can be accessed at /admin/api.php. With either no parameters or /admin/api.php?summary it returns the following JSON:

{  
   "domains_being_blocked":243038,
   "dns_queries_today":2385,
   "ads_blocked_today":414,
   "ads_percentage_today":17.35849,
   "unique_domains":429,
   "queries_forwarded":1537,
   "queries_cached":434,
   "clients_ever_seen":5,
   "unique_clients":5,
   "status":"enabled"
}

There are many more parameters, such as:

  • type & version
  • summaryRaw
  • summary
  • overTimeData10mins
  • topItems
  • getQuerySources
  • getForwardDestinations
  • getQueryTypes
  • getAllQueries
  • enable
  • disable
  • recentBlocked

Together with a token it is also possible to enable and disable (also with a set timeout) blocking via the API.

The API returns more information (in a slightly different format if FTL is running) - it supports a fall-back to the "old" PHP API if FTL is not running. Test the type and/or version of the API by using the parameter type and version.

You can’t perform that action at this time.