【エックスサーバー】LaravelをGitHubからデプロイして公開

Laravel

2023/10/09

はじめに
【紹介】個人開発
環境
バージョン確認
1. Git
GitHubからデプロイ(初回)
Laravelプロジェクトの更新時
1. GitHubからプル
参考
さいごに

はじめに

今回はエックスサーバーでLaravelプロジェクトをGitHubから取得し、構築する手順をまとめました。

開発時はローカルPCで行い、ソースの管理はGitHubを利用するケースは多いと思います。
公開サーバーでは、GitHubリポジトリから取得するようにすれば、改修する度にコマンドで最新状態にすることができますので、非常に楽です。

エックスサーバー上にLaravelの環境を構築する必要があります。
以下の記事に詳細をまとめましたので参考にしてください。

エックスサーバーへの申し込みは以下からできます。

エックスサーバーへの新規申し込みは、無料期間がありますので満足いくかどうか事前に確認できます。
まずは申し込んで試してみましょう。

他にも私のブログで、Laravelについて解説している記事がありますのでご覧ください。

【紹介】個人開発

私の個人開発ですがQuiphaというサービスを開発しました。(Laravel, Vue3など)
良かったら、会員登録して動作を試してみて下さい。

また、Laravel 9 実践入門という書籍を出版しました。
Kindle Unlimitedを契約している方であれば、読み放題で無料でご覧いただくことができます。

是非多くの方に読んでいただき、Laravelの開発に少しでもお役に立てたら幸いです。

環境

エックスサーバー
Laravel Framework 8 / 9
git version 1.8.3.1

バージョン確認

エックスサーバーにSSHで接続します。
デフォルトでインストールされているバージョンを確認しましょう。

Git

Gitはインストールされていました。
このままのバージョンを利用します。

$ git --version
git version 1.8.3.1

GitHubからデプロイ(初回)

リポジトリの用意

事前に、LaravelのプロジェクトをGitHubに用意しましょう。
GitHubにプッシュされたLaravelプロジェクトをデプロイしますので、以下の記事を参考にしてください。

以下のプライベートリポジトリをGitHubに作成しました。

example-laravel-github

公開鍵・秘密鍵の作成

エックスサーバーにSSHで接続し、コマンドを実行します。

GitHubへの接続は、SSHで鍵認証で行います。
以下のコマンドで鍵を作成します。

$ ssh-keygen -t rsa -b 4096

出力先やパスフレーズを求められますが、任意で入力します。
（出力先はデフォルトのまま）

Generating public/private rsa key pair.
Enter file in which to save the key (/home/xxx/.ssh/id_rsa): 
Enter passphrase (empty for no passphrase): 
Enter same passphrase again: 
Your identification has been saved in /home/xxx/.ssh/id_rsa.
Your public key has been saved in /home/xxx/.ssh/id_rsa.pub.
The key fingerprint is:
SHA256:xx xx@xx.xserver.jp
The key's randomart image is:
+---[RSA 4096]----+
| ...             |
+----[SHA256]-----+

以下のファイルの中身を確認しましょう。
長い文字列が出力されますので、この内容は控えておきます。

$ cat $HOME/.ssh/id_rsa.pub
ssh-rsa AAAAB...== xxx@xxx.xserver.jp

GitHubの設定

リポジトリに公開鍵を登録します。
リポジトリのsettingsから「Deploy keys」を開きます。

「Add deploy key」をクリックします。

Titleは任意で入力し、Keyには先程の公開鍵の中身を貼り付けます。
「Add key」ボタンをクリックし登録します。

エックスサーバーからはプッシュしないので、「Allow write access」のチェックは不要です。

Gitの設定

Gitのconfigファイルを作成します。

$ vi ~/.ssh/config

中身を以下のように編集しました。

Host github.com
  HostName github.com
  IdentityFile ~/.ssh/id_rsa
  User ユーザ名を任意で指定

Laravel用のプロジェクトディレクトリを用意し、Gitクローンを行います。

$ mkdir laravel-project
$ cd laravel-project/
$ git clone git@github.com:xxx/example-laravel-github.git

パスフレーズの入力を求められますが、鍵を作成した際のパスフレーズを入力します。

Composerパッケージのインストール

プロジェクト直下へ移動します。

$ cd example-laravel-github/

Composerのパッケージをインストールします。

$ composer install

設定ファイルの用意

.envファイルを用意します。

$ cp .env.example .env

以下のコマンドでAPP_KEYを更新します。

$ php artisan key:generate

.envファイルを適宜修正します。（一部抜粋）

..
APP_ENV=production
APP_DEBUG=false
APP_URL=http://初期ドメイン

本番の公開の場合、Laravelの設定ファイルを必ず本番向けへ変更します。
（デバッグ画面など出さないように注意）

公開ディレクトリの設定

Laravelプロジェクト直下のpublicフォルダを、公開フォルダに配置します。
シンボリックリンクを貼りますが、以下は例です。

$ ln -s $HOME/laravel-project/example-laravel-github/public $HOME/xxx/public_html/laravel

