Komga Smart-Home-Integration, kostenlos und Open Source
Dein Komga-Server für Comics und Mangas in Gladys: neue Serien und Bände, laufende Lektüre, Scans.
Veröffentlicht von guim31
- Geräte
- Version 1.0.0
- Erfordert Gladys >=5.1.0
- ★ 0
Verbinde deinen Komga-Server (Comics, Manga, Bücher, selbst gehostet) mit Gladys: die Zahlen deiner Bibliotheken, deine laufenden Serien und die heute gelesenen Bände, die neuesten Zugänge mit ihren Covern auf dem Dashboard und Szenen, die reagieren, wenn eine neue Serie oder ein neuer Band ankommt oder du eine Serie beendest.
Die Integration wurde mit einem echten Komga-1.29.1-Server (dem offiziellen Docker-Image) getestet, noch nicht in einer echten Gladys-Installation: Rückmeldungen sind im Gladys-Forum oder in den Issues willkommen.
Voraussetzungen
- Gladys Assistant 5.1.0 oder neuer.
- Ein Komga-Server, den Gladys erreicht: in deinem Netzwerk oder im Internet hinter einem Reverse Proxy. Getestet mit Komga 1.29.
- Ein API-Schlüssel deines Komga-Kontos (ab Komga 1.12): in Komga unter Kontoeinstellungen → API-Schlüssel einen Schlüssel erstellen und kopieren. Bei einem älteren Komga gehen stattdessen E-Mail und Passwort des Kontos. Die Integration sieht, was dieses Konto sieht: seine Bibliotheken, seinen Lesefortschritt.
- Ein Administrator-Konto liefert zusätzlich die Version von Komga und erlaubt die Bibliotheks-Scans; ein Leserkonto reicht für alles andere.
Einrichtung
- Installiere die Integration aus dem Gladys-Katalog.
- Gib unter Konfiguration die Server-URL mit Port ein (zum Beispiel
http://192.168.1.20:25600; hinter einem Reverse Proxyhttps://example.org/komga) und den API-Schlüssel (oder, bei einem älteren Komga, E-Mail und Passwort des Kontos). - Wähle bei Bedarf, wie oft der Server gelesen wird (standardmäßig alle 5 Minuten), und die Sprache der Namen.
- Speichere und klicke auf Verbindung testen: Du siehst die Version, das Konto (Administrator oder Leser) und die gefundenen Zahlen.
- Füge im Tab Erkennung das Gerät Komga hinzu.
Gerät
Komga (ein Gerät für den Server, aus Sicht deines Kontos):
| Funktion | Bedeutung |
|---|---|
| Online | 1, solange die Integration den Server liest |
| Bibliotheken | Bibliotheken, die dein Konto sieht |
| Serien | Serien dieser Bibliotheken |
| Bände | Bände (Ausgaben, Hefte) dieser Bibliotheken |
| Laufende Serien | begonnene, nicht beendete Serien |
| Heute gelesene Bände | heute beendete Bände (unter den 20 zuletzt gelesenen) |
| Version | Version von Komga (nur mit Administrator-Konto) |
Dashboard
- Komga: neu hinzugefügt: ein Raster der zuletzt hinzugefügten Serien mit Covern, Datum, Bibliothek und Bandanzahl, die Zahl der Serien und Bände und (mit Administrator-Konto) ein Knopf Bibliotheken scannen, derselbe wie die Szenenaktion unten.
- Komga: weiterlesen: deine angefangenen Bände mit Covern, erreichter Seite und Fortschritt, die Zahl der laufenden Serien und die heute gelesenen Bände.
Szenen
Auslöser
- Neue Serie hinzugefügt: Eine neue Serie (Comic, Manga, Buch) erscheint nach einem Scan in einer Bibliothek. Filter: die Bibliothek, genau wie in Komga angezeigt. Informationen: Titel der Serie, Bibliothek, Bandanzahl.
- Neuer Band: Ein neuer Band (Ausgabe, Heft) kommt zu einer Serie hinzu, die schon in Komga ist. Filter: die Serie, der du folgst, ihr Titel genau wie in Komga. Informationen: Titel der Serie, Titel des Bandes, Bibliothek.
- Serie zu Ende gelesen: Du beendest den letzten ungelesenen Band einer Serie oder markierst die Serie als gelesen. Filter: die Bibliothek. Informationen: Titel der Serie, Bibliothek, Bandanzahl.
Aktionen
- Komga-Bibliotheken scannen: Komga sucht neue Dateien in einer Bibliothek (ihr Name, Groß- und Kleinschreibung egal) oder in allen; der Scan läuft im Hintergrund, die neuen Serien erscheinen einige Sekunden später. Nur mit Administrator-Konto. Ergebnis: die Zahl der gescannten Bibliotheken.
- Neueste Komga-Zugänge vorlesen: ein Satz für eine Benachrichtigung oder einen Lautsprecher, zum Beispiel „2 neue Serie(n) auf Komga in den letzten 7 Tagen: Blue Skies und Green Leaf.“ Ergebnisse: der Satz, die Zahl der neuen Serien, der Titel der neuesten (höchstens 12 Serien).
Szenen-Ideen
- Neuer Band meines Mangas: bei Neuer Band mit deiner Serie die Benachrichtigung „Neuer Band von {series}: {title}“ senden.
- Sonntags-Übersicht: jeden Sonntag um 10 Uhr Neueste Komga-Zugänge vorlesen und den Satz als Nachricht senden.
- Nach den Downloads: jede Nacht um 3 Uhr Komga-Bibliotheken scannen, damit die Dateien deiner Download-Werkzeuge am Morgen da sind.
Fehlerbehebung
- „der Server antwortet nicht“: Prüfe Adresse und Port von der
Gladys-Maschine aus. Gladys führt die Integration in einem Container aus:
localhostist der Container selbst, nimm die IP-Adresse der Maschine. - „API-Schlüssel oder Passwort abgelehnt“: Der Schlüssel wurde in Komga gelöscht oder das Passwort geändert; erstelle einen neuen Schlüssel.
- „dieses Konto ist kein Administrator“: Der Scan braucht ein Administrator-Konto.
- „kein Komga-Server unter dieser Adresse“ oder „die Adresse leitet
um“: Ein Server hinter einem Reverse Proxy braucht seinen Basispfad
(
https://example.org/komga); eine Anmeldeseite des Proxys blockiert die API. - „Zertifikat abgelehnt“: HTTPS mit selbst signiertem Zertifikat wird
nicht unterstützt; verwende die
http://-Adresse in deinem Netzwerk. - Die Integration protokolliert nur ihren Lebenszyklus; mit
LOG_LEVEL=debugprotokolliert sie auch jedes Ereignis mit den Titeln.
Einschränkungen
- Der Server wird alle 1 bis 15 Minuten gelesen. Die Integration hört auch auf die Ereignisse von Komga (ein Band oder eine Serie hinzugefügt, ein Lesefortschritt), um ihn innerhalb von Sekunden erneut zu lesen; ein Reverse Proxy, der diese Ereignisse zurückhält, verzögert die Szenen nur bis zum nächsten Lesen.
- Höchstens 10 Ereignisse einer Art pro Lesen (ein erster großer Scan meldet 10 Serien, nicht Hunderte). Bände, die vor mehr als 24 Stunden hinzukamen, werden nicht gemeldet (ein zwei Tage gestopptes Gladys spielt sie nicht nach).
- Serie zu Ende gelesen und Heute gelesene Bände verfolgen die 20 zuletzt gelesenen Bände.
- Ein Komga-Konto und ein Server pro Installation der Integration.
- Nicht mit dem Komga-Projekt verbunden.
Konfigurationseinstellungen
Diese Einstellungen fragt Komga in seinem Konfigurationsbildschirm in Gladys ab.
| Einstellung | Typ | Pflichtfeld | Beschreibung |
|---|---|---|---|
| Verbindung zu deinem Komga-Server | section | Nein | Gib die Serveradresse (z. B. http://192.168.1.20:25600) und einen API-Schlüssel deines Kontos ein: in Komga unter Kontoeinstellungen > API-Schlüssel (ab Komga 1.12). Ältere Server: stattdessen E-Mail und Passwort. Ein Admin-Konto liefert auch Version und Scans. |
| Server-URL | string | Ja | Adresse des Servers mit Port (standardmäßig 25600). Eine https-Adresse hinter einem Reverse Proxy funktioniert ebenfalls, mit ihrem Basispfad. |
| API-Schlüssel | secret | Nein | Empfohlen. Leer lassen, um E-Mail und Passwort unten zu verwenden. |
| E-Mail (ohne API-Schlüssel) | string | Nein | Nur für ein Komga vor 1.12: die E-Mail, mit der du dich anmeldest. |
| Passwort (ohne API-Schlüssel) | secret | Nein | |
| Aktualisierung | select | Nein | Wie oft der Server gelesen wird (jedes Mal etwa sieben leichte Anfragen). Neue Bände und Lesefortschritte ziehen das nächste Lesen auch vor. |
| Sprache der Namen | select | Nein | Sprache der Funktionsnamen und der Texte der Szenenaktionen. Die Namen werden beim Erstellen eines Geräts festgelegt: Um sie nach einer Änderung umzubenennen, lösche das Gerät und füge es erneut hinzu. |
So installierst du Komga in Gladys
- Öffne in Gladys Integrationen: Komga erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
- Klicke auf Installieren. Gladys lädt das Docker-Image (
ghcr.io/guim31/gladys-komga:1.0.0) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration). - Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
- Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/guim31/gladys-komga.
Komga 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
Komga 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.
- Alle Integrationen durchsuchen, native und aus der Community
- Deine eigene externe Integration bauen und veröffentlichen
- Quellcode auf GitHub — Quelle dieser Dokumentation