概要: Laravel Toolkit は無料の Plesk 拡張です。これを使用して、Laravel アプリケーションのホスティングに関連する定型タスクを簡素化できます。

このトピックでは、Plesk で Laravel アプリケーションをアップロード、設定、実行する方法について説明します。このトピックでは、既にアプリケーションを用意しているか、アプリケーションの作成を計画していることを前提としており、Laravel アプリケーションの作成方法を説明するものではありません。

前提条件

Laravel アプリケーションをホストする前に、無料の Laravel Toolkit 拡張を Plesk サーバにインストールする必要があります。

拡張のインストールが完了すると、利用を開始できます。画面左側のドロワーに[Laravel]ボタンが、所有しているすべてのドメインのドメインカードに[Laravel アプリケーションをインストール]ボタンが表示されます。

laravel drawer

laravel domain card install

アプリケーションをアップロードする

アプリケーションを構成して実行する前に、Plesk サーバにアップロードして Laravel Toolkit に登録する必要があります。これには 3 つの方法があります。

  • Laravel スケルトンを作成する。アプリケーションがコンピュータ上のフォルダまたは圧縮ファイルに格納されている場合、あるいはアプリケーションを最初から作成しようとしている場合は、Laravel Toolkit が必要なディレクトリ構造とローカル Git リポジトリを作成できます。
  • リモート Git リポジトリからインストールする。アプリケーションがリモートリポジトリに格納されている場合は、Plesk サーバにこれを展開できます。
  • 既存のアプリケーションをスキャンする。既にアプリケーションを Plesk にアップロードした場合は、このアプリケーションをスキャンすることで Laravel Toolkit にアプリケーションを登録できます。

注釈: Laravel スケルトンを作成するか、リモート Git リポジトリからインストールするためには、Plesk サーバに無料の Git 拡張 をインストールする必要があります。

Laravel スケルトンを作成する

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションをインストール]をクリックします。
  3. [スケルトンをインストール]を選択して、[アプリケーションをインストール]をクリックします。
  4. スケルトンがインストールされたら、アプリケーションファイルを Plesk にアップロードする必要があります(たとえば、FTP または ファイルマネージャを使用)。デフォルトファイルは必要に応じて置き換えます。

リモート Git リポジトリからインストールする

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションをインストール]をクリックします。
  3. [リポジトリからインストール]を選択します。
  4. アプリケーションのファイルが含まれるリモートリポジトリの URL を入力するか貼り付けます。
  5. このリモートリポジトリで認証が必要な場合は、このページに表示された公開鍵をリポジトリに追加します。
  6. [アプリケーションのインストール]をクリックします。

既存のアプリケーションをスキャンする

  1. Plesk にログインします
  2. Go to Websites & Domains, find the domain that will host your application, and then open the "Hosting & DNS" tab.
  3. [ホスティング設定]をクリックします。
  4. 「ドキュメントルート」の値を、アプリケーションの公開ディレクトリのパスに変更し(デフォルトでは /httpdocs/public)、[OK]をクリックします。
  5. [Laravel アプリケーションをインストール] > [キャンセル] > [スキャン]の順にクリックします。

アプリケーションのファイルをアップロードまたは展開し、アプリケーションが Laravel Toolkit に登録されたら、このアプリケーションをホスティングするドメインで[Laravel アプリケーションをインストール]ボタンが[Laravel アプリケーションを管理]ボタンに変わります。

laravel domain card manage

次のステップに進めます。

Artisan、Composer、Node.js コマンドを実行する

Laravel アプリケーションを管理するには、Artisan、Composer、Node.js コマンドの実行が必要になる可能性があります。Laravel Toolkit により、Plesk インターフェースからこれらのコマンドを簡単に実行できるため、シェルアクセスは必要ありません。

アプリケーションを正常に機能させるために、Artisan、Composer、Node.js コマンドを実行する必要があるかどうかわからない場合は、このアプリケーションの提供元である人または組織にお問い合わせください。

