# Self-host Spoolman

> A filament spool inventory manager for 3D printers with usage tracking and printer firmware integrations. MIT licensed. On first open, add your filaments and vendors; there is no login, so keep it behind a private network or an auth proxy.

- Page: https://levelrail.com/templates/spoolman/
- JSON: https://levelrail.com/templates/spoolman.json
- Category: Applications
- Licence: MIT (Permissive license)
- Source: https://github.com/Donkie/Spoolman
- Upstream docs: https://github.com/Donkie/Spoolman

## Requirements
- Memory: about 256 MiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: 0.27.1

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| spoolman | ghcr.io/donkie/spoolman | 0.27.1 | 8000 | data -> /home/app/.local/share/spoolman |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| spoolman | SPOOLMAN_DB_TYPE | preset |
| spoolman | TZ | preset |

## Deploy

### CLI

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

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

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

## Questions

### Can I deploy Spoolman 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 Spoolman, 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/donkie/spoolman:0.27.1 is what you deploy there.

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