zshot/cli
⌘K
Download

Environment

Both images read these variables. A flag after the image name overrides the variable that sets it.

VariableImageSets
ZSHOT_LICENSEBothThe license key, as --license-key
ZSHOT_NAVIGATOR_CREDENTIAL_SECRETBoth--navigator-credential-secret
ZSHOT_SERVER_PORTzshot-server--server-bind-port, which the health check follows. Default 3000
PORTzshot-serverThe port when ZSHOT_SERVER_PORT is unset, as Railway, Render and Heroku inject it
ZSHOT_SERVER_BIND_ADDRESSzshot-server--server-bind-address. Default 0.0.0.0
ZSHOT_SERVER_TOKEN_AUTHzshot-server--server-token-auth
ZSHOT_SERVER_BASIC_AUTHzshot-server--server-basic-auth, as user:password
ZSHOT_SERVER_SIGNED_URLzshot-server--server-signed-url, as hmac-sha256:<secret>
ZSHOT_SERVER_SIGNED_URL_MAX_AGEzshot-server--server-signed-url-max-age
ZSHOT_SERVER_MAX_CONCURRENCYzshot-server--server-max-concurrency, which also sizes the container’s memory
ZSHOT_SERVER_QUEUE_REQUESTSzshot-server--server-queue-requests

Example

Serve on port 8080 with a bearer token:

docker run --rm -p 8080:8080 \
  -e ZSHOT_LICENSE="MY-ZSHOT-LICENSE-KEY" \
  -e ZSHOT_SERVER_PORT=8080 \
  -e ZSHOT_SERVER_TOKEN_AUTH="MY-TOKEN" \
  scaleassembly/zshot-server