diff --git a/help.php b/help.php deleted file mode 100644 index 1c943486..00000000 --- a/help.php +++ /dev/null @@ -1,156 +0,0 @@ - 0) - { - $authenticationsystem = true; - } - else - { - $authenticationsystem = false; - } -?> - -
-
-

Help center

-

Header

-

Top left: Status display

-

Shows different status messages:

- -

Top right: About

- -
-
-
-
-

Dashboard

-

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

- -

The Top Domains and Top Advertisers lists may be hidden depending on the privacy Settings on the settings page

- -

Note that the login session does not expire on the dashboard, 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. By default, only the recent 10 minutes are shown to enhance the loading speed of the query log page. All domains can be requested by clicking on the corresponding link in the header of the page. Note that the result heavily depends on your privacy settings (see Settings 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.

-

Regex blacklisting is supported (entering ^example will block any domain starting with example, see also our Regex documentation). You can still whitelist specific domains even if they fall under a regex pattern.

-

You can white-/blacklist multiple entries at a time if you separate the domains by spaces.

-
-
-
-
-

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) -
-
-
-
-

Tools → Update Gravity

-

Will download any updates from the third-party blocklists that we source. By default, this command runs once a week via cron (Sunday).

-
-
-
-
-

Tools → Query Lists

- 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 blocklists, 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.

-
-
-
-
-

Tools → Tail pihole.log

- Live tailing of the raw Pi-hole log.

-
-
-
-
-

Settings

- Change settings for the Pi-hole -

System

- Displays network and other system information of Pi-hole. At the bottom there is a "Danger Zone" with actions such as disable query logging and reboot. -

Blocklists

- View and edit the blocklists sourced for blocked domains. -

DNS

- Customize used upstream DNS servers + advanced settings for DNS servers. Note that any number of DNS servers may be enabled at a time. -

DHCP

- 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. IPv4 DHCP will always be activated, IPv6 (stateless + statefull) can be enabled. -

API / Web Interface

- Change settings which apply to the API as well as the web interface -

Privacy

- Set the privacy level for queries. Note that decreasing the privacy level will not disclose previously hidden query data. -

Teleporter

- Import and export Pi-hole settings. -
-
-
-
-

Authentication system (currently enableddisabled)

-

Using the command

sudo pihole -a -p
and entering a password to be set, one can enable the authentication system of this web interface. Thereafter, a login is required for most pages (the dashboard 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 -
-
- - diff --git a/scripts/pi-hole/php/header.php b/scripts/pi-hole/php/header.php index 9c0ae084..3ed7f901 100644 --- a/scripts/pi-hole/php/header.php +++ b/scripts/pi-hole/php/header.php @@ -668,14 +668,12 @@ if($auth) { Donate - - - class="active"> - - Help + +
  • + + Donate
    • -