Docker Build Documentation for Self Hosting or VPS

[wchorski]

I'm requesting documentation on how to build an optimized production app with Keystone (for use in a self hosted / VPS production server) 

My Example Repo

Here in my repo I've been toying with Dockerfiles and compose.yml configurations. Specifically a combination of

• nextjs-app-framework
• custom-next-auth-session
• And the regular Keystone Admin UI build

Image Sizes

I'm very happy with the Dockerfile.frontend.standalone build of the Keystone in Next 14 usually sizing down to a 300MB image. I feel like the separate Keystone Admin UI Dockerfile.backend could be optimized a bit more as it runs around 1.2GB in image size, most of the bulk coming from the copied over node_modules folder.

I'm hoping this open discussion helps us understand what is needed in a production image of the Keystone Admin UI app, and possibly utilizing Next's "standalone" output feature.

Dockerfile.frontend.standalone

This file is just the Next's example dockerfile with a few tweaks. Comes out to be a tiny ~300MB image size

ARG PRODUCTION_PLATFORM
FROM --platform=$PRODUCTION_PLATFORM node:20-alpine AS base

FROM base AS builder
# # 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

COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
COPY . ./

RUN \
  if [ -f yarn.lock ]; then yarn install --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
RUN yarn add sharp
RUN yarn next telemetry disable
# Learn more here: https://nextjs.org/telemetry
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
RUN yarn next telemetry disable

# Production image, copy all the files and run next
FROM base AS runner
WORKDIR /app
ENV NEXT_TELEMETRY_DISABLED 1

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

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

COPY --from=builder /app/public ./public
# COPY --from=builder /app/.keystone ./.keystone
# COPY --from=builder /app/schema.prisma ./schema.prisma

# 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

Dockerfile.backend

Here is where I feel like a bit of soul searching is needed as this image size sees a lot of bloat from needing the node_modules folder for production.

ARG PRODUCTION_PLATFORM
FROM --platform=$PRODUCTION_PLATFORM node:20-alpine AS base

FROM base AS builder
WORKDIR /app

COPY package.json ./
COPY yarn.lock ./
COPY . ./

RUN yarn install --production --frozen-lockfile
RUN yarn generate
RUN yarn ks:build
RUN yarn next telemetry disable

# Learn more here: https://nextjs.org/telemetry
ENV NEXT_TELEMETRY_DISABLED 1

FROM base AS runner
WORKDIR /app

COPY --from=builder /app/package.json ./package.json
# COPY --from=builder /app/yarn.lock .
# COPY --from=builder /app/.env .

COPY --from=builder /app/.keystone ./.keystone
COPY --from=builder /app/schema.prisma ./schema.prisma
COPY --from=builder /app/migrations ./migrations
# COPY --from=builder /app/next.config.mjs ./
## todo try getting rid of `public` folder?
# COPY --from=builder /app/public ./public
## todo do i need `node_modules`?
COPY --from=builder /app/node_modules ./node_modules
## todo maybe only copy over single modules like 
# COPY --from=builder /app/node_modules/@keystone-core ./node_modules/@keystone-core
# etc

EXPOSE 3001
ENV NODE_ENV production
ENV PORT 3001

CMD ["yarn", "ks:start"]