Mastodon
/
nextpush-android
mirror of https://codeberg.org/NextPush/nextpush-android.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add home assistant to examples

This commit is contained in:
Undercut0150 2024-03-10 08:33:44 +00:00 committed by S1m
parent 23606fba68
commit 92ab85a0cb
1 changed files with 39 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
notification_channel_examples.md
View File

@ -1,9 +1,10 @@
# Notification Channel Examples
Here are some examples on how to set up Notification channels for some services. These are only examples so feel free to edit them and play with them to your hearts content.
Here are some examples on how to set up Notification channels for some services. .\
These are only examples so feel free to edit them and play with them to your hearts content.
## Testing
If you'd like to test your Notification channel, simply open a terminal and run this command.
If you'd like to test your Notification channel, simply open a terminal and run this command. .\
Remember to replace the placeholders with the Notification channel endpoint you get by longpressing.
`curl {Replace_with_Notification_channel_endpoint} -d "Hello world! This is a test."`
@ -12,7 +13,7 @@ How it should look:
## SSH & Local Logins
With your favorite text editor, open `/etc/profile` as root and add the following text to the very bottom of the file.
With your favorite text editor, open `/etc/profile` as root and add the following text to the very bottom of the file. .\
Remember to replace the placeholders with the Notification channel endpoint you get by longpressing.
```
@ -27,7 +28,7 @@ How it should look:
## DIUN
To get notified with DIUN, you will need to create a file and mount that file to your diun docker container.
To get notified with DIUN, you will need to create a file and mount that file to your diun docker container. .\
This example creates a file named `cmd.sh`, and mounts it at `/etc/diun/etc.sh`
With your favorite text editor, create and open `cmd.sh`, then paste this text.
@ -44,7 +45,10 @@ fi
curl {Replace_with_Notification_channel_endpoint} -d 'There is a Docker Image update available.'
```
add this to your DIUN conf under `notif:`
Afterwards, mark `cmd.sh` as executable: `chmod +x ./cmd.sh`
Finally add this to your DIUN config under `notif:`
```
script:
cmd: "sh"
@ -53,4 +57,34 @@ add this to your DIUN conf under `notif:`
- '/etc/diun/cmd.sh'
```
Now when DIUN runs you should get a notification that looks like this:
> Note: I'm not entirely versed in DIUN configuration and I know there is some way to let it tell you which container needs to be updated. Pull requests to fix this feature would be helpful!
## Home Assistant
To get Notifications from Home Assistant, we will be using the RESTful Notifications service built into Home Assistant.
With your favorite text editor, open your HA `configuration.yaml` and add the following text to the bottom of the file
```
rest_command:
notify_nextpush:
url: '{Replace_with_Notification_channel_endpoint}'
method: post
payload: '{{ message }}'
```
Reload your HA configuration, go to Settings > Automations & Scenes > + Creation Automation > Create new automation > Then do + Add action > Search for "RESTful Command: notify_nextpush" > Three dot menu in top right of RESTful command > Edit in YAML, and add a message that's relavent to the notification you'd like to recieve, and remember to add a When trigger.
```
service: rest_command.notify_nextpush
metadata: {}
data:
message: Motion detected at the front door.
```
How it should look:
## The end!
If there are more examples that you feel may be useful to add to these examples, feel free to submit a pull request!