Lissy93 / dashy

๐Ÿš€ A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
https://dashy.to
MIT License
17.35k stars 1.32k forks source link

[FEATURE_REQUEST] Widget for AdguardHome #493

Closed JohnFawkes closed 2 years ago

JohnFawkes commented 2 years ago

Is your feature request related to a problem? If so, please describe.

No response

Describe the solution you'd like

A widget made for selfhosted adguardhome

Priority

Medium (Would be very useful)

Is this something you would be keen to implement

No response

Lissy93 commented 2 years ago

Hey John, would this be something you'd be able to work on?

JohnFawkes commented 2 years ago

maybe. i dont know vue or yarn though. i thought about just forking the pihole one and making changes where needed for adguard

Lissy93 commented 2 years ago

Actually I remember looking into this a few weeks back, and it doesn't appear that AdGuard Home has an API that exposes any info, meaning it's not possible to build a widget for :( Here's a list of what's needed in order for it to be possible to build a widget.

JohnFawkes commented 2 years ago

it does though

JohnFawkes commented 2 years ago

https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi

AdGuardHome/openapi at master ยท AdguardTeam/AdGuardHome
Network-wide ads & trackers blocking DNS server. Contribute to AdguardTeam/AdGuardHome development by creating an account on GitHub.
Lissy93 commented 2 years ago

Awesome, then it will be possible then :)

At the moment I don't personally have time to build this myself, as I have a lot on atm. And this is what I'm going to be working on next, plus some media widgets. I can try and come back to AdGuard in the future.

I have written a guide on how to build a widget, it's pretty straigtforward, and you can use on the existing ones as a template.

JohnFawkes commented 2 years ago

sounds good. ill look at the templates and the guide and see if I can come up with something. If I can ill open a PR and maybe even try to work on some other widgets

Lissy93 commented 2 years ago

Awesome, let me know if you have any questions, or need any help :)

devosm commented 2 years ago

Was about to suggest this same thing, not sure if this is still being worked on? :)

Lissy93 commented 2 years ago

It is on my todo list :) But I've still got a bunch of other improvements, features and stuff that is above this on the list. If only there were more hours in the day...

devosm commented 2 years ago

It is on my todo list :) But I've still got a bunch of other improvements, features and stuff that is above this on the list. If only there were more hours in the day...

No worries, was just checking and wondering as the item was closed :) Keep up the good work! If I ever learn a bit how to do these things myself I'd be more than happy to contribute

Lissy93 commented 2 years ago

What sort of data would you like to see in an AdGuard widget?

I'm a Pi-Hole user, so this is new to me. I've spun up a fresh instance of AdGuard to build this, but since it doesn't have any real data, it's hard to visualize what's important to you guys, as AdGuard users.

Based on the API endpoints available, these are my ideas:

That sound okay?

For reference, you can see the AdGuard docs, by pasting this into here

Baftastic commented 2 years ago

I'm really glad if this widget arrive, because the AdGuard Home is the best solution for Encrypted DNS Server (DOT, DOH)+LetsEncrypt for using outside of my network, without VPN.

devosm commented 2 years ago

For me personally the main goal is to have query stats as in your first example as that's my main usage for Adguard. Similar to how Heimdall displays it image

The other suggestions are also useful though, I may look into those when I start configuring it further

Lissy93 commented 2 years ago

Thanks guys :)

Am working on this now! But need a small favor, my instance doesn't enough real data to properly test what I've done so far.

If one of you could share the output of the following URLs, that would be really helpful. If you redact anything, be sure the format remains the same. https://[adguard-hostname]/control/stats https://[adguard-hostname]/control/filtering/status https://[adguard-hostname]/control//dns_info

devosm commented 2 years ago

Any way I can send you that data directly? As I'm unsure if there's any personal data in there that I don't want on a public page here ๐Ÿ˜„

Lissy93 commented 2 years ago

Yeah, you can email it to alicia.sykes@protonmail.com Thanks so much!

liss-bot commented 2 years ago

It looks like this issue isn't in English - not a problem, here's the translation! ๐Ÿ‡ฌ๐Ÿ‡ง


Yeah, you can email it to alicia.sykes@protonmail.com Thanks so much!

devosm commented 2 years ago

It looks like this issue isn't in English - not a problem, here's the translation! ๐Ÿ‡ฌ๐Ÿ‡ง

Yeah, you can email it to alicia.sykes@protonmail.com Thanks so much!

Sent! :)

Lissy93 commented 2 years ago

Will get it merged either this evening or tomorrow evening...

Here's a preview:

Baftastic commented 2 years ago

One ting about this preview: We are able to specify multiple DNS Servers for upstream, like with the bootstrap servers image

Just to avoid design issues