Self-host Shelfmark with Levelrail

A web app to search for books and audiobooks and send them to your library folders.

  • Authorcalibrain
  • LicenceMIT
  • Memory256 MiB
  • Services1

How to self-host Shelfmark

  1. Pull the images

    One image is pulled on your server.

    Show images
    • ghcr.io/calibrain/shelfmark:v1.6.2
  2. Create the app

    One service starts in a single Compose app, with 2 named volume mounts for your data, on port 8084.

  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 settings page and pick your sources and the destination folder.

Shelfmark requirements

Memory
About 256 MiB
Architectures
amd64 unknown, arm64 unknown
Ports
8084
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive 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 Shelfmark. 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 Shelfmark docs page.

Deploy Shelfmark your way

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

Deploy Shelfmark from the CLI

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

levelrail-cli templates install shelfmark --name my-shelfmark

Deploy Shelfmark 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/shelfmark/install \
  -d '{
    "name": "my-shelfmark"
  }'

Shelfmark configuration

Shelfmark services

ServiceImagePortsVolumes
shelfmark ghcr.io/calibrain/shelfmark:v1.6.2 8084 config -> /configbooks -> /books

Shelfmark environment variables

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

Ports and volumes

Ports
8084
Volumes
2 named mounts: config -> /config, books -> /books

Shelfmark FAQ

How much memory does Shelfmark need?

The catalog lists about 256 MiB of memory for Shelfmark.

Does Shelfmark run on arm64?

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

What licence is Shelfmark under?

Shelfmark is licensed under MIT, which is permissive, with few conditions on reuse.

Does Shelfmark need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Shelfmark use?

Shelfmark listens on port 8084 inside the stack.

Where does Shelfmark keep its data?

In named volumes: config mounted at /config and books mounted at /books.

Can I deploy Shelfmark 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 Shelfmark, 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 ghcr.io/calibrain/shelfmark:v1.6.2 is what you deploy there.

levelrail-cli templates install shelfmark --name my-shelfmark