From 2178c3a5fd2f080ae0dfa473224c81eac24ed6d4 Mon Sep 17 00:00:00 2001 From: liss-bot Date: Sun, 5 Jun 2022 01:33:11 +0000 Subject: [PATCH] Auto Publish new pages --- authentication.md | 21 +++-- configuring.md | 27 +++++-- credits.md | 39 +++++---- privacy.md | 2 + showcase.md | 133 +++++++++++++++++-------------- troubleshooting.md | 12 +++ widgets.md | 194 +++++++++++++++++++++++++++++++++++++++++++-- 7 files changed, 337 insertions(+), 91 deletions(-) diff --git a/authentication.md b/authentication.md index 4b8e0e6..5a0e267 100644 --- a/authentication.md +++ b/authentication.md @@ -48,10 +48,10 @@ Once authentication is enabled, so long as there is no valid token in cookie sto With authentication setup, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting `appConfig.auth.enableGuestAccess: true`. ### Granular Access -You can use the following properties to make certain sections only visible to some users, or hide sections from guests. -- `hideForUsers` - Section will be visible to all users, except for those specified in this list -- `showForUsers` - Section will be hidden from all users, except for those specified in this list -- `hideForGuests` - Section will be visible for logged in users, but not for guests +You can use the following properties to make certain sections or items only visible to some users, or hide sections and items from guests. +- `hideForUsers` - Section or Item will be visible to all users, except for those specified in this list +- `showForUsers` - Section or Item will be hidden from all users, except for those specified in this list +- `hideForGuests` - Section or Item will be visible for logged in users, but not for guests For Example: @@ -71,7 +71,9 @@ For Example: displayData: hideForGuests: true items: - ... + - title: Hide Me + displayData: + hideForUsers: [alicia, bob] ``` ### Permissions @@ -149,9 +151,9 @@ appConfig: Note that if you are using Keycloak V 17 or older, you will also need to set `legacySupport: true` (also under `appConfig.auth.keycloak`). This is because the API endpoint was updated in later versions. ### 4. Add groups and roles (Optional) -Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections in Dashy. +Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy. Keycloak server administration and configuration is a deep topic; please refer to the [server admin guide](https://www.keycloak.org/docs/latest/server_admin/index.html#assigning-permissions-and-access-using-roles-and-groups) to see details about creating and assigning roles and groups. -Once you have groups or roles assigned to users you can configure access under each sections `displayData.showForKeycloakUser` and `displayData.hideForKeycloakUser`. +Once you have groups or roles assigned to users you can configure access under each section or item `displayData.showForKeycloakUser` and `displayData.hideForKeycloakUser`. Both show and hide configurations accept a list of `groups` and `roles` that limit access. If a users data matches one or more items in these lists they will be allowed or excluded as defined. ```yaml sections: @@ -161,6 +163,11 @@ sections: roles: ['canViewDevResources'] hideForKeycloakUsers: groups: ['ProductTeam'] + items: + - title: Not Visible for developers + displayData: + hideForKeycloakUsers: + groups: ['DevelopmentTeam'] ``` Depending on how you're hosting Dashy and Keycloak, you may also need to set some HTTP headers, to prevent a CORS error. This would typically be the `Access-Control-Allow-Origin [URL-of Dashy]` on your Keycloak instance. See the [Setting Headers](https://github.com/Lissy93/dashy/blob/master/docs/management.md#setting-headers) guide in the management docs for more info. diff --git a/configuring.md b/configuring.md index a2d88aa..18941b4 100644 --- a/configuring.md +++ b/configuring.md @@ -36,10 +36,12 @@ The following file provides a reference of all supported configuration options. - [`keycloak`](#appconfigauthkeycloak-optional) - Auth config for Keycloak - [**`sections`**](#section) - List of sections - [`displayData`](#sectiondisplaydata-optional) - Section display settings - - [`show/hideForKeycloakUsers`](#sectiondisplaydatahideforkeycloakusers-and-sectiondisplaydatashowforkeycloakusers) - Set user controls + - [`show/hideForKeycloakUsers`](#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers) - Set user controls - [`icon`](#sectionicon-and-sectionitemicon) - Icon for a section - [`items`](#sectionitem) - List of items - [`icon`](#sectionicon-and-sectionitemicon) - Icon for an item + - [`displayData`](#itemdisplaydata-optional) - Item display settings + - [`show/hideForKeycloakUsers`](#sectiondisplaydatahideforkeycloakusers-sectiondisplaydatashowforkeycloakusers-itemdisplaydatahideforkeycloakusers-and-itemdisplaydatashowforkeycloakusers) - Set user controls - [`widgets`](#sectionwidget-optional) - List of widgets - [**Notes**](#notes) - [Editing Config through the UI](#editing-config-through-the-ui) @@ -224,9 +226,24 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)** **`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well **`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background **`provider`** | `string` | _Optional_ | The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name +**`displayData`** | `object` | _Optional_ | Meta-data to optionally overide display settings for a given item. See [`displayData`](#itemdisplaydata-optional) **[⬆️ Back to Top](#configuring)** + +### `item.displayData` _(optional)_ + +**Field** | **Type** | **Required**| **Description** +--- | --- | --- | --- +**`hideForUsers`** | `string[]` | _Optional_ | Current item will be visible to all users, except for those specified in this list +**`showForUsers`** | `string[]` | _Optional_ | Current item will be hidden from all users, except for those specified in this list +**`hideForGuests`** | `boolean` | _Optional_ | Current item will be visible for logged in users, but not for guests (see `appConfig.enableGuestAccess`). Defaults to `false` +**`hideForKeycloakUsers`** | `object` | _Optional_ | Current item will be visible to all keycloak users, except for those configured via these groups and roles. See `hideForKeycloakUsers` +**`showForKeycloakUsers`** | `object` | _Optional_ | Current item will be hidden from all keycloak users, except for those configured via these groups and roles. See `showForKeycloakUsers` + +**[⬆️ Back to Top](#configuring)** + + ### `section.widget` _(optional)_ **Field** | **Type** | **Required**| **Description** @@ -259,7 +276,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)** **`showForUsers`** | `string[]` | _Optional_ | Current section will be hidden from all users, except for those specified in this list **`hideForGuests`** | `boolean` | _Optional_ | Current section will be visible for logged in users, but not for guests (see `appConfig.enableGuestAccess`). Defaults to `false` **`hideForKeycloakUsers`** | `object` | _Optional_ | Current section will be visible to all keycloak users, except for those configured via these groups and roles. See `hideForKeycloakUsers` -**`showForKeycloakUsers`** | `object` | _Optional_ | Current section will be hidden from all keyclaok users, except for those configured via these groups and roles. See `showForKeycloakUsers` +**`showForKeycloakUsers`** | `object` | _Optional_ | Current section will be hidden from all keycloak users, except for those configured via these groups and roles. See `showForKeycloakUsers` **[⬆️ Back to Top](#configuring)** @@ -271,12 +288,12 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)** **[⬆️ Back to Top](#configuring)** -### `section.displayData.hideForKeycloakUsers` and `section.displayData.showForKeycloakUsers` +### `section.displayData.hideForKeycloakUsers`, `section.displayData.showForKeycloakUsers`, `item.displayData.hideForKeycloakUsers` and `item.displayData.showForKeycloakUsers` **Field** | **Type** | **Required**| **Description** --- |------------| --- | --- -**`groups`** | `string[]` | _Optional_ | Current Section will be hidden or shown based on the user having any of the groups in this list -**`roles`** | `string[]` | _Optional_ | Current Section will be hidden or shown based on the user having any of the roles in this list +**`groups`** | `string[]` | _Optional_ | Current Section or Item will be hidden or shown based on the user having any of the groups in this list +**`roles`** | `string[]` | _Optional_ | Current Section or Item will be hidden or shown based on the user having any of the roles in this list **[⬆️ Back to Top](#configuring)** diff --git a/credits.md b/credits.md index 77ac089..1aef17e 100644 --- a/credits.md +++ b/credits.md @@ -41,7 +41,7 @@ - kitl000 + kitl000
Kit L.
@@ -90,6 +90,13 @@ + + + ced4568 +
+ Kyforker148 +
+ ratty222 @@ -153,14 +160,21 @@ Snyk Bot + + + pinarruiz +
+ Alejandro Pinar Ruiz +
+ + kashif-se
Kashif Sohail
- - + walkxcode @@ -195,15 +209,15 @@
Stanly0726
- + + onedr0p
ᗪєνιη ᗷυнʟ
- - + alexdelprete @@ -238,15 +252,15 @@
Rúben Silva
- + + Singebob
Jeremy Chauvin
- - + 0n1cOn3 @@ -254,13 +268,6 @@ 0n1cOn3 - - - pinarruiz -
- Alejandro Pinar Ruiz -
- BeginCI diff --git a/privacy.md b/privacy.md index 22909bf..5b56d93 100644 --- a/privacy.md +++ b/privacy.md @@ -111,6 +111,8 @@ Dashy supports [Widgets](/docs/widgets.md) for displaying dynamic content. Below - [IP-API Privacy Policy](https://ip-api.com/docs/legal) - **[IP Blacklist](/docs/widgets.md#ip-blacklist)**: `https://api.blacklistchecker.com` - [Blacklist Checker Privacy Policy](https://blacklistchecker.com/privacy) +- **[Domain Monitor](/docs/widgets.md#domain-monitor)**: `http://api.whoapi.com` + - [WhoAPI Privacy Policy](https://whoapi.com/privacy-policy/) - **[Crypto Watch List](/docs/widgets.md#crypto-watch-list)** and **[Token Price History](/docs/widgets.md#crypto-token-price-history)**: `https://api.coingecko.com` - [CoinGecko Privacy Policy](https://www.coingecko.com/en/privacy) - **[Wallet Balance](/docs/widgets.md#wallet-balance)**: `https://api.blockcypher.com/` diff --git a/showcase.md b/showcase.md index 63f13e8..a902a28 100644 --- a/showcase.md +++ b/showcase.md @@ -10,19 +10,74 @@ --- ### Ratty222 -> By [@ratty222](https://github.com/ratty222) [#384](https://github.com/Lissy93/dashy/discussions/384) +> By [@ratty222](https://github.com/ratty222) Re: [#384](https://github.com/Lissy93/dashy/discussions/384) ![screenshot-ratty222-dashy](https://user-images.githubusercontent.com/1862727/147582551-4c655d37-8bcc-4f95-ab41-164a9d0d6a07.png) --- ### Hugalafutro Dashy -> By [@hugalafutro](https://github.com/hugalafutro) [#505](https://github.com/Lissy93/dashy/discussions/505) +> By [@hugalafutro](https://github.com/hugalafutro) Re: [#505](https://github.com/Lissy93/dashy/discussions/505) [![hugalafutro-dashy-screenshot](https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif)](https://i.ibb.co/PDpLDKS/hugalafutro-dashy.gif) --- +### NAS Home Dashboard +> By [@cerealconyogurt](https://github.com/cerealconyogurt) Re: [#74](https://github.com/Lissy93/dashy/issues/74) + +![screenshot-networking-services](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/6-nas-home-dashboard.png) + +--- + +### Brewhack + +> By [@brpeterso](https://github.com/brpeterso) Re: [#680](https://github.com/Lissy93/dashy/issues/680) + +![screenshot-brewhack-dashboard](https://i.ibb.co/cNjzPT4/brewhack.png) + +--- + +### The Private Dashboard + +> By [@DylanBeMe](https://github.com/DylanBeMe) Re: [#419](https://github.com/Lissy93/dashy/issues/419) + +![screenshot-private-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png) + +--- + +### Homelab & VPS dashboard +> By [@shadowking001](https://github.com/shadowking001) Re: [#86](https://github.com/Lissy93/dashy/issues/86) + +![screenshot-shadowking001-dashy](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/8-shadowking001s-dashy.png) + +--- + +### Raspberry PI Docker Dashboard + +> By [@henkiewie](https://github.com/henkiewie) Re: [#622](https://github.com/Lissy93/dashy/issues/622) + +> I use this dashboard every day. It now even includes a player for a radio stream which I configured with Logitech media server and icecast. I made an smaller version of the grafana dashboard to fit an iframe in kiosk mode, so it monitors the most important values of my RPI. The PI is in Argon m2 case and used as a NAS. The dashboard is a copy of the adventure theme with some changes saved in `/app/src/styles/user-defined-themes.scss` + +![screenshot-henkiewie-dashy](https://i.ibb.co/jGzPm6b/henkiewie-dashy-showcase.png) + +--- + +### First Week of Self-Hosting +> By [u//RickyCZ](https://www.reddit.com/user/RickyCZ) via [Reddit](https://www.reddit.com/r/selfhosted/comments/pose15/just_got_started_a_week_ago_selfhosting_is_very/) + +![screenshot-week-of-self-hosting](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/11-ricky-cz.png) + +--- + +### EVO Dashboard + +> By [@EVOTk](https://github.com/EVOTk) Re: [#316](https://github.com/Lissy93/dashy/pull/316) + +![screenshot-evo-dashboard](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/12-evo-dashboard.png) + +--- + ### Networking Services > By [@Lissy93](https://github.com/lissy93) @@ -30,36 +85,6 @@ --- -### Homelab & VPS dashboard -> By [@shadowking001](https://github.com/shadowking001) - -![screenshot-shadowking001-dashy](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/8-shadowking001s-dashy.png) - ---- - -### EVO Dashboard - -> By [@EVOTk](https://github.com/EVOTk) - -![screenshot-evo-dashboard](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/12-evo-dashboard.png) - ---- - -### The Private Dashboard - -> By [@DylanBeMe](https://github.com/DylanBeMe) [#419](https://github.com/Lissy93/dashy/issues/419) - -![screenshot-evo-dashboard](https://i.ibb.co/hKS483T/private-dashboard-Dylan-Be-Me.png) - ---- - -### NAS Home Dashboard -> By [@cerealconyogurt](https://github.com/cerealconyogurt) - -![screenshot-networking-services](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/6-nas-home-dashboard.png) - ---- - ### Dashy Live > By [@Lissy93](https://github.com/lissy93) @@ -108,16 +133,9 @@ --- -### First Week of Self-Hosting -> By [u//RickyCZ](https://www.reddit.com/user/RickyCZ) - -![screenshot-week-of-self-hosting](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/11-ricky-cz.png) - ---- - ### HomeLAb 3.0 -> By [@skoogee](https://github.com/skoogee) (http://zhrn.cc) +> By [@skoogee](https://github.com/skoogee) (http://zhrn.cc) [#279](https://github.com/Lissy93/dashy/issues/279) > Dashy, is the most complete dashboard I ever tried, has all the features, and it sets itself apart from the rest. It is my default homepage now. I am thankful to the developer @Lissy93 for sharing such a wonderful creation. @@ -126,19 +144,12 @@ --- ### Ground Control -> By [@dtctek](https://github.com/dtctek) +> By [@dtctek](https://github.com/dtctek) Re: [#83](https://github.com/Lissy93/dashy/issues/83) ![screenshot-ground-control](https://user-images.githubusercontent.com/1862727/149821995-e9b41dab-186c-42e6-b5b3-e233259b241d.png) --- -### Morning Dashboard -> Displayed on my smart screen between 05:00 - 08:00, and includes all the info that I usually check before leaving for work - -![screenshot-morning-dash](https://i.ibb.co/4Wx8zb7/morning-dashboard.png) - ---- - ### Croco_Grievous > By [u/Croco_Grievous](https://www.reddit.com/user/Croco_Grievous/) via [reddit](https://www.reddit.com/r/selfhosted/comments/t4xk3z/everything_started_with_pihole_on_a_raspberry_pi/) @@ -154,16 +165,6 @@ --- -### Raspberry PI Docker Dashboard - -> By [@henkiewie](https://github.com/henkiewie) via [#622](https://github.com/Lissy93/dashy/issues/622) - -> I use this dashboard every day. It now even includes a player for a radio stream which I configured with Logitech media server and icecast. I made an smaller version of the grafana dashboard to fit an iframe in kiosk mode, so it monitors the most important values of my RPI. The PI is in Argon m2 case and used as a NAS. The dashboard is a copy of the adventure theme with some changes saved in `/app/src/styles/user-defined-themes.scss` - -![screenshot-henkiewie-dashy](https://i.ibb.co/jGzPm6b/henkiewie-dashy-showcase.png) - ---- - ### Stefantigro > By [u/stefantigro](https://www.reddit.com/user/stefantigro/) via [reddit](https://www.reddit.com/r/selfhosted/comments/t5oril/been_selfhosting_close_to_half_a_year_now_all/) @@ -171,12 +172,28 @@ --- +### Morning Dashboard +> Displayed on my smart screen between 05:00 - 08:00, and includes all the info that I usually check before leaving for work + +![screenshot-morning-dash](https://i.ibb.co/4Wx8zb7/morning-dashboard.png) + +--- + ### Yet Another Homelab ![screenshot-yet-another-homelab](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/9-home-lab-oblivion.png) --- +### The Dragons Lair +> By [dr460nf1r3](https://github.com/dr460nf1r3) via [#684](https://github.com/Lissy93/dashy/issues/684) + +> My new startpage featuring the stuff I use most. And of course dragons! + +![screenshot-dragons-lair](https://raw.githubusercontent.com/Lissy93/dashy/master/docs/showcase/13-dragons-lair.png) + +--- + ## Submitting your Dashboard #### How to Submit diff --git a/troubleshooting.md b/troubleshooting.md index b69d48e..c23fc90 100644 --- a/troubleshooting.md +++ b/troubleshooting.md @@ -31,6 +31,7 @@ - [Fixing Widget CORS Errors](#widget-cors-errors) - [Weather Forecast Widget 401](#weather-forecast-widget-401) - [Font Awesome Icons not Displaying](#font-awesome-icons-not-displaying) +- [Copy to Clipboard not Working](#copy-to-clipboard-not-working) - [How-To Open Browser Console](#how-to-open-browser-console) - [Git Contributions not Displaying](#git-contributions-not-displaying) @@ -436,6 +437,17 @@ Finally, check the [browser console](#how-to-open-browser-console) for any error --- +## Copy to Clipboard not Working + +If the copy to clipboard feature (either under Config --> Export, or Item --> Copy URL) isn't functioning as expected, first check the browser console. If you see `TypeError: Cannot read properties of undefined (reading 'writeText')` then this feature is not supported by your browser. +The most common reason for this, is if you not running the app over HTTPS. Copying to the clipboard requires the app to be running in a secure origin / aka have valid HTTPS cert. You can read more about this [here](https://stackoverflow.com/a/71876238/979052). + +As a workaround, you could either: +- Highlight the text and copy / Ctrl + C +- Or setup SSL - [here's a guide](https://github.com/Lissy93/dashy/blob/master/docs/management.md#ssl-certificates) on doing so + +--- + ## How-To Open Browser Console When raising a bug, one crucial piece of info needed is the browser's console output. This will help the developer diagnose and fix the issue. diff --git a/widgets.md b/widgets.md index 1f8e1fd..be9eb79 100644 --- a/widgets.md +++ b/widgets.md @@ -2,10 +2,6 @@ Dashy has support for displaying dynamic content in the form of widgets. There are several built-in widgets available out-of-the-box as well as support for custom widgets to display stats from almost any service with an API. -> ℹ️ **Note**: Widgets are still in the Alpha-phase of development. -> If you find a bug, please raise it.
-> Adding / editing widgets through the UI isn't yet supported, you will need to do this in the YAML config file. - ##### Contents - **[General Widgets](#general-widgets)** - [Clock](#clock) @@ -15,6 +11,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Image](#image) - [Public IP Address](#public-ip) - [IP Blacklist Checker](#ip-blacklist) + - [Domain Monitor](#domain-monitor) - [Crypto Watch List](#crypto-watch-list) - [Crypto Price History](#crypto-token-price-history) - [Crypto Wallet Balance](#wallet-balance) @@ -47,6 +44,10 @@ Dashy has support for displaying dynamic content in the form of widgets. There a - [Recent Traffic](#recent-traffic) - [Stat Ping Statuses](#stat-ping-statuses) - [Synology Download Station](#synology-download-station) + - [AdGuard Home Block Stats](#adguard-home-block-stats) + - [AdGuard Home Filters](#adguard-home-filters) + - [AdGuard Home DNS Info](#adguard-home-dns-info) + - [AdGuard Home Top Domains](#adguard-home-top-domains) - **[System Resource Monitoring](#system-resource-monitoring)** - [CPU Usage Current](#current-cpu-usage) - [CPU Usage Per Core](#cpu-usage-per-core) @@ -320,6 +321,43 @@ Notice certain web pages aren't loading? This widget quickly shows which blackli --- +### Domain Monitor + +Keep an eye on the expiry dates of your domain names, using public whois records fetched from [whoapi.com](https://whoapi.com/). Click the domain name to view additional info, like registrar, name servers and date last updated. + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`domain`** | `string` | Required | The domain to check +**`apiKey`** | `string` | Required | You can get your free API key from [my.whoapi.com](https://my.whoapi.com/user/signup) +**`showFullInfo`** | `boolean` | _Optional_ | If set to true, the toggle-full-info panel will be open by default + +##### Example + +```yaml + - type: domain-monitor + options: + domain: example.com + apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + + - type: domain-monitor + options: + domain: example2.com + apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +``` + +##### Info +- **CORS**: 🟢 Enabled +- **Auth**: 🔴 Required +- **Price**: 🟠 Free Plan (10,000 requests) +- **Host**: Managed Instance Only +- **Privacy**: _See [WhoAPI Privacy Policy](https://whoapi.com/privacy-policy/)_ + +--- + ### Crypto Watch List Keep track of price changes of your favorite crypto assets. Data is fetched from [CoinGecko](https://www.coingecko.com/). All fields are optional. @@ -1334,7 +1372,7 @@ Displays the current and recent uptime of your running services, via a self-host Displays the current downloads/torrents tasks of your Synology NAS -

+

##### Options @@ -1365,6 +1403,152 @@ Displays the current downloads/torrents tasks of your Synology NAS --- +### AdGuard Home Block Stats + +Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overview.html) instance, and +displays total number of allowed and blocked queries, plus a pie chart showing breakdown by block type. + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your AdGuard Home instance +**`username`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your username here +**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here + +##### Example + +```yaml +- type: adguard-stats + useProxy: true + options: + hostname: http://127.0.0.1 + username: admin + password: test +``` + +##### Info +- **CORS**: 🟠 Proxied +- **Auth**: 🟠 Optional +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [AdGuard Home](https://adguard.com/en/adguard-home/overview.html)) +- **Privacy**: _See [AdGuard Privacy Policy](https://adguard.com/en/privacy.html)_ + + +--- + +### AdGuard Home Filters + +Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overview.html) instance, to display the current status of each of your filter lists. Includes filter name, last updated, number of items, and a link to the list. + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your AdGuard Home instance +**`username`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your username here +**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here +**`showOnOffStatusOnly`** | `boolean` | _Optional_ | If set to `true`, will only show aggregated AdGuard filter status (on/off), instead of a list of filters + +##### Example + +```yaml +- type: adguard-filter-status + useProxy: true + options: + hostname: http://127.0.0.1 + username: admin + password: test + showOnOffStatusOnly: false +``` + +##### Info +- **CORS**: 🟠 Proxied +- **Auth**: 🟠 Optional +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [AdGuard Home](https://adguard.com/en/adguard-home/overview.html)) +- **Privacy**: _See [AdGuard Privacy Policy](https://adguard.com/en/privacy.html)_ + +--- + +### AdGuard Home DNS Info + +Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overview.html) instance, and displays the current status (Enabled / Disabled) of AdGuard DNS. Click show more to view detailed info, including upstream DNS provider, active ports, and the status of DNSSEC, EDNS CS, PTR and IPv6. + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your AdGuard Home instance +**`username`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your username here +**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here +**`showFullInfo`** | `boolean` | _Optional_ | If set to `true`, the full DNS info will be shown by default, without having to click "Show Info" + +##### Example + +```yaml +- type: adguard-dns-info + useProxy: true + options: + hostname: http://127.0.0.1 + username: admin + password: test + showFullInfo: false +``` + +##### Info +- **CORS**: 🟠 Proxied +- **Auth**: 🟠 Optional +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [AdGuard Home](https://adguard.com/en/adguard-home/overview.html)) +- **Privacy**: _See [AdGuard Privacy Policy](https://adguard.com/en/privacy.html)_ + +--- + +### AdGuard Home Top Domains + +Fetches data from your [AdGuard Home](https://adguard.com/en/adguard-home/overview.html) instance, and displays a list of the most queried, and most blocked domains. + +

+ +##### Options + +**Field** | **Type** | **Required** | **Description** +--- | --- | --- | --- +**`hostname`** | `string` | Required | The URL to your AdGuard Home instance +**`username`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your username here +**`password`** | `string` | _Optional_ | If you've got auth enabled on AdGuard, provide your password here +**`limit`** | `number` | _Optional_ | Specify the number of results to show, between `1` and `100`, defaults to `10` +**`hideBlockedDomains`** | `boolean` | _Optional_ | Don't show the blocked domains list (queried domains only) +**`hideQueriedDomains`** | `boolean` | _Optional_ | Don't show the queried domains list (blocked domains only) + +##### Example + +```yaml +- type: adguard-top-domains + useProxy: true + options: + hostname: http://127.0.0.1 + username: admin + password: test + limit: 10 +``` + +##### Info +- **CORS**: 🟠 Proxied +- **Auth**: 🟠 Optional +- **Price**: 🟢 Free +- **Host**: Self-Hosted (see [AdGuard Home](https://adguard.com/en/adguard-home/overview.html)) +- **Privacy**: _See [AdGuard Privacy Policy](https://adguard.com/en/privacy.html)_ + +--- + ## System Resource Monitoring The easiest method for displaying system info and resource usage in Dashy is with [Glances](https://nicolargo.github.io/glances/).