Help center

Header

Top left: Status display

Shows different status messages:

Status: Current status of the Pi-hole - Active (), Offline (), or Starting ()
Temp: Current CPU temperature (switch unit to Fahrenheit) (switch unit to Celsius)
Load: load averages for the last minute, 5 minutes and 15 minutes, respectively. A load average of 1 reflects the full workload of a single processor on the system. We show a red icon if the current load exceeds the number of available processors on this machine (which is )
Memory usage: Shows the percentage of memory actually blocked by applications. We show a red icon if the memory usage exceeds 75%

Top right: About

GitHub: Link to the Pi-hole repository
Details: Link to Jacob Salmela's blog with some more details, describing also the concept of the Pi-hole
Updates: Link to list of releases
Update notifications: If updates are available, a link will be shown here.
Session timer: Shows the time remaining until the current login session expires.

Main page

On the main page, you can see various Pi-hole statistics:

Summary: A summary of statistics showing how many total DNS queries have been blocked today, what percentage of DNS queries have been blocked, and how many domains are in the compiled ad list. This summary is updated every 10 seconds.
Queries over time: Graph showing DNS queries (total and blocked) over 10 minute time intervals. More information can be acquired by hovering over the lines. This graph is updated every 10 minutes.
Query Types: Identifies the types of processed queries:
- A: address lookup (most commonly used to map hostnames to an IPv4 address of the host)
- AAAA: address lookup (most commonly used to map hostnames to an IPv6 address of the host)
- PTR: most common use is for implementing reverse DNS lookups
- SRV: Service locator (often used by XMPP, SIP, and LDAP)
- and others
Query Types: Shows to which upstream DNS the permitted requests have been forwarded to.
Top Domains: Ranking of requested sites by number of DNS lookups.
Top Advertisers: Ranking of requested advertisements by number of DNS lookups.
Top Clients: Ranking of how many DNS requests each client has made on the local network.

Note that the login session does not expire on the main page, as the summary is updated every 10 seconds which refreshes the session.

Query Log

Shows the recent queries by parsing Pi-hole's log. It is possible to search through the whole list by using the "Search" input field. If the status is reported as "OK", then the DNS request has been permitted. Otherwise ("Pi-holed") it has been blocked. By clicking on the buttons under "Action" the corresponding domains can quickly be added to the white-/blacklist. The status of the action will be reported on this page.

White- / Blacklist

Add or remove domains (or subdomains) from the white-/blacklist. If a domain is added to e.g. the whitelist, any possible entry of the same domain will be automatically removed from the blacklist and vice versa. Adding wildcards using the web UI is currently not supported.

Update Lists

Will download any updates from the third-party ad-serving domain lists that we source. By default, this command runs once a week via cron.

Query adlists

This function is useful to find out what list a domain appears on. Since we don't control what the third-parties put on the block lists, you may find that a domain you normally visit stops working. If this is the case, you could run this command to scan for strings in the list of blocked domains and it will return the list the domain is found on. This proved useful a while back when the Mahakala list was adding apple.com and microsoft.com to their block list.

Disable / Enable

Disables/enables Pi-Hole blocking completely. You may have to wait a few minutes for the changes to reach all of your devices. The change will be reflected by a changed status (top left)

Donate

Keep in mind that Pi-hole is free. If you like Pi-hole, please consider a small donation to help support its development

Help (this page)

Shows information about what is happening behind the scenes and what can be done with this web user interface (web UI). The Help center will show details concerning the authentication system only if it is enabled

Authentication system (currently enableddisabled)

Using the command

sudo pihole -a -p pa22w0rd

where pa22w0rd is the password to be set in this example, one can enable the authentication system of this web interface. Thereafter, a login is required for most pages (the main page will show a limited amount of statistics). Note that the authentication system may be disabled again, by setting an empty password using the command shown above. The Help center will show more details concerning the authentication system only if it is enabled

Login / Logout

Using the Login / Logout function, a user can initiate / terminate a login session. The login page will also always be shown if a user tries to access a protected page directly without having a valid login session

Footer

Shows the currently installed Pi-hole and Web Interface version. If an update is available, this will be indicated here

Emergency help

Depending on your system and how heavily your Pi-hole is used, you may want to flush the log throughout the day by clicking on FLUSH. By default, the log if flushed at the end of the day via cron, but a very large log file can slow down the Web interface, so flushing it can be useful. Note that your statistics will be reset and you lose the statistics up to this point.