Version 3.1.0 - The Community Update 👬 Hardcover Integration 💜, Calibre Plugins 🔌, Split Library Support 💞, KoReader Sync 🗘 and much more! 📚

[crocodilestick]

Version 3.1.0 - The Community Update 👬 Hardcover Integration 💜, Calibre Plugins 🔌, Split Library Support 💞, KoReader Sync 🗘 and much more! 📚

"Calibre-Web Automated is extremely lucky and privileged to have such a large and vibrant community of people who support, enjoy and contribute to the project. The bulk of the new features and bugfixes this update brings were created by the best and brightest of our community and I want to celebrate that and their work here in the hope that our community only continues to grow!" - CrocodileStick

Release V3.1.0 Changelog

Major Changes 🚀

NEW: Split Library Support 💞

• As promised, all CWA features are now fully compatible with Calibre-Web's Split Library Functionality
• This enables users to store their Calibre Library in a a separate location to their metadata.db file
• To configure this, in the Admin Panel, navigate to Edit Calibre Database Configuration -> Separate Book Files from Library
  • The use of Network Shares (especially NFS) with this functionality is discouraged as they sometimes don't play well with CW & CWA's SQLite3 heavy stack. Many users use network shares without issues but there aren't enough resources to support those who can't get it working on their own

NEW: Hardcover API Integration 💜📖

• Hardcover is now officially not only available as a Metadata Provider, but using Hardcover's API, Kobo Shelves & Read Progress can now also be synced to a user's Hardcover account!

• Current workflow is scraping a book by title, you can then use the resulting hardcover-id identifier to search for editions of that book, by searching "hardcover-id:". Edition results are filtered to exclude Audiobooks editions, and sorted by ebook then physical book.

• If a shelf in CWA is selected for Kobo sync, when a book with id and edition identifiers is added to the shelf, it will also be added to Hardcovers want to read list. As the book is read on the Kobo device progress is synced to Hardcover as well when pushed to CWA.

• To use Hardcover as a Metadata Provider, simply provided a Hardcover API Token in your docker-compose under the HARDCOVER_TOKEN Environment Variable

  • To enable Kobo sync, a Hardcover API Token must be provided for each user in each user's respective Profile Page

• Thanks to demitrix! <3

Greatly Improved Metadata Selection UI 🎨

• Demitrix was really on a roll the last couple of months and also contributed some really cool functionality to the Metadata Selection UI

• Much more Elegant & Readable UI, both on Mobile & on Desktop

  • Improved CSS for the Fetch Metadata interface—making it easier and clearer for you to review and select metadata sources.

• Individually Selectable Elements

  • Say goodbye to having to having all of your book's metadata overwritten simply becuasse you wanted a better looking cover!
  • As of V3.1.0, all metadata elements can be individually updated from multiple sources instead of the only option being to take everything for a single source!

• Visual Quality Comparison Between the Cover Your Book Already Those Available from Metadata Providers

  • Looking for a specific cover but not sure if the image file is low quality or not? As of V3.1.0, the resolution of cover images is now displayed on the bottom right corner of the preview, the background of which is colour-coded to indicate whether the available cover is of greater, lower or equal quality to the one already attached to the ebook!

• Thanks to demitrix for their contributions to this! <3

NEW: KoReader Sync Functionality! 📚🗘

• CWA now includes built-in KOReader syncing functionality, providing a modern alternative to traditional KOReader sync servers!
• Universal KOReader Syncer: Works across all KOReader-compatible devices, storing sync data in a readable format for future CWA features
• Modern Authentication: Uses RFC 7617 compliant header-based authentication instead of legacy MD5 hashing for enhanced security
• CWA Integration: Leverages your existing CWA user accounts and permissions - no additional server setup required
• Easy Installation: Plugin and setup instructions are available directly from your CWA instance at /kosync
• Provided by sirwolfgang! <3

Support for the Latest Versions of Calibre, even on devices with older Kernels! 🆕🎉

