This guide walks through a self-hosted installation of Spoolman.
For Docker installation, see Docker.
For a quick setup using the official container image:
mkdir spoolman && cd spoolman
cat > docker-compose.yml << EOF
version: '3.8'
services:
spoolman:
image: ghcr.io/donkie/spoolman:latest
container_name: spoolman
restart: unless-stopped
ports:
- "8000:8000"
volumes:
- ./data:/data
environment:
- SPOOLMAN_DATABASE_URL=sqlite:////data/spoolman.sqlite3
EOF
docker compose up -d
If you prefer to use the source code:
Install Git to clone the project repository.
sudo apt-get update && sudo apt-get install -y git
Download the source code to the server.
git clone https://github.com/Donkie/spoolman spoolman
Move into the project folder to access deployment files.
cd spoolman
Use Docker Compose to start services in the background.
docker compose up -d
Spoolman supports multiple database backends:
sqlite:////data/spoolman.sqlite3postgresql://username:password@host:port/databasemysql://username:password@host:port/databaseghcr.io/donkie/spoolman:latest (currently v0.23.1)ghcr.io/donkie/spoolman:v0.23.1 for version pinningghcr.io/donkie/spoolman:edge for latest features (not recommended for production)Prefer automation? See Spoolman Ansible Setup for an example playbook.
Prefer containers? See Spoolman Docker Setup.
Any questions?
Feel free to contact us. Find all contact information on our contact page.