Skip to content

docs(readme): clarify Docker self-host prerequisites#4758

Open
byigitt wants to merge 1 commit into
simstudioai:mainfrom
byigitt:byigitt/issue-4383-docker-prereqs
Open

docs(readme): clarify Docker self-host prerequisites#4758
byigitt wants to merge 1 commit into
simstudioai:mainfrom
byigitt:byigitt/issue-4383-docker-prereqs

Conversation

@byigitt
Copy link
Copy Markdown

@byigitt byigitt commented May 27, 2026

This updates the self-hosted quickstart to call out the Compose v2 requirement and the memory headroom needed for the default Docker stack.

Testing:

  • Docs change only

Closes #4383

@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

@byigitt is attempting to deploy a commit to the Sim Team on Vercel.

A member of the Team first needs to authorize it.

@cursor
Copy link
Copy Markdown

cursor Bot commented May 27, 2026

PR Summary

Low Risk
Documentation-only change to README quickstart; no runtime or application code affected.

Overview
The Quickstart section now includes a Docker prerequisites block before the self-hosted paths. It states that both NPM and Compose self-hosting need Docker running with Compose v2 (docker compose), and that the legacy docker-compose binary is insufficient.

It also documents expected memory for the default stack (up to 8 GB app, 1 GB realtime, plus DB/overhead) and recommends at least 10 GB on Docker Desktop. The NPM package Note is tightened to mention Compose v2 instead of only “Docker installed and running.”

Reviewed by Cursor Bugbot for commit e28fc16. Bugbot is set up for automated code reviews on this repo. Configure here.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 27, 2026

Greptile Summary

This PR adds a new "Docker prerequisites" section to the README to clarify the Compose v2 requirement and the memory headroom needed before spinning up the default container stack.

  • Adds a pre-installation callout covering the Compose v2 plugin requirement and memory sizing guidance (8 GB app + 1 GB realtime + PostgreSQL overhead → 10 GB recommended on Docker Desktop), all of which are accurate against docker-compose.prod.yml and docker-compose.local.yml.
  • Updates the existing "Note" under the NPM self-hosted path to mention Compose v2 explicitly.

Confidence Score: 5/5

Documentation-only change; verified memory figures match the Compose files. Safe to merge.

The added text accurately reflects the memory limits defined in the Compose files and the Compose v2 requirement. The two nits (heading level and "reserves" vs "can use up to") are purely wording issues with no impact on the running software.

No files require special attention.

Important Files Changed

