id: gotify
name: Gotify
version: "1.0"
description: Self-hosted push notification server with Android client support.
icon: https://serverkit.ai/imgs/template-icons/gotify.svg
website: https://gotify.net
documentation: https://gotify.net/docs/install
categories:
  - notifications
  - messaging

variables:
  - name: HTTP_PORT
    description: Port for the Gotify web UI and API (auto-assigned)
    type: port
    default: "8080"
    hidden: true
  - name: ADMIN_USERNAME
    description: Default admin username
    type: string
    default: "admin"
  - name: ADMIN_PASSWORD
    description: Default admin password (auto-generated)
    type: password
    length: 24

ports:
  - port: "${HTTP_PORT}"
    protocol: http
    description: Gotify Web UI & API

requirements:
  memory: 128MB
  storage: 500MB

compose:
  services:
    gotify:
      image: gotify/server:2.7.3
      container_name: ${APP_NAME}
      restart: unless-stopped
      ports:
        - "${HTTP_PORT}:80"
      environment:
        GOTIFY_DEFAULTUSER_NAME: "${ADMIN_USERNAME}"
        GOTIFY_DEFAULTUSER_PASS: "${ADMIN_PASSWORD}"
        GOTIFY_DATABASE_DIALECT: sqlite3
        GOTIFY_DATABASE_CONNECTION: data/gotify.db
        GOTIFY_SERVER_PORT: "80"
        GOTIFY_REGISTRATION: "false"
      volumes:
        - gotify-data:/app/data
      healthcheck:
        test: ["CMD", "curl", "-f", "http://127.0.0.1:80/health"]
        interval: 5s
        timeout: 20s
        retries: 10

  volumes:
    gotify-data:

post_install: |
  Gotify is installed and running!

  - Web UI: http://your-server:${HTTP_PORT}
  - Default login: ${ADMIN_USERNAME} / ${ADMIN_PASSWORD}

  Download the Android app and point it at http://your-server:${HTTP_PORT}.
  Create application tokens and send notifications via the REST API.