Version 2.1.2 - Multi-Platform Images, Personalise Your Instance and Big UI Improvements! ✨💪

CWA is finally Multi-Platform!! 💪🎉

• This and all future releases are now Multi-Platform! From now on, CWA will have both linux/amd64 & linux/arm64 images available for each new version!

UI Changes & Fixes 📛

• Fixed the user's ability to rebrand the Web UI with whatever name they see fit

  • To do so, navigate to the Settings/ Admin panel, select Edit UI Configuration and under the View Configuration tab, change the Title field to whatever you want!
  • The name you select here will the replace the default Calibre-Web Automated across the Web-UI ect. for all your users
  • The branding will change throughout as soon as you've saved your changes, no restart required!

  

• Added descriptions for each setting in the CWA Settings page as well as tooltips

Fixes and Improvements to the Book List page 🦋

• The Header and page elements now conform to the same design language as the rest of the pages

• The Bulk Edit buttons have been moved from the Table Headings to the top of the page and some of the page headings have been shortened to maximise the available horizontal space on any given device and make the page much easier to use (especially on mobile)

• The Pagination widget has been properly aligned and centred with regards to the other page elements

• The Columns selection widget now expands to the left and into a already visible section of the page instead of off to the right and expanding the width of the page

• And in the CaliBlur/ Dark Theme:

  • The search button of the search field it now properly aligned and sized to the search field, no longer slightly smaller than it should have been to the ire of many

  • The pagination widget on the top left is now themed black, orange and white to match the aesthetic of the rest of the UI elements

  BEFORE 🤢

  

  AFTER ✨

  

Version 2.1.1 - Minor Bugfixes on V2.1.0

Minor Bugfixes for bugs introduced in V2.1.0:

• Calibre Binary location now set by default to /usr/bin in app.db
• Restored split setting option in config_db to prevent 500 errors some users were having
• Fixed dependency issues introduced in convert-library
• Added isfile check for convert-library.log to prevent crash on first run that could result if a log file didn't already exist

---

Version 2.1.0 - Major Fix for NAS & Unraid users, more User Customisability, Major Improvements to the Ingest and Conversion systems and more! 🎊 ✨📖

MAJOR FIX - Synology & Unraid Users (plus those running old Linux Kernels) 🎉

• After months of working with the community to try and find a fix for the widespread issues Synology users in particular were having, we have finally arrived on a fix! 🎉
• The issue was that the most recent binaries utilised by CWA from the linuxserver universal-calibre mod are incompatible with older versions of the Linux Kernel (particularly versions 4.4 and 3.2)
• This meant that for users using older NASs ect., the binaries would be unavailable, rendering the CWA functions that require them unusable
• A fix was discovered by user @loli71 here in this thread who found that the binaries within V7.16 of the universal-calibre mod are compatible with those still using older kernel versions!
• Therefore from now on, baring issues, CWA will use V7.16 of the mod by default to ensure maximum compatibility for as many users as possible
• Special thank to @iroQuai, @Malek-GHub and @inkanyamba for their help in solving the issue in the now closed thread here

New Features ✨

• Added a CWA Settings panel to allow users to enable and disable certain CWA Settings based on their preferences
• Added Ability to check the status of the CWA Monitoring services from within the Web UI
• Added the ability for users to use the Convert-Library function from the Web UI using the "Convert Library to epub" button in the settings page
• Added a new auto compression feature (cwa-auto-zipper) that automatically zips all backed up files, once a day just before midnight to minimise disk space and help keep backed up files organised. The feature is also user toggleable in the new CWA Settings page
• Added a page called "Show CWA History" in the Admin Panel that users can now use to view the historical logs/ stats of all previous metadata enforcements, conversions & imports in the Web UI

Major Changes ⛰️

• Updated base CW base version to 0.6.23 from 0.6.22
• Reworked and vastly improved the auto ingest process to solve issues for a number of users and to improve reliability and performance
  • Users who has their ingest folders on different drives to their Calibre Libraries were experiencing permission issues that could only be rectified through the mounting of a temp folder used by the old ingest process
  • With the new process these issues have been resolved on top of it being more reliable and performant in general
