Self-host Ubooquity with Levelrail

A home server for comics and ebooks with a reader in the browser and OPDS support, packaged by the community maintainers. GPL-3.0 licensed. Set an admin password on first visit.

  • Authorlinuxserver
  • LicenceGPL-3.0-only
  • Memory384 MiB
  • Services1

How to self-host Ubooquity

  1. Pull the images

    One image is pulled on your server.

    Show images
    • lscr.io/linuxserver/ubooquity:3.1.0-ls98
  2. Create the app

    One service starts in a single Compose app, with 4 named volume mounts for your data, on ports 2202, 2203.

  3. Fill in the secrets

    3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

After the first start

  • Open the admin page on the next port, set a password, then point the library at the books and comics volumes.

Ubooquity requirements

Memory
About 384 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
2202, 2203
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
GPL-3.0-only, copyleft license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Ubooquity. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Ubooquity docs page.

Deploy Ubooquity your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Ubooquity from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain ubooquity=app.example.com.

levelrail-cli templates install ubooquity --name my-ubooquity

Deploy Ubooquity with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/ubooquity/install \
  -d '{
    "name": "my-ubooquity"
  }'

Ubooquity configuration

Ubooquity services

ServiceImagePortsVolumes
ubooquity lscr.io/linuxserver/ubooquity:3.1.0-ls98 2202, 2203 config -> /configbooks -> /bookscomics -> /comicsfiles -> /files

Ubooquity environment variables

VariableServiceValue
PGID ubooquity Preset by the template
PUID ubooquity Preset by the template
TZ ubooquity Preset by the template

Ports and volumes

Ports
2202, 2203
Volumes
4 named mounts: config -> /config, books -> /books, comics -> /comics, files -> /files

Ubooquity FAQ

How much memory does Ubooquity need?

The catalog lists about 384 MiB of memory for Ubooquity.

Does Ubooquity run on arm64?

For Ubooquity, arm64 support is not confirmed; amd64 is unknown.

What licence is Ubooquity under?

Ubooquity is licensed under GPL-3.0-only, which is copyleft, so changes you distribute must be shared under the same terms.

Does Ubooquity need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Ubooquity use?

Ubooquity listens on ports 2202 and 2203 inside the stack.

Where does Ubooquity keep its data?

In named volumes: config mounted at /config, books mounted at /books, comics mounted at /comics and files mounted at /files.

Can I deploy Ubooquity on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Ubooquity, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image lscr.io/linuxserver/ubooquity:3.1.0-ls98 is what you deploy there.

levelrail-cli templates install ubooquity --name my-ubooquity