0) { $authenticationsystem = true; } else { $authenticationsystem = false; } ?>

Help center

Header

Top left: Status display

Shows different status messages:

Top right: About

Main page

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

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)

Settings

Change settings for the Pi-Hole

Networking

Displays information about the interfaces of the Pi-Hole. No changes possible

Pi-Hole DHCP Server

Using this setting you can enable/disable the DHCP server of the Pi-Hole. Note that you should disable any other DHCP server on your network to avoid IP addresses being used more than once. You have to give the range of IPs that DHCP will serve and the IP of the local router (gateway). If the DHCP server is active, the current leases are shown on the settings page.

Upstream DNS Servers

Customize used upstream DNS servers + advanced settings

Query Logging

Enabled/disable query logging on your Pi-hole

API

Change settings which apply to the API as well as the web UI
Note that Top Clients have to be given as IP addresses

Web User Interface

Other settings which affect the webUI but not the API of Pi-hole

System Administration

Apply system-wide actions like restarting of the server

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

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

Footer

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