• Numerous changes have been made to make the ingest process much less destructive:
  • The originals of converted and imported books, as well as those that have failed to be ingested, are now automatically backed up by default to /config/processed_books
  • This as well as many other functions are also now able to be disabled in the new "CWA Settings" page in the Admin Panel
• Rewrote convert-library.py to be much less destructive through the implementation of user toggleable file backup settings, more reliable and to support statistical output to cwa.db
• Added fix for updated metadata & covers not reliably updating on Kobo devices. Courtesy of @tsheinen. See the thread here
• Added the enforcement of Timezones given as environment variables. Previously giving a timezone as an environment variable didn't change the system clock of the container environment consistently for all users and functions and so now the /etc/localtime and /etc/timezone files are automatically corrected during container startup by the cwa-auto-zipper service, defaulting to UTC time if no TZ was given or in the event of an error or unrecognised timezone. This has made scheduled tasks more consistent and reliable.
• Added lock file for convert-library.py to prevent multiple simultaneous instances

Minor Changes & Bugfixes ✅

• Added greater support for special characters in Book Titles and Author Names
• Improved error handling for files that are unable to be successfully processed
• Fix for bug where the Web UI could become unavailable due to not receiving a response for a API query to the project's GitHub page. Courtesy of @Buco7854
• Made it so CWA only checks for available updates once per day
• Made it so that the "Enable Uploads" setting in the Feature Configuration screen is on by default for new installs as new users who had yet to enable it were confused by not being able to upload new covers for example
• Added oneshot service at init to check for and remove any potential leftover cwa lock files (cwa-init-remove-locks)
• Added default paths to included calibre & kepubify binaries so their additional functionality is enabled by default for new installs
• Deprecated new-book-detector as part of the reworking of the auto ingest system
• Renamed numerous scripts to make their functions clearer
• Made the available update notifications optional through the new CWA Settings page
• Fixed Library Refresh Pop-Up messaging

Coming in V2.2.0 🍃

• Making CWA much more user configurable through the new CWA Settings panel e.g. giving users the ability to disable the conversion of certain formats ect.
• Restoring the ability for users to rebrand the Web UI
• Re-enabling Split Library functionality and having it work seamlessly with CWA's other features

Version 2.1.0 - Major Fix for NAS & Unraid users, more User Customisability, Major Improvements to the Ingest and Conversion systems and more! 🎊 ✨📖

MAJOR FIX - Synology & Unraid Users (plus those running old Linux Kernels) 🎉

• After months of working with the community to try and find a fix for the widespread issues Synology users in particular were having, we have finally arrived on a fix! 🎉
• The issue was that the most recent binaries utilised by CWA from the linuxserver universal-calibre mod are incompatible with older versions of the Linux Kernel (particularly versions 4.4 and 3.2)
• This meant that for users using older NASs ect., the binaries would be unavailable, rendering the CWA functions that require them unusable
• A fix was discovered by user @loli71 here in this thread who found that the binaries within V7.16 of the universal-calibre mod are compatible with those still using older kernel versions!
• Therefore from now on, baring issues, CWA will use V7.16 of the mod by default to ensure maximum compatibility for as many users as possible
• Special thank to @iroQuai, @Malek-GHub and @inkanyamba for their help in solving the issue in the now closed thread here

New Features ✨

• Added a CWA Settings panel to allow users to enable and disable certain CWA Settings based on their preferences
• Added Ability to check the status of the CWA Monitoring services from within the Web UI
• Added the ability for users to use the Convert-Library function from the Web UI using the "Convert Library to epub" button in the settings page
• Added a new auto compression feature (cwa-auto-zipper) that automatically zips all backed up files, once a day just before midnight to minimise disk space and help keep backed up files organised. The feature is also user toggleable in the new CWA Settings page
• Added a page called "Show CWA History" in the Admin Panel that users can now use to view the historical logs/ stats of all previous metadata enforcements, conversions & imports in the Web UI

Major Changes ⛰️

• Updated base CW base version to 0.6.23 from 0.6.22
• Reworked and vastly improved the auto ingest process to solve issues for a number of users and to improve reliability and performance
  • Users who has their ingest folders on different drives to their Calibre Libraries were experiencing permission issues that could only be rectified through the mounting of a temp folder used by the old ingest process
  • With the new process these issues have been resolved on top of it being more reliable and performant in general
