Download the PHP package dogado/mugshot without Composer
On this page you can find all versions of the php package dogado/mugshot. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dogado/mugshot
More information about dogado/mugshot
Files in dogado/mugshot
Package mugshot
Short Description A small service that helps you take screenshots of web pages.
License MIT
Informations about the package mugshot
dogado MugShot
A small service that helps you take screenshots of web pages and generate PDFs from HTML content.
Requirements
- PHP 8.4+
- MariaDB / MySQL
- Node.js for Puppeteer
Installation
Clone the repository and install dependencies:
Set up your environment and generate an application key:
Install Puppeteer:
Docker / Laravel Sail
The project ships with a docker-compose.yml for local development via Laravel Sail:
Authentication
API endpoints are protected with Laravel Sanctum. Include a Bearer token in every request:
Usage
Capture Screenshot
| Parameter | Type | Required | Description |
|---|---|---|---|
url |
string |
yes | URL of the page to capture (http / https) |
width |
integer |
no | Viewport width in pixels |
height |
integer |
no | Viewport height in pixels |
fullPage |
boolean |
no | Capture the full scrollable page |
deviceScale |
integer |
no | Device scale factor, between 1 and 3 |
quality |
integer |
no | JPEG quality, between 30 and 100 (ignored for PNG) |
delay |
integer |
no | Seconds to wait before capturing (useful for JS-heavy pages) |
fileExtension |
string |
no | Output format: jpeg (default) or png |
response |
string |
no | Response mode: inline (default), download, or json |
Generate PDF
| Parameter | Type | Required | Description |
|---|---|---|---|
content |
string |
yes | Raw HTML content to render as a PDF |
response |
string |
no | Response mode: inline (default) or download |
Health Check
Returns application health status. No authentication required.
Development
Running tests
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.
All versions of mugshot with dependencies
ext-exif Version *
ext-json Version *
guzzlehttp/guzzle Version ^7.15
laravel/framework Version ^12.66
laravel/sanctum Version ^4.0
laravel/tinker Version ^2.11
league/mime-type-detection Version ^1.16
sentry/sentry-laravel Version *
spatie/browsershot Version ^5.2.3
spatie/laravel-health Version ^1.39