jeremykenedy / laravel-https
Laravel Https is middleware to check for Secure HTTP requests. Laravel Https middleware providers can check and redirect if the user is not hitting the https url of your app/site or the request can be automatically redirected to a Secure Http (HTTPS) request.
Fund package maintenance!
jeremykenedy
Patreon
Installs: 118 569
Dependents: 1
Suggesters: 0
Security: 0
Stars: 35
Watchers: 5
Forks: 6
Open Issues: 0
Requires
- php: ^7.2|^8.0|^8.1|^8.2|^8.3
This package is auto-updated.
Last update: 2024-10-27 03:47:14 UTC
README
Laravel HTTPS Web and API Checker
Laravel Https is middleware to check for Secure HTTP requests. Laravel Https has can check for HTTPS and throw an error or automatically redirect to HTTPS.
- About
- Features
- Requirements
- Installation Instructions
- Configuration
- Usage
- Screenshots
- File Tree
- Opening an Issue
- License
Features
Requirements
Installation Instructions
-
From your projects root folder in terminal run:
composer require jeremykenedy/laravel-https
-
Register the package
-
Laravel 5.5 and up Uses package auto discovery feature, no need to edit the
config/app.php
file. -
Laravel 5.4 and below Register the package with laravel in
config/app.php
underproviders
with the following:
'providers' => [ ... jeremykenedy\LaravelHttps\LaravelHttpsServiceProvider::class, ];
-
-
Optionally publish the packages views, config file, and language files by running the following from your projects root folder:
php artisan vendor:publish --tag=LaravelHttps
-
Add the middleware to your routes or controller. See Usage.
Configuration
laravel-https can be configured in directly in /config/laravel-https.php
if you published the assets.
Or you can variables to your .env
file.
Environment File
Here are the .env
file variables available:
LARAVEL_HTTP_ERROR_CODE=403
Usage
From Route File:
- You can include the
checkHTTPS
orforceHTTPS
in a route groups or on individual routes.
Route Group Example:
Route::group(['middleware' => ['web', 'checkHTTPS']], function () { Route::get('/', 'WelcomeController@welcome'); });
Individual Route Examples:
Route::get('/', 'WelcomeController@welcome')->middleware('checkHTTPS'); Route::match(['post'], '/test', 'Testing\TestingController@runTest')->middleware('forceHTTPS');
From Controller File:
- You can include the
checkHTTPS
orforceHTTPS
in the contructor of your controller file.
Controller File Example:
/** * Create a new controller instance. * * @return void */ public function __construct() { $this->middleware('forceHTTPS'); }
Screenshots
File Tree
├── .gitignore ├── LICENSE ├── README.md ├── composer.json └── src ├── LaravelHttpsServiceProvider.php ├── app │ └── Http │ └── Middleware │ ├── CheckHTTPS.php │ └── ForceHTTPS.php ├── config │ └── laravel-https.php └── resources ├── lang │ └── en │ └── laravel-https.php └── views └── errors └── 403.blade.php
- Tree command can be installed using brew:
brew install tree
- File tree generated using command
tree -a -I '.git|node_modules|vendor|storage|tests'
Opening an Issue
Before opening an issue there are a couple of considerations:
- You are all awesome!
- Read the instructions and make sure all steps were followed correctly.
- Check that the issue is not specific to your development environment setup.
- Provide duplication steps.
- Attempt to look into the issue, and if you have a solution, make a pull request.
- Show that you have made an attempt to look into the issue.
- Check to see if the issue you are reporting is a duplicate of a previous reported issue.
- Following these instructions show me that you have tried.
- If you have a questions send me an email to jeremykenedy@gmail.com
- Need some help, I can do my best on Slack: https://opensourcehelpgroup.slack.com
- Please be considerate that this is an open source project that I provide to the community for FREE when openeing an issue.
Open source projects are a the community’s responsibility to use, contribute, and debug.
License
Laravel-https is licensed under the MIT license. Enjoy!