# Self-host 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.

- Page: https://levelrail.com/templates/ubooquity/
- JSON: https://levelrail.com/templates/ubooquity.json
- Category: Media
- Licence: GPL-3.0-only (Copyleft license)
- Source: https://github.com/linuxserver/docker-ubooquity
- Upstream docs: https://github.com/linuxserver/docker-ubooquity

## Requirements
- Memory: about 384 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: 3.1.0-ls98

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| ubooquity | lscr.io/linuxserver/ubooquity | 3.1.0-ls98 | 2202, 2203 | config -> /config; books -> /books; comics -> /comics; files -> /files |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| ubooquity | PGID | preset |
| ubooquity | PUID | preset |
| ubooquity | TZ | preset |

## Deploy

### CLI

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

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

### API

```bash
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"
  }'
```

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

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

## Questions

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

Self-host Ubooquity, Ubooquity docker compose file, deploy Ubooquity on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
