PrintMaster DOCS
GitHub ↗
Documentation

PrintMaster Documentation

Cross-platform printer/copier fleet management for MSPs, MPS providers, and IT departments.


Quick Start

DocumentDescription
Installation GuideInstall on Windows, Linux, macOS, Docker
Getting StartedFirst steps after installation

User Guides

DocumentDescription
Features GuideAll features explained with examples
ConfigurationConfig files, environment variables, UI settings
TroubleshootingCommon issues and solutions
FAQFrequently asked questions

Deployment

DocumentDescription
Docker DeploymentDocker and Docker Compose setup
Database UpgradePostgreSQL and TimescaleDB upgrade procedure
Unraid DeploymentUnraid-specific installation

API Reference

DocumentDescription
API ReferenceREST API for agent and server

What is PrintMaster?

PrintMaster consists of two components:

Agent

A lightweight service that runs at each site:

  • Discovers printers on your network via SNMP
  • Collects page counts, toner levels, device info
  • Local web UI for management
  • Can run standalone or report to server

Server

Central hub for managing multiple agents:

  • Aggregates data from all agents
  • Fleet view dashboard
  • Remote agent access via WebSocket proxy
  • Multi-tenant support

Architecture

┌─────────────┐         ┌─────────────┐         ┌─────────────┐
│   Agent     │────────▶│   Server    │◀────────│   Agent     │
│   Site A    │         │  (Central)  │         │   Site B    │
└─────────────┘         └─────────────┘         └─────────────┘
      ↓                       ↓                       ↓
  Printers              Web Dashboard            Printers

Getting Help


For Developers

See Developer Documentation for:

  • Build instructions and project structure
  • Internal architecture and design
  • Contributing guidelines