Repository files navigation

Capture screenshots of websites as a (host it yourself) API. This project is awrapper around this library:https://github.com/sindresorhus/capture-website

1. Pull the image:

docker pull robvanderleek/capture-website-api

2. Start the container:

docker run -it -p 8080:8080 robvanderleek/capture-website-api

3. Make screenshot test request:

curl 'localhost:8080/capture?url=https://news.ycombinator.com/' -o screenshot.png

1. Clone the repo:

git clone git@github.com:robvanderleek/capture-website-api.git

2. Go to thestandalone directory:

cd capture-website-api/standalone

3. Build the image:

docker build -t cwa.

4. Start the container:

docker run -it -p 8080:8080 cwa

5. Do screenshot test request:

curl'localhost:8080/capture?url=https://www.youtube.com' -o screenshot.png

Run in a terminal:

1. Clone the repo:

git clone git@github.com:robvanderleek/capture-website-api.git

2. Go to thestandalone directory:

cd capture-website-api/standalone

3. Install dependencies:

yarn

4. Start the server:

yarn start

5. Do screenshot test request:

curl'localhost:8080/capture?url=https://www.reddit.com' -o screenshot.png

Deploy and run on Vercel:

1. Clone the repo:

git clone git@github.com:robvanderleek/capture-website-api.git && cd capture-website-api/serverless

2. Deploy to Vercel:

vercel deploy

3. Get site URL:

vercel ls

7. Make screenshot test request:

curl "${SITE_URL}/api/capture?url=https://www.linkedin.com" -o screenshot.png

Call the/capture endpoint and pass the site URL using the query parametersurl:

curl'https://capture-website-api.vercel.app/api/capture?url=http://gmail.com' -o screenshot.png

Simple as that.

Application configuration options can be set as environment veriables or ina.env file in the root folder. There's an example.env file in the codebase:.env.example

Supported options are:

Most of the configuration options from the wrappedcapture-website library are supported using query parameters.For example, to capture a site with a 650x350 viewport, no default background and animations disabled use:

curl 'https://capture-website-api.vercel.app/api/capture?url=http://amazon.com&width=650&height=350&scaleFactor=1&defaultBackground=false&disableAnimations=true&wait_before_screenshot_ms=300' -o screenshot.png

Seehttps://github.com/sindresorhus/capture-website for a full list of options.

You may require to wait for async requests or animations to finish before capturing the screenshot. There are two ways of doing this, both specified in the query parameters:

1. wait_before_screenshot_ms (in ms, defaults to300) will wait before capturing a screenshot.
2. For standalone:capture-website library'sdelay (in seconds)

Sometimes thecapture-website library has problems capturing sites. You cantry to capture these sites with plain Puppeteer by supplying the queryparameterplainPuppeteer=true

This app looks at two environment variables:

• SHOW_RESULTS: iftrue the latest capture result can be viewed in thebrowser by browsing the base url
• SECRET: when set all capture requests need to contain a query parametersecret whose value matches the value of this environment variable

To run the serverless version locally, executevercel dev in the root folderof the repository.

If you have suggestions for improvements, or want to report a bug,open anissue!

ISC © 2019 Rob van der Leekrobvanderleek@gmail.com(https://twitter.com/robvanderleek)