Download the PHP package akshay/laravel-url-maintenance without Composer
On this page you can find all versions of the php package akshay/laravel-url-maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download akshay/laravel-url-maintenance
More information about akshay/laravel-url-maintenance
Files in akshay/laravel-url-maintenance
Package laravel-url-maintenance
Short Description The akshay/laravel-url-maintenance package allows you to easily put a specific URL or route of your Laravel application under maintenance or bring it back up. It provides Artisan commands to manage site maintenance on a per-route basis.
License MIT
Informations about the package laravel-url-maintenance
URL Down Package for Laravel
What It Does
The package allows you to easily put a specific URL or route of your Laravel application under maintenance or bring it back up. It provides Artisan commands to manage site maintenance on a per-route basis.
Installation
To install the package, run the following Composer command:
After installation, the service provider will be automatically registered if you're using Laravel 5.5 or later, thanks to package auto-discovery. For earlier versions of Laravel, you may need to add the service provider manually to your config/app.php file:
Next, publish the configuration file:
This will publish the urldown.php configuration file to the config directory of your application.
Configuration
The configuration file config/urldown.php contains the settings for this package:
- The routes_path is used to define the storage location for the route in the cache directory. You can customize this path to suit your project's structure.
- The HTTP status code to show when a route is down (default is 503).
You can modify these settings as per your needs.
Commands
This package provides two Artisan commands:
This command will set a specific route or URL as "under maintenance". It will ask you to select the route name, and then it will mark it as down, showing the maintenance message and error code specified in the configuration.
Usage:
After running the command, it will ask you to select the route name. Once a route is selected, it will be marked as down, and the configured error page will be displayed when that route is accessed.
This command will bring a specific route or URL back online by removing it from maintenance mode. It will ask you to select the route name and remove it from the "under maintenance" state. Usage:
After running this command, the selected route will be restored, and it will no longer show the maintenance page.
How It Works
- The package works by storing the "down" routes in a list (which can be stored in a file, database, or any other medium you prefer).
- When a route is marked as "down", an error page will be displayed with the specified HTTP error code and the maintenance message.
- If the route is brought back up, it will start functioning as normal.
Example Usage:
- Run , then select a route like . Now, any user visiting will see a page (HTTP ).
- Run to bring back online.
Laravel Framework Support
This package is specifically designed to work with Laravel applications and will not function properly outside of the Laravel framework. Ensure you're using or later for automatic package discovery.
Testing
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.