Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robvanderleek/capture-website-api

Capture screenshots of websites as a (host it yourself) API 📸
https://github.com/robvanderleek/capture-website-api

docker heroku rest-api screenshot website-screenshot-capturer

Last synced: 1 day ago
JSON representation

Capture screenshots of websites as a (host it yourself) API 📸

Awesome Lists containing this project

README 

        
# Capture website API






[![Logo](static/logo_256x256.png)](https://www.freepik.com/icon/capture_6276243)









![Screenshot](static/screenshot.png)









[![Build Status](https://github.com/robvanderleek/capture-website-api/workflows/CICD/badge.svg)](https://github.com/robvanderleek/capture-website-api/actions)

[![Maintainability](https://api.codeclimate.com/v1/badges/20056816e22527745a74/maintainability)](https://codeclimate.com/github/robvanderleek/capture-website-api/maintainability)

[![Dependabot](https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot)](https://dependabot.com/)

[![DockerHub image pulls](https://img.shields.io/docker/pulls/robvanderleek/capture-website-api)](https://hub.docker.com/repository/docker/robvanderleek/capture-website-api)

![Vercel](https://vercelbadge.vercel.app/api/robvanderleek/capture-website-api)






Capture screenshots of websites as a (host it yourself) API.

This project is a wrapper around this library: https://github.com/sindresorhus/capture-website



# Installation



## Docker



### Run pre-built container from Docker Hub



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

``` 



### Build the docker image and run it



1. Clone the repo:

```

git clone [email protected]:robvanderleek/capture-website-api.git && cd capture-website-api/standalone

```



2. Build the image:

```

docker build -t cwa .

```



3. Start the container: 

```

docker run -it -p 8080:8080 cwa

```



4. Make screenshot test request:

```

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

```



## Yarn



Run in a terminal:



1. Clone the repo:

```

git clone [email protected]:robvanderleek/capture-website-api.git && cd capture-website-api/standalone

```



2. Install dependencies:

```

yarn

```



3. Start the server:

```

yarn start

```



4. Make screenshot test request:

```

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

```



## Vercel



Deploy and run on Vercel:



1. Clone the repo:

```

git clone [email protected]:robvanderleek/capture-website-api.git && cd capture-website-api/serverless

```



2. Deploy to Vercel:

```shell

vercel deploy

```



3. Get site URL:

```shell

vercel ls 

```



7. Make screenshot test request:

```

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

```



# Usage



Call the `/capture` endpoint and pass the site URL using the query parameters `url`:

```shell

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

```

Simple as that.



# Configuration



## Application options



Application configuration options can be set as environment veriables or in 

a `.env` file in the root folder. There's an example `.env` file in the codebase: [`.env.example`](https://github.com/robvanderleek/capture-website-api/blob/main/.env.example)



Supported options are:



| Name | Descrition | Default |

|---|---|---|

| TIMEOUT | Timeout in seconds for loading a web page | 20 |

| CONCURRENCY | Number of captures that run in parallel, more memory allows more captures to run in parallel | 2 |

| MAX_QUEUE_LENGTH | Requests that can't be handled directly are queued until the queue is full | 6 |

| SHOW_RESULTS | Enable web endpoint to show latest capture | false |

| SECRET | Secret string to prevent undesired usage on public endpoints | "" |



## Capturing options



Most of the configuration options from the wrapped `capture-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

```



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



### Capture Delay



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 to `300`) will wait before capturing a screenshot.

2. For standalone: `capture-website` library's [`delay`](https://github.com/sindresorhus/capture-website#delay) (in seconds)



## Use plain Puppeteer 



Sometimes the `capture-website` library has problems capturing sites. You can try to

capture these sites with plain Puppeteer by supplying the query parameter `plainPuppeteer=true`



## Environment variables



This app looks at two environment variables:



* `SHOW_RESULTS`: if `true` the latest capture result can be viewed in the browser by browsing the base url  

* `SECRET`: when set all capture requests need to contain a query parameter `secret` whose value matches the value of this environment variable



# Contributing



If you have suggestions for improvements, or want to report a bug, [open an issue](https://github.com/robvanderleek/capture-website-api/issues)!



# License



[ISC](LICENSE) © 2019 Rob van der Leek  (https://twitter.com/robvanderleek)