Installation & setup | laravel-screenshot | Spatie

 SPATIE

  Laravel Screenshot
=====================

spatie.be/open-source

  [Docs](https://spatie.be/docs)  [Laravel-screenshot](https://spatie.be/docs/laravel-screenshot/v1)  Installation & setup

 Version   v1

 Other versions for crawler [v1](https://spatie.be/docs/laravel-screenshot/v1)

- [ Introduction ](https://spatie.be/docs/laravel-screenshot/v1/introduction)
- [ Support us ](https://spatie.be/docs/laravel-screenshot/v1/support-us)
- [ Requirements ](https://spatie.be/docs/laravel-screenshot/v1/requirements)
- [ Installation & setup ](https://spatie.be/docs/laravel-screenshot/v1/installation-setup)
- [ Questions and issues ](https://spatie.be/docs/laravel-screenshot/v1/questions-issues)
- [ Changelog ](https://spatie.be/docs/laravel-screenshot/v1/changelog)
- [ About us ](https://spatie.be/docs/laravel-screenshot/v1/about-us)

Basic usage
-----------

- [ Taking screenshots ](https://spatie.be/docs/laravel-screenshot/v1/basic-usage/taking-screenshots)
- [ Customizing screenshots ](https://spatie.be/docs/laravel-screenshot/v1/basic-usage/customizing-screenshots)
- [ Saving screenshots to disks ](https://spatie.be/docs/laravel-screenshot/v1/basic-usage/saving-screenshots-to-disks)
- [ Queued screenshot generation ](https://spatie.be/docs/laravel-screenshot/v1/basic-usage/queued-screenshot-generation)
- [ Testing screenshots ](https://spatie.be/docs/laravel-screenshot/v1/basic-usage/testing-screenshots)

Drivers
-------

- [ Configuration ](https://spatie.be/docs/laravel-screenshot/v1/drivers/configuration)
- [ Customizing Browsershot ](https://spatie.be/docs/laravel-screenshot/v1/drivers/customizing-browsershot)
- [ Using the Cloudflare driver ](https://spatie.be/docs/laravel-screenshot/v1/drivers/using-the-cloudflare-driver)
- [ Custom drivers ](https://spatie.be/docs/laravel-screenshot/v1/drivers/custom-drivers)

Advanced usage
--------------

- [ Extending with macros ](https://spatie.be/docs/laravel-screenshot/v1/advanced-usage/extending-with-macros)

 Installation & setup
========================

###  On this page

1. [ Choosing a driver ](#content-choosing-a-driver)
2. [ Laravel Boost ](#content-laravel-boost)
3. [ Publishing the config file ](#content-publishing-the-config-file)

You can install the package via composer:

```
composer require spatie/laravel-screenshot
```

Choosing a driver
-----------------------------------------------------------------------------------------------------------

This package supports multiple screenshot drivers. You can set the driver via the `LARAVEL_SCREENSHOT_DRIVER` environment variable, or in the config file.

### Browsershot driver (default)

The Browsershot driver requires the `spatie/browsershot` package:

```
composer require spatie/browsershot
```

You'll also need to install the required dependencies for Browsershot to work. You can find the instructions [here](https://spatie.be/docs/browsershot/v4/requirements).

### Cloudflare driver

The Cloudflare driver uses [Cloudflare's Browser Rendering API](https://developers.cloudflare.com/browser-rendering/) to take screenshots. It does not require Node.js or a Chrome binary, making it a great choice for cloud-hosted Laravel apps.

To get started with Cloudflare:

1. Make sure you have a [Cloudflare account](https://dash.cloudflare.com/sign-up)
2. In the Cloudflare dashboard, go to **Manage account > Account API tokens** in the sidebar
3. Click **Create Token** and create a token with the **Account.Browser Rendering** permission
4. Your Account ID can be found in the address bar of the Cloudflare dashboard URL
5. Add the following to your `.env` file:

```
LARAVEL_SCREENSHOT_DRIVER=cloudflare
CLOUDFLARE_API_TOKEN=your-api-token
CLOUDFLARE_ACCOUNT_ID=your-account-id
```

That's it. No other dependencies are required since the Cloudflare driver uses Laravel's built-in HTTP client.

Laravel Boost
-----------------------------------------------------------------------------------------------

This package ships with a [Laravel Boost](https://laravel.com/docs/12.x/boost) skill. After installing the package, run `php artisan boost:install` to register the skill. This will help AI agents in your project generate correct screenshot code.

Publishing the config file
--------------------------------------------------------------------------------------------------------------------------------------

Optionally, you can publish the config file with:

```
php artisan vendor:publish --tag=screenshot-config
```

This is the content of the published config file:

```
return [
    'driver' => env('LARAVEL_SCREENSHOT_DRIVER', 'browsershot'),

    'job' => Spatie\LaravelScreenshot\Jobs\GenerateScreenshotJob::class,

    'defaults' => [
        'width' => 1280,
        'height' => 800,
        'device_scale_factor' => 2,
        'type' => 'png',
        'wait_until' => 'networkidle2',
    ],

    'browsershot' => [
        'node_binary' => env('LARAVEL_SCREENSHOT_NODE_BINARY'),
        'npm_binary' => env('LARAVEL_SCREENSHOT_NPM_BINARY'),
        'include_path' => env('LARAVEL_SCREENSHOT_INCLUDE_PATH'),
        'chrome_path' => env('LARAVEL_SCREENSHOT_CHROME_PATH'),
        'node_modules_path' => env('LARAVEL_SCREENSHOT_NODE_MODULES_PATH'),
        'bin_path' => env('LARAVEL_SCREENSHOT_BIN_PATH'),
        'temp_path' => env('LARAVEL_SCREENSHOT_TEMP_PATH'),
        'write_options_to_file' => env('LARAVEL_SCREENSHOT_WRITE_OPTIONS_TO_FILE', false),
        'no_sandbox' => env('LARAVEL_SCREENSHOT_NO_SANDBOX', false),
    ],

    'cloudflare' => [
        'api_token' => env('CLOUDFLARE_API_TOKEN'),
        'account_id' => env('CLOUDFLARE_ACCOUNT_ID'),
    ],
];
```