github paviro/KoShelf 2026.10.1

3 hours ago

What's Changed

This release adds library entries backed by KOReader metadata without the original document and tracks more document formats. It also fixes resource loading under reverse-proxy subpaths and tightens archive-removal validation.

Breaking Changes

  • List and detail API responses now use availability (available, metadata, or archived) instead of is_archived. API integrations must use the new field

Metadata Entries and Document Formats

  • KOReader sidecars can now create Metadata entries without the original document. New entries require a valid partial MD5 checksum and saved document properties
  • Metadata entries retain reading data and support metadata, cover, and annotation editing when writeback is enabled. Reader and document-download actions are available only when the document is present
  • Added tracking and downloads for PDF, DjVu, XPS/OXPS, CBT/CB7, AZW/AZW3, DOC/DOCX, RTF, ODT, CHM, PDB/PRC, FB3, and HTMLZ. Sidecars can introduce other extensions and extensionless documents; the in-app reader's supported formats are unchanged
  • PDF and other paged annotations expose page numbers while preserving their original geometry during edits
  • CBR files can be tracked and downloaded on Windows even though document metadata and cover extraction remain unavailable there

Library Preservation and Live Updates

  • A missing document with a surviving sidecar now becomes a Metadata entry. Entries become Archived only after both sources disappear; returning sources restore the same identity
  • Unreachable roots and incomplete scans preserve the last known availability instead of treating unreadable sources as deleted
  • Live updates now recognize sidecar-backed documents with arbitrary extensions and extensionless filenames
  • Syncthing bookkeeping folders and conflict copies are excluded from library sources
  • Static exports include availability badges and retain file downloads with --include-files; metadata-only and archived entries do not export document files

Fixes

  • Fixed API, static-data, and live-update resource URLs under Home Assistant ingress and other reverse-proxy subpaths
  • Archive removal now rejects non-canonical item IDs before constructing media paths

Full Changelog: 2026.10.0...2026.10.1

Don't miss a new KoShelf release

NewReleases is sending notifications on new releases.