Stars: 1764
Forks: 535
Pull Requests: 1935
Issues: 743
Watchers: 85
Last Updated: 2023-09-16 13:20:44
Pi-hole Dashboard for stats and more
License: Other
Languages: PHP, JavaScript, CSS
Network-wide ad blocking via your own Linux hardware
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™.
The Web interface is enabled by default when you install Pi-hole.
There are several ways to access the dashboard:
http://<IP_ADDRESS_OF_YOUR_PI_HOLE>/admin/
http://pi.hole/admin/
(when using Pi-hole as your DNS server)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:
A
, AAAA
, CNAME
, SRV
, TXT
, etc.)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!
Sending a donation using our links below is extremely helpful in offsetting a portion of our monthly expenses:
If you'd rather not donate (which is okay!), there are other ways you can help support us:
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.
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!
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.
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
.