Skip to content

A small service that helps you take screenshots of web pages.

License

Notifications You must be signed in to change notification settings

dogado-group/mugshot

Repository files navigation

dogado MugShot

Tests Coverage Status Total Downloads Latest Stable Version License

A small service that helps you take screenshots of web pages.

Requirements

Installation

git clone https://github.com/dogado/mugshot.git mugshot
composer install --no-dev -o

php artisan key:generate
php artisan migrate
php artisan storage:link

Mugshot uses Puppeteer in the background to create screenshots

npm install puppeteer --global

Usage

Capture Screenshot

POST /api/v1/screenshot
Parameter Type Description
url string URL of the page you want to capture
width integer Width of the screenshot
height integer Height of the screenshot
fullPage boolean Allows you to capture the entire page
deviceScale integer Between 1 and 3
quality integer Only works with JPG, uses percent
delay integer Wait in seconds before taking a screenshot of the page
fileExtension string PNG or JPG
response string inline, download, json

Status Check

GET /api/v1/status

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.