構築のヒント

Docker Compose でコンテナ間を連携させる際の環境変数の渡し方をまとめます。本課題の本質は Docker と Docker Compose の理解にあり、環境変数の渡し方のパターンは本質的な学習対象ではないため、自力で調べて進めていただいて構いませんが、詰まった場合は以下のヒントを適宜参考にしてください。

1. バックエンド(sns-camp-api)に DB 接続情報を渡す方法

展開して設定例を表示する

sns-camp-api のソースには .env.example が同梱されています。これをコピーして .env を作成し、Docker Compose の env_file から読み込ませる方法が簡単です。

アプリケーションのディレクトリに移動します。

cd sns-camp-api

.env.example をコピーして .env を作成します。

cp .env.example .env

.env を開き(例: vi .env)、Docker Compose 内の DB コンテナを参照するように DB_HOST を DB サービス名(例: db)に書き換えます。あわせて DB_USER / DB_PASSWORD / DB_NAME を、docker-compose.yml の DB コンテナ側の設定と揃えてください。

DB_HOST=db
DB_PORT=3306
DB_USER=root
DB_PASSWORD=password
DB_NAME=sns_camp

docker-compose.yml では、env_file ディレクティブで .env を読み込ませます。

services:
  api:
    build: ./sns-camp-api
    env_file:
      - ./sns-camp-api/.env
    ports:
      - "8080:8080"
    depends_on:
      - db

  db:
    image: mysql:8.0
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: sns_camp
    ports:
      - "3306:3306"

Docker Compose のサービス名(上の例では db)が、同じ Compose ネットワーク内で DNS 名として機能します。そのため .env の DB_HOST=db の指定だけで API コンテナから DB コンテナに接続できます。

2. フロントエンド(sns-camp-front)に API の URL を渡す方法

展開して設定例を表示する

sns-camp-front は NEXT_PUBLIC_API_URL でバックエンド API の URL を指定します。この変数は Next.js のビルド時に埋め込まれるため、docker-compose.yml の build.args としてビルド時に渡す必要があります。

Dockerfile で外部から値を受け取る命令として ARG(ビルド時の変数)と ENV(ビルド中・ランタイム両方で参照できる環境変数)があります。コンテナ講座では扱っていませんが、ARG でビルド時に値を受け取り、ENV でそれをランタイムまで引き継ぐ、という流れで Next.js の環境変数をイメージに焼き込めます。

sns-camp-front の Dockerfile の冒頭に、以下のように ARG と ENV を追記しておきます。

ARG NEXT_PUBLIC_API_URL
ENV NEXT_PUBLIC_API_URL=$NEXT_PUBLIC_API_URL

docker-compose.yml では、build.args で NEXT_PUBLIC_API_URL を渡します。ブラウザから API に到達できる URL を指定するため、ホスト側から見える http://localhost:8080/api/v1 を指定します(Compose ネットワーク内のサービス名ではなく、ブラウザが到達できる URL を使う点に注意してください)。

services:
  front:
    build:
      context: ./sns-camp-front
      args:
        NEXT_PUBLIC_API_URL: http://localhost:8080/api/v1
    ports:
      - "3000:3000"