# ebook-convert-sidecar

ebook-convert-sidecar is a self-hosted automation app. Converts the books in your library folder to extra formats with Calibre's ebook-convert and saves them next to the original (Title.epub -> Title.azw3). It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/7215/ebook-convert-sidecar

## Description

Converts the books in your library folder to extra formats with Calibre's ebook-convert and saves them next to the original (Title.epub -> Title.azw3). Library apps that treat same-named files in one folder as one book, such as Grimmory and BookOrbit, then show the new file as an extra format of the existing book. Starts in dry-run mode: check the log for what it would create, then set Dry Run to false. When a source changes later (e.g. your library app writes edited metadata into the EPUB), the converted file is made again. Files it did not create itself are never touched. Optional Calibre plugins can be added through the plugins folder.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

39/100 (Low), based on 3 of 4 factors.
- Maintained: 72 (last commit 0 days ago)
- Popular: 0 (0 GitHub stars)
- Easy to install: 20 (1 install platform, Docker image)

## Links

- Unraid: https://ca.unraid.net/apps/app_fa05dc72b4a87776
- GitHub: https://github.com/jterpstra1/ebook-convert-sidecar

## Common questions

### Will it overwrite a converted file I created manually?

No. It only replaces files it created itself, so a file you put there yourself is never touched. Converted files that your library app moves or renames are still recognised.

### Why does the first run not convert any books?

It starts in dry-run mode and only logs what it would create. Set DRY_RUN to false to actually convert.

### How do I convert from a different source format or to more than one target format?

Set SOURCE_FORMATS and TARGET_FORMATS as comma-separated lists. The defaults are epub for source formats and azw3 for target formats.

### What settings does my library app need for this to work?

The app must group same-named files in one folder as one book, notice new files, and support the target format. It should also write metadata into the EPUB file if you want metadata edits to trigger re-conversion.

### Where is its state stored and how are failed conversions retried?

It keeps bookkeeping in /config/state.json, which records which files it created, source versions, and failures. A failed conversion is retried when the source changes, the Calibre plugins change, or you remove its entry from failed.

### Can I use custom Calibre plugins?

Yes. Optional Calibre plugins can be added through the plugins folder.

---
Source: Our Local Host (https://ourlocalhost.com/app/7215/ebook-convert-sidecar), the self-hosted and open-source app directory.