avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-01-11 18:31:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Alexandre
2021-02-23 16:05:59 +01:00
committed by GitHub
parent dbe926500b
commit a6103b5a18
1 changed files with 21 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
ubooquity/README.md
View File

@@ -1,10 +1,14 @@
# Home assistant add-on: Ubooquity
![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield]
# About
----------
[Ubooquity by vaemendis](https://vaemendis.net/ubooquity/) is a free, lightweight and easy-to-use home server for your comics and ebooks developed . This addon is based on the [docker image](https://github.com/linuxserver/docker-ubooquity) from [linuxserver.io](https://www.linuxserver.io/).
## About
Ubooquity supports many types of files, with a preference for ePUB, CBZ, CBR and PDF files. Metadata from library management software Calibre and ComicRack are also supported. Ubooquity lets you create user accounts and set access rights for each shared folder.
Free, lightweight and easy-to-use home server for your comics and ebooks
This addon is based on the [docker image](https://github.com/linuxserver/docker-ubooquity) from linuxserver.io.
This addons has several configurable options :
- allowing to mount local external drive, or smb share from the addon (decreases performance)
- **VERY IMPORTANT, CAN CRASH SYSTEM** : Setting of the maximum RAM usage for java. 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 and you'll get "java.lang.OutOfMemoryError: Java heap space errors". If the quantity allocated is too high for your system, it will crash home assistant and you'll need to manually reboot. Value is a number of megabytes ( put just a number, without MB).
It is recommended to enable OPDS server from option, then you can connect to your comics/eBook server from a mobile app (I use [Chunky](https://apps.apple.com/fr/app/chunky-comic-reader/id663567628) on iOS (paid), [Kuboo](https://play.google.com/store/apps/details?id=com.sethchhim.kuboo&hl=fr&gl=US) on android (free))
## Installation
@@ -16,24 +20,29 @@ comparison to installing any other Hass.io add-on.
1. Click the `Save` button to store your configuration.
1. Start the add-on.
1. Check the logs of the add-on to see if everything went well.
1. Carefully configure the add-on to your preferences, see the official documentation for for that.
1. Open the webUI, set an admin password and adapt the administration options
## Configuration
Access the admin page at http://<your-ip>:2203/ubooquity/admin and set a password.
Then you can access the webui at http://<your-ip>:2202/ubooquity/ (or top left of the admin page)
This container will automatically scan your files at startup.
# Configuration
--------------
Admin webui can be found at <http://your-ip:2203>.
Library webui can be found at <http://your-ip:2202>. You can also access it by clicking on the ubooquity logo at top left of the admin page, or use a mobile app (preferred option, see above for instructions)
The default username/password : described in the startup log.
Configurations can be done through the app webUI, except for the following options
Network disk is mounted to /mnt/sharename
Network disk is mounted to /mnt/share name
```yaml
GUID: user
GPID: user
maxmem: 200 # IMPORTANT : 200 is default for rpi3b+ ; 512 recommended if more 2gb RAM. 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. 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 or the whole system will crash). Value is a number of megabytes ( put just a number, without MB).
maxmem: 200 # IMPORTANT read above. 200 is default for rpi3b+ ; 512 recommended if more 2gb RAM.
networkdisks: "<//SERVER/SHARE>" # list of smbv2/3 servers to mount (optional)
cifsusername: "username" # smb username (optional)
cifspassword: "password" # smb password (optional)
smbv1: false # Should smbv1 be used instead of 2.1+?
```
# Illustration
--------------
![books_library|596x500](upload://bzV9qEgjl9iE90bX3hYyaYjdnTz.jpeg)
## Support
Create an issue on the [repository github][repository], or ask on the [home assistant thread](https://community.home-assistant.io/t/home-assistant-addon-ubooquity/283811)