Installation

docker run -d \
  --name=kmrs \
  --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 kmweb UI is embedded in the binary and served at /, so http://<host>:25600/ works in a browser immediately.

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: unless you set komf-rs’s KOMF_AUTH_KEY, its API has no authentication, and only kmrs needs to reach it (see komf integration). 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 KMServer_aarch64.dmg (Apple silicon, macOS 13 or later), open it, and drag KMServer.app to Applications.

Launch KMServer from Applications to start the server and show its menu bar icon. The menu opens the web UI, configuration directory, or logs folder, controls Open at Login, and quits the server.

KMServer is signed with Developer ID and notarized by Apple. It serves on port 25600 and keeps its configuration and databases in ~/.komga, sharing them with the command-line binary.

PDFium and its third-party license notices are included in the app, so PDF books work without a separate library installation.

To update the installed app, choose Check for Updates in the menu bar, then confirm Update and Restart. KMServer verifies the download, replaces the app, and starts it again. If the new server does not start, the previous app is restored.

Command-line, launchd, and Windows service deployments do not update themselves; upgrade them through the deployment method used to install them.

Download KMServer_x64-setup.exe and run it. The installer installs KMServer for the current user without administrator privileges and adds Start Menu shortcuts.

KMServer runs in the notification area (system tray). Its menu opens the web UI, configuration directory, or logs folder, controls Start with Windows, and exits the server. The first start opens the web UI in your default browser so you can create the initial admin account.

The server listens on port 25600 and stores its configuration and databases in ~/.komga, sharing them with the command-line binary. Open the configuration directory from the tray menu to find it.

PDFium is included. To update an installed copy, choose Check for Updates in the tray menu, then confirm Update and Restart. The installer replaces the app and starts it again.

The raw Windows zip remains available under Binary for command-line or service deployments.

Download the archive for your platform from the latest release (Linux x86_64/aarch64, Windows x86_64). For a double-clickable macOS app, use the macOS app tab instead.

The binary serves on port 25600 and keeps its configuration and databases in ~/.komga (override with --config-dir or KOMGA_CONFIG_DIR):

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

On Windows, kmrs.exe runs without a console window and lives in the notification area (system tray):

• Left-click the tray icon, or choose Open KMServer from its menu, to open the web UI. The menu also has Open configuration directory, Open logs folder, Start with Windows, and Exit.

• Start with Windows is off by default; tick it to launch kmrs at logon.

• The first start opens the web UI in your default browser so you can create the initial admin account.

• A fatal startup error, such as the port already being in use, is shown in a dialog.

• Started from a terminal, kmrs prints its startup output there and then detaches, so closing the terminal does not stop the server.

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

Platform OAuth secrets are compile-time inputs for source builds. See Development if you need tracker sign-in.