https://github.com/nevermendel/chrome-headless-screenshots
Node.js script and Docker image to take screenshots of webpages with Chrome headless and Puppeteer
https://github.com/nevermendel/chrome-headless-screenshots
chrome chrome-headless chromium docker headless-chrome nodejs puppeteer screenshot
Last synced: 22 days ago
JSON representation
Node.js script and Docker image to take screenshots of webpages with Chrome headless and Puppeteer
- Host: GitHub
- URL: https://github.com/nevermendel/chrome-headless-screenshots
- Owner: NeverMendel
- License: mit
- Created: 2021-08-18T21:16:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-01T16:15:31.000Z (4 months ago)
- Last Synced: 2025-01-01T17:22:28.892Z (4 months ago)
- Topics: chrome, chrome-headless, chromium, docker, headless-chrome, nodejs, puppeteer, screenshot
- Language: JavaScript
- Homepage:
- Size: 2.15 MB
- Stars: 15
- Watchers: 2
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Chrome Headless Screenshots
Node.js script and Docker image to take screenshots of webpages with Chrome headless and [Puppeteer](https://github.com/puppeteer/puppeteer).
If you find chrome-headless-screenshots helpful, please consider giving it a star ⭐️. Your support helps me gauge its usage and motivates further development.
Pull requests are welcome.
## How to use it
### Node.js
Run `yarn install` to install all the required dependencies and then execute the index.js file with node like in the following example.
```
node index.js https://github.com
```
### Docker
You can either build your own Docker image or you can use the pre-built one `nevermendel/chrome-headless-screenshots` or `ghcr.io/nevermendel/docker-texlive-xetex`
Build the Docker image:
```
docker build -t chrome-headless-screenshots .
```
To take a screenshot with a Docker container run:
```
docker run -it -v $(pwd):/usr/src/app/out --rm nevermendel/chrome-headless-screenshots https://github.com
```
To use the image iteratively, change the entry point to /bin/sh:
```
docker run -it --entrypoint=/bin/sh -v $(pwd):/usr/src/app/out --rm nevermendel/chrome-headless-screenshots
```
When using the image iteratively you can run `take-screenshot.sh` from anywhere to call the `index.js` script.
## Script usage
```
index.js [options]
Take a screenshot of a webpage
Positionals:
url Url of the webpage you want to take a screenshot of [string]
Options:
-h, --help Show help [boolean]
-v, --version Show version number [boolean]
--width Viewport width [number] [default: 1920]
--height Viewport height [number] [default: 1080]
--outputDir Output directory, defaults to current directory [string] [default: "."]
--filename Filename of the produced screenshot [string] [default: "screenshot"]
--inputDir Input directory, defaults to current directory [string] [default: "."]
--userAgent User agent [string] [default: ""]
--cookies Cookies in json format as string [string] [default: ""]
--cookiesFile Path of the file containing the cookies [string] [default: ""]
--delay Delay before taking the screenshot in ms [number] [default: 0]
--format Image format of the screenshot
[string] [choices: "png", "jpeg", "webp"] [default: "png"]
Examples:
index.js https://github.com Take a screenshot of https://github.com and save
it as screenshot.png
index.js --cookiesFile=cookies.json https://google.com Load the cookies from cookies.json, take a
screenshot of https://google.com and save it as
screenshot.png
```
## License
[MIT Licence](LICENSE.md)