ZShot's HTTP capture server: screenshots, PDFs, video, Markdown and web archives over an API.
10K+
ZShot renders web pages in Chromium and returns them as screenshots, PDFs, video, Markdown, accessibility trees, HAR files and web archives. This image runs its HTTP server on port 3000, configured from the environment, with a health check. zshot-cli.com documents it in full.
docker run --rm -p 3000:3000 \
-e ZSHOT_LICENSE="MY-ZSHOT-LICENSE-KEY" \
scaleassembly/zshot-server
Capture a page:
curl -X POST http://127.0.0.1:3000/ \
-H "Content-Type: application/json" \
-d '{"url":"https://zshot-cli.com/example_assets/hello_zshot/","output_type":"png"}' \
-o hello.png
The request schema lists every key a request takes, and Endpoints every route.
The server requires a license. Set ZSHOT_LICENSE, or mount a zshot.toml and pass --config; without either, the container exits at startup. A license activated from a key is released when the container stops, so allow time to shut down on SIGTERM.
| Variable | Sets |
|---|---|
ZSHOT_SERVER_PORT | Port to bind. Default 3000, or PORT when the platform injects it |
ZSHOT_SERVER_TOKEN_AUTH | Bearer token required on every request |
ZSHOT_SERVER_BASIC_AUTH | user:password required on every request |
ZSHOT_SERVER_MAX_CONCURRENCY | Maximum concurrent renders |
ZSHOT_SERVER_QUEUE_REQUESTS | Maximum requests queued for a free slot |
Environment lists every variable. Flags passed after the image name override environment variables. Front the server with an API gateway or reverse proxy when handling public traffic.
Chromium's sandbox needs a seccomp profile under Docker; without one, ZShot renders unsandboxed and prints a warning. Hardening covers the profile, recommended runtime settings, and a Compose file, and Kubernetes covers the manifests.
The image's HEALTHCHECK probes GET /status, which answers 200 once the server is ready and requires no authentication.
latest and each release, such as 0.55.0, for linux/amd64 and linux/arm64. Pin a release in production; see the changelog. Every image is signed with cosign; see Verify.
Content type
Image
Digest
sha256:49f5b7a65…
Size
379.1 MB
Last updated
3 days ago
docker pull scaleassembly/zshot-server