Zum Hauptinhalt springen

FreshRSS Smart-Home-Integration, kostenlos und Open Source

FreshRSS-Integration für Gladys Assistant

Dein FreshRSS-Reader in Gladys: Ungelesene, neue Artikel, als gelesen markieren.

Auf GitHub ansehenAlle Integrationen

Verbinde Gladys mit FreshRSS, dem selbst gehosteten Feed-Aggregator: Verfolge deine ungelesenen Artikel pro Kategorie und pro Feed, reagiere auf neue Artikel, markiere Artikel aus deinen Szenen als gelesen und sieh die neuesten ungelesenen Artikel im Dashboard. Die Integration folgt dem Zustand deines Readers (gelesen / ungelesen, in allen deinen FreshRSS-Apps gleich), nicht den Feeds selbst.

Getestet mit einem echten FreshRSS 1.30.4 (dem offiziellen Docker-Image) und Test-Feeds. Rückmeldungen sind im Gladys-Forum willkommen.

Voraussetzungen​

  • Gladys Assistant 5.1 oder neuer.
  • FreshRSS, zu Hause oder auf einem öffentlichen Server, von der Gladys-Maschine aus erreichbar.
  • Die API von FreshRSS erlaubt: Öffne als Administrator Administration → Authentifizierung und aktiviere API-Zugriff erlauben.
  • Ein API-Passwort für deinen Benutzer: Öffne Profil → API-Verwaltung, gib ein API-Passwort ein und speichere. Es ist nicht dein Anmeldepasswort; FreshRSS zeigt die API-Adresse auf derselben Seite.

Konfiguration​

  1. Öffne den Tab Konfiguration der Integration.
  2. Gib unter FreshRSS-Adresse die Adresse ein, unter der du FreshRSS öffnest, zum Beispiel 192.168.1.50:8080 (http, wenn nichts angegeben ist) oder https://rss.example.org. Die von FreshRSS angezeigte API-Adresse (…/api/greader.php) funktioniert auch.
  3. Gib deinen Benutzernamen und das API-Passwort ein.
  4. Optional: FreshRSS lesen alle (standardmäßig 5 Minuten) und Zu beobachtende Stichwörter, durch Kommas getrennt, für den Stichwortfilter des Auslösers „Neuer Artikel“.
  5. Klicke auf Verbindung testen: Der Test zeigt den Benutzer, die ungelesenen Artikel, die Feeds und die Kategorien.
  6. Öffne den Tab Entdecken und füge die gewünschten Geräte hinzu.

Geräte​

  • FreshRSS: Ungelesene Artikel (insgesamt) und FreshRSS erreichbar (0, solange FreshRSS nicht antwortet).
  • Ein Gerät pro Kategorie und ein Gerät pro Feed (für jede und jeden angeboten): ihre Ungelesenen Artikel.

Die Werte werden alle paar Minuten gelesen (die Einstellung oben) und direkt nach jeder Änderung aus Gladys. Die Werte bleiben im Verlauf, für ein Diagramm deines Ungelesen-Stapels. Um ab einer Schwelle zu handeln, nutze den Geräte-Auslöser von Gladys: zum Beispiel Ungelesene Artikel über 50.

Dashboard-Widget​

FreshRSS: die Zahl der ungelesenen Artikel, die sechs neuesten ungelesenen Artikel (Feed, Datum, Zusammenfassung, Links zum Artikel und zum Feed in FreshRSS, wenn sie https sind), eine Taste Aktualisieren, die FreshRSS sofort neu liest, und eine Taste Als gelesen mit Bestätigung, die die angezeigten Artikel als gelesen markiert (nur sie). Auf ein Kategorie- oder Feed-Gerät eingestellt, zeigt das Widget nur dieses.

Szenen-Auslöser​

  • Neuer Artikel: Ein ungelesener Artikel ist in FreshRSS angekommen. Filter: eine Kategorie (ein Kategorie-Gerät), ein Feed (ein Feed-Gerät), ein Stichwort (eines der Stichwörter der Konfiguration, im Titel gefunden, ohne Beachtung von Groß- und Kleinschreibung und Akzenten). Übergebene Informationen: Titel, Link, Feed, Kategorie, Autor, gefundenes Stichwort, Veröffentlichungsdatum und Artikel-ID.

Nichts wird beim ersten Lesen nach der Installation der Integration ausgelöst, auch nicht für die Artikel, die beim Hinzufügen eines Feeds schon da sind, noch für Artikel, die in einer anderen App schon gelesen wurden. Pro Lesen werden höchstens 10 Artikel gemeldet.

Szenen-Aktionen​

  • FreshRSS-Artikel als gelesen markieren: alle ungelesenen Artikel einer Kategorie oder eines Feeds; wähle das FreshRSS-Gerät, um alles zu markieren. Ergebnisse: markierte Artikel, Kategorie oder Feed.
  • Artikel per ID als gelesen markieren: eine oder mehrere Artikel-IDs, typischerweise die Artikel-ID des Auslösers „Neuer Artikel“. Ergebnis: markierte Artikel.
  • Ungelesene FreshRSS-Titel lesen: die neuesten ungelesenen Artikel (1 bis 10), aller oder einer Kategorie oder eines Feeds, auf Wunsch danach als gelesen markiert. Ergebnisse: Anzahl gelesen, ungelesene Artikel insgesamt, Titel einer pro Zeile („Titel — Feed“), Titel, Link und Feed des neuesten.

