homarr icon indicating copy to clipboard operation
homarr copied to clipboard

Add module for Speedtest Tracker - Traefik - NPM (Nginx Proxy Manager) - PiHole - Jellyfin

Open AuthorShin opened this issue 1 year ago • 4 comments

Name the integration

Add module for Speedtest Tracker - Traefik - NPM (Nginx Proxy Manager) - PiHole - Jellyfin. Let me know if I could help.

Please tick the boxes

  • [X] You've read the docs
  • [X] You've checked for duplicate issues
  • [X] You're not just putting an idea out there and actually give usefull information about how to implement your module idea

AuthorShin avatar Sep 08 '22 20:09 AuthorShin

Hi, thank you for your request. This is a very short description for what you want. Can you provide us with some additional data and information, such as but not limited to:

  • What data should be displayed?
  • How could the user interact

Also, please provide links for projects whenever possible. There are tons of Speedtests out there, and we're not going to be able to integrate all of them :)

manuel-rw avatar Sep 08 '22 21:09 manuel-rw

Hi Sure Speedtest Tracker Example: (Showing the latest test result)

Traefik

NPM (Nginx Proxy Manager) Their GitHub Example: (Showing the total/disabled/enabled number of proxies)

PiHole Example: (Showing the last 24h queries/blocked one and also the total number of domains in block list)

Jellyfin Linuxserver Image Their GitHub

Source for images and the idea is Homepage

AuthorShin avatar Sep 09 '22 04:09 AuthorShin

* What data should be displayed?

* How could the user interact

@manuel-rw There can be an option on the right menu of each service for showing this information or a separate widget or even like Homepage, users can show/hide those information by clicking on the green dot (Ping) of each service. Since the tiles are big enough and there's not a lot of information to show for each app, I suggest the menu option or green dot (Ping) rather than a separate widget for each, but I understand it might be easier and more convenient to simply add more widgets.

AuthorShin avatar Sep 09 '22 04:09 AuthorShin

Thank you for clarifying. Due to Homarr's current architecture, it's not possible to display such statistics or numbers easily. Version 1.0 will bring major improvements to Homarr, which will enable us to do such things.

Adding more widgets is easier for now, but it will also add lots of empty and wasted screen space.

@ajnart I think displaying numbers closer to the actual service card makes sense. Do we already have planned such a feature for 1.0?

manuel-rw avatar Sep 09 '22 13:09 manuel-rw

Not planned at the moment. (speedtest feature)

Ideally in the future any integration could be added by editing a service to send a request to it and read data at a certain JSON path. Displaying the wanted info. Perhaps we could make some global config file containing "presets" i.e. Service preset is PiHole --> Requests {service}/api/stats and displays {global.requests.blocked} {t('presets.pihole.blocked'} (t is the translation function) Also adding required fields for login/pass auth or API auth to the respective APIs when needed

This is a LOT of work but is in my ideal roadmap for Homarr.

ajnart avatar Oct 11 '22 01:10 ajnart