Skip to content

igotify.md

Latest commit

 

History

History
184 lines (140 loc) · 4.46 KB

igotify.md

File metadata and controls

184 lines (140 loc) · 4.46 KB

Push Notifications with iGotify

Author: Fran

Overview

Gotify is a self-hosted server for sending and receiving push notifications, offering a simple web interface and apps for real-time message delivery. iGotify is a containerized notification bridge that works alongside a Gotify server. Deployed via Docker (commonly with Docker Compose on Ubuntu), iGotify decrypts Gotify messages and forwards them as push notifications through Apple’s APNs to iOS devices—addressing Gotify’s lack of native support for iOS push alerts.

Deployment Steps

  1. Prepare Docker Compose file

Create or edit /srv/gotify/docker-compose.yml with the following content:

version: "3.8"

services:
  gotify:
    image: gotify/server
    container_name: gotify
    restart: unless-stopped
    volumes:
      - ./gotify-data:/app/data
    # Expose ONLY on loopback for use behind Nginx:
    ports:
      - "127.0.0.1:8180:80"

  igotify:
    image: ghcr.io/androidseb25/igotify-notification-assist:latest
    container_name: igotify
    restart: unless-stopped
    environment:
      - GOTIFY_URLS=http://gotify
      - SECNTFY_TOKENS=NTFY-DEVICE-xxxxx
      - GOTIFY_CLIENT_TOKENS=CLe.xxxx
    depends_on:
      - gotify
    ports:
      - "127.0.0.1:2080:8080"
    volumes:
      - ./igotify-data:/app/data
  1. Deploy or update containers
cd /srv/gotify
docker compose down --remove-orphans  # optional
sudo docker compose pull
sudo docker compose up -d
  1. Configure Nginx reverse proxy

Create or edit /etc/nginx/sites-available/ntfy.beachlab.org with:

server {
  listen 443 ssl;
  listen [::]:443 ssl;
  http2 on;
  server_name ntfy.beachlab.org;

  ssl_certificate     /etc/letsencrypt/live/ntfy.beachlab.org/fullchain.pem;
  ssl_certificate_key /etc/letsencrypt/live/ntfy.beachlab.org/privkey.pem;

  client_max_body_size 20m;

  location / {
    proxy_pass http://127.0.0.1:8180;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-Proto https;
    proxy_set_header X-Forwarded-For $remote_addr;

    proxy_http_version 1.1;   # SSE/WebSocket
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";     
    proxy_buffering off;       # SSE
    proxy_read_timeout 3600s;  # SSE
  }

  location /igotify/ {
    proxy_pass http://127.0.0.1:2080/;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;

    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_buffering off;
    proxy_read_timeout 3600s;
  }
}
  1. Reload and test Nginx
sudo nginx -t
sudo systemctl reload nginx
  1. iOS app setup
  • Gotify Server URL: https://ntfy.beachlab.org
  • Notification Assist URL: https://ntfy.beachlab.org/igotify/
  1. Get token in iOS app and test

Obtain a token in the iOS app, then test sending a notification:

curl -s -X POST "https://ntfy.beachlab.org/message" \
  -H "X-Gotify-Key: TU_APP_TOKEN" \
  -F "title=Test Push" \
  -F "message=Hola desde APNs"
  1. Setup notifier script and environment variables

Create environment variables file /etc/notify.env (replace tokens accordingly):

sudo tee /etc/notify.env >/dev/null <<'EOF'
GOTIFY_URL="https://ntfy.beachlab.org/message"
GOTIFY_APP_TOKEN="Ar_xxxxxx"
DEFAULT_PRIORITY="5"
EOF

Notifier Script

Create the notifier script /usr/local/bin/notify.sh:

sudo tee /usr/local/bin/notify.sh >/dev/null <<'EOF'
#!/usr/bin/env bash
set -euo pipefail
[ -f /etc/notify.env ] && . /etc/notify.env

TITLE="${1:-Notice}"
MSG="${2:-(no message)}"
PRIO="${3:-${DEFAULT_PRIORITY:-5}}"

curl -fsS -X POST "$GOTIFY_URL" \
  -H "X-Gotify-Key: ${GOTIFY_APP_TOKEN}" \
  -F "title=${TITLE}" \
  -F "message=${MSG}" \
  -F "priority=${PRIO}" >/dev/null
EOF
sudo chmod +x /usr/local/bin/notify.sh

You can now send a notification with:

/usr/local/bin/notify.sh "Test ✅" "This is a test notification from the server"

Optionally, create an alias for convenience:

alias notify='/usr/local/bin/notify.sh'
source ~/.bashrc

Then use:

notify "Test 🚀" "Alias works fine"

To send notifications that bypass Do Not Disturb mode, use a higher priority (e.g., 10):

notify "Backup failed ❌" "Disk full" 10