README Getting Started ends at a server a newcomer cannot get an image from #357

Closed
opened 2026-11-11 21:13:26 +01:00 by clawbot · 1 comment
Collaborator

Found in the hands-on acceptance test of next (092176d), #356. Docs only.

Steps

Follow README.md Getting Started literally, on a clean Debian 13 machine with only git.

What happened

  • The block's make build fails: nothing has installed Go, libvips or libheif. The block never runs script/bootstrap --cgo; only the paragraph under it names that script. With script/bootstrap --cgo first, make build works.
  • After ./bin/pixad --config config.yml, opening http://localhost:8080/ and logging in answers 403 Forbidden - origin invalid. The example config has debug: false, and pixa then refuses any form from a page opened over plain HTTP. README Routes says so; Getting Started does not.
  • The section never shows a request that returns an image. The example config allowlists no host, so every /v1/image/ URL needs a signature, and the reader has not yet been shown how to make one. The generator page is out of reach for the reason above.

What should happen

A reader who runs the Getting Started commands in order, starting from a machine with only git, sees an image served by their own pixa:

  • the block runs script/bootstrap --cgo before make build;
  • it says that debug: true makes the login page work at http://localhost:8080/ on the reader's own machine, and that otherwise the pages need HTTPS through a reverse proxy (see Deployment);
  • it ends with one request that returns an image of any public HTTPS host: a signed URL made with a short openssl dgst -sha256 -hmac ... -binary | base64 | tr '+/' '-_' command, built as under Signed URLs. Not by allowlisting a public host: #249 removed those from the example config.

Model: opus-5-5

Found in the hands-on acceptance test of `next` (`092176d`), https://git.eeqj.de/sneak/pixa/issues/356. Docs only. ## Steps Follow `README.md` Getting Started literally, on a clean Debian 13 machine with only `git`. ## What happened - The block's `make build` fails: nothing has installed Go, libvips or libheif. The block never runs `script/bootstrap --cgo`; only the paragraph under it names that script. With `script/bootstrap --cgo` first, `make build` works. - After `./bin/pixad --config config.yml`, opening `http://localhost:8080/` and logging in answers 403 `Forbidden - origin invalid`. The example config has `debug: false`, and pixa then refuses any form from a page opened over plain HTTP. README Routes says so; Getting Started does not. - The section never shows a request that returns an image. The example config allowlists no host, so every `/v1/image/` URL needs a signature, and the reader has not yet been shown how to make one. The generator page is out of reach for the reason above. ## What should happen A reader who runs the Getting Started commands in order, starting from a machine with only `git`, sees an image served by their own pixa: - the block runs `script/bootstrap --cgo` before `make build`; - it says that `debug: true` makes the login page work at `http://localhost:8080/` on the reader's own machine, and that otherwise the pages need HTTPS through a reverse proxy (see Deployment); - it ends with one request that returns an image of any public HTTPS host: a signed URL made with a short `openssl dgst -sha256 -hmac ... -binary | base64 | tr '+/' '-_'` command, built as under Signed URLs. Not by allowlisting a public host: https://git.eeqj.de/sneak/pixa/issues/249 removed those from the example config. Model: opus-5-5
Author
Collaborator

PR: #363 (branch issue-357-getting-started-image).

Getting Started now runs script/bootstrap --cgo before make build, says logging in at http://localhost:8080/ needs debug: true, and ends with a signed request for an image on any public HTTPS server.

Judgement call: the request names cdn.example.com and /photos/cat.jpg as placeholders the reader replaces, since docs use invented data.

Model: opus-5-5

PR: https://git.eeqj.de/sneak/pixa/pulls/363 (branch `issue-357-getting-started-image`). Getting Started now runs `script/bootstrap --cgo` before `make build`, says logging in at `http://localhost:8080/` needs `debug: true`, and ends with a signed request for an image on any public HTTPS server. Judgement call: the request names `cdn.example.com` and `/photos/cat.jpg` as placeholders the reader replaces, since docs use invented data. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/pixa#357