feat(integration): add ntfy integration

internal/database/migrations.go

@@ -921,4 +921,20 @@ var migrations = []func(tx *sql.Tx) error{
 		_, err = tx.Exec(sql)
 		return err
 	},
+	func(tx *sql.Tx) (err error) {
+		sql := `
+			ALTER TABLE integrations ADD COLUMN ntfy_enabled bool default 'f';
+			ALTER TABLE integrations ADD COLUMN ntfy_url text default '';
+			ALTER TABLE integrations ADD COLUMN ntfy_topic text default '';
+			ALTER TABLE integrations ADD COLUMN ntfy_api_token text default '';
+			ALTER TABLE integrations ADD COLUMN ntfy_username text default '';
+			ALTER TABLE integrations ADD COLUMN ntfy_password text default '';
+			ALTER TABLE integrations ADD COLUMN ntfy_icon_url text default '';
+
+			ALTER TABLE feeds ADD COLUMN ntfy_enabled bool default 'f';
+			ALTER TABLE feeds ADD COLUMN ntfy_priority int default '3';
+		`
+		_, err = tx.Exec(sql)
+		return err
+	},
 }

internal/integration/integration.go

@@ -16,6 +16,7 @@ import (
 	"miniflux.app/v2/internal/integration/linkwarden"
 	"miniflux.app/v2/internal/integration/matrixbot"
 	"miniflux.app/v2/internal/integration/notion"
+	"miniflux.app/v2/internal/integration/ntfy"
 	"miniflux.app/v2/internal/integration/nunuxkeeper"
 	"miniflux.app/v2/internal/integration/omnivore"
 	"miniflux.app/v2/internal/integration/pinboard"
@@ -470,6 +471,28 @@ func PushEntries(feed *model.Feed, entries model.Entries, userIntegrations *mode
 		}
 	}
 
