From 108179a26422f7a67f8adf2190e62fba78d87ddc Mon Sep 17 00:00:00 2001 From: RD WebDesign Date: Thu, 15 Aug 2024 01:03:22 -0300 Subject: [PATCH] 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 --- README.md | 118 +++++++++++++++++++++++++----------------------------- 1 file changed, 54 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index bcadadba..da13989a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,31 @@ -

+

- - - - Pi-hole website - + Pi-hole website
Network-wide ad blocking via your own Linux hardware

- - Pi-hole Web interface - -

+
+ Pi-hole website | + Documentation | + Discourse Forum | + Donate +
+
+
+
+ +# Pi-hole Web Interface + +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 - Pie charts + Pie charts

## Top lists of domains and clients @@ -127,39 +131,47 @@ While we are primarily reachable on our

-## A filterable and sortable query log +## The Query Log

- Query log + Query log

-## 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: + +Query log advanced filter + + +## Blocking and allowing domains + +> [!WARNING] +> **TODO:** this section needs more details. + +- Adlists: gravity and antigravity +- Domains and Regex +- groups

- Long-term stats + Domain Management

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

- Debugger -

- -## Black and white lists - -

- Blacklist -

- Whitelist -

- -## The ability to easily manage and configure Pi-hole features +> [!WARNING] +> **TODO:** replace the images and maybe add some text with details

Settings

-## ... 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.

Tail the log @@ -169,38 +181,16 @@ While we are primarily reachable on our [!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`. +

+ API documentation +