Gotify to Ntfy Proxy

This is intended to be used with Proxmox v8+ to get Ntfy integration with the "new" notification system. At time of writing there is no native Ntfy integration in Proxmox.

Proxmox settings

Go to Datacenter > Notifications > Add > Gotify

In this example the proxy is running on "http://10.0.0.6:8008" topic on Ntfy is "your_topic_name" and the ntfy token is "tk_yoursupersecretntfytoken".

After adding the proxy create a "Notification Matcher" or edit the default one. The proxy also works with Proxmox Backup Server since it uses the same notification system as Proxmox.

Example .env file

The protocol part of the NTFY_SEVER variable is mandatory.

NODE_ENV=production

RELAY_HOST_IP=0.0.0.0
RELAY_PORT=8008

NTFY_SERVER=https://ntfy.sh

# This is a workaround option for iOS users due to no attatchment support on iOS
# set this to any value to enable message splitting
SPLIT_LARGE_MESSAGES=

Example topic.js file

const topics = {
  you_topic_name_one: {
    ntfyToken: 'tk_yoursupersecretntfytoken'
  },
  you_topic_name_two: {
    ntfyToken: 'tk_yoursupersecretntfytoken'
  },
}

module.exports = topics

Run local

Ensure node v20+ and yarn 1.22+ are installed

git clone https://github.com/LevantinLynx/gotify-to-ntfy-proxy.git

cd gotify-to-ntfy-proxy

cp .env.defaut .env
# Edit .env file

cp topics.defaut.js topics.js
# Edit tocics.js file
# MAKE SURE THIS IS SAVE! IT CONTAINS YOUR NTFY TOKEN/S.

yarn install

yarn start

Docker

IMPORTANT: If you are using docker container names to route between containers make sure you still use the protocol "http://" in front of the container name. Otherwise it wont work. e.g. NTFY_SERVER=http://ntfy_container_name

docker run \
  -p 8008:8008 \
  -v /path/to/your/.env:/home/node/app/.env \
  -v /path/to/your/topics.js:/home/node/app/topics.js \
  --restart unless-stopped \
  levantinlynx/gotify-to-ntfy-proxy:latest

Optionally you can also pass the environment variables instead of using the .env file or use docker compose.

services:
  gotify-to-ntfy-proxy:
    image: 'levantinlynx/gotify-to-ntfy-proxy:latest'
    restart: unless-stopped
    volumes:
      - '/path/to/your/topics.js:/home/node/app/topics.js'
    ports:
      - '8008:8008'
    environment:
      - RELAY_HOST_IP=0.0.0.0
      - RELAY_PORT=8008
      - NTFY_SERVER=https://ntfy.sh
      # This is a workaround option for iOS users due to no attatchment support on iOS
      # set this to any value to enable message splitting, remove it to disable
      - SPLIT_LARGE_MESSAGES=

If no environment file or variables are provided, the service will start with the following default values:

NODE_ENV=production
RELAY_HOST_IP=0.0.0.0
RELAY_PORT=8008
NTFY_SERVER=https://ntfy.sh

iOS workaround for long messages

The iOS/Adroid notification system has a limit on content length of about 4K. Ntfy will convert long messages to an attatchment automatically. This is no problem for Android users, but the iOS App does not support attatchments at the moment. The environment variable SPLIT_LARGE_MESSAGES can be set to any value to enable message splitting. If enabled, the message will be chunked and send in 1 second interval to provide correct order and readability for long logs. The split message titles will be appended with PART #/#.

---

Credits

Thank you to all the contributers of Gotify and Ntfy for creating and maintaining such amazing and usefull software.

Logo

The gotify-to-ntfy-proxy logo is licensed under the Creative Commons Attribution 4.0 International Public License.

Gotify

The Gotify logo is licensed under the Creative Commons Attribution 4.0 International Public License. The original Go gopher was designed by Renee French (http://reneefrench.blogspot.com/).