Ubooquity

Free, lightweight home server for your comics and ebooks (EPUB, MOBI, PDF, CBZ, CBR) with OPDS support and a web reader.

Port	2202
Registry	ghcr.io/daemonless/ubooquity
Source	https://vaemendis.net/ubooquity/
Website	https://vaemendis.net/ubooquity/

Version Tags

Tag	Description	Best For
latest	Upstream Binary. Built from official release.	Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  ubooquity:
    image: "ghcr.io/daemonless/ubooquity:latest"
    container_name: ubooquity
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - MAXMEM=512  # Maximum Java memory allocation pool in MB (default: 512)
    volumes:
      - "/containers/ubooquity:/config"
      - "/path/to/books:/books" # optional
      - "/containers/ubooquity/comics:/comics" # optional
      - "/containers/ubooquity/files:/files" # optional
    ports:
      - "2202:2202"
      - "2203:2203"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=ubooquity
PUID=1000
PGID=1000
TZ=UTC
MAXMEM=512

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  ubooquity:
    name: ubooquity
    options:
      - container: 'args:--pull'
      - expose: '2202:2202 proto:tcp'
      - expose: '2203:2203 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - MAXMEM: !ENV '${MAXMEM}'
    volumes:
      - ubooquity: /config
      - books: /books
      - ubooquity_comics: /comics
      - ubooquity_files: /files
volumes:
  ubooquity:
    device: '/containers/ubooquity'
  books:
    device: 'books'
  ubooquity_comics:
    device: '/containers/ubooquity/comics'
  ubooquity_files:
    device: '/containers/ubooquity/files'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/ubooquity:${tag}

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  ubooquity:
    name: ubooquity
    image: "ghcr.io/daemonless/ubooquity:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - MAXMEM=512
    volumes:
      - "/containers/ubooquity:/config"
      - "/path/to/books:/books"
      - "/containers/ubooquity/comics:/comics"
      - "/containers/ubooquity/files:/files"

Save as bastille-compose.yml, then run bastille up.

Access at: http://localhost:2202

Parameters

Environment Variables

Variable	Default	Description
PUID	1000	User ID for the application process
PGID	1000	Group ID for the application process
TZ	UTC	Timezone for the container
MAXMEM	512	Maximum Java memory allocation pool in MB (default: 512)

Volumes

Path	Description
/config	Configuration directory, database, and settings
/books	Book library directory (EPUB, MOBI, PDF) (Optional)
/comics	Comic library directory (CBZ, CBR, CBT) (Optional)
/files	Raw documents and files directory (Optional)

Ports

Port	Protocol	Description
2202	TCP	Library Web UI & OPDS server
2203	TCP	Administration Web UI (set the admin password on first visit)

Architectures: amd64, aarch64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1

---

Need help? Join our Discord community.