【Laravel】artisanのdownコマンドを解説

チートシート

Laravel 10.xのartisanの「down」コマンドを解説します。

Description

アプリケーションをメンテナンス/デモモードにします。

Usage

php artisan down [--redirect [REDIRECT]] [--render [RENDER]] [--retry [RETRY]] [--refresh [REFRESH]] [--secret [SECRET]] [--status [STATUS]]

Options

オプション省略形必須説明
redirect--ユーザーがリダイレクトされるべきパス
render--メンテナンスモード時に表示するためにプリレンダリングすべきビュー
retry--リクエストの再試行が可能な秒数
refresh--ブラウザが更新されるまでの秒数
secret--メンテナンスモードを回避するために使用される秘密のフレーズ
status--メンテナンスモードレスポンスを返すときに使用するステータスコード

Example

no options

php artisan down
   INFO  Application is now in maintenance mode.  

ブラウザアクセス時は以下のような503 SERVICE UNAVAILABLEが表示されます。

render

php artisan down --render="errors::503"

表示するビューを指定できます。
様々な機能やプラグインなどをロードする前にレンダリングするので、ユーザーがメンテナンス中にアクセスすることによりエラーが発生することを防いだりできます。

retry

php artisan down --retry=3600

HTTPヘッダのRetry-Afterを設定します。
このヘッダは見た目などに変化はありませんが、Googleのクローラーなどが再クロールまでの時間を調整してくれます。

refresh

php artisan down --refresh=30

HTTPヘッダのRefreshが設定されます。指定した秒数毎にブラウザがリロードされます。

secret

php artisan down --secret=abcdefg

通常のアクセスはメンテナンスモードの503となりますが、以下のようにsecretで指定した文字列のURLからアクセスすると、/へリダイレクトされ通常通りアクセスできるようになります。

http://your.domain/abcdefg

status

php artisan down --status=404

Source

10.x

framework/src/Illuminate/Foundation/Console/DownCommand.php at 11.x · laravel/framework
The Laravel Framework. Contribute to laravel/framework development by creating an account on GitHub.

11.x

framework/src/Illuminate/Foundation/Console/DownCommand.php at 11.x · laravel/framework
The Laravel Framework. Contribute to laravel/framework development by creating an account on GitHub.

コメント

タイトルとURLをコピーしました