• Numerous changes have been made to make the ingest process much less destructive:
  • The originals of converted and imported books, as well as those that have failed to be ingested, are now automatically backed up by default to /config/processed_books
  • This as well as many other functions are also now able to be disabled in the new "CWA Settings" page in the Admin Panel
• Rewrote convert-library.py to be much less destructive through the implementation of user toggleable file backup settings, more reliable and to support statistical output to cwa.db
• Added fix for updated metadata & covers not reliably updating on Kobo devices. Courtesy of @tsheinen. See the thread here
• Added the enforcement of Timezones given as environment variables. Previously giving a timezone as an environment variable didn't change the system clock of the container environment consistently for all users and functions and so now the /etc/localtime and /etc/timezone files are automatically corrected during container startup by the cwa-auto-zipper service, defaulting to UTC time if no TZ was given or in the event of an error or unrecognised timezone. This has made scheduled tasks more consistent and reliable.
• Added lock file for convert-library.py to prevent multiple simultaneous instances

Minor Changes & Bugfixes ✅

• Added greater support for special characters in Book Titles and Author Names
• Improved error handling for files that are unable to be successfully processed
• Fix for bug where the Web UI could become unavailable due to not receiving a response for a API query to the project's GitHub page. Courtesy of @Buco7854
• Made it so CWA only checks for available updates once per day
• Made it so that the "Enable Uploads" setting in the Feature Configuration screen is on by default for new installs as new users who had yet to enable it were confused by not being able to upload new covers for example
• Added oneshot service at init to check for and remove any potential leftover cwa lock files (cwa-init-remove-locks)
• Added default paths to included calibre & kepubify binaries so their additional functionality is enabled by default for new installs
• Deprecated new-book-detector as part of the reworking of the auto ingest system
• Renamed numerous scripts to make their functions clearer
• Made the available update notifications optional through the new CWA Settings page
• Fixed Library Refresh Pop-Up messaging

Coming in V2.2.0 🍃

• Making CWA much more user configurable through the new CWA Settings panel e.g. giving users the ability to disable the conversion of certain formats ect.
• Restoring the ability for users to rebrand the Web UI
• Re-enabling Split Library functionality and having it work seamlessly with CWA's other features

Version 2.0.1 - Minor Fix to Update Notification System

Very small update, only fixes the following:

• A bug where the Update Availability notification would be shown even when no update was available. Now works as intended
• A bug some users where facing that resulted in a 500 error when trying to load the admin page

CrocodileStick

Version 2.0.0 - Bulk Editing, Auto-Library Detection, Wider Compatibilityand lots, lots more! ✨

Version 2.0.0 - 28.08.2024 🌅🎉

🚨 Please Update to the latest DockerHub image ASAP to avoid stability & import/ ingest issues that have been corrected from previous versions

If you find any bugs, please be sure to create an issue in the Issues Section! 🪲

New Features ✨

• Dockerfile is now freely available & provides wider system / hardware compatibility 🐋

• Offical Support for Proxmox and NAS Based-Systems 💾

  • If you've previously tried to use CWA and couldn't get it to work properly, many permissions related issues from the previous releases have now been fixed and so V2.0.0 should now work for pretty much anyone! (except those on ARM-based systems)

