Skip to content

A Docker image for running Calibre with KFX support to allow conversion of KFX files to other formats.

License

Notifications You must be signed in to change notification settings

yshalsager/calibre-with-kfx

Repository files navigation

Calibre with KFX Docker

GitHub CI Docker Hub badge ghcr.io badge ghcr.io size badge

GitHub license GitHub release

PayPal Patreon Liberapay

A Docker image for converting eBooks using Calibre with KFX support.

KFX is Amazon's proprietary eBook format used for Kindle devices.

Why?

Because Amazon's Kindle Previewer 3 is the only way currently to convert books into KFX using Calibre KFX Input and KFX Output plugins, and it's not available on Linux, so I run it under docker using Wine.

Usage

To use the Docker image, you can build it locally using the Dockerfile provided in this repository, or you can pull the image from Docker Hub using the following command:

docker pull yshalsager/calibre-with-kfx

Once you have the Docker image, you can run it using the following command:

docker run --rm -it -v "/path/to/local/folder:/app:rw" yshalsager/calibre-with-kfx [input_file] [output_file] [extra args]

Examples:

  • Convert to azw3 with extra arguments: docker run --rm -it -v "$(pwd):/app:rw" yshalsager/calibre-with-kfx epub30-spec.epub epub30-spec.azw3 --dont-compress
  • Convert to KFX: docker run --rm -it -v "$(pwd):/app:rw" yshalsager/calibre-with-kfx epub30-spec.epub epub30-spec.kfx

Versioning

The docker image versions are tagged with build date and time. There's a GitHub release for each tag that lists versions of each component of the image, like base OS, Calibre and its plugins, and Kindle Previewer.

Whenever any component gets updated, a new image is built and pushed.