Skip to content

Installation

Install Sumidoku with Docker, release binaries, the portable Windows app, or from source.

Docker Compose

The quickest way to run Sumidoku is the published Docker image. Save this as docker-compose.yml:

services:
  sumidoku:
    image: sumidoku/sumidoku:latest
    ports:
      - "3000:3000"
    volumes:
      - ./config:/config       # database, settings, cover cache, source packages
      - ./downloads:/downloads
      - trawl-ca:/trawl-ca:ro  # TRAWL shared CA
    environment:
      - SUMIDOKU_NET_TRAWL_PROXY=http://trawl:8192
      - SUMIDOKU_NET_TRAWL_CA=/trawl-ca/ca.crt
      # CF clearance solver + webview browser backend (trawl's API port; requires trawl ≥ v1.9.1,
      # satisfied by the `latest` image below). Without it, challenged hosts fall back to the proxy.
      - SUMIDOKU_NET_BROWSER_TRAWL=http://trawl:8191
      # - SUMIDOKU_NET_RELAY_DOMAINS=cf.example.com
      # site-wide auth (web UI and REST API share one password)
      # - SUMIDOKU_AUTH_USERNAME=admin
      # - SUMIDOKU_AUTH_PASSWORD=
    depends_on:
      - trawl

  trawl:
    image: ghcr.io/germondai/trawl:latest
    shm_size: 1gb
    environment:
      - MITM_ENABLED=true
      - MITM_PORT=8192
      - MITM_CA_DIR=/data/proxy-ca
      - MITM_MAX_TIER=3
      - TIER1_TRANSPORT=wreq
      # this compose ships no redis; the session cache lives in process memory
      - SESSION_CACHE_DRIVER=memory
    volumes:
      - trawl-ca:/data/proxy-ca
      - trawl-data:/data
    # no ports exposed; reachable only on the compose internal network

volumes:
  trawl-ca:
  trawl-data:

Then start it:

docker compose up -d

The compose file pulls the published sumidoku/sumidoku:latest image and mounts ./config and ./downloads. Open http://localhost:3000.

The bundled trawl service is the optional sidecar that solves Cloudflare challenges and powers browser-based source logins — see Sidecars. If you don’t need it, drop the trawl service, the SUMIDOKU_NET_* variables, the trawl-ca volume and the depends_on line, and the rest works unchanged.

Volume Purpose
/config database, settings, cover cache, source packages
/downloads downloaded chapters

The same image is published to GitHub Container Registry as ghcr.io/sumidoku/sumidoku; point the compose image: at either registry.

Release binaries

Each GitHub release ships five platform archives, built by the release pipeline: Linux x86_64 and aarch64, macOS x86_64 and aarch64, and Windows x86_64. Download the archive for your platform, extract it, and run the sumidoku-server binary. The server listens on 0.0.0.0:3000 by default and keeps its data in ./data unless configured otherwise — see Configuration.

Windows desktop app

The release also ships a portable Windows app: download sumidoku_<version>_x86_64-pc-windows-msvc.zip from the latest release, extract it anywhere, and run sumidoku-server.exe. It listens on http://localhost:3000 only, keeps its data under %LOCALAPPDATA%\Sumidoku, and sits in the notification area — a left click (or Open) opens the web UI, and the menu offers the data and log folders, Start with Windows, and Exit.

Started as a service or a scheduled task it stays headless and takes the same configuration channels as any other install.

Building from source

The web UI is embedded into the binary at compile time, so it must be built first:

cd webui && npm ci && npm run build && cd ..
cargo build --release -p sumidoku-server

See Development for the test and lint commands and the repository layout.

Installing sources

Aidoku source packages

Drop .aix source packages (or extracted source directories) into ./config/sources, then press the scan button on the web UI’s browse page (or POST /api/v1/sources/scan).

Source repositories

You can also add an Aidoku-compatible source repository from the browse page and install sources from it directly — browse with language/NSFW filters, one-click install and update.

OPDS catalogs

Use the browse page to add Komga, Kavita, Calibre-Web or other OPDS 1.2/2.0 catalogs as sources. Multiple catalogs can be added, with optional per-catalog credentials.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close