• NEW FEATURE - Library Auto-Detect 📚🕵️

  • Made to MASSIVELY simplify the setup process for both new and existing users alike
  • New Users without existing Libraries: 🆕
    • New users without existing Calibre Libraries no longer need to copy and paste metadata.db files and point to their location in the Web UI, CWA will now automatically detect the lack of Library in your given bind and automatically create a new one for you! It will even automatically register it with the Web UI so you can really hit the ground running
  • New or Existing Users with Existing Libraries:
    • Simply bind a directory containing your Calibre Library (search is done recursively so it doesn't matter how deep in the directory it is) and CWA will now automatically find it and mount it to the Web UI
    • Should you bind a directory with more than 1 Calibre Library in it, CWA will intelligently compare the disk sizes of all discovered libraries and mount the largest one
      • CWA supports only one library per instance though support for multiple libraries is being investigated for future releases
      • In the meantime, users with multiple libraries who don't want to consolidate them are advised to run multiple, parallel instances

• NEW FEATURE - Easy Dark/ Light Mode Switching ☀️🌙

• Switch between Light & Dark Modes in just one click from anywhere!
  • Simply click/tap the 🕶️ icon on the Web UI's navbar and switch between themes at your leisure

• NEW FEATURE - Internal Update Notification System 🛎️

  • Users will now be automatically notifed of the availability of new updates from within the Web UI
    • Automatically triggered by a difference between the version number of the most recent GitHub release and the version installed
    • Set to only show once per calendar day until updated as to not be annoying
      • Visible to Admin users only

• NEW FEATURE - Manual Library Refresh ♻️

  • Ever had books get stuck in the ingest folder after an unexpected powercut ect.? Well say goodbye to having to manually copy the books to be ingested back in and out of the ingest folder, simply press the Refresh Library button on the navbar of the Web UI and anything still sitting in the ingest folder will be automatically ingested!

• NEW FEATURE - Batch Editing & Deletion! 🗂️🗄️

• Say goodbye to clicking that edit button again, and again, and again just to remove or edit a single series!
• To use, simply navigate to the Books Listpage on the left hand side of the Web UI, select the books you wish to edit/ delete and use the buttons either above the table or within the headers to do whatever you need!
  • Courtesy of @jmarmstrong1207

Bugfixes 🐜:

• Fixed a slew of permissions related issues that previously prevented Proxmox users and users with NAS-Based systems from being able to run CWA without issue. These configurations are now officially supported!
• Fixed a bug with cover_enforcer.py where books with '/' characters in the title or author's name(s) would break the process
• Fixed a bug that resulted in excessive memory usage over time when ingesting large libraries (1000+ books)

Tweaks/ Minor Improvments ✨:

• The Version Numbers of the installed distributions for CWA, Calibre, Stock CW, Kepubify and the Linuxserver.io base image are now all displayed at the bottom of the Settings page
• Added links to the CWA Github and Discord in the Settings Page
• Added Consistent CWA Branding throughout

Version 1.2.2 - Major Bugfixes, Book Import & Ingest Finally Fully Working 🎊

🚨 NEW UPDATE WITH FIXES 🚨 - Version 1.2.2 - 29.07.2024

🚨 Please Update to the latest DockerHub image ASAP to avoid major issues with the old Import/Ingest System and for General Stability Improvements

This update should now render the Auto-Import system FULLY STABLE, with all the major bugs now being fixed! 🎊

If you find any bugs however, please be sure to create an issue in the Issues Section! 🪲

Fixed Bugs:

• Fixed moving (not copying) a folder into cwa-book-ingest not detecting the folder and its contents
• Fixed import duplication issues that sometimes happens from slower drive speeds or mass importing

New Features:

• Calibre-Web-Automated's Version Number now shows up alongside the version of the stock CW running as a base on the Settings page

Coming Next (Version 1.2.3):

• Auto-Library Detection / Deployment to make installing & switching a breeze for anyone, existing libraries or no!
• A Dockerfile for the project (finally! 🎉)

Version 1.2.1 - Major Bugfixes & Base Update to 0.6.22 Oxana

New in Version 1.2.1 - 27.07.2024

🚨 TO ALL USERS 🚨 Please update to the latest DockerHub image ASAP to avoid major issues with the old Import/Ingest System

• Major Bugfixes to existing book Import & Ingest Methods that could previously result in:
  • Some books being imported multiple times when importing large numbers at once
  • The ingestion of some books failing due to the import process triggering too quickly, before the transfer of said files is complete, leading to the attempted import of incomplete files which inevitably fails
  • Fixed auto importing folders recursively when copied into the ingest folder. Moving folders (rather than copy) still doesn't work. This has been fixed in the upcoming update
  • Fixes courtesy of @jmarmstrong1207
• Current issues:
  • Mass importing can potentially cause duplication issues. This has been fixed in the upcoming update
• Base version of stock Calibre-Web updated to : V 0.6.22 - Oxana which comes with the following fixes & features:

New features:	Bug Fixes:
lubimyczytac metadata fetches now the right tags section	CB7 metadata extraction working with newer version of py7zr
OPDS catalog now only shows categories which are also visible in the normal User interface	douban metadata fetching is working again
PRC is added as source for book conversion	Improved Content Security Policy header
Added option for read status "Any" in Advanced Searching	Improvements for Caliblur! Dark Theme
Metadata Backup is supported now	It's now possible to reset Kobo sync for other users
Metadata Backup is supported now	Improved parsing of book content on upload to prevent crashes
In all categories a category "No category applied (None) is visible	Refactored author renaming issue to prevent Oops Database corrupt messages
	Fix on Windows that prevents starting calibre-web
	Ä Ö Ü are now counting as uppercase letters for Passwords
	Fix for Text reader to handle invalid mulitbyte sequence (mainly for CJK-Languaes)
	Fix for _internal folder showing up using windows installer version
	Security fix: File upload mimetype is checked to prevent malicious file content in the books library
	Security fix: Cross-site scripting (XSS) stored in comments section is prevented better (switching from lxml to bleach for sanitizing strings)

Version 1.2.0 - Cover Heaven & New Super Easy Install! 🎉📚🐋

Calibre-Web Automated 1.2.0 - Cover Heaven & New Super Easy Install! 🎉📚🐋

Version 1.2.0 - Changelog

New Features

• Automatic Enforcement of Changes made to Covers & Metadata through the Calibre-Web UI! 🙌📔

• Something that's always bothered me as a Kindle user has been Calibre-Web's inability to change the Metadata and Covers stored within the .epub files of our books, despite letting us change these things in the Web UI

• This has resulted in many people, including myself, running instances of both Calibre-Web AND full-fat Calibre, to make use of Calibre's much more robust editing tools to change out those ugly covers and keep our Kindle Libraries looking a bit more
  _~ a e s t h e t i c ~_ and our metadata correct between devices

• Well, no more! ⏰

• Using CWA 1.2.0, whenever you change any Covers or Metadata using the Calibre-Web UI, those changes will now be automatically applied directly to the .epub files in your library, as well as in the Web UI itself, meaning that from now on what you see really is what you get!

• One Step Full Library Conversion - Any format -> .epub ✏️

  • Calibre-Web Automated has always been designed with .epub libraries in mind due to many factors, chief among which being the fact they are Compatible with the Widest Range of Devices, Ubiquitous as well as being Easy to Manage and Work with
  • Previously this meant that anyone with non-epub ebooks in their existing Calibre Libraries were unable to take advantage of all of Calibre-Web Automator's features reliably
  • So new to Version 1.2.0 is the ability for those users to quickly and easily convert their existing eBook Libraries, no matter the size, to .epub Version 3 format using a one step CLI Command from within the CWA Container
  • This utility gives the user the option to either keep a copy of the original of all converted files in /config/original-library or to trust the process and have CWA simply convert and replace those files (not recommended)
  • Full usage details can be found here

• Simple CLI Tools for manual fixes, conversions, enforcements, history viewing ect. 👨‍💻

  • Built-in command-line tools now also exist for:
    • Viewing the Edit History of your Library files (detailed above)
    • Listing all of the books currently in your Library with their current Books IDs
    • Manually enforcing the covers & metadata for ALL BOOKS in your library using the cover-enforcer -all command from within the container (RECOMMENDED WITH FIRST TIME USE)
    • Manually Enforcing the Covers & Metadata for any individual books by using the following command
    • cover-enforcer --dir <path-to-folder-containing-the-books-epub-here>
  • Full usage and documentation for all new CLI Commands can be found here

• Easy to View Change Database and Internal Automatic Logging 📈

• In combination with the New Cover & Metadata Enforcement Features, a database now exists to keep track of any and all enforcements, both for peace of mind and to make the checking of any bugs or weird behaviour easier, but also to make the data available for statistical analysis or whatever else someone might want to use the data for
• Full documentation can be found below here

IMPORTANT NOTE: ⚡ Current users of Calibre-Web Automated versions before 1.2.0 should perform a fresh install using the new DockerHub image method below to ensure stability and to keep up-to-date with future bugfixes and updates

New and Simplified Installation Methods

• Now Fully installable through Docker Compose using our Latest DockerHub Image! 🐋🎉🙌

  • Full install now possible using the Docker Compose file below (Full installation documentation can be found under the Installation section of the projects GitHub):

---
services:
  calibre-web-automated:
    image: crocodilestick/calibre-web-automated:latest
    container_name: calibre-web-automated
    environment:
      - PUID=1000
      - PGID=100
      - TZ=UTC
    volumes:
      - /path/to/config/folder:/config
      - /path/to/the/folder/you/want/to/use/for/book/ingest:/cwa-book-ingest
      - /path/to/your/calibre/library:/calibre-main # Point to your Calibre config folder not the 'Calibre Library' folder directly
      #- /path/to/where/you/keep/your/books:/books #Optional
      #- /path/to/your/gmail/credentials.json:/app/calibre-web/gmail.json #Optional
    ports:
      - 8084:8083 # Change the first number to change the port you want to access the Web UI, not the second
    restart: unless-stopped
    

• Updated Script Installer (Alternative Install Method) 👨‍💻

  • Due to updates to Calibre-Web, the script installer needs to be run within the included calibre-web-base-image, newer versions of Calibre-Web are currently INCOMPATIBLE with Calibre-Web Automated.
  • Script install method edited to support the new 1.2.0 features and simplified to make the installation as easy as possible
  • The Installer will now automatically detect any books in your Library that are not in .epub format and will give the user the option to run the new Library Conversion Process during setup
  • Full documentation on this install method can be found under the Installation section of the projects GitHub page.

Bugfixes

• Fixed a few potential crashes during the Script Install process
• Fixed errors that could occur during the import of books with non-english characters in the title or author's name ect.
• Fixed an error that could occur when many new books were placed into the ingest folder at once
• Overall speed and reliability improvements

Upcoming Features 🌱 - Coming Soon™

• Adding buttons to the Web UI to enable easier execution of features like full library conversion and others currently only available through the command-line interface
• Reworking the book ingest system to be more robust and reliable when used with drives with slow transfer speeds
• Please suggest any ideas or wishes you might have! I'm open to anything!

Future Development

• I've now been daily driving this version of Calibre-Web Automated (formerly Calibre-Web Automator) for a couple weeks now and it now does everything I need for my reading workflow, I personally love the new features and hope you do to!
• I will continue to maintain this project but as to new features I'm very much open to requests so please reach out with any suggestions or ideas you might have and I'll do my best to implement them!

xoxo,
CrocodileStick

Version 1.0.1

Calibre-Web Automator V1.0.1

New in Version 1.0.1:

• Fixed some bugs and pathing issues I missed in the release of Version 1.0.0
• Simplified the Install process and updated the instructions here to match
• Added terminal commands you can use to change the given directories & check on the current status of the monitoring services
• Made preparations for Version 1.1.0 which is coming soon with new features

v1.0.0

Calibre-Web Automator V1.0.0

First official public release! Please let me know if you have any problems and I'll endeavour to help / make fixes ASAP.

Current Features:

• Easy, Guided Setup via CLI interface
• Automatic imports of .epub files into your Calibre-Web library
• Automatic Conversion of newly downloaded books into .epub format for optimal compatibility with the widest number of eReaders, library homogeneity, and seamless functionality with Calibre-Web's excellent Send-to-Kindle Function.
• User-defined File Structure
• A Weighted Conversion Algorithm:
  • Using the information provided in the Calibre eBook-converter documentation on which formats convert best into epubs, CWA is able to determine from downloads containing multiple eBook formats, which format will convert most optimally, ignoring the other formats to ensure the best possible quality and no duplicate imports
• Optional Persistance within your Calibre-Web instance between container rebuilds
• Easy tool to quickly check whether or not the service is currently running as intended / was installed successfully
• Easy to follow logging in the regular container logs to diagnose problems or monitor conversion progress ect. (Easily viewable using Portainer or something similar)
  • Logs also contain performance benchmarks in the form of a time to complete, both for an overall import task, as well as the conversion of each of the individual files within it
• Supported file types for conversion:
  • .azw, .azw3, .azw4, .mobi, .cbz, .cbr, .cb7, .cbc, .chm, .djvu, .docx, .epub, .fb2, .fbz, .html, .htmlz, .lit, .lrf, .odt, .pdf, .prc, .pdb, .pml, .rb, .rtf, .snb, .tcr, .txt, .txtz

Coming Soon ™️

• Ability to automatically push all newly imported books to your kindle through the existing Send-to-Kindle feature