-
-
Notifications
You must be signed in to change notification settings - Fork 271
Home
Welcome to the Spoolman Wiki! This is your go-to resource for everything related to Spoolman, a 3D printer spool management app that helps you track your filament spools with ease.
The first step to using Spoolman is to install it somewhere. Spoolman is a self-hosted app, so you need to run it on your own hardware. This could be a Raspberry Pi, or some other machine running in your closet. If you have SSH access to your 3D-printer, and it's a regular Linux machine, then you could probably install Spoolman straight on it!
Included in the Spoolman installation is both the server back-end, and a web-based front-end that lets you manage your inventory directly.
Install Spoolman by following the installation guide. This page covers all steps for setting up the app, including system requirements and any additional tools or dependencies needed.
Spoolman runs fine with no configuration at all, but you can point it at another database, move where its files are stored, change the port, or turn on metrics. This page covers where the settings go — environment variables in Docker, the .env file in a standalone install — and lists every one of them with its default.
Spoolman has no authentication, so the network it sits on is what protects your data. This page explains what that means in practice, what Spoolman blocks on its own, and how to configure SPOOLMAN_CORS_ORIGIN and SPOOLMAN_ALLOWED_HOSTS.
Interested in contributing to Spoolman? This page provides guidelines for developers.