41 lines
3.1 KiB
Markdown
41 lines
3.1 KiB
Markdown
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/Donkie/Spoolman/assets/2332094/4e6e80ac-c7be-4ad2-9a33-dedc1b5ba30e">
|
|
<source media="(prefers-color-scheme: light)" srcset="https://github.com/Donkie/Spoolman/assets/2332094/3c120b3a-1422-42f6-a16b-8d5a07c33000">
|
|
<img alt="Icon of a filament spool" src="https://github.com/Donkie/Spoolman/assets/2332094/3c120b3a-1422-42f6-a16b-8d5a07c33000">
|
|
</picture>
|
|
|
|
<br/>
|
|
|
|
_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](https://octoprint.org/) and [Klipper](https://www.klipper3d.org/)/[Moonraker](https://moonraker.readthedocs.io/en/latest/). 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](https://donkie.github.io/Spoolman/) 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.
|
|
* **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](https://hosted.weblate.org/projects/spoolman/).
|
|
* **Database Support**: SQLite, PostgreSQL, MySQL, and CockroachDB.
|
|
* **Multi-Printer Management**: Handles spool updates from several printers simultaneously.
|
|
* **Advanced Monitoring**: Integrate with [Prometheus](https://prometheus.io/) for detailed historical analysis of filament usage, helping you track and optimize your printing processes.
|
|
|
|
**Spoolman integrates with:**
|
|
* [Moonraker](https://moonraker.readthedocs.io/en/latest/configuration/#spoolman) and most front-ends (Fluidd, KlipperScreen, Mainsail, ...)
|
|
* [OctoPrint](https://github.com/mdziekon/octoprint-spoolman)
|
|
* [OctoEverywhere](https://octoeverywhere.com/spoolman?source=github_spoolman)
|
|
* [Homeassistant](https://github.com/Disane87/spoolman-homeassistant)
|
|
|
|
**Web client preview:**
|
|
|
|
|
|
## Installation
|
|
Please see the [Installation page on the Wiki](https://github.com/Donkie/Spoolman/wiki/Installation) for details how to install Spoolman.
|