From 212e12e8da87e2c6c7564b04879542ddd5cf45c0 Mon Sep 17 00:00:00 2001 From: RD WebDesign Date: Tue, 3 Sep 2024 22:40:09 -0300 Subject: [PATCH] More changes: - Replace some more images (v6 version); - Add text description for settings; - Use TEX code to highlight some text labels; Signed-off-by: RD WebDesign --- README.md | 72 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 55 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index da13989a..f9369428 100644 --- a/README.md +++ b/README.md @@ -146,24 +146,68 @@ You can filter your log using the advanced filter: ## Blocking and allowing domains -> [!WARNING] -> **TODO:** this section needs more details. +Lists, domains (block or allow) and regex entries can be managed through groups. -- Adlists: gravity and antigravity -- Domains and Regex -- 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/) + +

Domain Management

-## Manage and configure Pi-hole features +## Settings - Manage and configure Pi-hole features -> [!WARNING] -> **TODO:** replace the images and maybe add some text with details + +System Settings - Basic and Expert + +**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

- Settings + All Settings

## Tools @@ -174,19 +218,13 @@ You can filter your log using the advanced filter: - Search a domain in your lists.

- Tail the log + Live Pi-hole log

- Query ad lists + Search a domain in your lists

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