Skip to content

docs: document Docker build memory requirement - #1214

Open
Wenjunyun123 wants to merge 1 commit into
f:mainfrom
Wenjunyun123:codex/document-docker-build-memory
Open

docs: document Docker build memory requirement#1214
Wenjunyun123 wants to merge 1 commit into
f:mainfrom
Wenjunyun123:codex/document-docker-build-memory

Conversation

@Wenjunyun123

@Wenjunyun123 Wenjunyun123 commented Jun 26, 2026

Copy link
Copy Markdown

Summary:

  • Documents the memory needed for local Docker production builds.
  • Notes that exit code 137 usually indicates an OOM kill.
  • Points users to the pre-built image when local Docker memory is constrained.

Testing:

  • git diff --check

Fixes #1083

AI assistance: This documentation fix was prepared with AI assistance and reviewed before submission.

Updated the Docker quick-start docs to warn that local production builds require enough Docker memory.

  • Added guidance that an exit code 137 during the build usually means the process was killed for running out of memory.
  • Pointed users to increase Docker memory or use the pre-built image when local resources are constrained.
  • Documentation-only change; validated with git diff --check.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 93710e4f-75ed-4a7b-8a6a-ea4d4d2ef7b2

📥 Commits

Reviewing files that changed from the base of the PR and between 2588522 and ccdf91f.

📒 Files selected for processing (1)
  • DOCKER.md

📝 Walkthrough

Walkthrough

The Docker quick-start instructions now note that local builds run a full Next.js production build, may exit with code 137 when Docker memory is too low, and suggest increasing the Docker memory limit or using the pre-built image.

Changes

Docker documentation note

Layer / File(s) Summary
Local build memory note
DOCKER.md
The “To build locally” section now includes a warning about production build memory usage and exit code 137 out-of-memory failures.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • f/prompts.chat#1133: Also updates DOCKER.md with guidance about Docker memory limits and 137 exits during local or first-run builds.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting Docker build memory requirements.
Linked Issues check ✅ Passed The docs update matches issue #1083 by explaining exit code 137 as likely OOM and pointing users to increase Docker memory or use the pre-built image.
Out of Scope Changes check ✅ Passed The pull request appears scoped to the documented Docker memory note and adds no unrelated code changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Report: local docker fail at first run

1 participant