Download the PHP package bagisto/bagisto-varnish without Composer
On this page you can find all versions of the php package bagisto/bagisto-varnish. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package bagisto-varnish
Varnish Integration for Bagisto
This package integrates Varnish Cache with Bagisto to boost site performance by delivering cached pages quickly, while still supporting dynamic components through ESI (Edge Side Includes) or AJAX-based dynamic views.
π Features
- β‘ Full-page caching via Varnish
- π Automatic cache purging on product, category, or content updates
- π ESI support for dynamic blocks
- π± AJAX-based dynamic view loading for improved Core Web Vitals
- π Artisan commands for cache management
- π₯ Admin tools for purging cache & exporting VCL
- π¨ Theme-ready Blade components
- π‘ Middleware for cache headers (cacheable & non-cacheable routes)
π Request Flow
Explanation:
- 443 (HTTPS) β Nginx handles SSL termination and forwards traffic.
- 80 (HTTP) β Varnish Proxy caches and serves pages, or passes the request to the backend.
- 8080 β Bagisto (Laravel app) generates fresh content when needed.
Flow Summary: Browser β Nginx β Varnish Proxy β Bagisto β Response (cached or fresh)
π¦ Installation
1. Install via Composer
2. Register the Service Provider
In bootstrap/providers.php
:
Note: Autoloading via Composerβs package auto-discovery is not possible for this provider. The registry order mattersβ
VarnishServiceProvider
must be listed after the Shop package or at the end of the providers array. Auto-discovery would load it too early, which can cause issues.
3. Publish Assets & Config
βοΈ Varnish Server Configuration
-
Install Varnish 6.x on your server.
-
Replace
/etc/varnish/default.vcl
with the provided file: - Restart Varnish:
π¨ Theme Integration
You can integrate dynamic content in two ways:
1 β Define Dynamic Views / Fragments
In config/varnish.php
, define a key (identifier) and its corresponding Blade view path:
- Key β Used in ESI or AJAX call (
customer-desktop-dropdown
) - Path β Full Blade view path to render (
varnish::...
)
2 β ESI Include
- Injects content at the Varnish level (server-side).
- Appears immediately on page load.
- May affect LCP/FCP if the backend is slow.
3 β AJAX Dynamic View (Recommended for LCP)
- Loads via AJAX after user interaction.
- Improves LCP/FCP.
- Ideal for non-critical dropdowns, modals, and menus.
π Cache-Control Headers
For routes that should NOT be cached by Varnish:
For routes that should be cached:
(Example: 7 days)
Middleware for Cache Headers in Bagisto
Weβve created a middleware Webkul\Varnish\Http\Middleware\VarnishCache
to handle cache headers.
Attach it to routes like this:
π UI Configuration (Export VCL)
Navigate to: Admin β Configuration β Full Page Cache β Configuration
Select Varnish as the cache application, then provide the following:
- Access List β IPs allowed to purge the cache (e.g.,
localhost
). - Varnish Host URL β Varnish server IP and port for purging/banning cache via UI.
- Backend Host URL β Laravel Bagisto server IP used in the exported VCL.
- Backend Host Port β Laravel Bagisto server port used in the exported VCL.
- Grace Period β Duration for serving stale content if the backend is slow or unavailable.
π Cache Management
Navigate to: Admin β Configuration β Full Page Cache β Cache Management
- Purge by URLs β Enter full URLs (comma-separated) to clear specific cache entries. Paths and domains must match exactly.
- Purge Everything β Clears all cache entries from Varnish. Use with caution, as it may temporarily affect performance.
π‘ Automatic Cache Purging
The package automatically purges cache when:
- Products, categories, pages, orders, reviews, refunds, or theme changes occur.
You can also manually trigger purging by adding your own events in EventServiceProvider
and calling:
π₯ Admin Panel Tools
- Purge Full Cache
- Purge by URL
- Export VCL
π Best Practices
- Use ESI for small, critical personalized blocks (e.g., login status, cart count).
- Use AJAX dynamic views for non-critical interactive elements to improve Core Web Vitals.
- Set Cache-Control headers with appropriate TTL values to control caching behavior.
- Always test on a staging environment before deploying to production.
- Monitor LCP, FCP, and TTFB after enabling Varnish.