Szenen-Beispiele​

  • Morgenüberblick: um 7:30 Ungelesene FreshRSS-Titel lesen (Kategorie Nachrichten, 5 Artikel, danach als gelesen markieren), dann eine Telegram-Nachricht mit dem Ergebnis Titel senden (mit der Variablenauswahl einfügen).
  • Ein Thema beobachten: mit Gladys in den Stichwörtern, Neuer Artikel mit dem Stichwort Gladys → eine Nachricht mit Titel und Link des Artikels senden, dann Artikel per ID als gelesen markieren mit seiner Artikel-ID.
  • Zu viel zu lesen: Geräte-Auslöser Ungelesene Artikel des FreshRSS-Geräts über 100 → FreshRSS-Artikel als gelesen markieren für die Kategorie Unkategorisiert.

Fehlerbehebung​

  • „Die API von FreshRSS ist deaktiviert“: Erlaube den API-Zugriff unter Administration → Authentifizierung (das muss ein Administrator von FreshRSS tun).
  • „FreshRSS hat den Benutzernamen oder das API-Passwort abgelehnt“: Das API-Passwort ist nicht das Anmeldepasswort; lege es unter Profil → API-Verwaltung neu fest.
  • „FreshRSS antwortet nicht“: Prüfe Adresse und Port von der Gladys-Maschine aus. Hinter einem Reverse Proxy gib die vollständige Adresse mit Pfad ein.
  • „FreshRSS leitet auf eine andere Adresse um“: FreshRSS antwortet unter einer anderen Adresse, oft derselben mit https://: Gib diese ein.
  • „Diese Adresse antwortet nicht wie FreshRSS“: Die Adresse führt zu einem anderen Dienst oder zu einer Anmeldeseite (ein Authentifizierungs-Proxy vor FreshRSS muss /api/ durchlassen).
  • Kein Ereignis „Neuer Artikel“: Artikel kommen an, wenn FreshRSS seine Feeds aktualisiert (sein Cronjob, CRON_MIN im offiziellen Docker-Image; jeder Feed standardmäßig höchstens einmal pro Stunde), dann beim nächsten Lesen der Integration.
  • Mehr Details: Setze die Variable LOG_LEVEL der Integration auf debug.

Grenzen​

  • FreshRSS kennt Kategorien nur über ihren Namen: Eine in FreshRSS umbenannte Kategorie wird als neues Gerät angeboten, das alte bleibt ohne Werte.
  • Die API von FreshRSS meldet keine Feeds mit Fehler und kann keine Aktualisierung der Feeds anstoßen: FreshRSS behält seinen eigenen Takt.
  • Die Filter der Auslöser vergleichen nur exakte Werte: Der Stichwortfilter ist eines der konfigurierten Stichwörter, geschrieben wie in der Konfiguration (das erste im Titel gefundene).
  • Favoriten, Labels und die Feeds selbst werden nicht aus Gladys verwaltet. Höchstens 100 Kategorien und 200 Feeds werden als Geräte angeboten.
  • Die Links des Widgets öffnen nur https-Adressen: Ein Artikel oder ein FreshRSS über einfaches http hat keinen Link.
  • Nicht mit FreshRSS verbunden.

Konfigurationseinstellungen​

Diese Einstellungen fragt FreshRSS in seinem Konfigurationsbildschirm in Gladys ab.

EinstellungTypPflichtfeldBeschreibung
FreshRSS verbindensectionNeinErlaube in FreshRSS den API-Zugriff (Administration → Authentifizierung) und lege dann ein API-Passwort für deinen Benutzer fest (Profil → API-Verwaltung). Gib die Adresse von FreshRSS, deinen Benutzernamen und dieses API-Passwort ein: Die Integration liest deine Ungelesenen, meldet neue Artikel und markiert Artikel aus deinen Szenen als gelesen.
FreshRSS-AdressestringJaDie Adresse, unter der du FreshRSS öffnest, oder die API-Adresse aus Profil → API-Verwaltung.
BenutzernamestringJa
API-PasswortsecretJaNicht das Anmeldepasswort: FreshRSS → Profil → API-Verwaltung → API-Passwort.
FreshRSS lesen alleselectNeinNeue Artikel werden beim nächsten Lesen gemeldet, sobald FreshRSS sie abgerufen hat (seine eigene Aktualisierung per Cronjob).
Zu beobachtende Stichwörter (optional)stringNeinDurch Kommas getrennt. Ein neuer Artikel, dessen Titel eines enthält, trägt es für den Stichwortfilter des Auslösers.
Sprache der Namen und MeldungenselectNeinDie Namen der Funktionen werden beim Hinzufügen eines Geräts zu Gladys festgelegt.

So installierst du FreshRSS in Gladys​

  1. Öffne in Gladys Integrationen: FreshRSS erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
  2. Klicke auf Installieren. Gladys lädt das Docker-Image (ghcr.io/guim31/gladys-freshrss:1.0.0) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration).
  3. Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
  4. Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/guim31/gladys-freshrss.

FreshRSS benötigt Gladys >=5.1.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.

Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.

Über externe Integrationen​

FreshRSS ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von guim31 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.

Abonniere den Newsletter von Gladys Assistant

Ein paar E-Mails im Monat zu neuen Releases und Neuigkeiten aus dem Projekt. Verschickt von Pierre-Gilles Leymarie, dem Gründer des Projekts. Jederzeit abbestellbar 🙂
Zuletzt aktualisiert am