Dockerを使ってLaravelの開発環境を整える【WSL + Docker + Laravel】｜ブログ

はじめに 弊社のブログでは以前、WindowsのWSLにDocker環境を整える記事を紹介したかと思います。ここでは、そのDocker環境でLaravelの開発環境を構築していく方法を紹介したいと思います。 WSLでのDocker環境構築についてはこちらを参照ください。 WindowsでDocker環境構築 /blog/windows%e3%81%a7docker%e7%92%b0%e5%a2%83%e6%a7%8b%e7%af%89/ なお、今回紹介するのはあくまで開発環境の構築であり、簡易的なものになっております。実際に運用されるものとして想定はしておりません。 Docker Compose の確認 今回Dockerの環境を構築するうえでは、「Docker Compose」を利用します。Docker Compose とは複数のDockerコンテナの定義や実行を簡単にできるようにするツールです。 前回のDocker環境構築で行ったDocker for Windowsのインストールを行えば、自動的にインストールされているはずです。WSL上で以下のコマンドを実行してバージョンが表示されるか確認してみましょう。 docker compose version フォルダ構成 さっそく構築のためのフォルダを作成していきましょう。今回は「dockerlaravel」というプロジェクト名で構築していきます。 以下のフォルダ構成を準備します。 [homedir] └--dockerlaravel |-- php | |-- Dockerfile | └-- 000-default.conf |-- db | └-- my.cnf |-- src | └-- (Laravel) └-- compose.yml Dockerfile Dockerfileとは新規にDockerイメージをビルドする際に行う手順を記したものになります。Dockerfileに記載することで、構築に必須となる手順を自動化することが可能です。 またファイルとして管理することで、gitといったバージョン管理システムの管理化に置くことができるため、チーム内での共有や管理も用意となります。 compose.yml Docker Composeで利用する設定ファイルであり、ここに作成するコンテナの設定をYAML形式で定義していきます。このファイルはプロジェクトのルートディレクトリに配置されるのが一般的です。 簡単なPHPを実行する さっそく簡単なPHPを実行するための構築を行っていきましょう。 php フォルダにある Dockerfile に以下のように記述します。 利用する Docker image の指定 FROM php:8.2-apache この一行だけで、PHP のバージョン 8.2 と apache がインストールされた Docker コンテナが作成されます。つまりWEBサーバーがこれだけで作成されます。 PHP のバージョンを変更したい場合は “8.2” の部分を変更すれば対応できたりと、開発したい環境に合わせて柔軟に Docker 環境を作成できます。 次に 実行する PHP ファイルを作成します。 src フォルダに index.php ファイルを作成し以下のように記述します。アクセスするとPHPの情報を出力するだけのコードになります。 php src/index.php <?php phpinfo(); そして compose.yml ファイルに今回作成した構築を docker コンテナで実行する場合の設定を記述していきます。 services: php: containername: dockerlaravel build: ./php volumes: ./src:/var/www/html ports: 8000:80 | services | Dockerの各種アプリケーションを定義するための項目です。 複数のアプリケーションを定義することが可能です。 | | --- | --- | | php | （任意で変更可能） Dockerで起動するアプリケーションの名前を設定します。ここではPHPを動かすアプリケーションについての設定を記述しているので “php” としました。 | | containername | （任意で変更可能） 該当アプリケーションのコンテナ名となります。 | | build | Dockerをビルドする際に読み込むDockerfileの場所を指定します。 指定には絶対パスは使用できず、相対パスで指定する必要があります。 「.」を使うことで compose.yml の場所を基準に指定することが可能です。 | | volume | Docker内でマウントされるファイルやフォルダなどを指定します。 Docker内で作成されたファイルは永続的ではなく、コンテナの再起動などを行うと消えてしまうので、永続的に保存しておきたいものを指定します。 | | port | Dockerへのアクセスする際の対応するポートを指定できます。 \[アクセスするポート\]:\[Dockerで接続されるポート\] という指定になり、 8000:80 ですと localhost の8000番ポートにアクセスすると、Dockerコンテナ内の80番ポートにつながるということになります。 | compose.yml の記述が完了したら、WSL上でコマンドを実行します。 以下のコマンドで、コンテナの立ち上げとコンテナのビルドを両方実行しています。 cd /dockerlaravel docker compose up -d --build | docker compose up | Docker Compose で Docker コンテナを立ち上げるためのコマンドです。 | | --- | --- | | -d, –detach | このオプションを指定することで、コンテナをデタッチモードで起動します。 デタッチモードで起動すると、バックグラウンドでコンテナを実行するため、同じターミナル上で作業が可能です。 | | –build | コンテナ開始前にDockerの構築をします。 | コマンド実行後、以下のようなテキストが表示されれば Docker コンテナの起動は完了です。 Container dockerlaravel Started ブラウザで「http://localhost:8000」にアクセスしてみましょう。 正常に動作すれば phpinfo の実行結果がページに表示されているはずです。 Laravelを動かすために必要なものをDockerで構築する Composer のインストール、ユーザーの作成 簡単な PHP を動かすだけならこれだけで可能ですが、Laravel を動かすとなると他にも色々な PHP モジュールが必要になります。また composer も必要になるかと思いますのでこちらもコンテナで構築していきます。 Dockerfileに追記していきましょう。 FROM php:8.2-apache COPY --from=composer:latest /usr/bin/composer /usr/bin/composer ARG UID=1000 ARG USER=docker RUN useradd -G www-data,root -u ${UID} -d /home/${USER} ${USER} RUN mkdir -p /home/${USER}/.composer RUN chown -R ${USER}:${USER} /home/${USER} USER ${UID} まず Composer を利用できるようにするために、3行目でComposer のインストールを行うように記述しています。 また docker コンテナ内でプロジェクトの作成やソースコードの修正を行った場合、root ユーザーで行われてしまうため、WSL上で操作を行う際にパーミッションエラーが起きてしまいます。そのため、5～11 行目までの操作で Dockerコンテナ用のユーザーを作成しています。 USER については任意のユーザー名で構いません。UID についても任意の ID を指定できますが、dockerコンテナ内の他のユーザーと被らないようにする必要があります。よくわからなければ 1000 で問題ないでしょう。 ここまでが完了したら、コンテナの再ビルドを行いコンテナ内で以下のコマンドを実行しましょう。 srcにあるindex.phpは不要なので削除 rm -rf src/index.php コンテナを落とす docker compose stop コンテナを再ビルド docker compose build --no-cache コンテナを起動 docker compose up -d コンテナ内でコマンドを実行する docker compose exec php bash “docker compose stop” は起動しているコンテナを停止するコマンドです。 “docker compose build” はコンテナのビルドを行うコマンドです。–no-cache オプションをつけることでキャッシュを利用せずにビルドし、Dockerfile の変更を確実に反映させます。 基本的に Dockerfile は変更がなかった場合はキャッシュを利用し、変更があればキャッシュを使わずにビルドを行うため、キャッシュについてはあまり意識する必要はありません。 もし Dockerfile を変更しても Docker コンテナに反映されていない場合は、–no-cahce オプションを利用しましょう。 “docker compose exec” は起動しているコンテナ内でコマンドを実行するものです。引数として2つ取り、1つ目はコマンド実行するアプリケーションを compose.yml で指定したアプリケーション名で指定します。2つ目は実行するコマンドを指定します。このコマンドで “bash” を指定すると、コンテナ内で bash を起動、つまりコンテナ内に入ることになります。これでコンテナ内で bash 操作を行うことができます。 このように docker ユーザーで /var/www/html フォルダ内に入ることができれば成功です。 Laravel プロジェクトの作成 ではコンテナ内で Laravel のプロジェクトを作成しましょう。 以下のコマンドで現在いるフォルダに Laravel の雛形を作成することができます。最後の「. (ドット)」を忘れないようにしましょう。 composer create-project laravel/laravel . 実際に実行してみると上記のようにエラーとなったかと思います。 これは Laravel を実行するのに必須となっている ZIP 拡張機能がインストールされていないためです。 必要なモジュールは公式のこのページを参照してください。これをコンテナ内にインストールするように Dockerfile に記述します。 FROM php:8.2-apache COPY --from=composer:latest /usr/bin/composer /usr/bin/composer RUN apt-get update \ && apt-get install -y zip unzip libzip-dev libicu-dev \ && docker-php-ext-install pdo pdomysql mysqli zip intl bcmath ARG UID=1000 ARG USER=docker RUN useradd -G www-data,root -u ${UID} -d /home/${USER} ${USER} RUN mkdir -p /home/${USER}/.composer RUN chown -R ${USER}:${USER} /home/${USER} USER ${UID} Dockerfile を修正後、改めてコンテナを再ビルドし Laravel のプロジェクトを作成してみましょう。今度は正常に作成されるかと思います。 docker compose down docker compose up -d --build docker compose exec php bash dockerコンテナ内で実行 composer create-project laravel/laravel . Apache サーバーの設定を変更する ここまでで Laravel のプロジェクトは作成出来たかと思います。 しかし Laravel の実行ファイルは 「public/index.php」 であり、これは dockerコンテナ内でいうと「/var/www/html/public」に存在することになります。 この場合、この Laravel にアクセスしようと思うと「http://localhost:8000/public」にアクセスする必要があります。 これではあまりイケてないので、apache の公開ディレクトリの設定を書き換えましょう。 php フォルダにある 「000-default.conf」を以下のように記載します。 DocumentRoot /var/www/html/public その後 Dockerfile に記述を追加します。 FROM php:8.2-apache COPY --from=composer:latest /usr/bin/composer /usr/bin/composer RUN apt-get update \ && apt-get install -y zip unzip libzip-dev libicu-dev \ && docker-php-ext-install pdo pdomysql mysqli zip intl bcmath ARG UID=1000 ARG USER=docker RUN useradd -G www-data,root -u ${UID} -d /home/${USER} ${USER} RUN mkdir -p /home/${USER}/.composer RUN chown -R ${USER}:${USER} /home/${USER} USER ${UID} ADD 000-default.conf /etc/apache2/sites-enabled/ 「000-default.conf」ファイルは apache 用の設定ファイルであり、”DocumentRoot” を記述することで、既存の DocumentRoot の設定を上書きしています。 それを \ の中に書くことで、80番ポートからのアクセス時に適用させるようにしています。 これを、Dockerコンテナ内にある apache の設定用フォルダに追加すればいいので、Dockerfile にそれを記載しています。 また 今回はサーバーに apache を利用しているため、rewritemodule を有効にする必要があります。 Laravel の public/.htaccess を見てみると以下のような記述があるかと思います。 .... .... これは rewritemodule が存在している場合に、記載されている処理を行うという意味なので rewritemodule がないと動きません。 Dockerfile に rewritemodule を有効にするための記述を追加します。 FROM php:8.2-apache COPY --from=composer:latest /usr/bin/composer /usr/bin/composer RUN apt-get update \ && apt-get install -y zip unzip libzip-dev libicu-dev \ && docker-php-ext-install pdo pdomysql mysqli zip intl bcmath RUN cd /etc/apache2/mods-enabled \ && ln -s ../mods-available/rewrite.load ARG UID=1000 ARG USER=docker RUN useradd -G www-data,root -u ${UID} -d /home/${USER} ${USER} RUN mkdir -p /home/${USER}/.composer RUN chown -R ${USER}:${USER} /home/${USER} USER ${UID} ADD 000-default.conf /etc/apache2/sites-enabled/ ここまでが完了したら、再度Dockerコンテナの再ビルドを行います。 また Laravel の実行に必要なコマンドも実行しておきましょう。 docker compose down docker compose up -d --build docker compose exec php bash laravel の実行に必要なコマンドを実行 chmod -R 777 storage php artisan storage:link これで「http://localhost:8000」にアクセスすると Laravel のページが表示されるはずです。 データベースを動かす これで Laravel の環境は構築できましたが、実際のアプリケーションではデータベースへのアクセスも必要になってくるでしょう。 なので、Dockerコンテナ上でデータベースの環境を構築しましょう。ここではMySQLを利用していきます。 まず compose.yml を以下のように修正しましょう。 services: php: containername: dockerlaravel build: ./php volumes: ./src:/var/www/html ports: 8000:80 db: containername: dockermysql image: mysql:8 volumes: data:/var/lib/mysql ./db/my.cnf:/etc/mysql/conf.d/my.cnf ports: 3306:3306 environment: MYSQLDATABASE=laravel MYSQLROOTUSER=root MYSQLROOTPASSWORD=password volumes: data: | db | （任意で変更可能） Dockerで起動するアプリケーションの名前を設定します。 | | --- | --- | | image | 利用する Docker イメージを指定します。php アプリケーションでは Dockerfile に記述していましたが、compose.yml で指定することも可能です。 | | enviroment | Docker イメージ内での環境変数を指定します。MySQLに用意されている環境変数を定義して、Docker イメージ作成時にデータベースに必要な設定を行う。 ・MYSQLDATABASE Docker イメージ作成時に生成されるデータベース名を指定する。 ・MYSQLROOTUSER Docker イメージ作成時に生成される root ユーザー名を指定する。 ・MYSQLROOTPASSWORD Docker イメージ作成時に生成される root ユーザーのパスワードを指定する。 | | volumes | データベースに保存されたデータは永続化される必要があるので、ボリュームとしてマウントしています。また MySQL の設定ファイルを共有できるように、設定ファイルもマウントしておきます。 “data” という指定は下記に記述する Docker 内のボリューム名を指定します。 | | volumes (servicesの外で指定) | volumes を services の外で指定すると、該当のDocker Compose を実行した際に Docker 内に 指定した名前でボリュームが自動で作成されます。 MySQLのデータは永続化する必要がありますが、それを ローカルPCと共有する必要はないため、このように Docker 内のボリュームとして永続化しています。 | 続いて Laravel の .env ファイルのデータベース接続設定を変更します。 DBCONNECTION=mysql DBHOST=db DBPORT=3306 DBDATABASE=laravel DBUSERNAME=root DBPASSWORD=password | DBCONNECTION | データベースのどの接続設定を利用するかを指定します。 Laravel11 からデフォルトが “sqlite” になったので “mysql” に変更します。 | | --- | --- | | DBHOST | 接続するデータベースのホスト名を指定します。 Docker コンテナを利用している場合、compose.yml で指定したアプリケーション名を指定することが可能です。 | | DBPORT | 接続するデータベースのポート番号を指定します。 compose.yml の ports で指定したポート番号を指定します。 | | DBDATABASE | 接続するデータベースのデータベース名を指定します。 compose.yml で指定した MYSQLDATABASE に合わせて指定します。 | | DBUSERNAME | データベースに接続する際のユーザー名を指定します。 compose.yml で指定した MYSQLROOTUSER に合わせて指定します。 | | DBPASSWORD | データベースに接続する際のパスワードを指定します。 compose.yml で指定した MYSQLROOTPASSWORD に合わせて指定します。 | 最後に my.cnf を使って MySQL の設定を変更してみましょう。 MySQL はデフォルトのタイムゾーンが UTC になっているので、変更します。 [mysqld] default-time-zone = 'Asia/Tokyo' 設定の変更が完了したら Docker コンテナを再起動しましょう。 compose.yml の変更だけならば、再ビルドを行う必要はありません。 docker compose down docker compose up -d 実際にデータベースに接続できるかを、Laravel のマイグレーションを実行して確認してみましょう。 docker compose exec php bash dockerコンテナ内で実行 php artisan migrate 正常にマイグレーションが完了したら成功です。 開発したい環境に合わせた構築をDockerで手軽に！ 以上で最低限の Laravel の環境が整いました。 今回は PHP8.2、サーバーは apache、データベースは MySQL8 の環境が出来ていますが、実際に開発したい環境に合わせて Dockerfile や compose.yml を変更することで簡単に複数の環境が構築可能です。 Docker を利用して、目的に合わせた環境を手軽に作成することができるのが大きなメリットですね。