printservant/README.md

40 lines
898 B
Markdown
Raw Normal View History

2024-01-31 19:03:18 +00:00
# Printservant
2024-01-31 20:23:01 +00:00
HTTP to IPP proxy, a.k.a. HSWAW Rube Goldberg printing microservice.
2024-01-31 19:03:18 +00:00
## Usage
2024-02-01 14:38:03 +00:00
`GET /` to see available API routes
2024-01-31 19:03:18 +00:00
2024-02-01 14:38:03 +00:00
## Quick start
2024-01-31 19:03:18 +00:00
2024-02-01 14:38:03 +00:00
Configuration available:
2024-01-31 19:03:18 +00:00
2024-02-01 14:38:03 +00:00
```
PRINTSERVANT_PORT - Port (default: 3199)
PRINTSERVANT_CONFIG - JSON config, like so:
{
printers: [
{
name: 'DYMO_LabelWriter450',
aliases: ['dymo', 'label'],
ipp_url: 'ipp://$SECRET@printmaster.waw.hackerspace.pl/printers/DYMO_LabelWriter450',
},
...
]
}
PRINTSERVANT_SECRET - Optional, used to substitute $SECRET in printer configs' ipp_urls
2024-01-31 19:03:18 +00:00
```
```
2024-02-01 14:38:03 +00:00
PRINTSERVANT_CONFIG='{"printers":[{"name":"DYMO_LabelWriter450","aliases":["dymo"],"ipp_url":"ipp://printmaster.local:631/printers/DYMO_LabelWriter450"}]}' node index.js
2024-01-31 19:03:18 +00:00
```
2024-01-31 19:14:14 +00:00
or:
```
docker build -t printservant .
2024-02-01 14:38:03 +00:00
docker run --env PRINTSERVANT_CONFIG='... put config here ...' -it -p 3199:3199 printservant
2024-01-31 19:14:14 +00:00
```