c6digital/laravel-site-redirect

A small package to redirect all requests elsewhere.

This package can be used to redirect all requests to a site elsewhere with the flick of an environment variable.

Installation

You can install the package via Composer:

composer require c6digital/laravel-site-redirect

You can publish the config file with:

php artisan vendor:publish --tag="laravel-site-redirect-config"

Usage

Use environment variables to enable & disable the redirect and configure the redirect location.

SITE_REDIRECT_ENABLED=true
SITE_REDIRECT_LOCATION=https://my-site.test

The middleware that handles the redirect is registered globally by the package.

Bypassing redirects

There are times when you want to allow somebody to bypass the redirect mechanism. This can be achieved with a "bypass token".

Start by specifying the bypass token as an environment variables.

SITE_REDIRECT_BYPASS_TOKEN=example-token

To bypass the redirect, simply provide the bypass token in the query string of the request.

https://my-site.test/?bypass_token=example-token

This will let you access the site as normal. The bypass will be active for 1 hour so subsequent requests will not require a token.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Ryan Chandler
• All Contributors

License

The MIT License (MIT). Please see License File for more information.