mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-09-01 17:53:32 +02:00
b417da3980
* fix(komga): restore add-on reverted by a transient ghcr login failure The amd64 builder job failed at docker login (denied: denied) before any build step ran, which tripped revert-on-failure. Re-running the same commit unchanged succeeded and both arch images are published. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * fix(komga): poll komga directly instead of bashio::net.wait_for, clarify config path Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
71 lines
3.1 KiB
Markdown
71 lines
3.1 KiB
Markdown
# Home Assistant Add-on: Komga
|
|
|
|
Free and open source comics/mangas media server.
|
|
|
|
[Komga](https://komga.org) organizes your comics, mangas, BDs, magazines and ebooks, serves them
|
|
through a web reader, and exposes OPDS, Kobo sync and a REST API for third-party readers
|
|
(Tachiyomi/Mihon, Panels, Chunky, ...).
|
|
|
|
## About
|
|
|
|
- Browse and read CBZ, CBR, PDF and EPUB files from any browser
|
|
- Import metadata, edit series/books, build collections and read lists
|
|
- Multi-user, with per-user library restrictions and age ratings
|
|
- OPDS v1/v2, Kobo sync, and a documented REST API
|
|
|
|
## Installation
|
|
|
|
1. Add this repository to Home Assistant.
|
|
2. Install the **Komga** add-on.
|
|
3. Start the add-on and open it from the sidebar (ingress), or on port `25600` at
|
|
`http://homeassistant:25600/komga`.
|
|
4. Create the initial user account when the web interface asks for it.
|
|
5. Add a library pointing at your comics, for example `/media/comics` or `/share/comics`.
|
|
|
|
The first start takes longer than usual: Komga is a JVM application and builds its database and
|
|
search index on first boot.
|
|
|
|
## Configuration
|
|
|
|
| Option | Description |
|
|
|--------|-------------|
|
|
| `PUID` / `PGID` | Ownership applied to the add-on configuration directory. Defaults to `0` (root). |
|
|
| `TZ` | Timezone, e.g. `Europe/Paris`. |
|
|
| `localdisks` | Local disks to mount, e.g. `sda1` or a disk label. |
|
|
| `networkdisks` | SMB shares to mount, e.g. `//192.168.1.2/comics`. Mounted under `/mnt`. |
|
|
| `cifsusername` / `cifspassword` / `cifsdomain` | Credentials for the SMB shares. |
|
|
| `smbv1` | Allow the legacy SMBv1 protocol. |
|
|
| `env_vars` | Extra environment variables passed to Komga. See the [wiki](https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2). |
|
|
|
|
Most Komga settings can be passed through `env_vars` using the upstream naming, see the
|
|
[Komga configuration options](https://komga.org/docs/installation/configuration/). A common one:
|
|
|
|
- `JAVA_TOOL_OPTIONS` = `-Xmx1g` — cap the JVM heap on small machines.
|
|
|
|
`SERVER_SERVLET_CONTEXTPATH` and `SERVER_PORT` are reserved by the add-on: ingress is built
|
|
around the `/komga` path on port 25600, and overriding either breaks the sidebar panel.
|
|
|
|
## Ingress and URLs
|
|
|
|
Komga is served from the `/komga` subpath so that it works behind Home Assistant ingress:
|
|
|
|
- from the Home Assistant sidebar: ingress, no extra setup
|
|
- directly: `http://homeassistant:25600/komga`
|
|
|
|
External clients — OPDS readers, Kobo sync, Tachiyomi/Mihon, Panels — must use the direct
|
|
`http://homeassistant:25600/komga` url. Ingress is browser-session based, so those clients cannot
|
|
authenticate through it.
|
|
|
|
|
|
## Data
|
|
|
|
Komga's database, logs and search index live in `/config` inside the add-on, which Home Assistant
|
|
maps to this add-on's own configuration directory — `/addon_configs/<repository_id>_komga`, browsable
|
|
with the Filebrowser add-on. They survive add-on updates. Libraries stay where you put them, under
|
|
`/media`, `/share` or a mounted disk.
|
|
|
|
## Support
|
|
|
|
- [Komga upstream project](https://github.com/gotson/komga)
|
|
- [Add-on repository issues](https://github.com/alexbelgium/hassio-addons/issues)
|