erlandmuchasaj/laravel-gzip

Gzip your responses.

1.1.7 2024-09-03 13:24 UTC

Requires

• php: ^8.0
• ext-exif: *
• ext-fileinfo: *
• ext-json: *
• illuminate/contracts: ^8|^9|^10|^11
• illuminate/filesystem: ^8|^9|^10|^11
• illuminate/http: ^8|^9|^10|^11
• illuminate/support: ^8|^9|^10|^11
• nesbot/carbon: ^2|^3

Requires (Dev)

• brianium/paratest: ^7.4
• orchestra/testbench: ^9.0
• phpunit/phpunit: ^11.0
• rawr/phpunit-data-provider: ^3.3

MIT

• Erland Muchasaj

• package
• library
• cms
• response
• laravel
• optimize
• gzip
• emcms

README

Laravel Gzip is a simple and effective way to gzip your response for a better performance.

Installation

You can install the package via composer:

composer require erlandmuchasaj/laravel-gzip

Config file

Publish the configuration file using artisan.

php artisan vendor:publish --provider="ErlandMuchasaj\LaravelGzip\GzipServiceProvider"

Usage

This package has a very easy and straight-forward usage.

Laravel v11+

Just add the middleware in bootstrap/app.php, like so:

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        // ...
    )
    ->withMiddleware(function (Middleware $middleware) {
        $middleware->append(\ErlandMuchasaj\LaravelGzip\Middleware\GzipEncodeResponse::class);
    })
    // ...

Laravel v10 and older

Just add the middleware to the $middleware array in app/Http/Kernel.php like so:

/**
 * The application's global HTTP middleware stack.
 *
 * These middleware are run during every request to your application.
 *
 * @var array<int, class-string|string>
 */
protected $middleware = [
    \ErlandMuchasaj\LaravelGzip\Middleware\GzipEncodeResponse::class,
    //...
];

Important

In a previous version, we recommended adding the middleware to the web middleware group. Now, we recommend adding to global $middleware because we want to apply gzip to all requests. Additionally, registering the middleware in the web group caused debugbar to break.

Also, if you are using spatie/laravel-cookie-consent package, you should register this middleware before the \Spatie\CookieConsent\CookieConsentMiddleware::class middleware.

That's it! Now your responses will be gzipped.

Benchmark

I tested this package with a fresh installed laravel in homepage and got:

No Gzip => 72.9kb

With Gzip => 19.2kb *

Support me

I invest a lot of time and resources into creating best in class open source packages.

If you found this package helpful you can show support by clicking on the following button below and donating some amount to help me work on these projects frequently.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please see SECURITY for details.

Credits

• Erland Muchasaj

License

The MIT License (MIT). Please see License File for more information.