Donkie
c781869d09
The screenshot was the 2023 React client -- a different application from the one a new visitor now installs. The replacement is client_v2's library with a spool's details open beside it, which is where anyone using Spoolman spends their time, and it lives in the repo rather than on user-content URLs so it can be regenerated with the client. The feature list gains search/group/filter, which client_v2 makes a first-class part of the library rather than per-column table filters. Installation now mentions SPOOLMAN_LEGACY_CLIENT. Someone whose setup the new client misbehaves on will look here before .env.example, and the useful thing to know is that both clients ship in every release and share the API, so falling back costs nothing. Claude-Session: https://claude.ai/code/session_01UB5KocsTBm9GL5x3Uuup5F
4.0 KiB
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.
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.
- Search, group and filter your inventory by manufacturer, material, location and more.
- Add custom fields to tailor information to your specific needs.
- Design and 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
- MCP Server - Manage your filament inventory through AI assistants like Claude using the Model Context Protocol
Web client preview:
Installation
Please see the Installation page on the Wiki for details how to install Spoolman.
If the new client misbehaves on your setup, set SPOOLMAN_LEGACY_CLIENT=TRUE to go back to
the previous one. Both ship in every release and talk to the same API, so your data is
untouched either way — but please report the problem
so it can be fixed.