Description

Features

Usage

http(s)://domain_or_ip:port(/resource)domain_or_ip:port(/resource)domain_or_ip(/resource)

Options

webscreenshot.py version 2.94usage: webscreenshot.py [-h] [-i INPUT_FILE] [-o OUTPUT_DIRECTORY] [-w WORKERS] [-v] [--no-error-file] [-z SINGLE_OUTPUT_FILE] [-p PORT] [-s] [-m]                        [-r {phantomjs,chrome,chromium,edgechromium,firefox}] [--renderer-binary RENDERER_BINARY] [--no-xserver] [--window-size WINDOW_SIZE]                        [-f {pdf,png,jpg,jpeg,bmp,ppm}] [-q [0-100]] [--ajax-max-timeouts AJAX_MAX_TIMEOUTS] [--crop CROP] [--custom-js CUSTOM_JS] [-l]                        [--label-size LABEL_SIZE] [--label-bg-color LABEL_BG_COLOR] [--imagemagick-binary IMAGEMAGICK_BINARY] [-c COOKIE] [-a HEADER]                        [-u HTTP_USERNAME] [-b HTTP_PASSWORD] [-P PROXY] [-A PROXY_AUTH] [-T PROXY_TYPE] [-t TIMEOUT]                        [URL]optional arguments:  -h, --help            show this help message and exitMain parameters:  URL                   Single URL target given as a positional argument  -i INPUT_FILE, --input-file INPUT_FILE                        <INPUT_FILE> text file containing the target list. Ex: list.txt  -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY                        <OUTPUT_DIRECTORY> (optional): screenshots output directory (default './screenshots/')  -w WORKERS, --workers WORKERS                        <WORKERS> (optional): number of parallel execution workers (default 4)  -v, --verbosity       <VERBOSITY> (optional): verbosity level, repeat it to increase the level { -v INFO, -vv DEBUG } (default verbosity ERROR)  --no-error-file       <NO_ERROR_FILE> (optional): do not write a file with the list of URL of failed screenshots (default false)  -z SINGLE_OUTPUT_FILE, --single-output-file SINGLE_OUTPUT_FILE                        <SINGLE_OUTPUT_FILE> (optional): name of a file which will be the single output of all inputs. Ex. test.pngInput processing parameters:  -p PORT, --port PORT  <PORT> (optional): use the specified port for each target in the input list. Ex: -p 80  -s, --ssl             <SSL> (optional): enforce SSL/TLS for every connection  -m, --multiprotocol   <MULTIPROTOCOL> (optional): perform screenshots over HTTP and HTTPS for each targetScreenshot renderer parameters:  -r {phantomjs,chrome,chromium,edgechromium,firefox}, --renderer {phantomjs,chrome,chromium,edgechromium,firefox}                        <RENDERER> (optional): renderer to use among 'phantomjs' (legacy but best results), 'chrome', 'chromium', 'edgechromium', 'firefox'                        (version > 57) (default 'phantomjs')  --renderer-binary RENDERER_BINARY                        <RENDERER_BINARY> (optional): path to the renderer executable if it cannot be found in $PATH  --no-xserver          <NO_X_SERVER> (optional): if you are running without an X server, will use xvfb-run to execute the renderer (by default, trying to                        detect if DISPLAY environment variable existsScreenshot image parameters:  --window-size WINDOW_SIZE                        <WINDOW_SIZE> (optional): width and height of the screen capture (default '1200,800')  -f {pdf,png,jpg,jpeg,bmp,ppm}, --format {pdf,png,jpg,jpeg,bmp,ppm}                        <FORMAT> (optional, phantomjs only): specify an output image file format, "pdf", "png", "jpg", "jpeg", "bmp" or "ppm" (default                        'png')  -q [0-100], --quality [0-100]                        <QUALITY> (optional, phantomjs only): specify the output image quality, an integer between 0 and 100 (default 75)  --ajax-max-timeouts AJAX_MAX_TIMEOUTS                        <AJAX_MAX_TIMEOUTS> (optional, phantomjs only): per AJAX request, and max URL timeout in milliseconds (default '1400,1800')  --crop CROP           <CROP> (optional, phantomjs only): rectangle <t,l,w,h> to crop the screen capture to (default to WINDOW_SIZE: '0,0,w,h'), only                        numbers, w(idth) and h(eight). Ex. "10,20,w,h"  --custom-js CUSTOM_JS                        <CUSTOM_JS> (optional, phantomjs only): path of a file containing JavaScript code to be executed before taking the screenshot. Ex:                        js.txtScreenshot label parameters:  -l, --label           <LABEL> (optional): for each screenshot, create another one displaying inside the target URL (requires imagemagick)  --label-size LABEL_SIZE                        <LABEL_SIZE> (optional): font size for the label (default 60)  --label-bg-color LABEL_BG_COLOR                        <LABEL_BACKGROUND_COLOR> (optional): label imagemagick background color (default NavajoWhite)  --imagemagick-binary IMAGEMAGICK_BINARY                        <LABEL_BINARY> (optional): path to the imagemagick binary (magick or convert) if it cannot be found in $PATHHTTP parameters:  -c COOKIE, --cookie COOKIE                        <COOKIE_STRING> (optional): cookie string to add. Ex: -c "JSESSIONID=1234; YOLO=SWAG"  -a HEADER, --header HEADER                        <HEADER> (optional): custom or additional header. Repeat this option for every header. Ex: -a "Host: localhost" -a "Foo: bar"  -u HTTP_USERNAME, --http-username HTTP_USERNAME                        <HTTP_USERNAME> (optional): specify a username for HTTP Basic Authentication.  -b HTTP_PASSWORD, --http-password HTTP_PASSWORD                        <HTTP_PASSWORD> (optional): specify a password for HTTP Basic Authentication.Connection parameters:  -P PROXY, --proxy PROXY                        <PROXY> (optional): specify a proxy. Ex: -P http://proxy.company.com:8080  -A PROXY_AUTH, --proxy-auth PROXY_AUTH                        <PROXY_AUTH> (optional): provides authentication information for the proxy. Ex: -A user:password  -T PROXY_TYPE, --proxy-type PROXY_TYPE                        <PROXY_TYPE> (optional): specifies the proxy type, "http" (default), "none" (disable completely), or "socks5". Ex: -T socks  -t TIMEOUT, --timeout TIMEOUT                        <TIMEOUT> (optional): renderer execution timeout in seconds (default 30 sec)

Examples

list.txt--------http://google.frhttps://216.58.213.131216.58.213.131https://duckduckgo.com/robots.txtDefault execution with a list-----------------------------$ python webscreenshot.py -i list.txtwebscreenshot.py version 2.3[+] 4 URLs to be screenshot[+] 4 actual URLs screenshot[+] 0 error(s)Default execution with a single URL-----------------------------------$ python webscreenshot.py -v google.frwebscreenshot.py version 2.3[INFO][General] 'google.fr' has been formatted as 'http://google.fr:80' with supplied overriding options[+] 1 URLs to be screenshot[INFO][http://google.fr:80] Screenshot OK[+] 1 actual URLs screenshot[+] 0 error(s)Increasing verbosity level execution-----------------------------------$ python webscreenshot.py -i list.txt -vwebscreenshot.py version 2.3[INFO][General] 'http://google.fr' has been formatted as 'http://google.fr:80' with supplied overriding options[INFO][General] 'https://216.58.213.131' has been formatted as 'https://216.58.213.131:443' with supplied overriding options[INFO][General] '216.58.213.131' has been formatted as 'http://216.58.213.131:80' with supplied overriding options[INFO][General] 'https://duckduckgo.com/robots.txt' has been formatted as 'https://duckduckgo.com:443/robots.txt' with supplied overriding options[+] 4 URLs to be screenshot[INFO][https://duckduckgo.com:443/robots.txt] Screenshot OK[INFO][http://216.58.213.131:80] Screenshot OK[INFO][https://216.58.213.131:443] Screenshot OK[INFO][http://google.fr:80] Screenshot OK[+] 4 actual URLs screenshot[+] 0 error(s)Results-------$ ls -l screenshots/total 187-rwxrwxrwx 1 root root 53805 May 19 16:04 http_216.58.213.131_80.png-rwxrwxrwx 1 root root 53805 May 19 16:05 http_google.fr_80.png-rwxrwxrwx 1 root root 53805 May 19 16:04 https_216.58.213.131_443.png-rwxrwxrwx 1 root root 27864 May 19 16:04 https_duckduckgo.com_443_robots.txt.png

Supported options by renderers

Requirements

Changelog

Copyright and license

Contact