Download the PHP package tfd/laravel-well-known-traffic-advice without Composer
On this page you can find all versions of the php package tfd/laravel-well-known-traffic-advice. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tfd/laravel-well-known-traffic-advice
More information about tfd/laravel-well-known-traffic-advice
Files in tfd/laravel-well-known-traffic-advice
Package laravel-well-known-traffic-advice
Short Description A Laravel package that provides a standardized .well-known/traffic-advice endpoint for communicating server load, maintenance windows, and access recommendations to automated clients, crawlers, and partner services.
License MIT
Homepage https://github.com/21stdigital/laravel-well-known-traffic-advice
Informations about the package laravel-well-known-traffic-advice
Laravel Traffic Advice — Standardized Server Load & Access Recommendations via .well-known/traffic-advice
This package provides a standardized endpoint for exposing server traffic and load advice, following the emerging .well-known
convention. It enables your Laravel application to communicate current server load, maintenance windows, or other traffic-related recommendations to automated clients, crawlers, or partner services. This helps external systems make informed decisions about when to access your application, improving reliability and reducing unnecessary load during peak times or scheduled downtimes.
Key features include:
- Customizable checks for server load, CPU usage, and disallowed access times.
- Easy integration with your existing Laravel application.
- Extensible architecture for adding your own traffic advice logic.
- Simple configuration and usage, following Laravel best practices.
Background: What is traffic advice?
The upcoming Traffic Advice is a standardized way for servers to communicate their current load and access recommendations to automated clients via the /.well-known/traffic-advice endpoint
. This helps systems like Chrome's Private Prefetch Proxy decide when and how much to prefetch from your site.
By providing information such as server load, allowed prefetch fractions, or disallowing access during maintenance, Traffic Advice helps optimize resource usage and improve reliability. It enables sites to control automated traffic dynamically, reducing unnecessary load during peak times while enhancing user experience when capacity allows.
Implementing this endpoint allows your application to participate in smarter, automated traffic management, benefiting both your server and clients.
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
Creating Custom Checks
You can implement your own checks to define custom criteria for traffic advice. A custom check must implement the TrafficAdviceCheck
interface.
Example: Custom Check
Create a new class, e.g., in app/Checks/CustomCheck.php
:
Registering the Check
Add your check to the checks
array in the config/well-known-traffic-advice.php
configuration file:
Your check will now be considered on every request to /.well-known/traffic-advice
.
You can find more examples in the src/Checks
directory.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
This project is maintained by 21st digital. We appreciate the contributions from the community that help make this project better.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Stefan Gruna
- All Contributors
- Spatie
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-well-known-traffic-advice with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^10.0||^11.0||^12.0