This project is a fork of Donkie/Spoolman with an improvement to simplify spool management.

In the original workflow, users often had to create multiple spool entries for the same filament type and manually adjust the spool ID each time. This was inconvenient when the only changing parameter was the remaining filament weight.

To address this, the fork introduces a new feature:

A new UI button allows modifying the initial filament weight of a spool. This makes it possible to maintain a single spool entry and simply update the available weight as needed, without creating duplicates.

Using with Docker Compose To run Spoolman via Docker Compose, use the following configuration:

version: '3.8'
services:
  spoolman:
    image: interpol/spoolman
    restart: unless-stopped
    volumes:
      # Mount the host machine's ./data directory into the container's /home/app/.local/share/spoolman directory
      - type: bind
        source: ./data  # Local directory where the data will be stored. You may also use a path like /home/pi/printer_data/spoolman.
        target: /home/app/.local/share/spoolman  # Do NOT modify this line
    ports:
      # Map the host machine's port 7912 to the container's port 8000
      - "7912:8000"
    environment:
      - TZ=Europe/Kiev  # Optional, defaults to UTC

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.

• 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:

• Moonraker and most front-ends (Fluidd, KlipperScreen, Mainsail, ...)
• OctoPrint
• OctoEverywhere
• Home Assistant

Web client preview:

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