Ubooquity 3 (BETA)

15 october 2023    Uncategorized

A BETA version of Ubooquity 3 is available.

Due to the high number of changes made since the last release, a few bugs might still be around.
Wait a few weeks for the next stable release(version 3.1) if you want to minimize the risk of issues.
Until that stable release is available, the download and documentation pages of this site will still reference Ubooquity 2.
Documentation specific to version 3 is mentionned below.

New requirements and migration from version 2

The minimum Java version required to run Ubooquity is now Java 17.

When coming from Ubooquity version 2, your preferences (in the preferences.json file) will be automatically converted to the new preference format (in the preferences-2.json file) without erasing them. The whole database will have to be recreated though, meaning your collection will have to be rescanned.
Themes from version 2 are not compatible with version 3, you should revert to the default theme (in the settings) if you use a custom theme.

Download Ubooquity3 BETA

New features

  • Comics and books sections have ben unified. When sharing a folder, you have to select a category (comics, books, magazines, documents or others), but this category will just be used to group the files on the home page, Ubooquity no longer treats your files differently depending on their section/category.
  • Reading progress is now displayed in the library and details views, with "mark as read/unread" buttons in the details.

  • Themes have been made much more flexible, with full control over the HTML files. See the dedicated documentation for more details, and the variable reference for a complete list of the data you can use in your custom themes:
  • Thumbnail compression level can now be adjusted in the settings.
  • Two new API endpoints (callable using a secret API key, see the advanced settings page for details and examples) were added:
    • one to remotely trigger a collection scan
    • one to remotely trigger a server shutdown.
  • Duplicate files detection: at the end of each scan Ubooquity will list in the logs the duplicates it found (files with the same name and size).

Other changes

  • Fixed display of transparent images in DJVU documents.
  • Upgraded all dependencies.
  • Made epub parsing more resilient.
  • Improved handling of files with incorrect extensions.
  • Reimplemented the desktop UI in Swing since Java 11+ does not support JavaFX out of the box anymore.
  • Ubooquity is now developped in Kotlin, although a lot of Java code is still there. Full code conversion/rewrite will be done progressively.
  • A lot of miscellaneous small bug fixes.


Any question or feedback ? Go to the Ubooquity forum.


Ubooquity is not affected by Log4shell

13 december 2021    General

You might have heard about Log4shell, a critical vulnerability in the widely used Log4j logging library.

Ubooquity does not use this library (logging is done with Logback), so it is not affected by this vulnerability.


Ubooquity 2.1.2

11 october 2018    Release

Ubooquity 2.1.2 is available.

To upgrade, just stop Ubooquity and replace the Ubooquity.jar file.


Download Ubooquity

Change log

Bug fixes:

  • fixed 'writers' replaced by 'publication date' in comics metadata
  • fixed comic metadata reading bug

New features:

  • new option to bypass Calibre individual book folders (try it if you share a Calibre library)


  • "__MACOSX" folder in archives are now ignored (they used to prevent cover display)
  • OPDS pages now have unique ids
  • improved security
  • updated internal RAR library (RAR 5 files are still not supported though)

Ubooquity 2.1.1, minor release

22 september 2017    Release

Ubooquity 2.1.1 is available.

This is a minor release: a few bug fixes and a few very specific features.
To upgrade, just stop Ubooquity and replace the Ubooquity.jar file.


Download Ubooquity

Change log

Bug fixes:

  • fixed a bug preventing bookmark saving on Ubooquity server for PDF files shared in the "books" section
  • fixed log display issue on administration page
  • fixed wrong MIME type for some "folder info" resources

New features:

  • prevent Ubooquity from responding to HTTP CONNECT requests
  • add FictionBook (FB2) ebook format support
  • add Comic Book Info metadata support for CBZ files (with a small variation compared to the specs: Ubooquity expects boolean instead of "YES/NO" in the credits.primary field)



Ubooquity 2.1.0

08 july 2017    Release

Ubooquity 2.1.0 is available.

This is the first 2.x stable version. If you were still using version 1.x, you should now be able to upgrade without taking too big a risk. And in any case, should you need them, previous versions are still available for download.


Download Ubooquity 2.1.0

Change log

(since 2.0.2)

  • Fixed PDF wrong MIME type
  • Added link to the library on the admin page
  • Added public preferences access through user API ( /public-api/preferences )
  • Added option to prevent database removal of unavailable root folders
  • Added limited support for AZW and AZW3 files
  • Added page up/down keyboard shortcut in comics reader
  • Modified the bookmark API to include update date in bookmark

If you upgrade from Ubooquity 1.x, read the 2.0.0 release notes, as they contain important information about database and preferences format changes (in a nutshell, you'll have to reconfigure Ubooquity and rescan your collection).

The documentation has also been updated to reflect 2.x modifications.