Gotify yunohost notifications.md

These hooks allow you to get notified on your phone or pc via gotify app. So you have to install this app (on any server). Don't forget to replace __GOTIFYPATH__ by the gotify app path (domain.com/gotify) and __TOKEN__ with a registered app on your gotify server. Make changes as you like to the messages.

1. Change user to root and change current working dir to yunohost hooks

# Change user to root and change current working dir to yunohost hooks
sudo -i
cd /etc/yunohost/hooks.d/

2. Get notified after adding a domain

# Add post_domain_add notification
mkdir post_domain_add
nano post_domain_add/01-post_domain_add

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
notif="$current_date : Domain $1 added"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - Domains" -F "message=$notif" > /dev/null 2>&1

3. Get notified after removing a domain

# Add post_domain_remove notification
mkdir post_domain_remove
nano post_domain_remove/01-post_domain_remove

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
notif="$current_date : Domain $1 removed"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - Domains" -F "message=$notif" > /dev/null 2>&1

4. Get notified after a certificate update

# Add post_cert_update notification
mkdir post_cert_update
nano post_cert_update/01-post_cert_update

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
notif="$current_date : Certificate for domain $1 updated"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - Certificates" -F "message=$notif" > /dev/null 2>&1

5. Get notified after a backup is finished

# Add backup notification
mkdir backup
nano backup/01-backup

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
id=$YNH_APP_ID
current_version=$YNH_APP_MANIFEST_VERSION
notif="$current_date : Backup of App : $id $current_version successful"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - App Backup" -F "message=$notif" > /dev/null 2>&1

6. Get notified after a restore is finished

# Add restore notification
mkdir restore
nano restore/01-restore

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
id=$YNH_APP_ID
current_version=$YNH_APP_MANIFEST_VERSION
notif="$current_date : Restore of App : $id $current_version successful"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - App Restore" -F "message=$notif" > /dev/null 2>&1

7. Get notified after an app is installed

# Add post_app_install notification
mkdir post_app_install
nano post_app_install/01-post_app_install

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
id=$YNH_APP_ID
current_version=$YNH_APP_MANIFEST_VERSION
notif="$current_date : App : $id $current_version installed successfully"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - App Install" -F "message=$notif" > /dev/null 2>&1

8. Get notified after an app is removed

# Add post_app_remove notification
mkdir post_app_remove
nano post_app_remove/01-post_app_remove

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
id=$YNH_APP_ID
current_version=$YNH_APP_MANIFEST_VERSION
notif="$current_date : App : $id $current_version removed successfully"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - App Remove" -F "message=$notif" > /dev/null 2>&1

9. Get notified after an app is updated

# Add post_app_upgrade notification
mkdir post_app_upgrade
nano post_app_upgrade/01-post_app_upgrade

paste, save and exit

#!/bin/bash
source /usr/share/yunohost/helpers
current_date=$(date +"%d/%m/%Y %T")
id=$YNH_APP_ID
current_version=$YNH_APP_CURRENT_VERSION
updated_version=$YNH_APP_MANIFEST_VERSION
notif="$current_date : App : $id updated from $current_version to $updated_version successfully"
curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno HomeServer - App Update" -F "message=$notif" > /dev/null 2>&1

10. Get notified when a successful ssh connection is established

# Get notified when a successful ssh connection is established
nano /etc/profile.d/gotify_ssh_login.sh

paste, save and exit

curl -X POST "https://__GOTIFYPATH__/message?token=__TOKEN__" -F "title=Yuno Server - SSH login" -F "message=$USER connected from $SSH_CLIENT" > /dev/null 2>&1" > 

11. Set up notifications for low disk space on Linux server using gotify:

11.1. Script Creation:

We'll create a bash script that checks disk space and sends a notification via gotify if it falls below a threshold.

• Create a new file (e.g., check_disk_space.sh) using a text editor.
• Add the following content to the script, replacing the following:
  • /dev/sdX: Replace this with the actual mount point of your disk drive (you can check with the df command).
  • <YOUR_GOTIFY_URL>: Replace this with your gotify server URL, including the port (e.g., http://localhost:8080).
  • <YOUR_GOTIFY_ACCESS_TOKEN>: Replace this with your gotify access token (you can find this in your gotify settings).
  • <THRESHOLD>: Set your desired threshold for free disk space in MB (e.g., 10240 for 10GB).

#!/bin/bash

# Get free disk space in MB
FREE_SPACE=$(df -m /dev/sdX | awk '$2 > 0 {print $4}')

# Check if free space is below threshold
if [[ $FREE_SPACE -lt <THRESHOLD> ]]; then
  # Prepare message content
  MESSAGE="Server running low on disk space! Free space on /dev/sdX: $FREE_SPACE MB"

  # Send notification via gotify with curl
  curl -X POST "<YOUR_GOTIFY_URL>/message" \
    -H "Content-Type: application/json" \
    -d "{\"title\": \"Disk Space Alert\", \"message\": \"$MESSAGE\"}" \
    -H "Authorization: Token <YOUR_GOTIFY_ACCESS_TOKEN>"
fi

11.2. Make the script executable:

• Open a terminal and navigate to the directory where you saved the script.
• Run the following command:

chmod +x check_disk_space.sh

11.3. Schedule the script (cron):

• Open your crontab for editing:

crontab -e

• Add a new line following the format:

MINUTE HOUR DAY_OF_MONTH MONTH DAY_OF_WEEK COMMAND

Here's an example to run the script every hour:

0 * * * * /path/to/check_disk_space.sh

• Replace /path/to/check_disk_space.sh with the actual path to your script.

11.4. Save and Close:

• Save the crontab after making edits.
• This will now run your script every hour, checking disk space and sending a notification via gotify if it's below the threshold.

11.5. The recommended location for your custom scripts on a Linux server depends on a few factors:

Who will use the script?

• Personal Use: If the script is only for you and won't be used by other users, a good option is ~/.local/bin. This directory is within your home directory (~) and is included in your PATH by default on most systems after logging in. This makes the script accessible from anywhere in your home directory without specifying the full path.
• System-wide Use: If the script needs to be available to all users, a common location is /usr/local/bin. This directory is typically included in the system-wide PATH, allowing all users to execute the script by name from the command line.