Skip to content

[FEAT] New mod - calibre-kfxgen #1171

Closed

Description

@yshalsager

Is this a new feature request?

  • I have searched the existing issues

Name of mod

calibre-kfxgen

Wanted change

Please create a calibre-kfxgen branch from template so I can submit a PR adding native KFX conversion to the LinuxServer.io Calibre image.

Reason for change

jloutsch/kfxgen generates KFX without Wine or Kindle Previewer. This lets users convert books through the existing Calibre browser desktop without another image or service.

The mod installs the bundled plugin as abc into /config/.config/calibre before services start. It preserves plugin preferences and does not disable other plugins; users must disable KFX Output if installed because it otherwise takes priority.

Proposed code change

Prepared on my fork's calibre-kfxgen branch, based on your template branch:

  • Single-layer scratch mod with an s6 v3 init script.
  • Pinned plugin ZIP with SHA-256 verification and bundled GPLv3 source/license.
  • Your template build workflow, with BASEIMAGE=calibre, MODNAME=kfxgen, and the official repository/registry settings unchanged.
  • An integration smoke test for startup, PUID/PGID ownership, native conversion, and disabled-plugin preference preservation across restart.

The port passed its integration smoke test on an amd64 Linux Docker host. The standalone implementation also has passing CI and published amd64/arm64 images. Arm64 runtime and Kindle rendering have not been validated. Formatting, particularly Arabic/RTL, can differ from Previewer.

I can adapt version-update automation to your preferred process before submitting the PR.

Activity

  1. aptalca commented on Nov 12, 2026

    @aptalca
    Member

    Thanks for creating the mod, but I'm confused about one thing.

    As far as I can see, this plugin does not have any dependencies that are currently missing in our image and only needs the zip file installed as a plugin through calibre (something that can be done through the gui).

    Why is a mod necessary?

    Did you try adding this plugin to the calibre plugins registry? There are tons of third party plugins there: https://plugins.calibre-ebook.com/
    They are discoverable within the Calibre gui and can be one click installed.

    My concern is that, once we add your mod to our official mod list, we would assume the burden of having to review all the changes you make to your plugin, for seemingly little gain.

  2. yshalsager commented on Nov 12, 2026

    @yshalsager
    Author

    Thanks for review @aptalca

    That's good point, right now the plugin isn't available yet to be directly installed via calibre, jloutsch/kfxgen#216

    But I assume it's just a matter of time, so I'll closing this.

  3. moved this from Issues to Done in Issue & PR Trackeron Nov 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions