# Grimmory-convert

Grimmory-convert is a self-hosted media applications app. Grimmory-convert converts books in a Grimmory library 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/7219/grimmory-convert

## Description

Grimmory-convert converts books in a Grimmory library to extra formats with Calibre's ebook-convert and saves them next to the original (Title.epub -> Title.azw3). Grimmory's library watcher then attaches the new file to the existing book as an extra format. When a source changes later (e.g. Grimmory writes edited metadata into the EPUB), the converted file is made again, and files it did not create itself are never touched. The project is now archived and continued as ebook-convert-sidecar, which also works with other library apps; the Docker image stays available but receives no further updates.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

5/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (GitHub repository is archived)
- Popular: 0 (0 GitHub stars)
- Easy to install: 20 (1 install platform, Docker image)

## Links

- Unraid: https://ca.unraid.net/apps/app_c691f89960a2cd02
- GitHub: https://github.com/jterpstra1/grimmory-convert
- Documentation: https://github.com/grimmory-tools/grimmory

## Common questions

### Does the container start converting immediately after it is deployed?

No. It starts in dry-run mode and only logs the conversions it would make. Set DRY_RUN to false to make it create files.

### What Grimmory settings are needed for the converted files to appear?

The library needs folder monitoring enabled, or you must trigger a rescan. The organisation mode must be Auto detect or Book per folder; Book per file makes the converted file appear as a duplicate book.

### Which source and target formats can it use?

Source formats default to epub and target formats default to azw3. Both are comma-separated lists, and target formats should be limited to formats Grimmory knows, such as epub, pdf, mobi, azw3, and fb2.

### When will it regenerate a converted file?

It regenerates the file when the source file changes after conversion, such as Grimmory writing edited metadata or a new cover into the EPUB. That only works if Grimmory's Write metadata to file setting is on for EPUB.

### Will it overwrite files that were not created by grimmory-convert?

No. It only replaces files it created itself, so a converted file you placed there manually is never touched. Converted files that Grimmory moves or renames are still recognised.

### Where does it store its bookkeeping and how are failed conversions handled?

It keeps bookkeeping in /config/state.json, including which files it created and which conversions failed. A failed conversion is retried only when the source changes or when you remove its entry from the failed list.

## Alternatives

- Alfa eBooks Manager: The most powerful and easy-to-use Book Organizer Alfa Ebooks Manager is a free program that allows to organize your electronic and paper bo…
- Calibre-Web: Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing calibre database.
- Citadel (ebook library manager): Citadel helps you manage your ebook libraries.
- GCstar: Desktop application to manage of various types of collections (books, comics, films, TV shows, music, games, wines, stamp, coins, etc...).
- Tellico: Tellico is a software application for organizing your collections.
- Thorium Reader: Thorium Reader is a free, open source multi-language EPUB reader for Windows 10, MacOS and Linux.
- calibre: Free e-book manager offering library management, multi-format conversion, syncing to devices, news download as e-books, built-in viewer, ed…

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