This package is a clone from jeroennoten/Laravel-Prerender with jeroennoten as author. CasperLaiTW provided Laravel 6,7 & 8 Support by an unmerged (14th September 2020) Pull-Request.
This package currently only supports >= Laravel 6 && >= PHP 5.5.9 If you're looking for an older version checkout jeroennoten/Laravel-Prerender.
Modern search engines like Google are constantly trying to visit and render your website. Unfortunately, they don't execute javascript. So the content of your website is not getting indexed. Prerender helps you out there. A middleware intercepts requests to your Laravel website or application from crawlers. It then makes a call to the external Prerender Service to get the static HTML instead of the javascript for that page. It is a perfect match for Vue JS, Angular JS, Backbone JS, Ember JS and any other Javascript Framework.
Prerender adheres to google's _escaped_fragment_ proposal, which we recommend you use. It's easy:
- Just add
<meta name="fragment" content="!">to the<head>of all of your pages - If you use hash urls (#), change them to the hash-bang (#!), but you can also use HTML5's push-state
- That's it! Perfect SEO on javascript pages.
Require this package run:
composer require codebar-ag/laravel-prerender
Apply the Prerender Middleware to your app/Http/Middleware/Kernel.php or routes/web.php
CodebarAg\LaravelPrerender\PrerenderMiddleware;
If you want to make use of the prerender.io service, add the following to your .env file:
PRERENDER_TOKEN=yoursecrettoken
If you are using a self-hosted service, add the server address in the .env file.
PRERENDER_URL=http://example.com
You can disable the service by adding the following to your .env file:
PRERENDER_ENABLE=false
This may be useful for your local development environment.
- The middleware checks to make sure we should show a prerendered page
- The middleware checks if the request is from a crawler (
_escaped_fragment_or agent string) - The middleware checks to make sure we aren't requesting a resource (js, css, etc...)
- (optional) The middleware checks to make sure the url is in the whitelist
- (optional) The middleware checks to make sure the url isn't in the blacklist
- The middleware checks if the request is from a crawler (
- The middleware makes a
GETrequest to the prerender service (phantomjs server) for the page's prerendered HTML - Return the HTML to the crawler
To customize the whitelist and the blacklist, you first have to publish the configuration file:
$ php artisan vendor:publish --provider="CodebarAg\LaravelPrerender\LaravelPrerenderServiceProvider"
Whitelist paths or patterns. You can use asterix syntax. If a whitelist is supplied, only url's containing a whitelist path will be prerendered. An empty array means that all URIs will pass this filter. Note that this is the full request URI, so including starting slash and query parameter string.
// prerender.php:
'whitelist' => [
'/frontend/*' // only prerender pages starting with '/frontend/'
],Blacklist paths to exclude. You can use asterix syntax. If a blacklist is supplied, all url's will be prerendered except ones containing a blacklist path. By default, a set of asset extentions are included (this is actually only necessary when you dynamically provide assets via routes). Note that this is the full request URI, so including starting slash and query parameter string.
// prerender.php:
'blacklist' => [
'/api/*' // do not prerender pages starting with '/api/'
],Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent