# Self-host Shelfmark

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

- Page: https://levelrail.com/templates/shelfmark/
- JSON: https://levelrail.com/templates/shelfmark.json
- Category: Media
- Licence: MIT (Permissive license)
- Source: https://github.com/calibrain/shelfmark
- Upstream docs: https://github.com/calibrain/shelfmark

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: v1.6.2

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| shelfmark | ghcr.io/calibrain/shelfmark | v1.6.2 | 8084 | config -> /config; books -> /books |

## Environment

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

## Deploy

### CLI

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

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain shelfmark=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/shelfmark/install \
  -d '{
    "name": "my-shelfmark"
  }'
```

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

## First run
1. Open the settings page and pick your sources and the destination folder.

## Questions

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

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