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

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

Description

アプリケーションをメンテナンス／デモモードにします。
メンテナンス中は通常のアクセスが503エラーとなり、指定したビューが表示されます。

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

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

php artisan down

   INFO  Application is now in maintenance mode.

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

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

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

php artisan down --retry=3600

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

php artisan down --refresh=30

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

php artisan down --secret=abcdefg

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

http://your.domain/abcdefg

php artisan down --status=404