Download the PHP package brickx/laravel-filament-maintenance without Composer

On this page you can find all versions of the php package brickx/laravel-filament-maintenance. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-filament-maintenance

Filament Maintenance Plugin

GitHub Tests Action Status Packagist Downloads

⚠️ IMPORTANT

This repository has been archived, as a newer version for Filament v3 can be found here: Maintenance Switch.

I'll try my best to make this new repository compatible with Filament v2 as well, but I can't guarantee when that will happen. Feel free to use this archived version in the meantime.


This plugin allows you to easily toggle maintenance mode from your Filament Admin Panel. You can also set a secret token to bypass the maintenance mode.

Requirements

This plugin was developed for Filament v2, and will soon be archived.

If you're using Filament v3, please check out the new repository for the plugin: brickx/maintenance-switch.

Installation

You can install the package via composer:

You can publish the config file with:

This is the contents of the published config file:

You can publish the translations with:

Optionally, you can publish the views using:

Setup

An optional step (but highly recommended) is to modify the App\Http\Middleware\PreventRequestsDuringMaintenance class to add the following code:

This is because Laravel's default maintenance middleware will redirect to the / route, which feels weird for the user. Of course, you can redirect to any URL you want.

Usage

The plugin will add a toggle button to your Filament Admin Panel, right before the search bar.

Clicking it will trigger the php artisan down command if the website is live, and the php artisan up command otherwise.

Secret Token

You can set a secret token in the config file. If you do so, you will be able to bypass the maintenance mode by visiting the following URL: https://your-domain.test/{secret}.

If the secret key is set to null, a random one will be generated on the fly each time the maintenance mode is activated.

Refresh Interval

If you want to instruct browsers to refresh pages after a certain amount of time, you can set the refresh key in the config file.

When set to false, no Refresh HTTP header will be sent. You can specify an integer to define the number of seconds before reloading pages under maintenance mode.

Visibility

By default, any logged-in user will be able to toggle the maintenance mode.

If you want to restrict maintenance mode toggling to certain users, you can set the permissions key in the config file.

The plugin will use Laravel's default authorization system to check for permissions, via the can method on the User model. It will also work well with Spatie's Laravel Permission package.

Todo

Changelog

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

Security Vulnerabilities

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

Credits

License

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


All versions of laravel-filament-maintenance with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
blade-ui-kit/blade-icons Version ^1.5
filament/filament Version ^2.17
filament/notifications Version ^2.17
illuminate/contracts Version ^9.0|^10.0
livewire/livewire Version ^2.10
spatie/laravel-package-tools Version ^1.15
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package brickx/laravel-filament-maintenance contains the following files

Loading the files please wait ....