Frequently Asked Questions
Don’t forget to check the forum if you don’t find here the answer you were looking for.
Table of content
- I shared a folder but I can’t see it on my Ubooquity page
- How can I change the admin password once it has been set ?
- I can download my comics using Ubooquity server, now how do I read them ?
- How can I make Ubooquity start with Windows ?
- How do I run Ubooquity on a Linux server ?
- Why does Ubooquity connect to the internet when it starts ?
- Can I use Ubooquity to share my Calibre library ?
- Some of the information I see in Calibre do not appear in Ubooquity
- Some of my books appear duplicated in Ubooquity but not in Calibre
- How can I add metadata to my comics so that Ubooquity displays them ?
- Can I run Ubooquity on a Raspberry Pi ?
- Can Ubooquity read DRM protected files ?
- How do I install Ubooquity on an Asustor NAS ?
- How do I install Ubooquity on an Synology NAS ?
- Files with non-ASCII characters are ignored by Uboquity
- I have “java.lang.OutOfMemoryError: Java heap space” messages in the logs
- How do I customize the format of my logs ?
- Can I have a Docker container for Ubooquity?
- Where can I find the source code of Ubooquity ?
- Can I generate password hashes myself for the admin and users ?
I shared a folder but I can’t see it on my Ubooquity page
If you chose to protect shared folders by creating users, you must specify for each folder the list of authorized users.
How can I change the admin password once it has been set ?
When you choose your admin password for the first time, Ubooquity creates a webadmin.cred file in its working directory. To change the password, just delete the webadmin.cred file and the next time you go on the admin page, Ubooquity will ask you to choose a password again.
I can download my comics using Ubooquity server, now how do I read them ?
Many comics readers exist for whatever device you might be using, here are only a few suggestions :
- Windows users might want to try Comic Rack (for advanced comics management) or Sumatra PDF (for easy reading of a lot of formats like cbr, cbz, epub, pdf…).
- on iPad, Chunky Reader has implemented Ubooquity specific comic streaming support and can also be used to access a Ubooquity server through its internal browser. Comic Glass is also quite good (although it does not support streaming and its internal browser is not as intuitive to use).
- Android users also have excellent viewers at their disposal, Challenger Comics Viewer and Comic Viewer for Ubooquity for instance
How can I make Ubooquity start with Windows ?
Just create a shortcut to the Ubooquity.jar file (right-click, create shortcut) and put it in your Startup folder (located at
How do I run Ubooquity on a Linux server ?
You can use the
ubooquity.sh script available here.
Why does Ubooquity connect to the internet when it starts ?
Ubooquity checks once a day if a newer version is available so that you can download it if you want.
Can I use Ubooquity to share my Calibre library ?
Yes, just share your Calibre library folder. Ubooquity will even read and display Calibre-specific informations like rating and series name and we have a special page for Calibre related tips.
Some of the information I see in Calibre do not appear in Ubooquity
You must force Calibre to write information in the epub files containing your books. Everything is explained in the Calibre related tips.
Some of my books appear duplicated in Ubooquity but not in Calibre
Sometimes Calibre generates extra epub files when a problem occurs during file modification. To remove them, follow the procedure described in the Calibre related tips.
How can I add metadata to my comics so that Ubooquity displays them ?
Here is a [detailed tutorial]](tutorials/add-metadata-with-comicrack.html) on using ComicRack to update comics matadata. (thanks to Matthew Sanders)
Can I run Ubooquity on a Raspberry Pi ?
Yes, Ubooquity has been succesfully tested on a Pi.
Raspbian images ship with Oracle Java by default. It also can be installed with the following command:
sudo apt-get update && sudo apt-get install oracle-java8-jdk
Once you have the Java Runtime Environment installed, just follow the command line installation instructions in Ubooquity documentation like you would do for an installation on any regular Linux.
Can Ubooquity read DRM protected files ?
No, unfortunately it can’t. These files are designed to be read only on some specific ebooks reader. They are protected against access by any other software or device, including Ubooquity.
How do I install Ubooquity on an Asustor NAS ?
Here is a detailed tutorial for the Asustor NAS. (thanks to lavraielilybellule)
How do I install Ubooquity on an Synology NAS ?
Here is a detailed tutorial. (thanks to Matthew Sanders)
Files with non-ASCII characters are ignored by Uboquity
The problem comes from the underlying OS. If your environment is not configured to run processes with more than just the ASCII charset (as it happens on some NAS), you’ll have issues.
There is no single workaround (different users reported different results with different system settings), but you can take a look at this thread:
Also, these ones might contain interesting info as well:
I have “java.lang.OutOfMemoryError: Java heap space” messages in the logs
The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get java.lang.OutOfMemoryError: Java heap space errors.
To fix the problem, you can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware).
If you use the startup script provided by the documentation, find and uncomment (remove the “#”) the following line:
512 is the number of MegaBytes Ubooquity will be allowed to occupy, change it to the value that suits you.
How do I customize the format of my logs ?
Follow the instructions of this tutorial.
Can I have a Docker container for Ubooquity?
Docker containers have been set up by some users and are available here:
Docker repository: https://registry.hub.docker.com/u/hurricane/ubooquity/
Forum thread: http://lime-technology.com/forum/index.php?topic=36278.0
Github repository for scripts: https://github.com/HurricaneHernandez/ubooquity
(not packaged by me, please address your questions directly on the Lime Technology forums)
For x64 devices
Docker repository: https://hub.docker.com/r/linuxserver/ubooquity/
Github repository: https://github.com/linuxserver/docker-ubooquity
(not packaged by me, please address setup queries directly on the LinuxServer.io forum, LinuxServer.io IRC chatroom or, for Unraid users, the Lime Technology forum)
For ARM devices
Docker repository: https://hub.docker.com/r/lsioarmhf/ubooquity/
Github repository: https://github.com/linuxserver/docker-ubooquity-armhf
(not packaged by me, please address setup queries directly on the LinuxServer.io forum or the LinuxServer.io IRC chatroom)
Where can I find the source code of Ubooquity ?
Ubooquity is free to use but is not open source. That is not to say it will never be. Just not in the foreseeable future.
Can I generate password hashes myself for the admin and users ?
Although Ubooquity generates theses hashes for you, if you need to generate hashes separately (for the
preferences.json files), you can do it using this page: