The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
# linuxserver/ubooquity
[](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/ubooquity "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-ubooquity/)
Find us at:
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
# PSA: Changes are happening
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
[](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com")
[](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com")
[Ubooquity](https://vaemendis.net/ubooquity/) is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
Simply pulling `linuxserver/ubooquity` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
Here are some example snippets to help you get started creating a container.
### docker
```
docker create \
--name=ubooquity \
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-e MAXMEM=<maxmem> \
-p 2202:2202 \
-p 2203:2203 \
-v <pathtodata>:/config \
-v <pathtobooks>:/books \
-v <pathtocomics>:/comics \
-v <pathtorawfiles>:/files \
-e MAXMEM=<maxmem> \
-e PGID=<gid> -e PUID=<uid> \
-p 2202:2202 \
-p 2203:2203 \
--restart unless-stopped \
linuxserver/ubooquity
```
## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
### docker-compose
* `-p 2202` - the library port
* `-p 2203` - the admin port
* `-v /config` - Config files and database for ubooquity
* `-v /books` - Location of books.
* `-v /comics` - Location of comics.
* `-v /files` - Location of raw files.
* `-e MAXMEM` - to set the maximum memory
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
Compatible with docker-compose v2 schemas.
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it ubooquity /bin/bash`.
```
---
version: "2"
services:
ubooquity:
image: linuxserver/ubooquity
container_name: ubooquity
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
- MAXMEM=<maxmem>
volumes:
- <pathtodata>:/config
- <pathtobooks>:/books
- <pathtocomics>:/comics
- <pathtorawfiles>:/files
ports:
- 2202:2202
- 2203:2203
mem_limit: 4096m
restart: unless-stopped
```
### MAXMEM
## Parameters
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.
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
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).
| Parameter | Function |
| :----: | --- |
| `-p 2202` | The library port. |
| `-p 2203` | The admin port. |
| `-e PUID=1001` | for UserID - see below for explanation |
| `-e PGID=1001` | for GroupID - see below for explanation |
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `-e MAXMEM=<maxmem>` | To set the maximum memory. |
| `-v /config` | Config files and database for ubooquity. |
| `-v /books` | Location of books. |
| `-v /comics` | Location of comics. |
| `-v /files` | Location of raw files. |
If no value is set it will default to 512MB.
## User / Group Identifiers
### User / Group Identifiers
When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
Ubooquity has now been upgraded to [version 2](http://vaemendis.net/ubooquity/article19/ubooquity-2-1-0) and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below.
@ -86,28 +143,53 @@ Then you can access the webui at `http://<your-ip>:2202/ubooquity/`
This container will automatically scan your files at startup.
## Info
### MAXMEM
* Shell access whilst the container is running: `docker exec -it ubooquity /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f ubooquity`
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.
* container version number
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).
`docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity`
If no value is set it will default to 512MB.
* image version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity`
## Support Info
* Shell access whilst the container is running: `docker exec -it ubooquity /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f ubooquity`
* container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity`
* image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity`
## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
### Via Docker Run/Create
* Update the image: `docker pull linuxserver/ubooquity`
* Stop the running container: `docker stop ubooquity`
* Delete the container: `docker rm ubooquity`
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* Start the new container: `docker start ubooquity`
* You can also remove the old dangling images: `docker image prune`
### Via Docker Compose
* Update the image: `docker-compose pull linuxserver/ubooquity`
* Let compose update containers as necessary: `docker-compose up -d`
* You can also remove the old dangling images: `docker image prune`
## Versions
+ **28.01.19:** Add pipeline logic and multi arch.
+ **15.10.18:** Upgrade to Ubooquity 2.1.2.
+ **23.08.18:** Rebase to alpine 3.8.
+ **09.12.17:** Rebase to alpine 3.7.
+ **07.10.17:** Upgrade to Ubooquity 2.1.1.
+ **16.07.17:** Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
+ **26.05.17:** Rebase to alpine 3.6.
+ **08.04.17:** Switch to java from 3.5 repo, fixes login crashes.
+ **06.02.17:** Rebase to alpine 3.5.
+ **06.12.16:** Initial Release.
* **28.01.19:** - Add pipeline logic and multi arch.
* **15.10.18:** - Upgrade to Ubooquity 2.1.2.
* **23.08.18:** - Rebase to alpine 3.8.
* **09.12.17:** - Rebase to alpine 3.7.
* **07.10.17:** - Upgrade to Ubooquity 2.1.1.
* **16.07.17:** - Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
* **26.05.17:** - Rebase to alpine 3.6.
* **08.04.17:** - Switch to java from 3.5 repo, fixes login crashes.
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
*[forum.linuxserver.io][forumurl]
*[IRC][ircurl] on freenode at `#linuxserver.io`
*[Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/ubooquity
[](https://microbadger.com/images/linuxserver/ubooquity "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/ubooquity "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-ubooquity/)
Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
*`-p 2202` - the library port
*`-p 2203` - the admin port
*`-v /config` - Config files and database for ubooquity
*`-v /books` - Location of books.
*`-v /comics` - Location of comics.
*`-v /files` - Location of raw files.
*`-e MAXMEM` - to set the maximum memory
*`-e PGID` for GroupID - see below for explanation
*`-e PUID` for UserID - see below for explanation
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it ubooquity /bin/bash`.
### MAXMEM
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).
If no value is set it will default to 512MB.
### User / Group Identifiers
Sometimes when using data volumes (`-v` flags) permissions issues can arise between the host OS and the container. We avoid this issue by allowing you to specify the user `PUID` and group `PGID`. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
project_blurb:"[{{ project_name|capitalize }}]({{ project_url }}) is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer."
Ubooquity has now been upgraded to [version 2](http://vaemendis.net/ubooquity/article19/ubooquity-2-1-0) and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below.
@ -92,29 +58,23 @@ full_custom_readme: |
This container will automatically scan your files at startup.
## Info
* Shell access whilst the container is running:`docker exec -it ubooquity /bin/bash`
* To monitor the logs of the container in realtime:`docker logs -f ubooquity`
*container version number
`docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity`
### MAXMEM
*image version number
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.
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ubooquity`
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).
## Versions
If no value is set it will default to 512MB.
+ **28.01.19:** Add pipeline logic and multi arch.
+ **15.10.18:** Upgrade to Ubooquity 2.1.2.
+ **23.08.18:** Rebase to alpine 3.8.
+ **09.12.17:** Rebase to alpine 3.7.
+ **07.10.17:** Upgrade to Ubooquity 2.1.1.
+ **16.07.17:** Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
+ **26.05.17:** Rebase to alpine 3.6.
+ **08.04.17:** Switch to java from 3.5 repo, fixes login crashes.
+ **06.02.17:** Rebase to alpine 3.5.
+ **06.12.16:** Initial Release.
{%- endraw %}
# changelog
changelogs:
- {date:"28.01.19:", desc:"Add pipeline logic and multi arch."}
- {date:"15.10.18:", desc:"Upgrade to Ubooquity 2.1.2."}
- {date:"23.08.18:", desc:"Rebase to alpine 3.8."}
- {date:"09.12.17:", desc:"Rebase to alpine 3.7."}
- {date:"07.10.17:", desc:"Upgrade to Ubooquity 2.1.1."}
- {date:"16.07.17:", desc:"Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users."}
- {date:"26.05.17:", desc:"Rebase to alpine 3.6."}
- {date:"08.04.17:", desc:"Switch to java from 3.5 repo, fixes login crashes."}
- {date:"06.02.17:", desc:"Rebase to alpine 3.5."}
thelamer
6 years ago