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

    Runs the command

    sudo pihole -g
    and prints the result transparently to the web UI. The gravity.sh script will update the list of ad-serving domains

    Query adlists

    Runs the command

    sudo pihole -q searchstring
    and prints the result transparently to the web UI. This command can be used to scan for strings in the list of blocked domains, e.g., "analytics" will deliver all domains which *analytics*, where the asterisk (*) represents a number of characters or an empty string

    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 sites (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 haveing 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

    In case the web UI does not work properly anymore (i.e. timeout errors or diagrams not showing up) you can try to flush the Pi-hole config file by clicking FLUSH. Note that your statistics will be reset and you lose the statistics up to this point.