• ABI tag from the extracted libQt6* files removed to allow them to be used with older kernels
• Adds binutils to install strip for calibre-included Dockerfile.
  strip libQt6*.so files of the ABI tag so that they can work with older kernels (harmless for newer kernels).
  These libraries appear to still contain fallbacks for any missing syscalls that calibre might use.
  add .gitattributes to enforce LF checkout on .sh files (useful for those who build on windows)
• Thanks to these changes, CWA now has much greater compatibility with a much wider range of devices & is able to keep up to date with the latest Calibre Releases! 🎉
• Provided by FennyFatal <3

NEW: Calibre Plugin Support (WIP) 🔌

• Users can now install Calibre plugins such as DeDRM
• The feature is still a work in progress but users with existing Calibre instances can simply bind their existing Calibre plugins folder to /config/.config/calibre/plugins in their docker-compose file

NEW: Bulk Add Books to Shelves 📚📚📚

Contributed by netvyper, you can now select multiple books from the book list page and add them to a shelf in one go!

• New "Add to Shelf" button in bulk actions on the book list.
• Modal dialog lets you pick your shelf.
• Backend checks for permissions, duplicates, and provides clear success/error feedback.

Better Docs Cometh - The Birth of the CWA Wiki 📜

• The documentation for CWA while for many enough, could really be better in helping as many users find the answers and information they need as quickly as possible
• Therefore We have started work on the CWA Wiki to strive towards this goal!
• While still very much a work in progress, submissions for pages, edits ect. are open to the community so if you stumble across something that seems wrong, missing or outdated, please jump in and change it if you can or let us know if you're not sure :)

Minor Changes ✨