+	if userIntegrations.NtfyEnabled && feed.NtfyEnabled {
+		slog.Debug("Sending new entries to Ntfy",
+			slog.Int64("user_id", userIntegrations.UserID),
+			slog.Int("nb_entries", len(entries)),
+			slog.Int64("feed_id", feed.ID),
+		)
+
+		client := ntfy.NewClient(
+			userIntegrations.NtfyURL,
+			userIntegrations.NtfyTopic,
+			userIntegrations.NtfyAPIToken,
+			userIntegrations.NtfyUsername,
+			userIntegrations.NtfyPassword,
+			userIntegrations.NtfyIconURL,
+			feed.NtfyPriority,
+		)
+
+		if err := client.SendMessages(feed, entries); err != nil {
+			slog.Warn("Unable to send new entries to Ntfy", slog.Any("error", err))
+		}
+	}
+
 	// Integrations that only support sending individual entries
 	if userIntegrations.TelegramBotEnabled || userIntegrations.AppriseEnabled {
 		for _, entry := range entries {

internal/integration/ntfy/ntfy.go

@@ -0,0 +1,120 @@
+// SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package ntfy // import "miniflux.app/v2/internal/integration/ntfy"
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"log/slog"
+	"net/http"
+	"time"
+
+	"miniflux.app/v2/internal/model"
+	"miniflux.app/v2/internal/version"
+)
+
+const (
+	defaultClientTimeout = 10 * time.Second
+	defaultNtfyURL       = "https://ntfy.sh"
+)
+
+type Client struct {
+	ntfyURL, ntfyTopic, ntfyApiToken, ntfyUsername, ntfyPassword, ntfyIconURL string
+	ntfyPriority                                                              int
+}
+
+func NewClient(ntfyURL, ntfyTopic, ntfyApiToken, ntfyUsername, ntfyPassword, ntfyIconURL string, ntfyPriority int) *Client {
+	if ntfyURL == "" {
+		ntfyURL = defaultNtfyURL
+	}
+	return &Client{ntfyURL, ntfyTopic, ntfyApiToken, ntfyUsername, ntfyPassword, ntfyIconURL, ntfyPriority}
+}
+
+func (c *Client) SendMessages(feed *model.Feed, entries model.Entries) error {
+	for _, entry := range entries {
+		ntfyMessage := &ntfyMessage{
+			Topic:    c.ntfyTopic,
+			Message:  entry.Title,
+			Title:    feed.Title,
+			Priority: c.ntfyPriority,
+			Click:    entry.URL,
+		}
+
+		if c.ntfyIconURL != "" {
+			ntfyMessage.Icon = c.ntfyIconURL
+		}
+
+		slog.Debug("Sending Ntfy message",
+			slog.String("url", c.ntfyURL),
+			slog.String("topic", c.ntfyTopic),
+			slog.Int("priority", ntfyMessage.Priority),
+			slog.String("message", ntfyMessage.Message),
+			slog.String("entry_url", entry.URL),
+		)
+
+		if err := c.makeRequest(ntfyMessage); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (c *Client) makeRequest(payload any) error {
+	requestBody, err := json.Marshal(payload)
+	if err != nil {
+		return fmt.Errorf("ntfy: unable to encode request body: %v", err)
+	}
+
+	request, err := http.NewRequest(http.MethodPost, c.ntfyURL, bytes.NewReader(requestBody))
+	if err != nil {
+		return fmt.Errorf("ntfy: unable to create request: %v", err)
+	}
+
+	request.Header.Set("Content-Type", "application/json")
+	request.Header.Set("User-Agent", "Miniflux/"+version.Version)
+
+	// See https://docs.ntfy.sh/publish/#access-tokens
+	if c.ntfyApiToken != "" {
+		request.Header.Set("Authorization", fmt.Sprintf("Bearer %s", c.ntfyApiToken))
+	}
+
+	// See https://docs.ntfy.sh/publish/#username-password
+	if c.ntfyUsername != "" && c.ntfyPassword != "" {
+		request.SetBasicAuth(c.ntfyUsername, c.ntfyPassword)
+	}
+
+	httpClient := &http.Client{Timeout: defaultClientTimeout}
+	response, err := httpClient.Do(request)
+	if err != nil {
+		return fmt.Errorf("ntfy: unable to send request: %v", err)
+	}
+	defer response.Body.Close()
+
+	if response.StatusCode >= 400 {
+		return fmt.Errorf("ntfy: incorrect response status code %d for url %s", response.StatusCode, c.ntfyURL)
+	}
+
+	return nil
+}
+
+// See https://docs.ntfy.sh/publish/#publish-as-json
+type ntfyMessage struct {
+	Topic    string       `json:"topic"`
+	Message  string       `json:"message"`
+	Title    string       `json:"title"`
+	Tags     []string     `json:"tags,omitempty"`
+	Priority int          `json:"priority,omitempty"`
+	Icon     string       `json:"icon,omitempty"` // https://docs.ntfy.sh/publish/#icons
+	Click    string       `json:"click,omitempty"`
+	Actions  []ntfyAction `json:"actions,omitempty"`
+}
+
+// See https://docs.ntfy.sh/publish/#action-buttons
+type ntfyAction struct {
+	Action string `json:"action"`
+	Label  string `json:"label"`
+	URL    string `json:"url"`
+}

internal/locale/translations/de_DE.json

@@ -347,6 +347,13 @@
     "form.feed.label.disabled": "Dieses Abonnement nicht aktualisieren",
     "form.feed.label.no_media_player": "Kein Media-Player (Audio/Video)",
     "form.feed.label.hide_globally": "Einträge in der globalen Ungelesen-Liste ausblenden",
+    "form.feed.label.ntfy_activate": "Push entries to ntfy",
+    "form.feed.label.ntfy_priority": "Ntfy priority",
+    "form.feed.label.ntfy_max_priority": "Ntfy max priority",
+    "form.feed.label.ntfy_high_priority": "Ntfy high priority",
+    "form.feed.label.ntfy_default_priority": "Ntfy default priority",
+    "form.feed.label.ntfy_low_priority": "Ntfy low priority",
+    "form.feed.label.ntfy_min_priority": "Ntfy min priority",
     "form.feed.fieldset.general": "Allgemein",
     "form.feed.fieldset.rules": "Regeln",
     "form.feed.fieldset.network_settings": "Netzwerkeinstellungen",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Webhook Geheimnis",
     "form.integration.rssbridge_activate": "Beim Hinzufügen von Abonnements RSS-Bridge prüfen.",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Push entries to ntfy",
+    "form.integration.ntfy_topic": "Ntfy topic",
+    "form.integration.ntfy_url": "Ntfy URL (optional, default is ntfy.sh)",
+    "form.integration.ntfy_api_token": "Ntfy API Token (optional)",
+    "form.integration.ntfy_username": "Ntfy Username (optional)",
+    "form.integration.ntfy_password": "Ntfy Password (optional)",
+    "form.integration.ntfy_icon_url": "Ntfy Icon URL (optional)",
     "form.api_key.label.description": "API-Schlüsselbezeichnung",
     "form.submit.loading": "Lade...",
     "form.submit.saving": "Speichern...",

internal/locale/translations/el_EL.json

@@ -351,6 +351,13 @@
     "form.feed.fieldset.rules": "Rules",
     "form.feed.fieldset.network_settings": "Network Settings",
     "form.feed.fieldset.integration": "Third-Party Services",
+    "form.feed.label.ntfy_activate": "Push entries to ntfy",
+    "form.feed.label.ntfy_priority": "Ntfy priority",
+    "form.feed.label.ntfy_max_priority": "Ntfy max priority",
+    "form.feed.label.ntfy_high_priority": "Ntfy high priority",
+    "form.feed.label.ntfy_default_priority": "Ntfy default priority",
+    "form.feed.label.ntfy_low_priority": "Ntfy low priority",
+    "form.feed.label.ntfy_min_priority": "Ntfy min priority",
     "form.category.label.title": "Τίτλος",
     "form.category.hide_globally": "Απόκρυψη καταχωρήσεων σε γενική λίστα μη αναγνωσμένων",
     "form.user.label.username": "Χρήστης",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Webhook Secret",
     "form.integration.rssbridge_activate": "Check RSS-Bridge when adding subscriptions",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Push entries to ntfy",
+    "form.integration.ntfy_topic": "Ntfy topic",
+    "form.integration.ntfy_url": "Ntfy URL (optional, default is ntfy.sh)",
+    "form.integration.ntfy_api_token": "Ntfy API Token (optional)",
+    "form.integration.ntfy_username": "Ntfy Username (optional)",
+    "form.integration.ntfy_password": "Ntfy Password (optional)",
+    "form.integration.ntfy_icon_url": "Ntfy Icon URL (optional)",
     "form.api_key.label.description": "Ετικέτα κλειδιού API",
     "form.submit.loading": "Φόρτωση...",
     "form.submit.saving": "Αποθήκευση...",

internal/locale/translations/en_US.json

@@ -347,6 +347,13 @@
     "form.feed.label.disabled": "Do not refresh this feed",
     "form.feed.label.no_media_player": "No media player (audio/video)",
     "form.feed.label.hide_globally": "Hide entries in global unread list",
+    "form.feed.label.ntfy_activate": "Push entries to ntfy",
+    "form.feed.label.ntfy_priority": "Ntfy priority",
+    "form.feed.label.ntfy_max_priority": "Ntfy max priority",
+    "form.feed.label.ntfy_high_priority": "Ntfy high priority",
+    "form.feed.label.ntfy_default_priority": "Ntfy default priority",
+    "form.feed.label.ntfy_low_priority": "Ntfy low priority",
+    "form.feed.label.ntfy_min_priority": "Ntfy min priority",
     "form.feed.fieldset.general": "General",
     "form.feed.fieldset.rules": "Rules",
     "form.feed.fieldset.network_settings": "Network Settings",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Webhook Secret",
     "form.integration.rssbridge_activate": "Check RSS-Bridge when adding subscriptions",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Push entries to ntfy",
+    "form.integration.ntfy_topic": "Ntfy topic",
+    "form.integration.ntfy_url": "Ntfy URL (optional, default is ntfy.sh)",
+    "form.integration.ntfy_api_token": "Ntfy API Token (optional)",
+    "form.integration.ntfy_username": "Ntfy Username (optional)",
+    "form.integration.ntfy_password": "Ntfy Password (optional)",
+    "form.integration.ntfy_icon_url": "Ntfy Icon URL (optional)",
     "form.api_key.label.description": "API Key Label",
     "form.submit.loading": "Loading…",
     "form.submit.saving": "Saving…",

internal/locale/translations/es_ES.json

@@ -347,6 +347,13 @@
     "form.feed.label.disabled": "No actualice este feed",
     "form.feed.label.no_media_player": "No media player (audio/video)",
     "form.feed.label.hide_globally": "Ocultar artículos en la lista global de no leídos",
+    "form.feed.label.ntfy_activate": "Push entries to ntfy",
+    "form.feed.label.ntfy_priority": "Ntfy priority",
+    "form.feed.label.ntfy_max_priority": "Ntfy max priority",
+    "form.feed.label.ntfy_high_priority": "Ntfy high priority",
+    "form.feed.label.ntfy_default_priority": "Ntfy default priority",
+    "form.feed.label.ntfy_low_priority": "Ntfy low priority",
+    "form.feed.label.ntfy_min_priority": "Ntfy min priority",
     "form.feed.fieldset.general": "General",
     "form.feed.fieldset.rules": "Rules",
     "form.feed.fieldset.network_settings": "Network Settings",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Webhook Secret",
     "form.integration.rssbridge_activate": "Check RSS-Bridge when adding subscriptions",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Push entries to ntfy",
+    "form.integration.ntfy_topic": "Ntfy topic",
+    "form.integration.ntfy_url": "Ntfy URL (optional, default is ntfy.sh)",
+    "form.integration.ntfy_api_token": "Ntfy API Token (optional)",
+    "form.integration.ntfy_username": "Ntfy Username (optional)",
+    "form.integration.ntfy_password": "Ntfy Password (optional)",
+    "form.integration.ntfy_icon_url": "Ntfy Icon URL (optional)",
     "form.api_key.label.description": "Etiqueta de clave API",
     "form.submit.loading": "Cargando...",
     "form.submit.saving": "Guardando...",

internal/locale/translations/fi_FI.json

@@ -347,6 +347,13 @@
     "form.feed.label.disabled": "Älä päivitä tätä syötettä",
     "form.feed.label.no_media_player": "No media player (audio/video)",
     "form.feed.label.hide_globally": "Piilota artikkelit lukemattomien listassa",
+    "form.feed.label.ntfy_activate": "Push entries to ntfy",
+    "form.feed.label.ntfy_priority": "Ntfy priority",
+    "form.feed.label.ntfy_max_priority": "Ntfy max priority",
+    "form.feed.label.ntfy_high_priority": "Ntfy high priority",
+    "form.feed.label.ntfy_default_priority": "Ntfy default priority",
+    "form.feed.label.ntfy_low_priority": "Ntfy low priority",
+    "form.feed.label.ntfy_min_priority": "Ntfy min priority",
     "form.feed.fieldset.general": "General",
     "form.feed.fieldset.rules": "Rules",
     "form.feed.fieldset.network_settings": "Network Settings",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Webhook Secret",
     "form.integration.rssbridge_activate": "Check RSS-Bridge when adding subscriptions",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Push entries to ntfy",
+    "form.integration.ntfy_topic": "Ntfy topic",
+    "form.integration.ntfy_url": "Ntfy URL (optional, default is ntfy.sh)",
+    "form.integration.ntfy_api_token": "Ntfy API Token (optional)",
+    "form.integration.ntfy_username": "Ntfy Username (optional)",
+    "form.integration.ntfy_password": "Ntfy Password (optional)",
+    "form.integration.ntfy_icon_url": "Ntfy Icon URL (optional)",
     "form.api_key.label.description": "API Key Label",
     "form.submit.loading": "Ladataan...",
     "form.submit.saving": "Tallennetaan...",

internal/locale/translations/fr_FR.json

@@ -347,6 +347,13 @@
     "form.feed.label.disabled": "Ne pas actualiser ce flux",
     "form.feed.label.no_media_player": "Pas de lecteur multimedia (audio/vidéo)",
     "form.feed.label.hide_globally": "Masquer les entrées dans la liste globale non lue",
+    "form.feed.label.ntfy_activate": "Activer les notifications",
+    "form.feed.label.ntfy_priority": "Priorité de notification",
+    "form.feed.label.ntfy_max_priority": "Priorité maximale de notification",
+    "form.feed.label.ntfy_high_priority": "Priorité élevée de notification",
+    "form.feed.label.ntfy_default_priority": "Priorité par défaut de notification",
+    "form.feed.label.ntfy_low_priority": "Priorité basse de notification",
+    "form.feed.label.ntfy_min_priority": "Priorité minimale de notification",
     "form.feed.fieldset.general": "Général",
     "form.feed.fieldset.rules": "Règles",
     "form.feed.fieldset.network_settings": "Paramètres réseau",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Secret du webhook",
     "form.integration.rssbridge_activate": "Check RSS-Bridge when adding subscriptions",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Envoyer les entrées vers ntfy",
+    "form.integration.ntfy_topic": "Sujet Ntfy",
+    "form.integration.ntfy_url": "URL de Ntfy (optionnel, ntfy.sh par défaut)",
+    "form.integration.ntfy_api_token": "Jeton d'API Ntfy (optionnel)",
+    "form.integration.ntfy_username": "Nom d'utilisateur Ntfy (optionnel)",
+    "form.integration.ntfy_password": "Mot de passe Ntfy (facultatif)",
+    "form.integration.ntfy_icon_url": "URL de l'icône Ntfy (facultatif)",
     "form.api_key.label.description": "Libellé de la clé d'API",
     "form.submit.loading": "Chargement...",
     "form.submit.saving": "Sauvegarde en cours...",

internal/locale/translations/hi_IN.json

@@ -347,6 +347,13 @@
     "form.feed.label.disabled": "इस फ़ीड को रीफ़्रेश न करें",
     "form.feed.label.no_media_player": "No media player (audio/video)",
     "form.feed.label.hide_globally": "वैश्विक अपठित सूची में प्रविष्टियां छिपाएं",
+    "form.feed.label.ntfy_activate": "Push entries to ntfy",
+    "form.feed.label.ntfy_priority": "Ntfy priority",
+    "form.feed.label.ntfy_max_priority": "Ntfy max priority",
+    "form.feed.label.ntfy_high_priority": "Ntfy high priority",
+    "form.feed.label.ntfy_default_priority": "Ntfy default priority",
+    "form.feed.label.ntfy_low_priority": "Ntfy low priority",
+    "form.feed.label.ntfy_min_priority": "Ntfy min priority",
     "form.feed.fieldset.general": "General",
     "form.feed.fieldset.rules": "Rules",
     "form.feed.fieldset.network_settings": "Network Settings",
@@ -488,6 +495,13 @@
     "form.integration.webhook_secret": "Webhook Secret",
     "form.integration.rssbridge_activate": "Check RSS-Bridge when adding subscriptions",
     "form.integration.rssbridge_url": "RSS-Bridge server URL",
+    "form.integration.ntfy_activate": "Push entries to ntfy",
+    "form.integration.ntfy_topic": "Ntfy topic",
+    "form.integration.ntfy_url": "Ntfy URL (optional, default is ntfy.sh)",
+    "form.integration.ntfy_api_token": "Ntfy API Token (optional)",
+    "form.integration.ntfy_username": "Ntfy Username (optional)",
+    "form.integration.ntfy_password": "Ntfy Password (optional)",
+    "form.integration.ntfy_icon_url": "Ntfy Icon URL (optional)",
     "form.api_key.label.description": "एपीआई कुंजी लेबल",
     "form.submit.loading": "लोड हो रहा है...",
     "form.submit.saving": "सहेजा जा रहा है...",