Skip to content

Commit 7c0dceb

Browse files
committed
docs: update installation and blur option docs for GD and Imagick drivers
1 parent 08f9f41 commit 7c0dceb

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

docs/pages/available-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ blur=50
3232
```
3333

3434
> [!CAUTION]
35-
> The `blur` option is a resource-intensive operation and may cause memory issues if the image is too large. It is recommended to use this option with caution and test beforehand, or disable it in the config.
35+
> When using the default GD driver, `blur` is very resource-intensive and may cause memory issues if the image is too large. We recommend the [Imagick driver](/installation#driver-configuration) if you want to use this option, or else to leave it disabled in the config.
3636
3737
## `contrast`
3838

docs/pages/installation.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,12 @@
44

55
- PHP \>= 8.4
66
- Laravel 12.x
7-
- [GD PHP Library](https://www.php.net/manual/en/book.image.php)
7+
- [GD](https://www.php.net/manual/en/book.image.php) or [Imagick](https://www.php.net/manual/en/book.imagick.php) PHP extension installed and [enabled](#driver-configuration)
88

99
::: tip
1010
If you want to use the file caching feature (highly recommended), a configured `Storage` disk and a `Cache` driver is required. More info in the [Image Caching](/image-caching) section.
1111
:::
1212

13-
### Important `php.ini` settings❗
14-
1. The underlying image processing library (GD) can use alot more RAM than regular web requests. It's highly recommended to set your memory limit to *at least* 256MB.
15-
```
16-
memory_limit=512M
17-
```
18-
2. If you have the [Swoole extension](https://laravel.com/docs/octane#swoole) installed, make sure you have the following setting to [avoid conflicts](https://github.com/ace-of-aces/laravel-image-transform-url/issues/4) with Laravel's `defer` helper which this package uses.
19-
```
20-
swoole.use_shortname=off
21-
```
22-
2313
## Installation
2414

2515
Install the package via composer:
@@ -33,3 +23,24 @@ Publish the config file with:
3323
```bash
3424
php artisan vendor:publish --tag="image-transform-url-config"
3525
```
26+
27+
## Driver Configuration
28+
29+
To use Imagick instead of the default GD library for image processing (recommended for performance), you will have to [change the default image driver](https://image.intervention.io/v3/getting-started/frameworks#application-wide-configuration) for the underlying [Intervention Image](https://image.intervention.io/) package.
30+
31+
::: info
32+
The [`libvips` driver](https://github.com/Intervention/image-driver-vips) is currently not supported.
33+
:::
34+
35+
## PHP Settings
36+
37+
Depending on your environment, you may need to adjust some `php.ini` settings.
38+
39+
1. If you are using the default GD driver, be aware that it can use alot more RAM than regular web requests. It's highly recommended to set your memory limit to *at least* 256MB.
40+
```
41+
memory_limit=512M
42+
```
43+
2. If you have the [Swoole extension](https://laravel.com/docs/octane#swoole) installed, make sure you have the following setting to [avoid conflicts](https://github.com/ace-of-aces/laravel-image-transform-url/issues/4) with Laravel's `defer` helper which this package uses.
44+
```
45+
swoole.use_shortname=off
46+
```

0 commit comments

Comments
 (0)