Gotify Push Notifications

Key Features

• Real-time WebSocket connections for instant message delivery to web clients and mobile apps
• Multi-application support with individual API tokens for different services and projects
• Plugin system for extending functionality with custom message processing and integrations
• Message priority levels with different notification behaviors and retention policies
• Web-based administration interface for managing applications, clients, and message history
• Android mobile application with customizable notification sounds and vibration patterns
• REST API with comprehensive documentation for programmatic message sending and management
• SQLite database backend with automatic schema migrations and data integrity checks

Common Use Cases

• 1Home automation systems sending alerts for security events, sensor readings, and device status changes
• 2CI/CD pipeline notifications for build failures, deployment completions, and code review requests
• 3Server monitoring and alerting for system resource usage, service failures, and backup completion status
• 4Small team collaboration with custom application notifications for task assignments and project updates
• 5Development environment integration for test results, error logging, and debugging information
• 6Personal productivity applications with reminders, calendar events, and habit tracking notifications
• 7IoT device management with sensor alerts, device offline notifications, and data collection status updates

Prerequisites

• Docker Engine 20.10 or later with Docker Compose V2 support
• Minimum 128MB RAM allocation for the Gotify container and SQLite operations
• Available port 8080 on the host system for web interface and API access
• Environment variables configured: TZ (timezone), GOTIFY_USER (admin username), GOTIFY_PASS (admin password)
• Basic understanding of REST API concepts for application token management and message sending
• Android device or web browser for receiving and testing push notifications

docker-compose.yml

1services: 
2  gotify: 
3    image: gotify/server:latest
4    container_name: gotify
5    environment: 
6      - TZ=${TZ}
7      - GOTIFY_DEFAULTUSER_NAME=${GOTIFY_USER}
8      - GOTIFY_DEFAULTUSER_PASS=${GOTIFY_PASS}
9    volumes: 
10      - gotify_data:/app/data
11    ports: 
12      - "8080:80"
13    restart: unless-stopped
14    networks: 
15      - gotify-network
16
17volumes: 
18  gotify_data: 
19
20networks: 
21  gotify-network: 
22    driver: bridge

.env Template

1# Gotify
2TZ=UTC
3GOTIFY_USER=admin
4GOTIFY_PASS=admin123

Usage Notes

Quick Start

1# 1. Create the compose file
2cat > docker-compose.yml << 'EOF'
3services:
4  gotify:
5    image: gotify/server:latest
6    container_name: gotify
7    environment:
8      - TZ=${TZ}
9      - GOTIFY_DEFAULTUSER_NAME=${GOTIFY_USER}
10      - GOTIFY_DEFAULTUSER_PASS=${GOTIFY_PASS}
11    volumes:
12      - gotify_data:/app/data
13    ports:
14      - "8080:80"
15    restart: unless-stopped
16    networks:
17      - gotify-network
18
19volumes:
20  gotify_data:
21
22networks:
23  gotify-network:
24    driver: bridge
25EOF
26
27# 2. Create the .env file
28cat > .env << 'EOF'
29# Gotify
30TZ=UTC
31GOTIFY_USER=admin
32GOTIFY_PASS=admin123
33EOF
34
35# 3. Start the services
36docker compose up -d
37
38# 4. View logs
39docker compose logs -f

One-Liner

Run this command to download and set up the recipe in one step:

1curl -fsSL https://docker.recipes/api/recipes/gotify-notifications/run | bash

Troubleshooting