Rewrite the README to reflect the v6 changes (#3109)

README.md

@@ -1,44 +1,54 @@
-<p align="center">
+<div align="center">
   <a href="https://pi-hole.net/">
-    <picture>
-      <source media="(prefers-color-scheme: dark)" srcset="https://pi-hole.github.io/graphics/Vortex/Vortex_Vertical_wordmark_darkmode.png">
-      <source media="(prefers-color-scheme: light)" srcset="https://pi-hole.github.io/graphics/Vortex/Vortex_Vertical_wordmark_lightmode.png">
-      <img src="https://pi-hole.github.io/graphics/Vortex/Vortex_Vertical_wordmark_lightmode.png" width="168" height="270" alt="Pi-hole website">
-    </picture>
+    <img src="https://pi-hole.github.io/graphics/Vortex/vortex_with_text.svg" width="144" height="256" alt="Pi-hole website">
   </a>
   <br>
   <strong>Network-wide ad blocking via your own Linux hardware</strong>
   <br>
   <br>
-  <a href="https://pi-hole.net/">
-    <img src="https://pi-hole.github.io/graphics/Screenshots/pihole_dashboard_v5.png" alt="Pi-hole Web interface">
-  </a>
-</p>
+  <div align="center">
+    <a href="https://pi-hole.net/">Pi-hole website</a> |
+    <a href="https://docs.pi-hole.net/">Documentation</a> |
+    <a href="https://discourse.pi-hole.net/">Discourse Forum</a> |
+    <a href="https://pi-hole.net/donate">Donate</a>
+  </div>
+  <br>
+  <br>
+</div>
+
+# Pi-hole Web Interface
+
+<img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_dashboard.png" alt="Pi-hole Web interface">
 
 Pi-hole[®](https://pi-hole.net/trademark-rules-and-brand-guidelines/)'s Web interface (based off of [AdminLTE](https://github.com/ColorlibHQ/AdminLTE)) provides a central location to manage your Pi-hole and review the statistics generated by FTLDNS[™](https://pi-hole.net/trademark-rules-and-brand-guidelines/).
 
 - **Easy-to-interpret**: simple graphs and beautiful colors make Pi-hole's stats easy to understand
 - **Responsive**: looks great on desktop, tablets, and mobile devices
 - **Useful**: control and configure your Pi-hole with our settings
-- **Insightful**: use the query log, audit log, or long-term stats to gain insight into your networks activity
+- **Insightful**: use the query log, including long-term stats to gain insight into your networks activity
 
----
+<br>
+<img src="https://pi-hole.github.io/graphics/Badges/browserstack-badge.png" width="150">
 
-<img src="https://pi-hole.github.io/graphics/Badges/browserstack-badge.png" height="80"><br>
+---
+<br>
 
 # Installation
 
 The Web interface is enabled by default when you install Pi-hole.
 
 ## Post-installation: access the Web interface and gain insight into your network's activity
 
-There are several ways to [access the dashboard](https://discourse.pi-hole.net/t/how-do-i-access-pi-holes-dashboard-admin-interface/3168):
+There are several ways to access the dashboard:
+
+1. `https://<IP_ADDRESS_OF_YOUR_PI_HOLE>/admin/`
+2. `https://pi.hole/admin/` (when using Pi-hole as your DNS server)
+3. `https://pi.hole/` (when using Pi-hole as your DNS server)
 
-1. `http://<IP_ADDRESS_OF_YOUR_PI_HOLE>/admin/`
-2. `http://pi.hole/admin/` (when using Pi-hole as your DNS server)
-3. `http://pi.hole/` (when using Pi-hole as your DNS server)
+> [!TIP]
+> You can access the web interface using `http://` or `https://` protocols.
 
-Once logged in (forgot your password?), you can view your network stats to see things like:
+Once logged in, you can view your network stats to see things like:
 
 - the domains being queried on your network
 - the time the queries were initiated
@@ -58,8 +68,8 @@ 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:
 
-- <img src="https://pi-hole.github.io/graphics/Badges/paypal-badge-black.svg" width="24" height="24" alt="PP"> [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
-- <img src="https://pi-hole.github.io/graphics/Badges/bitcoin-badge-black.svg" width="24" height="24" alt="BTC"> [Bitcoin, Bitcoin Cash, Ethereum, Litecoin](https://commerce.coinbase.com/checkout/dd304d04-f324-4a77-931b-0db61c77a41b)
+- <img src="https://pi-hole.github.io/graphics/Badges/paypal-badge-black.svg" width="20" height="20" align="absmiddle" alt="PayPal icon"> [Donate via PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3J2L3Z4DHW9UY)
+- <img src="https://pi-hole.github.io/graphics/Badges/bitcoin-badge-black.svg" width="20" height="20" align="absmiddle" alt="Bitcoin icon"> [Bitcoin, Bitcoin Cash, Ethereum, Litecoin](https://commerce.coinbase.com/checkout/dd304d04-f324-4a77-931b-0db61c77a41b)
 
 ### Alternative support
 
@@ -68,7 +78,6 @@ If you'd rather not [donate](https://pi-hole.net/donate/) (_which is okay!_), th
 - [Patreon](https://patreon.com/pihole) _Become a patron for rewards_
 - [Digital Ocean](https://www.digitalocean.com/?refcode=344d234950e1) _affiliate link_
 - [Stickermule](https://www.stickermule.com/unlock?ref_id=6055890701&utm_medium=link&utm_source=invite) _earn a \$10 credit after your first purchase_
-- [Pi-hole Swag Store](https://pi-hole.net/shop/) _affiliate link_
 - [Amazon](https://www.amazon.com/exec/obidos/redirect-home/pihole09-20) _affiliate link_
 - [DNS Made Easy](https://cp.dnsmadeeasy.com/u/133706) _affiliate link_
 - Spreading the word about our software, and how you have benefited from it
@@ -118,7 +127,7 @@ While we are primarily reachable on our <a href="https://discourse.pi-hole.net/"
 ## Detailed graphs and doughnut charts
 
 <p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/piecharts.png" alt="Pie charts">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_doughnut_graphics.png" alt="Pie charts">
 </p>
 
 ## Top lists of domains and clients
@@ -127,80 +136,104 @@ While we are primarily reachable on our <a href="https://discourse.pi-hole.net/"
   <img src="https://pi-hole.github.io/graphics/Screenshots/topdomains-clients.png" alt="Top domains/top clients">
 </p>
 
-## A filterable and sortable query log
+## The Query Log
 
 <p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/query-log-sorted.png" alt="Query log">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_query_log.png" alt="Query log">
 </p>
 
-## Long-term statistics to view data over user defined time ranges
+The *Query Log* shows recent and long-term data over user defined time ranges
 
-<p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/long-term-stats.png" alt="Long-term stats">
-</p>
+You can filter your log using the advanced filter:
 
-## A built-in debugger
+<img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_advanced_filter.png" alt="Query log advanced filter">
 
-<p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/debug.png" alt="Debugger">
-</p>
 
-## Black and white lists
+## Blocking and allowing domains
+
+Lists, domains (block or allow) and regex entries can be managed through groups.
+
+- [Group management overview](https://docs.pi-hole.net/group_management/groups/)
+- [How to use Pi-hole Groups with examples](https://docs.pi-hole.net/group_management/example/)
+
+<br>
 
 <p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/blacklist.png" alt="Blacklist">
-  <br><br>
-  <img src="https://pi-hole.github.io/graphics/Screenshots/whitelist.png" alt="Whitelist">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_domain_management.png" alt="Domain Management">
 </p>
 
-## The ability to easily manage and configure Pi-hole features
+## Settings - Manage and configure Pi-hole features
+
+
+<img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_settings_system.gif" alt="System Settings - Basic and Expert" align="right" width="45%">
+
+**System Settings:**
+  - System Information
+  - DNS reply metrics
+  - DNS cache metrics $\color{red}{\normalsize\textsf{[Expert]}}$
+  - DHCP server metrics $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Actions (Buttons) $\color{red}{\normalsize\textsf{[Expert]}}$
+
+**DNS Settings:**
+  - Upstream DNS Servers (including custom DNS servers)
+  - Interface settings $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Advanced DNS settings $\color{red}{\normalsize\textsf{[Expert]}}$
+  - DNS domain settings $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Rate-limiting $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Conditional forwarding $\color{red}{\normalsize\textsf{[Expert]}}$
+
+**DHCP Settings:**
+  - General DHCP Settings
+  - Advanced DHCP Settings $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Currently active DHCP leases table
+  - Static DHCP configuration $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Advanced description (Help text) $\color{red}{\normalsize\textsf{[Expert]}}$
+
+**Web Interface - API Settings:**
+  - Theme settings
+  - Advanced Settings $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Exclusions (Domains and Clients to be excluded from dashboard tables) $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Currently active sessions table $\color{red}{\normalsize\textsf{[Expert]}}$
+
+**Privacy Settings:**
+  - Query Logging
+  - Query Anonymization ("Privacy Level") $\color{red}{\normalsize\textsf{[Expert]}}$
+  - Privacy-related database settings $\color{red}{\normalsize\textsf{[Expert]}}$
+
+**Teleporter:**
+  - Export your Pi-hole's configuration
+  - Import previously exported configuration
+
+**Local DNS Settings:**
+  - Local DNS records
+  - Local CNAME records records
+
+**All Settings** (only visible in Expert mode):
+  - Advanced settings page, containing all available options
 
 <p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/dashboard-settings.gif" alt="Settings">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_all_settings.gif" alt="All Settings">
 </p>
 
-## ... and all the main features of the Command Line Interface!
+## Tools
+
+- Diagnostic messages;
+- View logs in real time: `pihole.log`, `FTL.log` and `webserver.log`;
+- Update your lists;
+- Search a domain in your lists.
 
 <p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/pihole-t.png" alt="Tail the log">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_tail_pihole_log.gif" alt="Live Pi-hole log">
   <br><br>
-  <img src="https://pi-hole.github.io/graphics/Screenshots/pihole-q.png" alt="Query ad lists">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_search.gif" alt="Search a domain in your lists">
 </p>
 
 ## API
 
-Full usage available [here](https://discourse.pi-hole.net/t/pi-hole-api/1863). Can be accessed at `/admin/api.php`. With either no parameters or `/admin/api.php?summary` it returns the following JSON:
-
-```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](https://discourse.pi-hole.net/t/pi-hole-api/1863), 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](https://discourse.pi-hole.net/t/is-there-an-api-command-to-disable-ad-blocking/7693).
-
-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`.
+The REST API can be accessed at `/api` and it returns data in JSON format.
+
+A local API documentation can be found at `/api/docs`:
+
+<p align="center">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_API.gif" alt="API documentation">
+</p>