注釈: Node.js コマンドを実行するためには、無料の Node.js 拡張を Plesk サーバにインストールする必要があります。

laravel run commands

Artisan、Composer、または Node.js コマンドを実行する

  1. Plesk にログインします

  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。

  3. 該当するタブに移動し、実行するコマンドを入力するかリストから選択して、Enter キーを押すか laravel run button ボタンをクリックします。

    注釈: Node.js コマンドを実行する際は、コマンドで必要な効果を得られるように、特定の Node.js バージョンやパッケージマネージャを指定する必要がある場合があります。どれを選択すべきかわからない場合は、このアプリケーションの提供元である人または組織にお問い合わせください。

アプリケーションのログファイルを表示する

Laravel アプリケーションは、実行中にログを個別のログファイルに記録します。このファイルの内容は Laravel Toolkit インターフェースから確認できるため、アプリケーションのモニタリングや発生した問題のトラブルシューティングが簡単になります。

laravel view logs

アプリケーションのログを表示する

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. [ログ]をクリックします。

This will open the domain log browser showing only the log entries from the Laravel log.

アプリケーションのスケジュール済みタスクを表示する

Laravel では、cron などの外部スケジューラを使用する代わりに、アプリケーションのコード内でタスクをスケジュールできます。Laravel Toolkit により、現在設定されているスケジュール済みタスクを Laravel Toolkit インターフェースから直接表示したり、Laravel のスケジュール済みタスクを有効化または無効化したりできます。

注釈: Laravel Toolkit インターフェースから Laravel のスケジュール済みタスクを 追加、削除、編集することはできません。 アプリケーションのコード内でタスクをスケジュールする方法をご確認ください

laravel view scheduled tasks

アプリケーションのスケジュール済みタスクを表示する

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. [スケジュール済みタスク]タブに移動します(このタブは、スケジュール済みタスクが 1 つ以上設定されている場合にのみ表示されます)。

注釈: アプリケーションのスケジュール済みタスクを有効化または無効化するためには、まず特定の処理を実行する必要があります。この処理は、Plesk for Linux と Plesk for Windows のどちらを使用しているかによって異なります。スケジュール済みタスクを実行したい Laravel アプリケーションをホストしているドメインごとに、この処理を行う必要があります。

Plesk for Linux でスケジュール済みタスクの管理を有効にする

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]に移動し、アプリケーションをホストするドメインを探し、[ホスティングと DNS]タブに移動して[ウェブホスティングアクセス]をクリックします。
  3. [SSH 経由のサーバアクセス]の下で、[禁止]以外のいずれかのオプションを選択して、[OK]をクリックします。

Plesk for Windows でスケジュール済みタスクの管理を有効にする

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]に移動し、アプリケーションをホストするドメインを探します。
  3. [アカウント]の下で、[カスタマイズ]をクリックします。
  4. [パーミッション]タブに移動して、[スケジューラ管理]の横のチェックボックスをオンにしてから、[更新してロック]をクリックします。

これで、アプリケーションのスケジュール済みタスクを有効または無効にできます。

アプリケーションのスケジュール済みタスクを有効にする

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. [スケジュール済みタスク]トグルボタンをクリックして、[有効]と表示させます。

これで、Laravel アプリケーションのスケジュール済みタスクが有効になります。

環境変数を編集する

アプリケーションが適切に機能するためには、カスタム環境変数が 1 つ以上必要である可能性があります。あるいは、設定されている環境変数に応じて、アプリケーションの挙動が変わる可能性があります。アプリケーションを適切に機能させるために必要な環境変数があるかどうかわからない場合は、このアプリケーションの提供元である人または組織にお問い合わせください。

環境変数を編集する

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. [環境変数(.env)]の横の[編集]ボタンをクリックします。
  4. 必要に応じて環境変数を編集して、[更新]をクリックします。

