Weave Code
Laravel Og Image Laravel Package
spatie/laravel-og-image
Generate Open Graph images in Laravel from Blade-defined HTML. Automatically renders screenshots, serves them from a route, and caches files. Templates reuse your app’s CSS, fonts, and Vite assets—no external API required.
Generate OG images for your Laravel app
Frequently asked questions about Laravel Og Image
- How do I generate Open Graph images for my Laravel blog without relying on third-party APIs like Facebook’s Debugger?
- Use `spatie/laravel-og-image` to define OG templates in Blade views (e.g., `<x-og-image>`). The package renders them server-side with Chromium, caches results, and serves them via a dedicated route. No external APIs are needed—everything runs on your Laravel server.
- What Laravel versions does spatie/laravel-og-image support?
- The package officially supports Laravel 9+. Check the [GitHub repo](https://github.com/spatie/laravel-og-image) for the latest compatibility notes. It leverages `spatie/laravel-screenshot`, which requires PHP 8.0+ and Node.js for asset compilation.
- Can I reuse my existing CSS (e.g., Tailwind or Bootstrap) in OG image templates?
- Yes. OG templates inherit your app’s CSS, fonts, and Vite assets automatically. No duplicate stylesheets are needed—just define your OG HTML in Blade, and the package applies your existing styles. Test edge cases like missing fonts in isolated templates.
- How does caching work, and can I adjust the TTL for OG images?
- The package caches generated images on disk with a default TTL of 1 day. You can configure this via the `ogImageCacheTTL` setting in your `.env` file. For dynamic content (e.g., user-generated posts), use content-hashed URLs to invalidate stale caches automatically.
- Will generating OG images on-demand slow down my Laravel app during traffic spikes?
- First-time generation adds ~2–5 seconds latency due to Chromium rendering. Mitigate this by pre-generating images via the `og-image:generate` Artisan command or queuing jobs (e.g., dispatch `GenerateOgImage` after content creation). Use Cloudflare or S3 for static delivery.
- How do I exclude certain routes (e.g., admin pages) from OG image generation?
- Add middleware to skip OG generation for excluded routes. For example, create a `SkipOgImageMiddleware` that checks `request()->is('admin/*')` and conditionally renders the `<x-og-image>` component. Alternatively, use route middleware in `RouteServiceProvider`.
- Are there alternatives to spatie/laravel-og-image for Laravel OG generation?
- Yes. For simpler needs, consider `spatie/laravel-share-buttons` (limited OG support) or third-party APIs like [Cloudinary’s OG generator](https://cloudinary.com/). However, `spatie/laravel-og-image` is unique for its server-side Blade integration, no API costs, and full asset inheritance.
- How do I test OG image generation in CI/CD or local development?
- Use the `GenerateOgImage` command or manually trigger the `/og-image` route. Mock Chromium failures in tests by overriding the `Screenshot` facade. Validate output with tools like [Facebook’s Sharing Debugger](https://developers.facebook.com/tools/debug/) or [Twitter Card Validator](https://cards-dev.twitter.com/validator).
- Can I store OG images on S3 or Cloudflare instead of local disk?
- Yes. Configure the `Storage` facade to use S3 or other Laravel storage adapters. For Cloudflare, use the `og-image` route with a CDN-friendly URL structure (e.g., `/og/{hash}.png`). This reduces PHP load and improves global delivery performance.
- What are the system requirements for spatie/laravel-og-image (e.g., Chrome, Docker)?
- You need Chrome/Chromium installed and accessible to the PHP process. In Docker, ensure the container has Chrome installed (e.g., via `selenium/standalone-chrome`). Node.js is required for Vite asset compilation. Monitor memory usage for complex OG templates (e.g., animations).
Weaver
How can I help you explore Laravel packages today?