{"id":20244789,"url":"https://github.com/renoki-co/laravel-prerender","last_synced_at":"2025-04-10T20:47:22.443Z","repository":{"id":36991454,"uuid":"405476853","full_name":"renoki-co/laravel-prerender","owner":"renoki-co","description":"Prerender Laravel pages using Clusteer and this nice package.","archived":false,"fork":false,"pushed_at":"2024-01-22T03:37:16.000Z","size":63,"stargazers_count":6,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T18:21:17.747Z","etag":null,"topics":["browser","clusteer","http","laravel","middleware","php","prerender","puppeteer","render"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/renoki-co.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"rennokki"}},"created_at":"2021-09-11T20:29:13.000Z","updated_at":"2023-05-23T23:19:49.000Z","dependencies_parsed_at":"2023-01-17T12:16:55.545Z","dependency_job_id":null,"html_url":"https://github.com/renoki-co/laravel-prerender","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"renoki-co/laravel-package-skeleton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renoki-co%2Flaravel-prerender","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renoki-co%2Flaravel-prerender/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renoki-co%2Flaravel-prerender/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renoki-co%2Flaravel-prerender/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renoki-co","download_url":"https://codeload.github.com/renoki-co/laravel-prerender/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248295512,"owners_count":21080120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser","clusteer","http","laravel","middleware","php","prerender","puppeteer","render"],"created_at":"2024-11-14T09:17:23.334Z","updated_at":"2025-04-10T20:47:22.404Z","avatar_url":"https://github.com/renoki-co.png","language":"PHP","funding_links":["https://github.com/sponsors/rennokki"],"categories":[],"sub_categories":[],"readme":"Laravel Clusteer Prerender\n==========================\n\n![CI](https://github.com/renoki-co/laravel-prerender/workflows/CI/badge.svg?branch=master)\n[![codecov](https://codecov.io/gh/renoki-co/laravel-prerender/branch/master/graph/badge.svg)](https://codecov.io/gh/renoki-co/laravel-prerender/branch/master)\n[![StyleCI](https://github.styleci.io/repos/405476853/shield?branch=master)](https://github.styleci.io/repos/405476853)\n[![Latest Stable Version](https://poser.pugx.org/renoki-co/laravel-prerender/v/stable)](https://packagist.org/packages/renoki-co/laravel-prerender)\n[![Total Downloads](https://poser.pugx.org/renoki-co/laravel-prerender/downloads)](https://packagist.org/packages/renoki-co/laravel-prerender)\n[![Monthly Downloads](https://poser.pugx.org/renoki-co/laravel-prerender/d/monthly)](https://packagist.org/packages/renoki-co/laravel-prerender)\n[![License](https://poser.pugx.org/renoki-co/laravel-prerender/license)](https://packagist.org/packages/renoki-co/laravel-prerender)\n\nPrerender Laravel pages using Clusteer and this nice package.\n\n## 🤝 Supporting\n\n**If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with [Github Sponsors](https://github.com/sponsors/rennokki). 📦**\n\n[\u003cimg src=\"https://github-content.s3.fr-par.scw.cloud/static/43.jpg\" height=\"210\" width=\"418\" /\u003e](https://github-content.renoki.org/github-repo/43)\n\n## 🚀 Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require renoki-co/laravel-prerender\n```\n\nThis package leverages [Clusteer](https://github.com/renoki-co/clusteer), a Puppeteer wrapper written for PHP [which is way faster than traditional packages](https://clusteer.renoki.org/getting-started/benchmarks) by running a long-lived process that can execute Puppeteer commands by opening new pages instead of opening new browsers for each website.\n\n**Clusteer is already installed when you will be installing Laravel Prerender, all you need to do is to [read the installation guide for Clusteer](https://clusteer.renoki.org/getting-started/installation)**\n\nAfter you have configured Clusteer, you may start the server with:\n\n```bash\nphp artisan clusteer:serve\n```\n\n## 🙌 Usage\n\nLaravel Prerender comes with a middleware you can attach to your web routes.\n\n```php\nuse App\\Http\\Controller;\nuse RenokiCo\\LaravelPrerender\\Middleware\\ShouldPrerender;\n\nclass Dashboard extends Controller\n{\n    public function __construct()\n    {\n        $this-\u003emiddleware([\n            ShouldPrerender::class,\n        ]);\n    }\n\n    public function index()\n    {\n        return view('welcome');\n    }\n}\n```\n\n## Prerendering Technique\n\nThe default prerendering instructions are the following:\n\n```php\nuse Illuminate\\Http\\Request;\nuse Jenssegers\\Agent\\Facades\\Agent;\nuse RenokiCo\\LaravelPrerender\\Prerender;\n\nPrerender::shouldPrerender(function (Request $request) {\n    // Avoid infinite loop by excluding Clusteerbot/3.0 from prerendering,\n    // because Clusteer is mimicking the browser.\n    if ($request-\u003eisFromClusteerBot()) {\n        return false;\n    }\n\n    if (! is_null($request-\u003equery('_escaped_fragment_'))) {\n        return true;\n    }\n\n    if (Agent::isRobot() || $request-\u003ehasHeader('X-BUFFERBOT')) {\n        return true;\n    }\n\n    return false;\n});\n```\n\nYou may overwrite the prerender technique in your `AppServiceProvider`'s `boot()` method. **Make sure to also avoid prerendering in case the `User-Agent` header is `Clusteerbot/3.0`**. In the future, this header might change according to the package updates, but they will be marked as breaking changes.\n\n```php\nuse Illuminate\\Http\\Request;\nuse RenokiCo\\LaravelPrerender\\Prerender;\n\nPrerender::shouldPrerender(function (Request $request) {\n    // Avoid infinite loop by excluding Clusteerbot/3.0 from prerendering,\n    // because Clusteer is mimicking the browser.\n    if ($request-\u003eisFromClusteerBot()) {\n        return false;\n    }\n\n    return $request-\u003eisGoogleBot();\n});\n```\n\n## Mutating the Clusteer request\n\nThe prerendering will be made using Clusteer's built-in PHP functions to get the rendered HTML. In some cases, you might want to modify the Clusteer's state with additional configs.\n\nThe `$clusteer` object is already initialized like below. You are free to append your own methods via the `mutateClusteerOnRequest` method in your `AppServiceProvider`'s `boot` method:\n\n```php\nClusteer::to($request-\u003efullUrl())\n    -\u003ewaitUntilAllRequestsFinish()\n    -\u003esetUserAgent('Clusteerbot/3.0')\n    -\u003ewithHtml();\n```\n\n```php\nuse RenokiCo\\LaravelPrerender\\Prerender;\n\nPrerender::mutateClusteerOnRequest(function (Clusteer $clusteer, Request $request) {\n    return $clusteer-\u003eblockExtensions(['.css']);\n});\n```\n\n## 🐛 Testing\n\n``` bash\nvendor/bin/phpunit\n```\n\n## 🤝 Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n## 🔒  Security\n\nIf you discover any security related issues, please email alex@renoki.org instead of using the issue tracker.\n\n## 🎉 Credits\n\n- [Alex Renoki](https://github.com/rennokki)\n- [All Contributors](../../contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenoki-co%2Flaravel-prerender","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenoki-co%2Flaravel-prerender","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenoki-co%2Flaravel-prerender/lists"}