[FEATURE-REQUEST] Action Buttons to execute web hooks

[marcbria]

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

Would be nice to be able to associate server actions to items so dashy could turn into a docker management tool.

Describe the solution you'd like

If dashy could associate to each item one or more icons to run docker and docker-compose commands... it will make possible to stop, rise or restart containers. If dashy can call bash scripts, we can make much more complex actions like container backups, application upgrades, etc.

To avoid security issues, it would only be possible for admin users.

Priority

Medium (Would be very useful)

Is this something you would be keen to implement

No response

[liss-bot]

Welcome to Dashy 👋 It's great to have you here, but unfortunately your ticket has been closed to prevent spam. Before reopening this issue, please ensure the following criteria are met.

Issues are sometimes closed when users:

• Have only recently joined GitHub
• Have not yet stared this repository
• Have not previously interacted with the repo

Before you reopen this issue, please also ensure that:

• You have checked that a similar issue does not already exist
• You have checked the documentation for an existing solution
• You have completed the relevant sections in the Issue template

Once you have verified the above standards are met, you may reopen this issue. Sorry for any inconvenience caused, I'm just a bot, and sometimes make mistakes 🤖

[Lissy93]

Heya @marcbria - Thanks for your suggestion :) Apologies that the ticket was closed. I'm actually working on dynamic content and actions at the moment (in PR: #382, see examples) which should be merged within the next week. And soon you will be able to execute actions through webhooks and API access. ...But turning Dashy into a full Docker management console might be a bit out of scope.

It would require access to the Docker daemon socket, and exposing /var/run/docker.sock comes with a lot of security considerations, so the best approach would be separation of concern - use a specialised app that does nothing but Docker management (like Portainer, Dozzle, cAdvisor, ShipYard, LazyDocker etc). And then use a dashboard app, like Dashy as a central dashboard.

[Lissy93]

Hiya @marcbria Just to let you know that support for dynamic content is now merged in #382. Once you've updated to V 1.9.4, take a look at the Widget Docs for a usage guide.

There isn't a Docker management widget, and because of the reasons listed above, I won't be building an official one. But everything should be in place for you to implement this if it's something you're still interested in. Feel free to reach out if you need any support with that :)

[marcbria]

Hi @Lissy93, nothing to sorry about. Instead of this, let me thanks you a lot for this wonderful project.

I'm actually working on dynamic content and actions at the moment (in PR: #382, see examples) which should be merged within the next week. And soon you will be able to execute actions through webhooks and API access. That's really impressive. I didn't know dashy was able to do all this. Great work and thanks to share it.

...But turning Dashy into a full Docker management console might be a bit out of scope. I full agree, but that is not what I am proposing. I'm sorry if I didn't make myself clear... English is not my mother tongue. What I'm suggesting is extending dashy to associate action-buttons to items.

Following the first unix philosophy maxima that defines that we should "make each program do one thing well" I see dashy as a frontend design tool able to call different "backends".

Then, we have "backend" tools like node-RED or flogo, that are able to run actions in our servers to do the docker management (or whatever you like to run) as they can be called from a single url.

What I'm suggesting here is extend Dashy with a new kind of widget (or extend item syntax) to be able to create "items" with multiple (arbitrary) "buttons" that will be able to release the potential of all those backends.

To illustrate it better what I have in mind, this is a mockup I took from the dashboard I like to build:

In this case, I have a row with some classic docker-managment buttons (pause, stop, restart) and then a second line with some tool-specific actions that will be performed by flogo calling a bash script (backup, duplicate, anonimize&send, notifications).

As said... I'm not not sure if this will fit well as a new widget or will be easier as item new attributes.

Actually, I'm more of a devOps guy and my coding skills are very rusty (I don't know anything about the current frameworks like nodeJS, vue.js) so I don't know if what I suggest is a feasible task or if it means major changes in your code.

It was just an idea for you to consider, because honestly, I think it opens a new hotizon for the tool to continue to grow in potential.

Cheers and thanks again for sharing your impressive work as free source software, m.

[Lissy93]

Got it, that makes perfect sense now - And I love the idea! I can definitely implement that :)

I think a lot of services (like NODE-Red) support web-hooks, which like you mentioned can execute actions just by hitting a URL, so that would probably be how I would build this.

I'm going to reopen and rename the issue, to keep track of it. Will update you here once it's finished. Might not be until mid-January though, as I lots on at work at the moment :/

[marcbria]

Wow... I admit I was convinced I wouldn't be able to convey how interesting this feature could be for Dashy and the community.

Thanks for listening. You're great Lissy.

From my side there is absolutely no rush... and just for considering the proposal I already feel indebted. :-)

When you have something (and I insist that there is no hurry), I can help testing the new functionality, making a first attempt of documentation (although my English is not good, a documentation draft could be better than nothing), helping with the translations to es_ES or ca_ES or being your "sparring" to evaluate if the configuration is clear enough for the end users...

If you want to extend the thread to clarify here how it will work (widget or item attributes? minimal viable product? what config params will be accepted?) just need to ask.

In short: Whatever you need, throw me a mention right here, please.

Thanks again for the fantastic project, m.

[Lissy93]

Thank you so much :) I will keep you updated :)

[liss-bot]

This issue has gone 6 weeks without an update. To keep the ticket open, please indicate that it is still relevant in a comment below. Otherwise it will be closed in 5 working days.

[Lissy93]

/keep-open

[nickm324]

Any progress on this?

[Lissy93]

Not yet, am working on multi-page support at the moment, then multi-media widgets. You interested?

[nickm324]

Not yet, am working on multi-page support at the moment, then multi-media widgets. You interested?

What could I do to help?

[rogerwilko1]

Hi @Lissy93, really appreciate all you’ve done to create and maintain this project. I just wanted to touch base to see if either the API Response widget or @marcbria’s idea has had any movement since your last update or if it’s on the horizon?

I have an API webhook that when accessed/navigated to by a remote client does some stuff server side and returns nothing (not the same server as the one hosting Dashy). I could just make a conventional icon and have it navigate to the webhook URL on click, but I don’t want to have the user able to see the API key in their address bar. Either the API Response widget or being able to execute a cURL request or execute a shell script remotely on click would allow me to implement this without leaking the API key to everyone that uses the Dashy panel. Alternatively, is there another easy enough way of doing this (is this something that can be implemented without too much of a headache by making my own widget? It’s amateur hour when it comes to me and JS.)

[VicVegas1]

I to need this, so my office staff can unlock doors.