search

engels74 / mover-status

Mover Status Script for Unraid / UnraidOS
GNU Affero General Public License v3.0
14 stars 0 forks source link

Request - Apprise API? #5

Open nebb00 opened 4 months ago

nebb00 commented 4 months ago

Just wondering if you would be interested adding Apprise support. Its just an curl using the right formatting, that way any notification service could be used. Just an idea.

https://github.com/caronc/apprise-api

engels74 commented 4 months ago

I'll look into it, no promises :).

But I'm thinking of restructuring this little project a bit, or doing an off-shoot version of it.. Probably in Python or something, where I can split up the project to multiple files. I don't think currently the user scripts plugin in Unraid supports this properly.

Either way, it's going to be a while before I'll take a proper look at this project again. I'll happily accept a PR, if anyone's up for it.

Reason being the bash script is getting increasingly complex, and that combined with me not being that great of a programmer, makes it a bit hard to manage. Especially if I keep on adding more and more notification services, that all has different approaches to how they accept/decode e.g. markdown or formatting in general.

So my plan is to make it available as a Docker image on the Unraid, that then uses pid=host or uses the /proc in read-only mode or something, if that's even possible. This should also mitigate the issue(s) with it not working with cron and so on. At least move away from having one huge / long bash script. Maybe not a docker image, but anything that's not one huge bash script.

RyanRoberts210 commented 1 month ago

I just wanted to second this great idea! It is so surprising that this functionality (i.e. mover status reporting) isn't just built in to Unraid itself... In addition to apprise there is always the built-in notification processes in Unraid itself which could be used. I totally get the length of the script but have to say it is immaculate in layout and documentation, I can follow all of it. :) I would love to have this functionality but don't have / use the services supported... Thanks for your consideration!

engels74 commented 1 month ago

I just wanted to second this great idea! It is so surprising that this functionality (i.e. mover status reporting) isn't just built in to Unraid itself... In addition to apprise there is always the built-in notification processes in Unraid itself which could be used. I totally get the length of the script but have to say it is immaculate in layout and documentation, I can follow all of it. :) I would love to have this functionality but don't have / use the services supported... Thanks for your consideration!

I know Unraid includes a notification system, but it's quite basic. Personally, I prefer the way the bash script is handling it currently, particularly the Discord one, because it is more visually appealing. It took me quite some time figuring out how to work with Discord Embeds 😭 . I tried Unraid's notification system a while ago, and it felt a little lackluster. Or maybe I don't know how to use it properly :).

When I have the time and motivation, I'll consider undertaking a restructuring or creating it from scratch in Python. To utilize a simple Docker image in Unraid. This should make it easy for me to add multiple/several new notification services, such as the Apprise API, Gotify and ntfy.

But I don't have the motivation (or time) right now, especially since the script is currently working well for me. So, once again, if anyone wants to make any PRs with a new notification service, I'll gladly merge it in. Especially considering it'll probably be a while before I get to complete a rework of the project.