binwiederhier/ntfy
Ntfy
ntfy is a self-hosted messaging infrastructure that provides a lightweight platform for sending and receiving real-time notifications. It functions as a topic-based pub-sub server, allowing users to publish and subscribe to message channels using standard HTTP requests. By bridging server-side events with native mobile and desktop clients, it enables the delivery of alerts across various environments through a unified communication layer.
The project distinguishes itself by offering a complete, private notification ecosystem that includes persistent message caching and robust access control. It supports the UnifiedPush protocol, acting as a gateway to native mobile operating system push services, which allows for decentralized notification delivery without reliance on proprietary cloud providers. Users can interact with the system through a command-line interface, webhooks, or persistent streaming connections like Server-Sent Events and WebSockets.
The platform covers a broad range of operational capabilities, including automated system monitoring, workflow integration, and cross-platform event broadcasting. It supports advanced message features such as content templating, file attachments, interactive buttons, and priority-based delivery. The system is designed for flexible deployment, offering containerized and binary-based installation options that simplify integration into existing infrastructure.
The software is distributed as a single static binary, facilitating straightforward deployment across Linux, macOS, and Windows environments.
Features
- PubSub Messaging Systems - Provides real-time communication by allowing clients to publish and subscribe to message topics over standard HTTP protocols.
- Notification Services - Provides command-line utilities for sending notifications to specific topics.
- Message Brokers - Facilitates asynchronous communication by allowing clients to publish and subscribe to specific message channels over standard HTTP protocols.
- Server-Sent Events - Maintains long-lived connections between server and client to push live message updates as they occur.
- Messaging Servers - Manages message persistence, user authentication, and real-time delivery for private notification networks.
- Self-Hosted Infrastructure - Provides a private messaging server for managing real-time alerts and message persistence.
- Push & Notifications - Standardises mobile notification delivery by acting as a gateway between self-hosted messaging servers and native operating system push services.
- Pub-Sub Systems - Listens for incoming messages on specific channels to trigger scripts.
- Message Caching Services - Stores incoming notifications in a relational database to allow clients to retrieve historical messages after reconnecting.
- Streaming Protocols - Receives real-time updates using persistent connections for live delivery.
- WebSocket Services - Establishes persistent connections to receive live data streams.
- Access Control - Secures message endpoints by requiring valid credentials or tokens.
- System Monitoring Tools - Tracks server health and background task status to trigger immediate alerts on state changes.
- Backend and Infrastructure - Push notification service for mobile and web.
- Communication Systems - Push notification service for phone and desktop.
- Native Modules & Bridges - Connects messaging services with local system handlers for device actions.
- Notification Clients - Provides native push alerts and message management across mobile, desktop, and command-line environments.
- Webhook Integrations - Triggers notifications using simple HTTP requests for system integration.
- Access Control Lists - Secures notification channels by configuring authentication requirements to prevent unauthorized users from reading or writing messages.
- Command Line Interfaces - Provides command-line utilities to manage notification topics, subscribe to message streams, and host local notification infrastructure.
- Priority Management - Assigns urgency levels to control device notification behavior.
- Event Buses - Connects disparate services and scripts through a shared topic-based messaging architecture.
- Interactive UI Elements - Allows attaching clickable buttons to trigger actions from alerts.
- Data Retrieval Services - Fetches historical notifications using polling or cached history.
- Database Abstraction Layers - Decouples application logic from storage by supporting interchangeable database drivers for message persistence and user access control.
- Task Schedulers - Delays notification transmission to a specific future time.
- Template Engines - Converts structured data into human-readable text using flexible formatting.
- Container Images - Runs notification services in containerized environments using official images with support for persistent data and custom configurations.
- Rate Limiters - Protects notification infrastructure from abuse by configuring request limits and identifying traffic sources behind proxy servers.
- File Transfer Utilities - Supports including files or images in notifications via HTTP.
- Task Monitoring - Monitors background tasks and scheduled scripts by sending status updates upon completion or failure.
