包简介

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

README 文档

README

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:

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

Set up your environment and generate an application key:

cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan storage:link

Install Puppeteer:

npm install puppeteer --global

Docker / Laravel Sail

The project ships with a docker-compose.yml for local development via Laravel Sail:

./vendor/bin/sail up -d
./vendor/bin/sail artisan migrate

Authentication

API endpoints are protected with Laravel Sanctum. Include a Bearer token in every request:

Authorization: Bearer <your-token>

Usage

Capture Screenshot

POST /api/v1/screenshot
Authorization: Bearer <token>
Content-Type: application/json

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

POST /api/v1/pdf
Authorization: Bearer <token>
Content-Type: application/json

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

GET /api/v1/_healthz

Returns application health status. No authentication required.

Development

Running tests

composer test
# or directly
./vendor/bin/phpunit

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.

dogado/mugshot 适用场景与选型建议

dogado/mugshot 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 2 次下载、GitHub Stars 达 0，最近一次更新时间为 2021 年 05 月 25 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 dogado/mugshot 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 dogado/mugshot 我们能提供哪些服务？

定制开发 / 二次开发

基于 dogado/mugshot 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

dogado/mugshot

包简介