README Getting Started ends with a signed image request (closes #357) #363

Merged
clawbot merged 1 commits from issue-357-getting-started-image into next 2026-11-11 22:40:59 +01:00
Collaborator

closes #357

README Getting Started now takes a reader from a machine with only git to an image served by their own pixa:

  • the block runs script/bootstrap --cgo before make build;
  • a paragraph says logging in at http://localhost:8080/ needs debug: true (or PIXA_DEBUG=true in the container), and that otherwise the pages need HTTPS through a reverse proxy;
  • the section ends with a signed /v1/image/ request, made with openssl dgst -hmac ... | base64 | tr '+/' '-_', for an image on any public HTTPS server.

Not visible in the diff:

  • The docker run line now takes the key the reader generated instead of a fresh random one, since the request needs that key to sign.
  • The container-settings paragraph moved up, unchanged, so the section ends with the request.
  • Judgement call: the request uses cdn.example.com and /photos/cat.jpg as placeholders the reader replaces, since docs use invented data. Naming a real public image instead is a two-line change.

Model: opus-5-5

closes https://git.eeqj.de/sneak/pixa/issues/357 README Getting Started now takes a reader from a machine with only `git` to an image served by their own pixa: - the block runs `script/bootstrap --cgo` before `make build`; - a paragraph says logging in at `http://localhost:8080/` needs `debug: true` (or `PIXA_DEBUG=true` in the container), and that otherwise the pages need HTTPS through a reverse proxy; - the section ends with a signed `/v1/image/` request, made with `openssl dgst -hmac ... | base64 | tr '+/' '-_'`, for an image on any public HTTPS server. Not visible in the diff: - The `docker run` line now takes the key the reader generated instead of a fresh random one, since the request needs that key to sign. - The container-settings paragraph moved up, unchanged, so the section ends with the request. - Judgement call: the request uses `cdn.example.com` and `/photos/cat.jpg` as placeholders the reader replaces, since docs use invented data. Naming a real public image instead is a two-line change. Model: opus-5-5
clawbot self-assigned this 2026-11-11 21:30:48 +01:00
clawbot added the needs-review label 2026-11-11 21:30:54 +01:00
Author
Collaborator

Verdict: FAIL
Head: a16c1c93aa

  1. README.md, Getting Started, the curl -o cat.webp ... line and the sentence "cat.webp is then the image at 400x300.": when pixa refuses the request, curl still exits 0 and saves pixa's JSON error as cat.webp. A reader who leaves a placeholder in (the key or cdn.example.com) or mistypes the key sees no error, gets a cat.webp that is not an image, and reads that it is the image. That is the dead end this section is meant to remove. Acceptable: curl reports a refused request and exits non-zero (for example curl --fail-with-body -o cat.webp ...), and one short sentence says that cat.webp then holds pixa's error message.

Model: opus-5-5

Verdict: FAIL Head: a16c1c93aa356356b7942976a0c63d33f41ec18d 1. `README.md`, Getting Started, the `curl -o cat.webp ...` line and the sentence "`cat.webp` is then the image at 400x300.": when pixa refuses the request, curl still exits 0 and saves pixa's JSON error as `cat.webp`. A reader who leaves a placeholder in (the key or `cdn.example.com`) or mistypes the key sees no error, gets a `cat.webp` that is not an image, and reads that it is the image. That is the dead end this section is meant to remove. Acceptable: curl reports a refused request and exits non-zero (for example `curl --fail-with-body -o cat.webp ...`), and one short sentence says that `cat.webp` then holds pixa's error message. Model: opus-5-5
clawbot added 1 commit 2026-11-11 21:59:31 +01:00
Getting Started now runs script/bootstrap --cgo before make build, says
that logging in at http://localhost:8080/ needs debug, and ends with a
signed /v1/image/ request for an image on any public HTTPS server. Its
curl exits non-zero when pixa refuses the request.

Model: opus-5-5
clawbot force-pushed issue-357-getting-started-image from a16c1c93aa to 21b875e86c 2026-11-11 21:59:31 +01:00 Compare
Author
Collaborator
  1. Fixed in 21b875e, rebased onto next: the request uses curl --fail-with-body, so a refused request exits non-zero, and a new sentence says cat.webp then holds pixa's error message.

Model: opus-5-5

1. Fixed in `21b875e`, rebased onto `next`: the request uses `curl --fail-with-body`, so a refused request exits non-zero, and a new sentence says `cat.webp` then holds pixa's error message. Model: opus-5-5
Author
Collaborator

Verdict: PASS
Head: 21b875e86c

Getting Started now takes a reader from a clean machine with only git to an image served by their own pixa, as #357 asks.

Model: opus-5-5

Verdict: PASS Head: 21b875e86cf75a6c41d0b4afcee4b9007f776f81 Getting Started now takes a reader from a clean machine with only `git` to an image served by their own pixa, as https://git.eeqj.de/sneak/pixa/issues/357 asks. Model: opus-5-5
clawbot merged commit 9bccaaf85a into next 2026-11-11 22:40:59 +01:00
clawbot deleted branch issue-357-getting-started-image 2026-11-11 22:40:59 +01:00
Sign in to join this conversation.