Filename Overview
README.md Adds "Docker prerequisites" section clarifying Compose v2 requirement and memory limits; memory figures are accurate against docker-compose files but minor wording and heading-hierarchy nits.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User wants to self-host] --> B{Has Docker with\nCompose v2?}
    B -- No --> C[Install Docker Desktop /\nDocker Engine + Compose v2 plugin]
    C --> D
    B -- Yes --> D{Docker Desktop\nmemory ≥ 10 GB?}
    D -- No --> E[Increase Docker Desktop\nmemory allocation]
    E --> F
    D -- Yes --> F{Which install path?}
    F --> G[NPM: npx simstudio]
    F --> H[Docker Compose:\ndocker compose up]
    G --> I[http://localhost:3000]
    H --> I
Loading

Reviews (1): Last reviewed commit: "docs(readme): clarify Docker self-host p..." | Re-trigger Greptile

Comment thread README.md

<a href="https://sim.ai" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/sim.ai-33c482?logo=data:image/svg%2bxml;base64,PHN2ZyB3aWR0aD0iNjE2IiBoZWlnaHQ9IjYxNiIgdmlld0JveD0iMCAwIDYxNiA2MTYiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CjxnIGNsaXAtcGF0aD0idXJsKCNjbGlwMF8xMTU5XzMxMykiPgo8cGF0aCBkPSJNNjE2IDBIMFY2MTZINjE2VjBaIiBmaWxsPSIjMzNjNDgyIi8+CjxwYXRoIGQ9Ik04MyAzNjUuNTY3SDExM0MxMTMgMzczLjgwNSAxMTYgMzgwLjM3MyAxMjIgMzg1LjI3MkMxMjggMzg5Ljk0OCAxMzYuMTExIDM5Mi4yODUgMTQ2LjMzMyAzOTIuMjg1QzE1Ny40NDQgMzkyLjI4NSAxNjYgMzkwLjE3MSAxNzIgMzg1LjkzOUMxNzcuOTk5IDM4MS40ODcgMTgxIDM3NS41ODYgMTgxIDM2OC4yMzlDMTgxIDM2Mi44OTUgMTc5LjMzMyAzNTguNDQyIDE3NiAzNTQuODhDMTcyLjg4OSAzNTEuMzE4IDE2Ny4xMTEgMzQ4LjQyMiAxNTguNjY3IDM0Ni4xOTZMMTMwIDMzOS41MTdDMTE1LjU1NSAzMzUuOTU1IDEwNC43NzggMzMwLjQ5OSA5Ny42NjY1IDMyMy4xNTFDOTAuNzc3NSAzMTUuODA0IDg3LjMzMzQgMzA2LjExOSA4Ny4zMzM0IDI5NC4wOTZDODcuMzMzNCAyODQuMDc2IDg5Ljg4OSAyNzUuMzkyIDk0Ljk5OTYgMjY4LjA0NUMxMDAuMzMzIDI2MC42OTcgMTA3LjU1NSAyNTUuMDIgMTE2LjY2NiAyNTEuMDEyQzEyNiAyNDcuMDA0IDEzNi42NjcgMjQ1IDE0OC42NjYgMjQ1QzE2MC42NjcgMjQ1IDE3MSAyNDcuMTE2IDE3OS42NjcgMjUxLjM0NkMxODguNTU1IDI1NS41NzYgMTk1LjQ0NCAyNjEuNDc3IDIwMC4zMzMgMjY5LjA0N0MyMDUuNDQ0IDI3Ni42MTcgMjA4LjExMSAyODUuNjM0IDIwOC4zMzMgMjk2LjA5OUgxNzguMzMzQzE3OC4xMTEgMjg3LjYzOCAxNzUuMzMzIDI4MS4wNyAxNjkuOTk5IDI3Ni4zOTRDMTY0LjY2NiAyNzEuNzE5IDE1Ny4yMjIgMjY5LjM4MSAxNDcuNjY3IDI2OS4zODFDMTM3Ljg4OSAyNjkuMzgxIDEzMC4zMzMgMjcxLjQ5NiAxMjUgMjc1LjcyNkMxMTkuNjY2IDI3OS45NTcgMTE3IDI4NS43NDYgMTE3IDI5My4wOTNDMTE3IDMwNC4wMDMgMTI1IDMxMS40NjIgMTQxIDMxNS40N0wxNjkuNjY3IDMyMi40ODNDMTgzLjQ0NSAzMjUuNiAxOTMuNzc4IDMzMC43MjIgMjAwLjY2NyAzMzcuODQ3QzIwNy41NTUgMzQ0Ljc0OSAyMTEgMzU0LjIxMiAyMTEgMzY2LjIzNUMyMTEgMzc2LjQ3NyAyMDguMjIyIDM4NS40OTQgMjAyLjY2NiAzOTMuMjg3QzE5Ny4xMTEgNDAwLjg1NyAxODkuNDQ0IDQwNi43NTggMTc5LjY2NyA0MTAuOTg5QzE3MC4xMTEgNDE0Ljk5NiAxNTguNzc4IDQxNyAxNDUuNjY3IDQxN0MxMjYuNTU1IDQxNyAxMTEuMzMzIDQxMi4zMjUgOTkuOTk5NyA0MDIuOTczQzg4LjY2NjggMzkzLjYyMSA4MyAzODEuMTUzIDgzIDM2NS41NjdaIiBmaWxsPSJ3aGl0ZSIvPgo8cGF0aCBkPSJNMjMyLjI5MSA0MTNWMjUwLjA4MkMyNDQuNjg0IDI1NC42MTQgMjUwLjE0OCAyNTQuNjE0IDI2My4zNzEgMjUwLjA4MlY0MTNIMjMyLjI5MVpNMjQ3LjUgMjM5LjMxM0MyNDEuOTkgMjM5LjMxMyAyMzcuMTQgMjM3LjMxMyAyMzIuOTUyIDIzMy4zMTZDMjI4Ljk4NCAyMjkuMDk1IDIyNyAyMjQuMjA5IDIyNyAyMTguNjU2QzIyNyAyMTIuODgyIDIyOC45ODQgMjA3Ljk5NSAyMzIuOTUyIDIwMy45OTdDMjM3LjE0IDE5OS45OTkgMjQxLjk5IDE5OCAyNDcuNSAxOThDMjUzLjIzMSAxOTggMjU4LjA4IDE5OS45OTkgMjYyLjA0OSAyMDMuOTk3QzI2Ni4wMTYgMjA3Ljk5NSAyNjggMjEyLjg4MiAyNjggMjE4LjY1NkMyNjggMjI0LjIwOSAyNjYuMDE2IDIyOS4wOTUgMjYyLjA0OSAyMzMuMzE2QzI1OC4wOCAyMzcuMzEzIDI1My4yMzEgMjM5LjMxMyAyNDcuNSAyMzkuMzEzWiIgZmlsbD0id2hpdGUiLz4KPHBhdGggZD0iTTMxOS4zMzMgNDEzSDI4OFYyNDkuNjc2SDMxNlYyNzcuMjMzQzMxOS4zMzMgMjY4LjEwNCAzMjUuNzc4IDI2MC4zNjQgMzM0LjY2NyAyNTQuMzUyQzM0My43NzggMjQ4LjExNyAzNTQuNzc4IDI0NSAzNjcuNjY3IDI0NUMzODIuMTExIDI0NSAzOTQuMTEyIDI0OC44OTcgNDAzLjY2NyAyNTYuNjlDNDEzLjIyMiAyNjQuNDg0IDQxOS40NDQgMjc0LjgzNyA0MjIuMzM0IDI4Ny43NTJINDE2LjY2N0M0MTguODg5IDI3NC44MzcgNDI1IDI2NC40ODQgNDM1IDI1Ni42OUM0NDUgMjQ4Ljg5NyA0NTcuMzM0IDI0NSA0NzIgMjQ1QzQ5MC42NjYgMjQ1IDUwNS4zMzQgMjUwLjQ1NSA1MTYgMjYxLjM2NkM1MjYuNjY3IDI3Mi4yNzYgNTMyIDI4Ny4xOTUgNTMyIDMwNi4xMjFWNDEzSDUwMS4zMzNWMzEzLjgwNEM1MDEuMzMzIDMwMC44ODkgNDk4IDI5MC45ODEgNDkxLjMzMyAyODQuMDc4QzQ4NC44ODkgMjc2Ljk1MiA0NzYuMTExIDI3My4zOSA0NjUgMjczLjM5QzQ1Ny4yMjIgMjczLjM5IDQ1MC4zMzMgMjc1LjE3MSA0NDQuMzM0IDI3OC43MzRDNDM4LjU1NiAyODIuMDc0IDQzNCAyODYuOTcyIDQzMC42NjcgMjkzLjQzQzQyNy4zMzMgMjk5Ljg4NyA0MjUuNjY3IDMwNy40NTcgNDI1LjY2NyAzMTYuMTQxVjQxM0gzOTQuNjY3VjMxMy40NjlDMzk0LjY2NyAzMDAuNTU1IDM5MS40NDUgMjkwLjc1OCAzODUgMjg0LjA3OEMzNzguNTU2IDI3Ny4xNzUgMzY5Ljc3OCAyNzMuNzI0IDM1OC42NjcgMjczLjcyNEMzNTAuODg5IDI3My43MjQgMzQ0IDI3NS41MDUgMzM4IDI3OS4wNjhDMzMyLjIyMiAyODIuNDA4IDMyNy42NjcgMjg3LjMwNyAzMjQuMzMzIDI5My43NjNDMzIxIDI5OS45OTggMzE5LjMzMyAzMDcuNDU3IDMxOS4zMzMgMzE2LjE0MVY0MTNaIiBmaWxsPSJ3aGl0ZSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzExNTlfMzEzIj4KPHJlY3Qgd2lkdGg9IjYxNiIgaGVpZ2h0PSI2MTYiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+&logoColor=white" alt="Sim.ai"></a>

#### Docker prerequisites
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The new section uses an #### heading but is placed immediately before a ### heading (### Self-hosted: NPM Package), making it a deeper level than the sections it introduces. It should be promoted to ### to sit at the same level as the self-hosted sections that follow.

Suggested change
#### Docker prerequisites
### Docker prerequisites

Comment thread README.md

Both self-hosted options require Docker to be installed and running with the Compose v2 plugin available (`docker compose version`). The legacy standalone `docker-compose` binary is not enough for the commands below.

The default container stack reserves up to 8 GB for the app and 1 GB for realtime, plus PostgreSQL and Docker overhead. On Docker Desktop, allocate at least 10 GB of memory before starting the stack.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Docker deploy.resources.limits.memory caps the maximum memory a container may consume; it does not pre-reserve that allocation on the host. "reserves up to" implies upfront reservation, which could mislead users into thinking 9 GB must always be free even when containers are idle. "can use up to" or "is limited to" is more accurate.

Suggested change
The default container stack reserves up to 8 GB for the app and 1 GB for realtime, plus PostgreSQL and Docker overhead. On Docker Desktop, allocate at least 10 GB of memory before starting the stack.
The default container stack can use up to 8 GB for the app and 1 GB for realtime, plus PostgreSQL and Docker overhead. On Docker Desktop, allocate at least 10 GB of memory before starting the stack.

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.

Clarify Docker Compose v2 and memory prerequisites in the self-hosted quickstart

1 participant