Conversation
The system requirements were buried at the bottom of getting-started as "A Note on System Requirements." Gave them their own page under Reference so they're easier to find and link to. Getting-started keeps the quick bullet list and links out to the new page for the full explanation.
The install command now reads total memory from /proc/meminfo and available disk space via syscall.Statfs before proceeding. If the system falls below our documented minimums (4 GB memory, 50 GB storage), installation is blocked with a friendly explanation and a link to the docs. Systems between minimum and recommended (8 GB / 100 GB) get a warning but can proceed. A --skip-system-check flag lets power users bypass the check.
Published docs live at miren.md, not miren.dev/docs. Adding this so we stop getting it wrong in CLI output and error messages.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughThis pull request implements system requirements validation for server installation. Changes include adding memory and disk space checks in the install workflow with a new Comment |
Mary managed to install miren on a 512 MB server, which happily accepted the install and then promptly died during a deploy. The installer had no guardrails — it checked for root and systemd but never looked at whether the machine could actually run everything.
We already document minimum requirements in the getting-started guide (4 GB memory, 50 GB storage), so this wires those thresholds into the install flow right after the existing prerequisite checks. If you're below the minimums, the install stops with a clear message explaining what's needed and links to the docs. If you're in the "it'll probably work but we wouldn't recommend it" zone (between minimum and recommended), you get a warning but things keep moving.
For unusual environments where we can't read
/proc/meminfoor stat the filesystem, we warn but don't block — no sense locking someone out just because their system is weird. And--skip-system-checkis there for anyone who knows what they're doing and wants to push through anyway.While we were at it, we moved the system requirements docs out of a buried anchor in getting-started and onto their own reference page, so the CLI has something stable to link to and users can actually find it. Also added a note to CLAUDE.md about the correct docs URL (
miren.md, notmiren.dev/docs) since we keep getting that wrong.Only applies to the systemd (bare metal) install path for now — Docker installs are a different story.
Closes MIR-748