Self-host Ubooquity on a VPS

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.

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

Specification

Status
Listed
Category
Media
Services
ubooquity
Ports
2202, 2203
Volumes
4
Memory
about 384 MiB
arm64
unknown
amd64
unknown
Settings to fill in
none
Listing
Community template

About Ubooquity

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.

What it deploys

Ubooquity runs as one service in a single Compose app, listening on ports 2202, 2203, with 4 named volume mounts.

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

Before you install

  • CPU architecture. arm64 unknown. The scan could not read a manifest or the tag is chosen at install time. This is not a claim either way.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.

Settings and environment

You do not have to fill in anything. Values are never shown here.

ServiceVariableValue
ubooquityPGIDPreset by the template
ubooquityPUIDPreset by the template
ubooquityTZPreset by the template

First run

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

Install Ubooquity on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get ubooquity
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default.

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

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install ubooquity --name my-ubooquity --domain ubooquity=ubooquity.example.com

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Ubooquity.

More in Media

All Media templates