• The Ingest Automerge Parameter is now configurable in the CWA Settings Panel (thanks to have-a-boy! PR Add configurable setting for ingest automerge parameter  #417)

  • Users now have the option of selecting their preferred automerge behaviour from the 3 available:

    1. new_record (Default)
       • Create a duplicate record, keeping both copies
    2. overwrite
       • Overwrite library copy with newly imported file
    3. ignore
       • Discard duplicate import, keep library copy

  • The next update will do a lot more to try and squash dupe issues once and for all but for now this solution should help a lot of people configure CWA to do what they need

• Links to IBDb enties from books now added to ebook identifiers when enabled thanks to chad3814! PR add links to ibdb #422

• Using a QR Code with the Magic-Link login page functionality is now possible thanks to coissac! PR Magic qrcode #408

• Tweaked refresh-library notification messages to be more visually appealing

• List of Metadata Providers on Fetch Metadata screen is now alphabetized

• Improvements to the CWA Ingest Processor:

  • The scope of the functions responsible for deleting empty directories during the ingest process has been narrowed to make sure files to be ingested in parent folders are more reliably ingested (thanks to demitrix)!

• User Profile Pictures can now be changed from the admin panel (thanks to angelicadvocate)!

• Cover images are now lazy loaded to improve responsiveness & performance on instances with many, many books

• CSS for Dark Mode users vastly improved across the board!

  • The book cover display on the homepage is now centered to vastly improve it's appearance on mobile devices
  • The filter buttons are now in the title bar on larger resolutions instead of taking up unnecessary space at the top on the book display (when pagination is not in use)
  • Fixed the ugly read indicators in Dark Mode
  • The side menu on mobile has been made much more visually appealing & pleasant to use
  • Hover animation over book covers is now snappier and more modern

• Amazon.jp is now available as a Metadata Provider (added by Hobogrammer)

Bugfixes 🐛

• CWA now grabs the correct Kebupify version for ARM64 based devices (thanks to Calychas)!
• .crdownload, .download and .part files are now ignored by the CWA Ingest Processor to prevent partially downloaded files from being processed (thanks to Aymendje)!
• PR#371 from Dee76 Fix: Kepub conversion not being passed the full path of the source file
• Notebook syncing fixed for Kobo users thanks to a CW PR by jvik! (#3316)
• Fixed 403 error when using proxy auth and accessing /ajax/updateThumbnails from a session authenticated by reverse proxy (CW PR #3390) by geekifier
• Ignore Formats from Ingest feature bug fixed by qliratu! PR Use replace to get the suffix only (no .) #308
• Fixed timeout issue (Issue #437)
• Fixed occasional application freeze when fetching metadata from Amazon to to request timeout
• Increased mail servers compatibility with Gmail
• pycountry dependency bump
• Users table on the settings page no longer continues off the screen at lower resolutions
• Prevented the Tasks table from inheriting both "table-bordered" and "table-no-bordered" classes resulting in an ugly mess
• Better general performance & responsiveness

Upcoming 🔮

• The next update will add a lot of changes and new features to make dupe problems a thing of the past 👯❌
• Auto-Send-to-Kindle 🛫⚙️
• User setting to pick preferred accent colour of the Web UI 🎨

Affliated Projects 👬

• In the spirit of community, I also wanted to give a shout out to some really great affiliate projects made by members of our community!
• As well as being featured here in the release, affiliated projects will now also be prominently feature on the CWA GitHub page to drive as much traffic & enthusiasm to them as possible
• If you've had an idea for a companion project for CWA, or want to get involved in helping improve CWA and/or it's affiliated projects, please just do so! We're all open-source here so you don't need anyone's permission, just go for it! :)

---

Calibre-Web Companion

• Built with Flutter and using Material You, Calibre Web Companion is an unofficial companion application for Calibre Web & Calibre Web Automated that allows you to browse your book collection and download books directly on your device, providing a much more modern, mobile-friendly UX than either service can currently provide on its own

---

Calibre-Web Automated Book Downloader

• An intuitive web interface for searching and requesting book downloads, designed to work seamlessly with Calibre-Web-Automated. This project streamlines the process of downloading books and preparing them for integration into your Calibre library

Supporting the Project ❤️

If you are in a position to, donations no matter how small are really appreciated & really help to keep the project going. Currently all money that has been and will be received is going towards a Kobo device so I can finally help out with the development & testing of CWA's KoSync & Kobo specific features :)

---

This discussion was created from the release Version 3.1.0 - The Community Update 👬 Hardcover Integration 💜, Calibre Plugins 🔌, Split Library Support 💞, KoReader Sync 🗘 and much more! 📚.

[nnmalex]

Amazing update.
Can't seem to make Hardcover integration work though. Does the API key need the "Bearer " part?
How often does the sync to Hardcover fire?

[crocodilestick]

@demitrix I think we'll probably need a script that can go through each book in an existing library and add the required identifiers from Hardcover then, I can add it to the UI and sort the UX if you have the time to give the script a shot since your better acquainted with the hardcover API?

[nnmalex]

Updating here as well. Hardcover requires both an id and edition in metadata to sync progress. When scraping from Hardcover the result should have a small magnifying glass with Editions next to it. This will populate the edition metadata and syncing should work.

I've got those for a few books I'm testing with. And they are not synced to Hardcover either.

[demitrix]

Updating here as well. Hardcover requires both an id and edition in metadata to sync progress. When scraping from Hardcover the result should have a small magnifying glass with Editions next to it. This will populate the edition metadata and syncing should work.

I've got those for a few books I'm testing with. And they are not synced to Hardcover either.

Can you join the Discord and we can troubleshoot further.

[nnmalex]

Figured it out. It wasn't clear to me that besides the user profile, you need to enable Hardcover sync in CWA admin settings.

[tinchodin]

@demitrix I think we'll probably need a script that can go through each book in an existing library and add the required identifiers from Hardcover then, I can add it to the UI and sort the UX if you have the time to give the script a shot since your better acquainted with the hardcover API?

Any news on this? i got hardcover working but going book by book manually its a tedious process.

[Strubbl]

In KOReader desktop, I found the plugins at the top menu status bar → Tools → Page 2 → More Tools → Plugin management and not directly at Settings → Tools → Plugin management.

But where are the CWA kosync plugin settings hidden? I cannot find them.

[Strubbl]

found the answer in the PR comment: #425 (comment):

it looks like the menu for it only shows up once you have a book/document open in Koreader, not if your in the navigation view

[komadorirobin]

Maybe I'm dumb, but I can't figure out how to find/enable the Calibre plugins in CWA. I've binded the folder in the composer file, but where do I actually access the settings? My DeDRM plugin doesn't work in CWA, for instance.

[Chang-Liang222]

Why is the Chinese translation gone?