Docker

You can containerize this stack and deploy it as a single container using Docker, or as a part of a group of containers using docker-compose. See ajcwebdev/ct3a-docker for an example repo based on this doc.

Docker Project Configuration

Please note that Next.js requires a different process for build time (available in the frontend, prefixed by NEXT_PUBLIC) and runtime environment, server-side only, variables. In this demo we are using two variables, pay attention to their positions in the Dockerfile, command-line arguments, and docker-compose.yml:

  • DATABASE_URL (used by the server)
  • NEXT_PUBLIC_CLIENTVAR (used by the client)

1. Next Configuration

In your next.config.mjs, add the standalone output-option configuration to reduce image size by automatically leveraging output traces:

export default defineNextConfig({
  reactStrictMode: true,
  swcMinify: true,
+ output: "standalone",
});

2. Remove Env Import

Remove the env-import from next.config.mjs so it isn’t pulled into the build image:

- import { env } from "./src/env/server.mjs";

3. Create dockerignore file

Click here and include contents in .dockerignore:
.env
Dockerfile
.dockerignore
node_modules
npm-debug.log
README.md
.next
.git

4. Create Dockerfile

Click here and include contents in Dockerfile:
##### DEPENDENCIES

FROM --platform=linux/amd64 node:16-alpine AS deps
RUN apk add --no-cache libc6-compat openssl
WORKDIR /app

# Install Prisma Client - remove if not using Prisma
COPY prisma ./

# 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 yarn global add pnpm && pnpm i; \
  else echo "Lockfile not found." && exit 1; \
  fi

##### BUILDER

FROM --platform=linux/amd64 node:16-alpine AS builder
ARG DATABASE_URL
ARG NEXT_PUBLIC_CLIENTVAR
WORKDIR /app
COPY --from=deps /app/node_modules ./node_modules
COPY . .

# ENV NEXT_TELEMETRY_DISABLED 1

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

##### RUNNER

FROM --platform=linux/amd64 node:16-alpine AS runner
WORKDIR /app

ENV NODE_ENV production
# ENV NEXT_TELEMETRY_DISABLED 1

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

COPY --from=builder /app/next.config.mjs ./
COPY --from=builder /app/public ./public
COPY --from=builder /app/package.json ./package.json

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

CMD ["node", "server.js"]

Notes

  • Emulation of --platform=linux/amd64 may not be necessary after moving to Node 18.
  • See node:alpine to understand why libc6-compat might be needed.
  • Next.js collects anonymous telemetry data about general usage. Uncomment the first instance of ENV NEXT_TELEMETRY_DISABLED 1 to disable telemetry during the build. Uncomment the second instance to disable telemetry during runtime.

Build and Run Image Locally

Build and run this image locally with the following commands:

docker build -t ct3a-docker --build-arg NEXT_PUBLIC_CLIENTVAR=clientvar .
docker run -p 3000:3000 -e DATABASE_URL="database_url_goes_here" ct3a-docker

Open localhost:3000 to see your running application.

Docker Compose

You can also use Docker Compose to build the image and run the container.

Follow steps 1-4 above, click here, and include contents in docker-compose.yml:
version: "3.9"
services:
  app:
    platform: "linux/amd64"
    build:
      context: .
      dockerfile: Dockerfile
      args:
        NEXT_PUBLIC_CLIENTVAR: "clientvar"
    working_dir: /app
    ports:
      - "3000:3000"
    image: t3-app
    environment:
      - DATABASE_URL=database_url_goes_here

Run this using the docker compose up command:

docker compose up

Open localhost:3000 to see your running application.

Deploy to Railway

You can use a PaaS such as Railway’s automated Dockerfile deployments to deploy your app. If you have the Railway CLI installed you can deploy your app with the following commands:

railway login
railway init
railway link
railway up
railway open

Go to “Variables” and include your DATABASE_URL. Then go to “Settings” and select “Generate Domain.” To view a running example on Railway, visit ct3a-docker.up.railway.app.

Useful Resources

ResourceLink
Dockerfile referencehttps://docs.docker.com/engine/reference/builder/
Compose file version 3 referencehttps://docs.docker.com/compose/compose-file/compose-file-v3/
Docker CLI referencehttps://docs.docker.com/engine/reference/commandline/docker/
Docker Compose CLI referencehttps://docs.docker.com/compose/reference/
Next.js Deployment with Docker Imagehttps://nextjs.org/docs/deployment#docker-image
Next.js in Dockerhttps://benmarte.com/blog/nextjs-in-docker/
Next.js with Docker Examplehttps://github.com/vercel/next.js/tree/canary/examples/with-docker
Create Docker Image of a Next.js apphttps://blog.tericcabrel.com/create-docker-image-nextjs-application/