This is a fork of gotson/komga with the following features:

• Add sort option using file date, and default sort option on libraries (closed PR)
• Add basic pan & zoom feature in the web pdf viewer

Additional instructions to build & develop locally below

Build locally

Common steps

• create ~/.jreleaser/config.properties

JRELEASER_GITHUB_TOKEN=no

• build at least once komga: ./gradlew komga:build
• build & copy UI: ./gradlew prepareThymeLeaf
• build package: ./gradlew jreleaserPackage

Build docker image with one of the methods below and redeploy docker with this image

Build docker without buildx

• find how to pass TARGETARCH, or replace it by amd64 in komga/docker/Dockerfile.tpl

• build docker image: docker build build/jreleaser/package/komga/docker/ -t komga:custom

One-liner:

./gradlew komga:build && ./gradlew prepareThymeLeaf && ./gradlew jreleaserPackage && docker build -t komga:rp-test build/jreleaser/package/komga/docker/

Build docker with build

• Install buildx, see official documentation: https://docs.docker.com/engine/install/ , or in debian bookworm, you can declare the debian repository with the script https://docs.docker.com/engine/install/debian/ and only install the buildx plugin with apt install docker-buildx-plugin (or install it manually)

• build with buildx docker buildx build --platform linux/amd64 -t komga:custom build/jreleaser/package/komga/docker/

One-liner:

./gradlew komga:build && ./gradlew prepareThymeLeaf && ./gradlew jreleaserPackage && docker buildx build --platform linux/amd64 -t komga:custom build/jreleaser/package/komga/docker/

Clean

./gradlew clean && rm -Rf komga-webui/node_modules && rm -Rf komga-webui/dist && rm -Rf .gradle

---

Komga

Komga is a media server for your comics, mangas, BDs, magazines and eBooks.

Chat on Discord

Features

• Browse libraries, series and books via a responsive web UI that works on desktop, tablets and phones
• Organize your library with collections and read lists
• Edit metadata for your series and books
• Import embedded metadata automatically
• Webreader with multiple reading modes
• Manage multiple users, with per-library access control, age restrictions, and labels restrictions
• Offers a REST API, many community tools and scripts can interact with Komga
• Download book files, whole series, or read lists
• Duplicate files detection
• Duplicate pages detection and removal
• Import books from outside your libraries directly into your series folder
• Import ComicRack cbl read lists

Installation

Refer to the website for instructions.

Documentation

Head over to our website for more information.

Develop in Komga

Check the development guidelines.

Translation

Sponsors

Credits

The Komga icon is based on an icon made by Freepik from www.flaticon.com