Gotify

Send push notifications via a self-hosted Gotify server. Gotify is a simple, self-hosted server for sending and receiving messages.

URL format

scheme

gotify://host/token

Segment	Required	Description
`host`	Yes	Hostname of your Gotify server (without `https://`)
`token`	Yes	Application token from your Gotify dashboard

Example

typescript

import { notify } from '@ambersecurityinc/notifly';

await notify(
  { urls: ['gotify://gotify.myserver.com/Axxxxxxxxxxxx'] },
  { title: 'Backup Complete', body: 'Daily backup finished', type: 'success' }
);

Finding your credentials

Log in to your Gotify dashboard.
Go to Apps → Create Application.
Give it a name (e.g. "notifly") and click Create.
Copy the application token — it looks like Axxxxxxxxxxxx and starts with A.

Self-hosting Gotify

docker-compose.yml

# Docker Compose example
version: '3'
services:
  gotify:
    image: gotify/server
    ports:
      - "80:80"
    environment:
      - GOTIFY_DEFAULTUSER_PASS=admin
    volumes:
      - ./gotify_data:/app/data

Quirks & limitations

Gotify requires a self-hosted server — there is no public cloud service.
The application token is per-app, not per-user. Create one app per project for easier management.
HTTPS is strongly recommended for production servers.