Docs · Architecture · Printers & cameras · Hardware · Deployment · API & MCP · Plugins · Troubleshooting
Start at the README to install PrintGuard. These pages cover everything after that.
| Page | Read it when you want to |
|---|---|
| Printers & cameras | Connect OctoPrint, Klipper, Elegoo, Prusa or Bambu Lab, add cameras, and set up alert channels |
| Hardware | Pick an image variant, understand the model runtimes, and use a GPU or NPU |
| Deployment | Reach a hub from outside your LAN without exposing it, and harden what you run |
| Troubleshooting | Fix a symptom like a dead feed, a failing printer test or a port already in use |
| API & MCP | Drive the hub from a script or an agent, with scoped access tokens |
| Plugins | Install an extension, understand what it can reach, or write one |
| Architecture | Understand how one engine runs in two places, or change the code |
| Contributing | Set up a dev environment, run the tests, add an integration or notifier |
- Hub mode is PrintGuard running as a server, either the Docker container or the desktop app. Local mode is the same engine running inside a browser tab with no server at all. Architecture explains why they cannot drift apart.
- A camera is a video source and a printer is a connection to a print service. A monitor binds one of each, the printer optionally, and carries the detection thresholds.
- Commands shown as
docker runassume the standard image. Compose users can apply the same options indocker-compose.yaml.