Apprise Config File
·
Sean P. McAdam
GitHub: caronc / apprise
- I took a look at this a few years back, but didn’t really dig too much into it.
- Now that I was playing around with Gotify alongside ntfy.sh, I thought it would be worth looking into Apprise again, so i don’t need to keep adding blocks for Gotify & ntfy to any scripts where I was leveraging them.
Config File: ~/.config/apprise/config.yaml
# https://github.com/caronc/apprise/wiki/config_yaml
# Host: LenovoM710q
# Path: /home/smc/.config/apprise/config.yaml
# Define your Groups
# groups:
# - friends:
# Multiple Group Assignments; reuse of a tag causes existing assignment
# to stack on the previous value.
# TeamA, Friends = user1, user3
# TeamB, Friends = user2, user4
# Our global tags to associate with all of the URLs we define
# tag:
urls:
# One-liner (no colon at the end); just the url as you'd expect it:
# - ntfys://ntfy.domain.home/topic1-General # topic1, topic2, topic3 # different topic names so i don't have to go looking them up.
# - gotifys://gotify.domain.home/appToken
# [Discord](https://github.com/caronc/apprise/wiki/Notify_discord):
# - discord://webhook_id/webhook_token
# - discord://avatar@webhook_id/webhook_token
# https://discord.com/api/webhooks/#########/a1b2c3d4
# id: #########
# token: a1b2c3d4
- discord://#########/a1b2c3d4
# [Gotify](https://github.com/caronc/apprise/wiki/Notify_gotify):
# - gotifys://gotify.domain.home/$token
# - gotifys://gotify.domain.home/$token?priority=$severity
# Applications:
# - Server 1: Token1
# - Server 2: Token2
# - Server 3: Token3
- gotifys://gotify.domain.home/appToken
# [Home Assistant](https://github.com/caronc/apprise/wiki/Notify_homeassistant):
# - hassios://homeassistant.domain.home/?accesstoken
# - hassios://user@homeassistant.domain.home/accesstoken
# - hassios://user:password@homeassistant.domain.home:443/accesstoken
# - hassios://homeassistant.domain.home/optional/path/accesstoken
- hassios://homeassistant.domain.home?appKey
# [Mastodon](https://github.com/caronc/apprise/wiki/Notify_mastodon):
# - mastodons://access_key@hostname
# - mastodons://access_key@hostname/@user
# - mastodons://access_key@hostname/@user1/@user2/@userN
# [MQTT](https://github.com/caronc/apprise/wiki/Notify_mqtt):
# - mqtts://mqtt.domain.home/$topic
# - mqtts://user@mqtt.domain.home/topic
# - mqtts://user:pass@mqtt.domain.home:9883/topic
# - mqtts://mqtt.domain.home:8883/mqttTopic # 20250928: SMc: Having issues with this one.
# [Nextcloud](https://github.com/caronc/apprise/wiki/Notify_nextcloud):
# - nclouds://adminuser:pass@nextcloud.domain.home/User
# - nclouds://adminuser:pass@nextcloud.domain.home/User1/User2/UserN
# [Nextcloud Talk](https://github.com/caronc/apprise/wiki/Notify_nextcloudtalk):
# - nctalks://user:pass@nextcloud.domain.home/RoomId
# - nctalks://user:pass@nextcloud.domain.home/RoomId1/RoomId2/RoomIdN
- nctalks://AppriseUser:passkey@nextcloud.domain.home/string
# [ntfy](https://github.com/caronc/apprise/wiki/Notify_ntfy):
# Topics: topic1, topic2
# - ntfys://ntfy.domain.home/$topic/
# - ntfys://ntfy.domain.home/$topic/
- ntfys://ntfy.domain.home/topic
# [Signal API](https://github.com/caronc/apprise/wiki/Notify_signal):
# - signals://signal-api.domain.home:443/FromPhoneNo
# - signals://signal-api.domain.home:443/FromPhoneNo/ToPhoneNo
# - signals://signal-api.domain.home:443/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
- signals://signal-api.domain.home:443/phoneNo/phoneNo
# [Telegram](https://github.com/caronc/apprise/wiki/Notify_telegram):
# Alphr: [How to Find a Chat ID in Telegram](https://www.alphr.com/find-chat-id-telegram/)
# - tgrams://bottoken/ChatID
# - tgrams://bottoken/ChatID1/ChatID2/ChatIDN
- tgram://ID:key/chatID # Message to my Telegram handle
# - tgram://ID:key/-100group # Message to the group.
- tgram://ID:key/-100group:1/ # Message to "General" topic in group.
# - tgram://ID:key/-100group:8/ # Message to "Testing" topic in group.