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-ubooquitySpecification
- Status
- Listed
- Category
- Media
- Services
- ubooquity
- Ports
- 2202, 2203
- Volumes
- 4
- Memory
- about 384 MiB
- arm64
- unknown
- amd64
- unknown
- Settings to fill in
- none
- License
- Copyleft license, GPL-3.0-only
- 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.
| Service | Image | Tag | Ports | Volumes |
|---|---|---|---|---|
| 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.
| Service | Variable | Value |
|---|---|---|
| ubooquity | PGID | Preset by the template |
| ubooquity | PUID | Preset by the template |
| ubooquity | TZ | Preset by the template |
First run
- 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
-
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 -
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 | shif the machine does not have it. See Getting started.levelrail-cli login --device -
Read the template
Shows the entry, including its full compose.yaml.
levelrail-cli templates get ubooquity -
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-ubooquityTo 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.
Docs and upstream
More in Media
- TubeSyncSyncs chosen video channels and playlists to local storage on a schedule and keeps media library files tidy.
- TransmissionA fast, lightweight BitTorrent client with a simple web interface.
- TdarrAutomated media transcoding, health checks, and library-wide format standardization.
- StumpA comics, manga and digital book server with a web reader and OPDS support.
- YamtrackA self-hosted media tracker for movies, TV, anime, manga, games, and books.
- StashA self hosted organiser and player for your personal video library, with tags and scraping.