killia/screenshoter

By killia

•Updated over 3 years ago

This image allows to screenshot any webpage without popups

Image

170

Overview Tags

killia/screenshoter repository overview

⁠screenshoter

Google Puppeteer⁠ as a Dockerized HTTP-service for making screenshots.

⁠installation

docker pull killia/screenshoter

⁠build

docker build -t killia/screenshoter:1.4.0 .

⁠publish

docker push killia/screenshoter:1.4.0

⁠Features

This project was forked from mingalevme/screenshoter⁠. Additionally to the great features of this project, I added a Popup Blocker to discard undesired popups when you access any webpage.

⁠Usage

⁠Basic usage

docker run -d --restart always -p 8080:8080 --name screenshoter killia/screenshoter

... or while development:

via docker

docker build -t screenshoter-dev .
docker run --rm -p 8080:8080 --name screenshoter-dev screenshoter --metrics --metrics-collect-default

via nodejs

npm install
node app.js --host 127.0.0.1 --port 8080

Then navigate to url

curl "http://localhost:8080/take?url=https%3A%2F%2Fhub.docker.com%2Fr%2Fkillia%2Fscreenshoter%2F" > /tmp/screenshot.png

Or capture screenshot without popups

curl "http://localhost:8080/take?popup-block=true&delay=30000&url=https://www.bershka.com/it/" > /tmp/screenshot.png

⁠Puppeteer arguments

CLI arg	EnvVar	Default	Comment
--puppeteer--proxy-server	PROXY_SERVER		Initializes proxy-server argument for Puppeteer

⁠Logging

CLI arg	EnvVar	Default	Comment
--logger-channel	SCREENSHOTER_LOGGER_CHANNEL	console	Console (StdOut/StdErr)
--logger-level	SCREENSHOTER_LOGGER_LEVEL	debug	Global default log level (debug, info, notice, warning, error, critical, alert, emergency)
--logger-console-level	SCREENSHOTER_LOGGER_CONSOLE_LEVEL		Console logger level

⁠Cache

CLI arg	EnvVar	Default	Comment
--cache-driver	SCREENSHOTER_CACHE_DRIVER		Cache driver (available: null, s3, filesystem)

⁠S3

CLI arg	EnvVar	Default	Comment
--cache-s3-endpoint-url	SCREENSHOTER_CACHE_S3_ENDPOINT_URL	https://s3.amazonaws.com⁠	s3 endpoint url
--cache-s3-region	SCREENSHOTER_CACHE_S3_REGION	us-east-1	s3 region
--cache-s3-access-key-id	SCREENSHOTER_CACHE_S3_ACCESS_KEY_ID		S3 access key id
--cache-s3-secret-access-key	SCREENSHOTER_CACHE_S3_SECRET_ACCESS_KEY		S3 secret access key
--cache-s3-bucket	SCREENSHOTER_CACHE_S3_BUCKET		S3 bucket
--cache-s3-force-path-style	SCREENSHOTER_CACHE_S3_FORCE_PATH_STYLE	0	Use path-style

⁠FileSystem

CLI arg	EnvVar	Default	Comment
--cache-file-system-base-dir	SCREENSHOTER_CACHE_FILE_SYSTEM_BASE_DIR	$TMP/screenshoter	Base dir
--cache-file-system-mode	SCREENSHOTER_CACHE_FILE_SYSTEM_MODE	0o666	File creation mode

⁠Prometheus metrics

