From b978a1429555f2ba99dd5ab4710d6a31e825a1c6 Mon Sep 17 00:00:00 2001 From: Julian Schramm Date: Mon, 23 Jun 2025 18:23:47 +0200 Subject: [PATCH] docs: improve requirements and installation instructions --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1520a69..2c48c11 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,19 @@ Easy, URL-based image transformations inspired by [Cloudflare Images](https://de - PHP \>= 8.4 - Laravel 12.x +- [GD PHP Library](https://www.php.net/manual/en/book.image.php) 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. -> [!IMPORTANT] -> It is highly recommended to set a minimum memory limit of 256MB in your `php.ini` file to avoid memory issues when images are being processed. +### Important `php.ini` settingsā— +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. +``` +memory_limit=512M +``` +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. +``` +swoole.use_shortname=off +``` ## Installation