https://github.com/monicahq/laravel-cloudflare
Add Cloudflare ip addresses to trusted proxies for Laravel.
https://github.com/monicahq/laravel-cloudflare
cloudflare-ips hacktoberfest trusted-proxies
Last synced: about 1 month ago
JSON representation
Add Cloudflare ip addresses to trusted proxies for Laravel.
- Host: GitHub
- URL: https://github.com/monicahq/laravel-cloudflare
- Owner: monicahq
- License: mit
- Created: 2018-10-05T08:43:26.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T21:41:03.000Z (4 months ago)
- Last Synced: 2025-05-07T02:32:48.528Z (about 1 month ago)
- Topics: cloudflare-ips, hacktoberfest, trusted-proxies
- Language: PHP
- Homepage:
- Size: 338 KB
- Stars: 299
- Watchers: 4
- Forks: 33
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Trust Cloudflare's Proxies for Laravel
Add Cloudflare ip addresses to trusted proxies for Laravel.
[](https://github.com/monicahq/laravel-cloudflare/releases)
[](https://packagist.org/packages/monicahq/laravel-cloudflare)
[](https://github.com/monicahq/laravel-cloudflare/actions?query=branch%3Amain)
[](https://sonarcloud.io/dashboard?id=monicahq_laravel-cloudflare)
[](https://sonarcloud.io/dashboard?id=monicahq_laravel-cloudflare)
# Installation
1. Install package using composer:
```
composer require monicahq/laravel-cloudflare
```
1. Configure Middleware
Replace `TrustProxies` middleware in your `bootstrap/app.php` file:
```php
->withMiddleware(function (Middleware $middleware) {
$middleware->replace(
\Illuminate\Http\Middleware\TrustProxies::class,
\Monicahq\Cloudflare\Http\Middleware\TrustProxies::class
);
})
```
## Custom proxies callback
You can define your own proxies callback by calling the `LaravelCloudflare::getProxiesUsing()` to change the behavior of the `LaravelCloudflare::getProxies()` method.
This method should typically be called in the `boot` method of your `AppServiceProvider` class:
```php
use Illuminate\Support\ServiceProvider;
use Monicahq\Cloudflare\LaravelCloudflare;
use Monicahq\Cloudflare\Facades\CloudflareProxies;
class AppServiceProvider extends ServiceProvider
{
/**
* Bootstrap any application services.
*/
public function boot(): void
{
LaravelCloudflare::getProxiesUsing(fn() => CloudflareProxies::load());
}
}
```
# How it works
The middleware uses [Illuminate\Http\Middleware\TrustProxies](https://github.com/laravel/framework/blob/8.x/src/Illuminate/Http/Middleware/TrustProxies.php) as a backend.
When the cloudflare ips are detected, they are used as trusted proxies.
# Refreshing the Cache
This package retrieves Cloudflare's IP blocks, and stores them in cache.
When request comes, the middleware will get Cloudflare's IP blocks from cache, and load them as trusted proxies.
You'll need to refresh the cloudflare cache regularely to always have up to date proxy.
Use the `cloudflare:reload` artisan command to refresh the IP blocks:
```sh
php artisan cloudflare:reload
```
## Suggestion: add the reload command in the schedule
Add a schedule to your `routes/console.php` file to refresh the cache, for instance:
```php
use Illuminate\Support\Facades\Schedule;
Schedule::command('cloudflare:reload')->daily();
```
# View current Cloudflare's IP blocks
You can use the `cloudflare:view` artisan command to see the cached IP blocks:
```sh
php artisan cloudflare:view
```
# Option: publish the package config file
If you want, you can publish the package config file to `config/laravelcloudflare.php`:
```sh
php artisan vendor:publish --provider="Monicahq\Cloudflare\TrustedProxyServiceProvider"
```
This file contains some configurations, but you may not need to change them normally.
## Running tests for your package
When running tests for your package, you generally don't need to get Cloudflare's proxy addresses.
You can deactivate the Laravel Cloudflare middleware by adding the following environment variable in
your `.env` or `phpunit.xml` file:
```
LARAVEL_CLOUDFLARE_ENABLED=false
```
# Compatibility
| Laravel | [monicahq/laravel-cloudflare](https://github.com/monicahq/laravel-cloudflare) |
|----------|----------|
| 5.x-6.x | <= 1.8.0 |
| 7.x-8.53 | 2.0.0 |
| >= 8.54 | >= 3.0.0 |
# Citations
This package was inspired by [lukasz-adamski/laravel-cloudflare](https://github.com/lukasz-adamski/laravel-cloudflare) and forked from [ogunkarakus/laravel-cloudflare](https://github.com/ogunkarakus/laravel-cloudflare).
# License
Author: [Alexis Saettler](https://github.com/asbiin)
This project is part of [MonicaHQ](https://github.com/monicahq/).
Copyright © 2019–2024.
Licensed under the MIT License. [View license](LICENSE.md).