To enable export Prometheus metrics (https://www.npmjs.com/package/express-prom-bundle⁠) add --metrics arg or set SCREENSHOTER_METRICS env var.

CLI arg	EnvVar	Default	Comment
--metrics	SCREENSHOTER_METRICS		Enable metrics export
--metrics-collect-default	SCREENSHOTER_METRICS_COLLECT_DEFAULT		Export default Prometheus NodeJS metrics
--metrics-buckets	SCREENSHOTER_METRICS_BUCKETS	0.1,0.5,1,3,5,10,20	"http_request_duration_seconds" buckets

Example:

docker run -d --restart always -p 8080:8080 --name screenshoter killia/screenshoter --metrics --metrics-collect-default --metrics-buckets "1,3,5,10,20,30,60"

Metrics are available on /metrics-path.

⁠Secure Link

You can restrict access to the service via link signing (https://www.npmjs.com/package/@killia/secure-link⁠). To enable the restriction run the service with secure-link-secret arg or SCREENSHOTER_SECURE_LINK_SECRET env var, that is you private key to sign/validate links.

CLI arg	EnvVar	Default	Comment
--secure-link-secret	SCREENSHOTER_SECURE_LINK_SECRET		Secret key
--secure-link-hasher	SCREENSHOTER_SECURE_LINK_HASHER	md5	Hasher, md5/sha1
--secure-link-signature-arg	SCREENSHOTER_SECURE_SIGNATURE_ARG	signature	signature query param name
--secure-link-expires-arg	SCREENSHOTER_SECURE_EXPIRES_ARG	expires	expiration query param name

Example:

docker run -d --restart always -p 8080:8080 --name screenshoter -e "SCREENSHOTER_SECURE_LINK_SECRET=secret" killia/screenshoter --secure-link-hasher sha1 --secure-link-signature-arg _sig --secure-link-expires-arg _expires --secure-link-secret "secret"

NOTE the example uses both env var and arg for setting a secret, any one is enough.

⁠API Reference

GET /take

⁠Arguments

Arg	Type	Required	Description
url	string	true	Absolute URL of the page to screenshot. Example: 'https://www.google.com⁠'
format	string	false	Image file format. Supported types are png or jpeg. Defaults to png.
quality	int	false	The quality of the image, between 1-100. Not applicable to png images.
full	int	false	When true, takes a screenshot of the full scrollable page. Defaults to false.
device	string	false	One of supported device, e.g. iPhone X, see https://github.com/puppeteer/puppeteer/blob/main/src/common/DeviceDescriptors.ts⁠ for a full list of devices
viewport-width	int	false	Width in pixels of the viewport when taking the screenshot. Using lower values like 460 can help emulate what the page looks like on mobile devices. Defaults to 800.
viewport-height	int	false	Height in pixels of the viewport when taking the screenshot. Defaults to 600.
is-mobile	bool (int)	false	Whether the meta viewport tag is taken into account. Defaults to false.
has-touch	bool (int)	false	Specifies if viewport supports touch events. Defaults to false.
is-landscape	bool (int)	false	Specifies if viewport is in landscape mode. Defaults to false.
device-scale-factor	int	false	Sets device scale factor (basically dpr) to emulate high-res/retina displays. Number from 1 to 4. Defaults to 1.
user-agent	string	false	Sets user agent
cookies	json	false	List with cookies objects (https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagesetcookiecookies⁠), e.g. [{"name":"foo","value":"bar","domain":".example.com"}]
timeout	int	false	Maximum navigation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout.
fail-on-timeout	bool (int)	false	If set to false, we will take a screenshot when timeout is reached instead of failing the request. Defaults to false.
popup-blocker	bool (int)	false	If set to true, we will disable any popup existing on the webpage. Defaults to false.
delay	int	false	If set, we'll wait for the specified number of seconds after the page load event before taking a screenshot.
wait-until-event	string	false	Controls when the screenshot is taken as the page loads. Supported events include: load - window load event fired (default); domcontentloaded - DOMContentLoaded event fired; networkidle0 - wait until there are zero network connections for at least 500ms; networkidle2 - wait until there are no more than 2 network connections for at least 500ms. domcontentloaded is the fastest but riskiest option–many images and other asynchronous resources may not have loaded yet. networkidle0 is the safest but slowest option. load is a nice middle ground.Defaults to load.
element	string	false	Query selector of element to screenshot.
transparency	bool (int)	false	Hides default white webpage background for capturing screenshots with transparency, only works when `format` is `png`. Defaults to 0.
scroll-page-to-bottom	bool (int)	false	(thx https://github.com/Kiuber⁠) Scroll the page to the bottom (https://www.npmjs.com/package/puppeteer-autoscroll-down⁠).
scroll-page-to-bottom-size	int	false	(scroll-page-to-bottom) Number of pixels to scroll on each step (default: 250).
scroll-page-to-bottom-delay-ms	int	false	(scroll-page-to-bottom) Delay in ms after each completed scroll step (default: 100).
scroll-page-to-bottom-steps-limit	int	false	(scroll-page-to-bottom) Max number of steps to scroll.
width	int	false	If resulted image's width is greater than provided value then image will be proportionally resized to provided width. This action runs before max-height checking. Defaults to 0 (do not resize).
max-height	int	false	If resulted image's height is greater than provided value then image's height will be cropped to provided value. Defaults to 0 (do not crop).
ttl	int	false	If last cached screenshot was made less than provided seconds then the cached image will be returned otherwise image will be cached for future use.

Tag summary

Recent tags

Content type

Image

Digest

sha256:120a8f6d8…

Size

411 MB

Last updated

over 3 years ago

docker pull killia/screenshoter:1.4.2