Spoolman

Spoolman

Docker app from mklecka's Repository

Overview

Keep track of your inventory of 3D-printer filament spools. Spoolman is a web service that helps you keep track of your filament spools and how they are being used. It acts as a database, where other printer software such as Octoprint and Moonraker can interact with to have a centralized place for spool information. For example, if used together with Moonraker, your spool weight will automatically be reduced as your print is progressing. For more container variables visit the official github repo https://github.com/Donkie/Spoolman#using-docker
Icon of a filament spool

Keep track of your inventory of 3D-printer filament spools.

Spoolman is a self-hosted web service designed to help you efficiently manage your 3D printer filament spools and monitor their usage. It acts as a centralized database that seamlessly integrates with popular 3D printing software like OctoPrint and Klipper/Moonraker. When connected, it automatically updates spool weights as printing progresses, giving you real-time insights into filament usage.

Static Badge GitHub Release

Features

  • Filament Management: Keep comprehensive records of filament types, manufacturers, and individual spools.
  • API Integration: The REST API allows easy integration with other software, facilitating automated workflows and data exchange.
  • Real-Time Updates: Stay informed with live spool updates through Websockets, providing immediate feedback during printing operations.
  • Central Filament Database: A community-supported database of manufacturers and filaments simplify adding new spools to your inventory. Contribute by heading to SpoolmanDB.
  • Web-Based Client: Spoolman includes a built-in web client that lets you manage data effortlessly:
    • View, create, edit, and delete filament data.
    • Add custom fields to tailor information to your specific needs.
    • Print labels with QR codes for easy spool identification and tracking.
    • Contribute to its translation into 18 languages via Weblate.
  • Database Support: SQLite, PostgreSQL, MySQL, and CockroachDB.
  • Multi-Printer Management: Handles spool updates from several printers simultaneously.
  • Advanced Monitoring: Integrate with Prometheus for detailed historical analysis of filament usage, helping you track and optimize your printing processes. See the Wiki for instructions on how to set it up.

Spoolman integrates with:

Web client preview: image

Installation

Please see the Installation page on the Wiki for details how to install Spoolman.

Install Spoolman on Unraid in a few clicks.

Find Spoolman in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Spoolman Review the template variables and paths Click Install

Related apps

Details

Repository
ghcr.io/donkie/spoolman:latest
Last Updated2026-07-17
First Seen2023-10-09

Runtime arguments

Web UI
http://[IP]:[PORT:8000]
Network
bridge
Shell
sh
Privileged
false

Template configuration

DataPathrw
Target
/home/app/.local/share/spoolman
Default
/mnt/user/appdata/spoolman
Value
/mnt/user/appdata/spoolman
WebUI PortPorttcp
Target
8000
Default
7912
Value
7912
SPOOLMAN_DB_TYPEVariable

Type of database, any of: postgres, mysql, sqlite, cockroachdb

Default
sqlite
SPOOLMAN_DB_HOSTVariable

Database hostname

Default
remove variable if not used
SPOOLMAN_DB_PORTVariable

Database port

Default
remove variable if not used
SPOOLMAN_DB_NAMEVariable

Database name

Default
remove variable if not used
SPOOLMAN_DB_USERNAMEVariable

Database username

Default
remove variable if not used
SPOOLMAN_DB_PASSWORDVariable

Database password

Default
remove variable if not used
PUIDVariable
Value
99
PGIDVariable
Value
100