Installation | kmworks

Every release publishes a Docker image to ghcr.io/kmworks/kmrs (tags: latest, MAJOR.x, x.y.z; platforms: linux/amd64, linux/arm64) and prebuilt binaries for Linux, macOS, and Windows (x86_64 and aarch64). The official Komga Docker instructions apply verbatim; just swap the image name.

docker run -d \
  --name=komga \
  --user 1000:1000 \
  -p 25600:25600 \
  --mount type=bind,source=/path/to/config,target=/config \
  --mount type=bind,source=/path/to/data,target=/data \
  --restart unless-stopped \
  ghcr.io/kmworks/kmrs

An existing komga /config directory (with database.sqlite / tasks.sqlite) is picked up and upgraded in place.

The image bundles the kmweb UI at /webui and serves it at /, so http://<host>:25600/ works in a browser immediately. Run with an empty KOMGA_WEBUI_DIR= to disable the UI.

services:
  kmrs:
    image: ghcr.io/kmworks/kmrs:latest
    container_name: kmrs
    user: "1000:1000"
    ports:
      - "25600:25600"
    volumes:
      - ./config:/config
      - ./data:/data
    restart: unless-stopped

A compose stack can also carry komf (the metadata fetcher) as a sidecar:

services:
  kmrs:
    image: ghcr.io/kmworks/kmrs:latest
    container_name: kmrs
    user: "1000:1000"
    ports:
      - "25600:25600"
    volumes:
      - ./config:/config
      - ./data:/data
    environment:
      # optional: pre-fills the komf integration form in the admin UI
      - KOMGA_KOMF_URL=http://komf:8085
      - KOMGA_KOMF_BASEURL=http://kmrs:25600
    restart: unless-stopped

  komf:
    image: ghcr.io/dyphire/komf-rs:latest
    container_name: komf
    volumes:
      - ./komf-config:/config
    restart: unless-stopped

komf’s port is deliberately not published: its API has no authentication, and only kmrs needs to reach it. Once the stack is up, open the integrations page in the admin UI (or call PUT /api/v1/komf/integration with the same two URLs) and confirm — kmrs mints an API key and provisions komf itself; komf then calls back in Komga mode and starts matching metadata.

Download the archive for your platform from the latest release (Linux, macOS, Windows; x86_64 and aarch64).

The binary serves on port 25600 with data directory ~/.komga (override with KOMGA_CONFIG_DIR):

./kmrs   # serves on http://localhost:25600

cargo build --release -p komga-server   # produces target/release/kmrs