Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE_REQUEST] Widget for AdguardHome #493

Closed
JohnFawkes opened this issue Feb 17, 2022 · 21 comments
Closed

[FEATURE_REQUEST] Widget for AdguardHome #493

JohnFawkes opened this issue Feb 17, 2022 · 21 comments
Labels
🦄 Feature Request [ISSUE] Suggestion for new feature, update or change 💤 Low Priority [ISSUE] Nice to have, but not currently in scope

Comments

@JohnFawkes
Copy link

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

@JohnFawkes JohnFawkes added the 🦄 Feature Request [ISSUE] Suggestion for new feature, update or change label Feb 17, 2022
@Lissy93
Copy link
Owner

Lissy93 commented Feb 17, 2022

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

@Lissy93 Lissy93 added the 💤 Low Priority [ISSUE] Nice to have, but not currently in scope label Feb 17, 2022
@JohnFawkes
Copy link
Author

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

@liss-bot liss-bot added the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label Feb 17, 2022
@Lissy93
Copy link
Owner

Lissy93 commented Feb 17, 2022

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.

@Lissy93 Lissy93 closed this as completed Feb 17, 2022
@liss-bot liss-bot removed the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label Feb 17, 2022
@JohnFawkes
Copy link
Author

it does though

@JohnFawkes
Copy link
Author

JohnFawkes commented Feb 17, 2022

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

Network-wide ads & trackers blocking DNS server. Contribute to AdguardTeam/AdGuardHome development by creating an account on GitHub.

@Lissy93
Copy link
Owner

Lissy93 commented Feb 17, 2022

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
Copy link
Author

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
Copy link
Owner

Lissy93 commented Feb 17, 2022

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

@devosm
Copy link

devosm commented May 28, 2022

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

@Lissy93
Copy link
Owner

Lissy93 commented May 28, 2022

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
Copy link

devosm commented May 28, 2022

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 Lissy93 reopened this May 28, 2022
@Lissy93
Copy link
Owner

Lissy93 commented May 28, 2022

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:

  • 1: AdGuard Stats

    • DNS query category pie chart
    • stats (query count, categories, etc)
  • 2: AdGuard DHCP Status

    • View status
    • V4 and V6 IP private IP addresses
    • List of leases
  • 3: AdGuard Safety, view status of and toggle (possibly)

    • Parental Controls (view, enable, disable)
    • Safe Search (view, enable, disable)
    • Safe Browsing (view, enable, disable)

That sound okay?

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

@Baftastic
Copy link

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.

@liss-bot liss-bot added the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 29, 2022
@devosm
Copy link

devosm commented May 29, 2022

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
Copy link
Owner

Lissy93 commented May 29, 2022

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

@liss-bot liss-bot removed the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 29, 2022
Lissy93 added a commit that referenced this issue May 29, 2022
@devosm
Copy link

devosm commented May 29, 2022

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 😄

@liss-bot liss-bot added the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 29, 2022
@Lissy93
Copy link
Owner

Lissy93 commented May 29, 2022

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

@liss-bot
Copy link
Collaborator

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!

@liss-bot liss-bot removed the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 29, 2022
@devosm
Copy link

devosm commented May 29, 2022

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! :)

@liss-bot liss-bot added the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 29, 2022
Lissy93 added a commit that referenced this issue May 29, 2022
Lissy93 added a commit that referenced this issue May 29, 2022
@Lissy93
Copy link
Owner

Lissy93 commented May 30, 2022

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

Here's a preview:

@liss-bot liss-bot removed the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 30, 2022
@Baftastic
Copy link

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

@liss-bot liss-bot added the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label May 30, 2022
Lissy93 added a commit that referenced this issue Jun 4, 2022
Lissy93 added a commit that referenced this issue Jun 4, 2022
Lissy93 added a commit that referenced this issue Jun 4, 2022
@Lissy93 Lissy93 closed this as completed in e451f86 Jun 4, 2022
@liss-bot liss-bot removed the 👤 Awaiting Maintainer Response [ISSUE] Response from repo author is pending label Jun 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🦄 Feature Request [ISSUE] Suggestion for new feature, update or change 💤 Low Priority [ISSUE] Nice to have, but not currently in scope
Projects
None yet
Development

No branches or pull requests

5 participants