From bb914077cf130ab06a039fb3161a623313cb20a6 Mon Sep 17 00:00:00 2001 From: Roman Priesol Date: Sat, 12 Sep 2026 16:07:48 +0200 Subject: [PATCH] Add README --- README.adoc | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..d0c5d6c --- /dev/null +++ b/README.adoc @@ -0,0 +1,34 @@ += labelprint + +Unified UI for printing labels/stickers: + +* Native ZPL printing to a Datamax-ONeil thermal barcode printer +* A proxy/switcher in front of three https://github.com/DL6ER/brother_ql_web[brother_ql_web] instances, one per Brother QL printer + +== Routes + +* `/` -- upload a PDF and print it (ZPL) +* `/upload` -- upload form +* `/test-print` -- print the bundled test label +* `/brother` -- pick which Brother QL printer to proxy to +* `/brother/select` -- switch the active Brother QL printer + +== Running + +[source,shell] +---- +bundle install +bundle exec ruby app.rb +---- + +Requires `config.json` (see printer definitions inside) and a `.session_secret` file (random string, not committed). + +== Deployment + +Runs as `sinatra.service` (systemd) on `rpi-printserver.local`, under RVM (`rvm default do bundle exec ruby app.rb` -- always uses whatever ruby is currently the RVM default, no manual bumping needed). + +`.gitea/workflows/deploy.yaml` deploys on every push to `main`: SSH into `rpi-printserver.local`, `git pull`, `bundle install`, restart the service. + +== Dependency updates + +`.gitea/workflows/renovate.yaml` runs Renovate on a schedule (Monday 06:00 Europe/Bratislava, or manually) to open PRs for outdated gems and GitHub Actions. See the "Dependency Dashboard" issue for current status.