JodaPrint documentation
JodaPrint lets any web or server application print silently to local printers: receipt printers, label printers and office printers, on Windows, macOS, Linux and Android.
Two ways to print:
| Mode | Path | Works |
|---|---|---|
| Local | Browser → @jodaprint/sdk → the agent on the same computer (wss://localhost:8182) | Without internet, with no server round trip |
| Cloud | Your server → REST API or @jodaprint/node → JodaPrint cloud → the agent | From any backend, behind any NAT: the agent keeps an outbound connection open |
The agent is a small service installed on each computer or Android device that has printers. It discovers the printers (USB, network, serial, Bluetooth, the OS spooler, built-in printers on Android POS devices), keeps a persistent job queue, and turns receipts described as JSON into printer commands.
The dashboard is where businesses activate devices and see printers and jobs, and where developers create API keys, signing keys and webhooks.
Start here
- Install the agent on the computer with the printer.
- Activate it with a code from the dashboard.
- Print your first receipt from a web page or from your server.
- Develop without a printer with the sandbox.
Find your way
- Guides explain receipts, labels, PDFs, printer brands, deployment to many computers, Android, webhooks and security.
- Reference lists every REST endpoint, error code, config setting and webhook event, and the API of both SDKs.
- Troubleshooting covers certificate warnings, offline printers, accents and ports.