linuxserver/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.

Supported Architectures¶

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/ubooquity:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Available	Tag
x86-64	✅	amd64-<version tag>
arm64	✅	arm64v8-<version tag>
armhf	❌

Application Setup¶

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/

This container will automatically scan your files at startup.

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). Value is a number of megabytes ( put just a number, without MB )

If no value is set it will default to 512MB.

Usage¶

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)¶

---
services:
  ubooquity:
    image: lscr.io/linuxserver/ubooquity:latest
    container_name: ubooquity
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - MAXMEM= #optional
    volumes:
      - /path/to/ubooquity/data:/config
      - /path/to/books:/books
      - /path/to/comics:/comics
      - /path/to/raw/files:/files
    ports:
      - 2202:2202
      - 2203:2203
    restart: unless-stopped

docker cli (click here for more info)¶

docker run -d \
  --name=ubooquity \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e MAXMEM= `#optional` \
  -p 2202:2202 \
  -p 2203:2203 \
  -v /path/to/ubooquity/data:/config \
  -v /path/to/books:/books \
  -v /path/to/comics:/comics \
  -v /path/to/raw/files:/files \
  --restart unless-stopped \
  lscr.io/linuxserver/ubooquity:latest

Parameters¶

Containers 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.

Ports (`-p`)¶

Parameter	Function
`2202`	The library port.
`2203`	The admin port.

Environment Variables (`-e`)¶

Env	Function
`PUID=1000`	for UserID - see below for explanation
`PGID=1000`	for GroupID - see below for explanation
`TZ=Etc/UTC`	specify a timezone to use, see this list.
`MAXMEM=`	To set the maximum memory. ( ex: set '1024' for 1GB )

Volume Mappings (`-v`)¶

Volume	Function
`/config`	Config files and database for ubooquity.
`/books`	Location of books.
`/comics`	Location of comics.
`/files`	Location of raw files.

Miscellaneous Options¶

Parameter	Function

Environment variables from files (Docker secrets)¶

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications¶

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

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.

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=1000 and PGID=1000, to find yours use id your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods¶

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

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" }}' lscr.io/linuxserver/ubooquity:latest

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 (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose¶

Update images:

All images:
```
docker-compose pull
```
Single image:
```
docker-compose pull ubooquity
```

Update containers:

All containers:
```
docker-compose up -d
```
Single container:
```
docker-compose up -d ubooquity
```

You can also remove the old dangling images:
```
docker image prune
```

Via Docker Run¶

Update the image:

docker pull lscr.io/linuxserver/ubooquity:latest

Stop the running container:
```
docker stop ubooquity
```
Delete the container:
```
docker rm ubooquity
```
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:
```
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)¶

Tip

We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally¶

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-ubooquity.git
cd docker-ubooquity
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/ubooquity:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions¶

06.06.24: - Rebase to Alpine 3.20.
20.03.24: - Rebase to Alpine 3.19.
29.10.23: - Bump JRE to 17 to support v3.
12.07.23: - Rebase to Alpine 3.18.
04.07.23: - Deprecate armhf. As announced here
05.03.23: - Rebase to Alpine 3.17.
10.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
23.01.21: - Rebasing to alpine 3.13.
01.06.20: - Rebasing to alpine 3.12.
19.12.19: - Rebasing to alpine 3.11.
28.06.19: - Rebasing to alpine 3.10.
23.03.19: - Switching to new Base images, shift to arm32v7 tag.
22.02.19: - Rebasing to alpine 3.9.
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.

linuxserver/ubooquity¶