Rewrite the README to reflect the v6 changes

- Change the initial logo block: - simplify the logo code using a SVG logo instead of 2 PNG files; - the new SVG file contains `prefers-color-scheme` CSS rule to change text color depending on the user preferences (dark/light modes) - add some links: Pi-hole site, Discourse, Documetation and Donate - Remove a broken link to Pi-hole store - Use new images and change a few texts to show v6 features - Remove "Audit log" and "Debug log" sections (they don't exist in v6) Signed-off-by: RD WebDesign <github@rdwebdesign.com.br>
2026-02-15 07:25:39 +00:00 · 2024-08-15 01:03:22 -03:00
parent 3e9ac6f7ac
commit 108179a264
1 changed files with 54 additions and 64 deletions
--- a/README.md
+++ b/README.md
@@ -1,26 +1,31 @@
-<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

 ---

@@ -68,7 +73,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 +122,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,39 +131,47 @@ 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
+
+You can filter your log using the advanced filter:
+
+<img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_advanced_filter.png" alt="Query log advanced filter">
+
+
+## Blocking and allowing domains
+
+> [!WARNING]
+> **TODO:** this section needs more details.
+
+- Adlists: gravity and antigravity
+- Domains and Regex
+- groups

 <p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/long-term-stats.png" alt="Long-term stats">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_domain_management.png" alt="Domain Management">
 </p>

-## A built-in debugger
+## Manage and configure Pi-hole features

-<p align="center">
-  <img src="https://pi-hole.github.io/graphics/Screenshots/debug.png" alt="Debugger">
-</p>
-
-## Black and white lists
-
-<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">
-</p>
-
-## The ability to easily manage and configure Pi-hole features
+> [!WARNING]
+> **TODO:** replace the images and maybe add some text with details

 <p align="center">
  <img src="https://pi-hole.github.io/graphics/Screenshots/dashboard-settings.gif" alt="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">
@@ -169,38 +181,16 @@ While we are primarily reachable on our <a href="https://discourse.pi-hole.net/"

 ## 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:
+> [!WARNING]
+> **TODO:**
+> - Rewrite
+> - Add a link to the online API documentation.
+> - Add an image of the API documentation interface.

-```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"
-}
-```
+The REST API can be accessed at `/api` and it returns data in JSON format.

-[There are many more parameters](https://discourse.pi-hole.net/t/pi-hole-api/1863), such as:
+A local API documentation can be found at `/api/docs`:

- `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`.
+<p align="center">
+  <img src="https://pi-hole.github.io/graphics/Screenshots/v6/v6_API.gif" alt="API documentation">
+</p>