https://github.com/bots-house/webshot
📷 Generate screenshot of any page (under active development)
https://github.com/bots-house/webshot
api chrome-headless screenshot self-hosted
Last synced: about 1 month ago
JSON representation
📷 Generate screenshot of any page (under active development)
- Host: GitHub
- URL: https://github.com/bots-house/webshot
- Owner: bots-house
- License: mit
- Created: 2021-05-10T22:51:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-25T03:02:33.000Z (over 2 years ago)
- Last Synced: 2024-06-19T05:47:31.992Z (over 1 year ago)
- Topics: api, chrome-headless, screenshot, self-hosted
- Language: Go
- Homepage: https://webshot.bots.house
- Size: 198 KB
- Stars: 7
- Watchers: 5
- Forks: 4
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📸 [WebShot](https://webshot.bots.house)
Self-hosted web page screenshot generator.
## API
```http
GET https://webshot.bots.house/image
```
| Param | Type | Description | Default |
| :------------ | :-------: | :------------------------------------------------------------ | :----------: |
| `url` | `string` | URL of target page | **Required** |
| `width` | `int` | Viewport width in pixels of the browser render | 1680 |
| `height` | `int` | Viewport height in pixels of the browser render | 867 |
| `scale` | `float` | Viewport scale | 1.0 |
| `format` | `string` | Output format (png, jpeg) | png |
| `quality` | `int` | Output image quiality | 100 |
| `clip_x` | `float64` | X offset in device independent pixels (dip). | null |
| `clip_y` | `float64` | Y offset in device independent pixels (dip). | null |
| `clip_width` | `float64` | Rectangle width in device independent pixels (dip). | null |
| `clip_height` | `float64` | Rectangle height in device independent pixels (dip). | null |
| `delay` | `int` | Delay in milliseconds, to wait after the page is loaded | null |
| `full_page` | `bool` | Capture full page screenshot | false |
| `scroll_page` | `bool` | Scroll through the entire page before capturing a screenshot. | false |
## Deploy
### Heroku
[](https://heroku.com/deploy?template=https://github.com/bots-house/webshot/tree/main)
### DigitalOcean
[](https://cloud.digitalocean.com/apps/new?repo=https://github.com/bots-house/webshot/tree/main)