PrintMaster Developer Documentation
Technical documentation for PrintMaster development. For user documentation, see /docs.
Current Version: Agent v0.23.6, Server v0.23.6
Start Here
- TODO.md – Consolidated pending features and improvements
- PROJECT_STRUCTURE.md – Repository layout and module overview
- BUILD_WORKFLOW.md – Build/test/release commands + VS Code tasks
User Documentation (Moved)
These docs are now in the parent /docs folder:
- API Reference – REST API for agent and server
- Configuration – Config files and environment variables
- Docker Deployment – Container deployment
- Unraid Deployment – Unraid-specific setup
Architecture & Internals
- SECURITY_ARCHITECTURE.md – Authentication/authorization design
- WEBSOCKET_PROXY.md – Server proxy tunnel details
- SNMP_REFERENCE.md – OIDs, vendor detection, discovery process
- SNMP_RESEARCH_NOTES.md – Protocol research and notes
- Printer-MIB.mib – Standard Printer-MIB file
- RANGE_SYNTAX.md – IP range syntax documentation
- USB_IMPLEMENTATION.md – USB printer support via IPP-USB proxy (Windows only)
Development & Testing
- TESTING.md – Testing strategy and patterns
- TEST_COVERAGE_ANALYSIS.md – Coverage status and gaps
Feature Plans (In Progress)
- AUTO_UPDATE_PLAN.md – Agent/server auto-update implementation
- EPSON_REMOTE_MODE_PLAN.md – Epson remote-mode integration
Reference
- DEPRECATIONS.md – Removed features and migration notes
- vendor/ – Vendor-specific OID documentation
For condensed AI/assistant guidance, see
.github/copilot-instructions.md
Auto-Update & Installer Repackaging Plan
This document captures the agreed strategy for server- and agent-driven updates, including manifest signing, installer …
Build & Release Workflow
Quick Start (Development) Windows PowerShell Quick Launch Use the helper script to test, build, and launch the agent: # From …
Deprecations and Removed Features
This document tracks features that have been removed or are pending removal, with rationale and migration notes. Removed Features …
Device Report Proxy Worker
This document describes the Cloudflare Worker that handles device diagnostic reports for PrintMaster. Overview The proxy worker …
End-to-End Tests
This directory contains integration/E2E tests that test agent and server components together. Running Tests # Run all E2E tests cd …
Epson Remote-Mode Integration Plan
This document captures the concrete steps required to land Epson remote-mode support in the agent while keeping the feature …
Git & GitHub Integration - Complete ✅
What Was Added 1. Automated Release Script (release.ps1) Location: c:\temp\printmaster\release.ps1 Usage: # Patch release (bug …
PrintMaster Test Coverage Analysis
Last Updated: December 27, 2025 This document provides a comprehensive analysis of test coverage across the PrintMaster codebase, …
PrintMaster TODO
Consolidated pending features and improvements from across the codebase. Current Version: Agent v0.23.6, Server v0.23.6 🔴 High …
PROJECT STRUCTURE
Project Structure (Overview) printmaster/ ├── agent/ # Agent service and embedded UI (Go) │ ├── main.go # Agent entrypoint │ ├── …
Range syntax and parsing rules
This file documents what the server accepts in the range editor textarea and how the ParseRangeText behavior works. Supported …
Security Architecture for Agent-Server Communication
Overview This document outlines the security architecture for when the PrintMaster agent communicates with a central server, …
SNMP Reference Guide
This document covers SNMP discovery, Printer-MIB OIDs, vendor detection, metrics collection, and meter history tracking in …
SNMP Research Notes
This file captures actionable takeaways from inspecting other open-source SNMP printer discovery/management tools so we can fold …
Testing and CI guidelines
This document describes how to write fast, deterministic tests for the PrintMaster agent and server. Test Types PrintMaster has …
USB Printer Support
Status: ✅ Implemented (Windows only) Summary USB printer support is implemented as an IPP-USB HTTP proxy, not the SNMP-over-USB …
Vendor-Specific OID Documentation
This directory contains vendor-specific SNMP OID mappings and analysis for printer manufacturers. Files EPSON_OID_MAPPING.md …
WebSocket HTTP Proxy Feature
Overview The PrintMaster system now supports proxying HTTP requests through the WebSocket connection between agents and the …