Next.jsのDocker開発メモ

マルチステージビルド

開発環境、ビルド環境、実行環境を段階的に構築することで各imageのサイズを抑えることができる。

<!-- 共通部分 -->
FROM node:18-alpine AS base

<!-- 開発環境 -->
# Install dependencies only when needed
FROM base AS deps
# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
RUN apk add --no-cache libc6-compat
WORKDIR /app

# Install dependencies based on the preferred package manager
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
RUN \
  if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
  elif [ -f package-lock.json ]; then npm ci; \
  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm i --frozen-lockfile; \
  else echo "Lockfile not found." && exit 1; \
  fi

<!-- ビルド環境 -->
# Rebuild the source code only when needed
FROM base AS builder
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .

# Next.js collects completely anonymous telemetry data about general usage.
# Learn more here: https://nextjs.org/telemetry
# Uncomment the following line in case you want to disable telemetry during the build.
# ENV NEXT_TELEMETRY_DISABLED 1

RUN \
  if [ -f yarn.lock ]; then yarn run build; \
  elif [ -f package-lock.json ]; then npm run build; \
  elif [ -f pnpm-lock.yaml ]; then corepack enable pnpm && pnpm run build; \
  else echo "Lockfile not found." && exit 1; \
  fi

<!-- 実行環境 -->
# Production image, copy all the files and run next
FROM base AS runner
WORKDIR /app

ENV NODE_ENV production
# Uncomment the following line in case you want to disable telemetry during runtime.
# ENV NEXT_TELEMETRY_DISABLED 1

RUN addgroup --system --gid 1001 nodejs
RUN adduser --system --uid 1001 nextjs

COPY --from=builder /app/public ./public

# Set the correct permission for prerender cache
RUN mkdir .next
RUN chown nextjs:nodejs .next

# Automatically leverage output traces to reduce image size
# https://nextjs.org/docs/advanced-features/output-file-tracing
COPY --from=builder --chown=nextjs:nodejs /app/.next/standalone ./
COPY --from=builder --chown=nextjs:nodejs /app/.next/static ./.next/static

USER nextjs

EXPOSE 3000

ENV PORT 3000

# server.js is created by next build from the standalone output
# https://nextjs.org/docs/pages/api-reference/next-config-js/output
CMD HOSTNAME="0.0.0.0" node server.js

standaloneモード

https://nextjs.org/docs/app/api-reference/next-config-js/output
通常、Next.jsをプロダクションビルドする時には以下の流れになる。

開発

yarn run dev

ビルド

yarn run build

実行

yarn run run

この時、実行環境ではビルドした.nextフォルダと依存するパッケージをinstallしたnode_modulesが必要となる。
コンテナでホスティングする場合、依存関係等々の容量がコンテナサイズの不要な拡大に影響していた。

そこでstandaloneモードを利用する。standaloneモードでビルドを実行すると.nextフォルダは以下にホスティングに必要なすべてのファイルが集約される。
また、実行には生成されるserver.jsを用いる形になる。流れを以下に示す。

開発

yarn run dev

ビルド設定

next.config.js

module.exports = {
  output: 'standalone',
}

ビルド

yarn run build

実行

node server.js