各自の環境に合わせて変更してください。

ブラウザから以下のURLにアクセスしてみましょう。

http://エックスサーバー初期ドメイン/laravel/

Laravelの起動画面が表示されました。

httpsでアクセスするには、エックスサーバーのサーバーパネルの「SSL設定」を行う必要があります。
無料でSSLが使用できますので、Webアプリケーションを公開する場合は必ず設定しましょう。

Nodeパッケージのインストールとビルド

プロジェクト直下で以下のコマンドを実行し、NPMパッケージをインストールします。

$ npm install

以下のコマンドでトランスパイルを行います。(JS/CSSをビルド)

最新のLaravelはViteに置き換わっておりますので、それぞれ本番環境とし以下を指定しました。

Viteの場合
$ npm run build

Mixの場合
$ npm run prod

プロジェクト直下のpublicフォルダにjs/cssが出力されます。

Viteの場合
./public/build/assets/app.xxx.css
./public/build/assets/app.xxx.js
./public/build/manifest.json

Mixの場合
./public/css/app.css
./public/js/app.js
./public/mix-manifest.json

Viteについては以下の記事にもまとめました。

データベースの設定

データベースへ接続してみましょう。

エックサーバーの最新サーバーでは、MySQLではなくMariaDBとなっています。

エックスサーバーのサーバーパネルの「MySQL設定」を開きます。

MariaDBのバージョンは10.5.xで、接続先はlocalhostになります。

「MySQL追加」を開き、データーベースを追加します。
データーベース名は任意で指定します。

文字コードはEUC-JP、UTF-8、Shift_JIS、Binaryから選択できますが、「UTF-8」を選択しましょう。

「MySQLユーザ追加」を開き、データベースにアクセスするユーザを追加します。
ユーザIDとパスワードは任意で指定します。

「MySQL一覧」を開き、作成したデータベースにユーザを設定します。
追加ボタンをクリックします。

Laravelのプロジェクトの直下にある、.envファイルを以下のように編集します。

DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=作成したデータベース名
DB_USERNAME=設定したユーザ名
DB_PASSWORD=設定したパスワード

以下のコマンドを実行します。
.envのAPP_ENVを「production」にしていたため、以下の確認メッセージが表示されますが、「yes」を入力します。

$ php artisan migrate
**************************************
*     Application In Production!     *
**************************************

 Do you really wish to run this command? (yes/no) [no]:
 >

開発環境とは違い、本番環境では誤操作防止のために確認メッセージが表示されます。

以下のようなメッセージが表示されれば、正常に実行完了です。

Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated:  2014_10_12_000000_create_users_table (4.82ms)
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated:  2014_10_12_100000_create_password_resets_table (27.93ms)
Migrating: 2019_08_19_000000_create_failed_jobs_table
Migrated:  2019_08_19_000000_create_failed_jobs_table (3.85ms)
Migrating: 2019_12_14_000001_create_personal_access_tokens_table
Migrated:  2019_12_14_000001_create_personal_access_tokens_table (26.28ms)

phpMyAdminを開き、テーブルが作成されていることを確認しましょう。

Laravelプロジェクトの更新時

GitHubからプル

開発時にプロジェクトを更新し、GitHubへソースをプッシュした後は、サーバー上でプルを行い最新状態にします。

試しにローカルPCでファイルを変更し、GitHubリポジトリへプッシュしてみましょう。

routes\web.php

Route::get('/sample', function () {
    return "sample";
});

エックスサーバー上で、以下のコマンドでGitプルを行い、最新状態にしましょう。

$ git pull

ブラウザから以下のURLにアクセスしてみましょう。

http://エックスサーバー初期ドメイン/laravel/sample

修正が反映されたことが確認できました。

参考

さくらのレンタルサーバーの例も参考にしてください。

ConoHa WINGの例も参考にしてください。

さいごに

Laravelで作成したWebアプリケーションを、GitHubからエックスサーバーに構築し公開する手順をまとめました。
是非試してみてください。

エックスサーバーへの申し込みは以下からできます。

エックスサーバーへの新規申し込みは、無料期間がありますので満足いくかどうか事前に確認できます。
まずは申し込んで試してみましょう。

他にも私のブログで、Laravelについて解説している記事がありますのでご覧ください。

コメントをどうぞコメントをキャンセル

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

投稿ルール

コメントは承認制となっており、管理人の判断で公開されます。
承認にはお時間をいただきます。(平日の日中は対応できません)
コメントを公開する際、内容を修正する場合があります。
ご質問の場合は、詳細な状況と内容を記載し、丁寧なコメントをお願い致します。
エラーメッセージだけではなく、各種バージョン、経緯、再現手順を記載ください。
記事とは無関係な内容やアバウトなど、その他の理由で承認されない場合があります。
必ずしも管理人が返信するわけではございませんのでご了承ください。

コメント ※

名前 ※

メール ※

サイト

日本語が含まれない投稿は無視されますのでご注意ください。（スパム対策）