Skip to main content

Komga smart home integration, free and open source

Komga integration for Gladys Assistant

Your Komga comics and manga server in Gladys: new series and books, reading in progress, scans.

View on GitHubAll integrations

Connect your Komga server (comics, manga, books, self-hosted) to Gladys: the counts of your libraries, your series in progress and the books read today, the latest additions with their covers on the dashboard, and scenes that react when a new series or a new book arrives, or when you finish a series.

The integration was tested against a real Komga 1.29.1 server (the official Docker image), not yet in a real Gladys installation: feedback welcome on the Gladys forum or in the issues.

Requirements​

  • Gladys Assistant 5.1.0 or later.
  • A Komga server reachable from Gladys: on your network, or on the Internet behind a reverse proxy. Tested with Komga 1.29.
  • An API key of your Komga account (Komga 1.12 and later): in Komga, Account settings → API Keys, create a key and copy it. On an older Komga, the e-mail and password of the account work instead. The integration sees what this account sees: its libraries, its reading progress.
  • An administrator account also gives the version of Komga and allows the library scans; a reader account works for everything else.

Setup​

  1. Install the integration from the Gladys catalog.
  2. In Configuration, enter the Server URL with its port (for example http://192.168.1.20:25600; behind a reverse proxy, https://example.org/komga) and the API key (or, on an older Komga, the E-mail and the Password of the account).
  3. If you wish, choose how often the server is read (every 5 minutes by default) and the language of the names.
  4. Save, then click Test the connection: it shows the version, the account (administrator or reader) and the counts it finds.
  5. In the Discovery tab, add the Komga device.

Device​

Komga (one device for the server, seen through your account):

FeatureMeaning
Online1 while the integration reads the server
Librarieslibraries your account can see
Seriesseries of these libraries
Booksbooks (volumes, issues) of these libraries
Series in progressseries you started and did not finish
Books read todaybooks you finished today (among the last 20 read)
Versionversion of Komga (administrator account only)

Dashboard​

  • Komga: recently added: a grid of the last series added, with their covers, the date, the library and the number of books, the number of series and books, and (administrator account) a Scan the libraries button, the same as the scene action below.
  • Komga: keep reading: your books in progress with their covers, the page reached and the progress, the number of series in progress and the books read today.

Scenes​

Triggers​

  • New series added: a new series (comic, manga, book) appears in a library after a scan. Filter: the library, exactly as shown in Komga. Information: series title, library, number of books.
  • New book: a new book (volume, issue) is added to a series already in Komga. Filter: the series you follow, its title exactly as shown in Komga. Information: series title, book title, library.
  • Series read to the end: you finish the last unread book of a series, or mark the series as read. Filter: the library. Information: series title, library, number of books.

Actions​

  • Scan Komga libraries: Komga looks for new files in one library (its name, any case) or in all of them; it scans in the background, and the new series show a few seconds later. Administrator account only. Result: the number of libraries scanned.
  • Read the latest Komga additions: a sentence for a notification or a speaker, for example "2 new series on Komga in the last 7 days: Blue Skies and Green Leaf." Results: the sentence, the number of new series, the title of the latest one (12 series at most).

Scene ideas​

  • New volume of my manga: when New book with your series, send a notification "New volume of {series}: {title}".
  • Sunday digest: every Sunday at 10 am, Read the latest Komga additions, then send the sentence as a message.
  • After the download: every night at 3 am, Scan Komga libraries, so the files your download tools dropped show up in the morning.

Troubleshooting​

  • "the server does not answer": check the address and the port from the Gladys machine. Gladys runs the integration in a container: localhost is the container itself, use the IP address of the machine.
  • "API key or password refused": the key was deleted in Komga, or the password changed; create a new key.
  • "this account is not an administrator": the scan needs an administrator account.
  • "no Komga server at this address" or "the address redirects": a server behind a reverse proxy needs its base path (https://example.org/komga); a login page of the proxy blocks the API.
  • "certificate refused": HTTPS with a self-signed certificate is not supported; use the http:// address of your network.
  • The integration only logs its lifecycle; with LOG_LEVEL=debug, it also logs each event, with the titles.

Limitations​

  • The server is read every 1 to 15 minutes. The integration also listens to the events of Komga (a book or a series added, a reading progress) to read it again within seconds; a reverse proxy that buffers these events only delays the scenes until the next reading.
  • At most 10 events of one kind per reading (a first big scan announces 10 series, not hundreds). New books older than 24 hours are not announced (a Gladys stopped two days does not replay them).
  • Series read to the end and Books read today follow the 20 books read last.
  • One Komga account and one server per installation of the integration.
  • Not affiliated with the Komga project.

Configuration settings​

These are the settings Komga asks for in its configuration screen in Gladys.

SettingTypeRequiredDescription
Connect to your Komga serversectionNoEnter the server address (e.g. http://192.168.1.20:25600) and an API key of your account: in Komga, Account settings > API Keys (Komga 1.12+). Older servers: the e-mail and password instead. An administrator account also gives the version and the scans.
Server URLstringYesAddress of the server, port included (25600 by default). An https address behind a reverse proxy works too, with its base path.
API keysecretNoRecommended. Leave empty to use the e-mail and password below.
E-mail (without API key)stringNoOnly for a Komga older than 1.12: the e-mail you sign in with.
Password (without API key)secretNo
RefreshselectNoHow often the server is read (about seven light requests each time). New books and readings also bring the next reading forward.
Language of the namesselectNoLanguage of the feature names and of the texts of the scene actions. Names are set when a device is created: to rename them after a change, delete and re-add the device.

How to install Komga in Gladys​

  1. In Gladys, open Integrations: Komga appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/guim31/gladys-komga:1.0.0), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration).
  3. Open the Configuration screen of the integration, fill in the settings, and save.
  4. You can also install it directly from its repository URL: https://github.com/guim31/gladys-komga.

Komga requires Gladys >=5.1.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.

Not running Gladys yet? It is free and open source: follow the installation guide to get started.

About external integrations​

Komga is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by guim31, not by the Gladys core team.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂
Last updated on