更新された環境変数が有効になります。

Putting Your Application in Maintenance Mode

To prevent website visitors from seeing errors while you are working on or updating your application, you can put it in maintenance mode. While your application is in maintenance mode, website visitors will see a page showing a "503 SERVICE UNAVAILABLE" error.

Putting your application in maintenance mode

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. Click the Maintenance mode toggle button so that it shows "Enabled".

Your Laravel application is now in maintenance mode.

注釈: Do not forget to take your application out of maintenance mode once you have finished working on or updating it.

アプリケーションを更新する

Whether your Laravel application's files are stored in a local or a remote Git repository, you need to make sure that the changes made to the application's code are propagated to the Plesk server. You can choose between deploying the changes manually or automatically.

If you need precise control over when your application is updated, we recommend updating it manually. This way, no changes made to the application's code in the repository are propagated to the Plesk server until you are ready to do so. The downside of this approach is that you must perform manual actions every time the application needs to be updated.

アプリケーションを手動で更新する

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. Go to the "Deployment" tab and, under "Deployment mode", select the "Manual" radio button.
  4. Under "Deployment scenario", clear the checkboxes corresponding to the steps you do not want to run during deployment, and then click Deploy.

Once Laravel Toolkit has run through all the deployment steps, your application and its dependencies will be updated.

If you want the changes made to the application's code to be automatically propagated to the Plesk server, the method differs depending on whether the application's code is stored in a local or a remote Git repository.

Updating your application automatically (local repository)

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. Go to the "Deployment" tab and under "Deployment mode" select the "Automatic" radio button.
  4. Under "Deployment scenario", clear the checkboxes corresponding to the steps you do not want to run during deployment.

Now, every time a commit is pushed to the master branch of the local repository storing the application's code, your application and its dependencies will be updated.

Updating your application automatically (remote repository)

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. Copy the webhook URL you see here, and then add it to the remote repository. For specific instructions, see your repository provider's documentation.
  4. Go to the "Deployment" tab and under "Deployment mode" select the "Automatic" radio button.
  5. Under "Deployment scenario", clear the checkboxes corresponding to the steps you do not want to run during deployment.

Now, every time the event triggering the webhook takes place in the remote repository storing the application's code, your application and its dependencies will be updated.

Configuring a Deployment Script

アプリケーションを正常に機能させるためには、デプロイメント中にサーバで特定のコマンドを実行する必要がある可能性があります。コマンドを手動で実行することを避けるには、アプリケーションが更新されるたびに実行されるデプロイメントスクリプトを設定できます。

アプリケーションを正常に機能させるために、デプロイメント中に何らかのコマンドを実行する必要があるかどうかわからない場合は、このアプリケーションの提供元である人または組織にお問い合わせください。

注釈: Plesk for Linux では、Laravel Toolkit インターフェースからデプロイメントスクリプトを編集する前に、SSH アクセスを有効にする必要があります。これは一度だけ行う作業です。

Enabling the ability to edit the deployment script in Plesk for Linux

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]に移動し、アプリケーションをホストするドメインを探し、[ホスティングと DNS]タブに移動して[ウェブホスティングアクセス]をクリックします。
  3. [SSH 経由のサーバアクセス]の下で、[禁止]以外のいずれかのオプションを選択して、[OK]をクリックします。

これで、Laravel Toolkit インターフェースでデプロイメントスクリプトを編集できるようになります。

デプロイメントスクリプトを編集する

  1. Plesk にログインします
  2. [ウェブサイトとドメイン]で、アプリケーションをホストするドメインを見つけて[Laravel アプリケーションを管理]をクリックします。
  3. [デプロイメント]タブに移動して、[スクリプトを編集]をクリックします。
  4. デプロイメントスクリプトを入力するか貼り付けてから、[更新]をクリックします。

デプロイメントスクリプトが有効になり、アプリケーションを更新するたびに実行されるようになります。