Skip to content

docs: add memory requirements and troubleshooting to README #19

Description

@bdougie

Problem

Railway deployments are failing with FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory during container startup. The container crashes ~38 seconds after starting, before the gateway can accept connections.

Root Cause

The Docker build compiles clawdbot from source (pnpm build and pnpm ui:build), which creates a large runtime that can exceed Railway's default memory limits (512MB on free tier, 1GB on starter).

Proposed Solution

Update the README with:

  1. Minimum Requirements Section

    • Recommended memory: 2GB+
    • Railway tier recommendation: Hobby plan or higher
  2. Troubleshooting Section
    Add entry for OOM errors with fixes:

    • Quick fix: Add Node memory flag to Dockerfile:
      CMD ["node", "--max-old-space-size=2048", "src/server.js"]
    • Long-term: Upgrade Railway plan for more memory
    • Alternative: Use pre-built releases instead of building from source
  3. Known Issues

    • Link to related issues about memory consumption
    • Note about recent builds having larger memory footprint

Related

  • Broken dashboard after setup #15 - Users experiencing crashes after setup (may be OOM-related)
  • Memory logs show: Scavenge 472.2 (486.6) -> 471.7 (487.4) MB, pooled: 0 MB

This would help users avoid frustration and provide clear solutions when they hit memory limits.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions