diff --git a/README.md b/README.md index 8898ea5..0dd907e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ UnifiedPush provider for Nextcloud - android application ## Requirements -You need the UnifiedPUsh provider on the server, and at least the NextPush client on Android: +You need the UnifiedPush provider on the server, and at least the NextPush client on Android: **Nextcloud Server** @@ -33,6 +33,10 @@ You need the UnifiedPUsh provider on the server, and at least the NextPush clien 3. Install one application supporting UnifiedPush [2], or UP-Example [3]. Login into the application if you need to, for instance with your mastodon account or with your matrix account. 4. The application will automatically detect NextPush and use it to send notifications. +## Notification Channels + +This app supports notification channels for use cases where UnifiedPush can't be used. Please check the [Examples](docs/notification_channel_examples.md) for more information. + ## Credit This application has been inspired by [Nextcloud Push Notifier](https://gitlab.com/Nextcloud-Push/nextcloud-push-notifier) diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 7ef22a4..85862ed 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -47,7 +47,7 @@ NO Unregistering Are you sure to unregister %d app(s)? -
Long press on the channel to copy the endpoint

Title:

]]> +

Give your notification a Title:

]]> (Notif) %s Push to be notified. Not related to UnifiedPush: messages aren\'t forwarded to any other app. Copy Endpoint diff --git a/docs/diun_example.png b/docs/diun_example.png new file mode 100644 index 0000000..cbd9b8d Binary files /dev/null and b/docs/diun_example.png differ diff --git a/docs/ha_example.png b/docs/ha_example.png new file mode 100644 index 0000000..cb1b269 Binary files /dev/null and b/docs/ha_example.png differ diff --git a/docs/notification_channel_examples.md b/docs/notification_channel_examples.md new file mode 100644 index 0000000..6470b4f --- /dev/null +++ b/docs/notification_channel_examples.md @@ -0,0 +1,99 @@ +# 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. + +## Testing + +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."` + +How it should look: + +An Android screenshot showcasing a NextPush notification test + +## 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. \ +Remember to replace the placeholders with the Notification channel endpoint you get by longpressing. + +``` +if [ -n "$SSH_CLIENT" ]; then +curl {Replace_with_Notification_channel_endpoint} -d "${USER}@$(hostname -f) has logged in via SSH." > /dev/null +else +curl {Replace_with_Notification_channel_endpoint} -d "${USER}@$(hostname -f) has logged in locally." > /dev/null +fi +``` + +How it should look: + +An Android screenshot showcasing a NextPush SSH Login notification + +## DIUN +[DIUN Project Documentation](https://github.com/crazy-max/diun) \ +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. \ +Remember to replace the placeholders with the Notification channel endpoint you get by longpressing. + + +``` +#!/bin/sh + +env > /etc/diun/output +apk add curl +if [ "${DIUN_ENTRY_STATUS}" -ne "new" ]; then + return 0 +fi +curl {Replace_with_Notification_channel_endpoint} -d 'There is a Docker Image update available.' +``` + +Afterwards, mark `cmd.sh` as executable: `chmod +x ./cmd.sh` + +Finally add this to your DIUN config under `notif:` + +``` + script: + cmd: "sh" + args: + - '-c' + - '/etc/diun/cmd.sh' +``` + +Now when DIUN runs you should get a notification that looks like this: + +An Android screenshot showcasing a NextPush DIUN notification + +> 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 +[Home Assistant Documentation](https://www.home-assistant.io/docs/) +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 \ +Remember to replace the placeholders with the Notification channel endpoint you get by longpressing. + +``` +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: + +An Android screenshot showcasing a NextPush Home Assistant notification test + + ## 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! \ No newline at end of file diff --git a/docs/ssh_example.png b/docs/ssh_example.png new file mode 100644 index 0000000..e9a4ea2 Binary files /dev/null and b/docs/ssh_example.png differ diff --git a/docs/test_example.png b/docs/test_example.png new file mode 100644 index 0000000..0c2e8ef Binary files /dev/null and b/docs/test_example.png differ