Skip to content

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

@20bytes

Description

@20bytes

Hi maintainers, I noticed a concrete issue while reviewing the repository and wanted to write it up clearly in case it is useful.

Summary

The self-hosted quickstart in the top-level README could be clearer about its runtime prerequisites before users run the first local command.

Why It May Be Worth Tracking

Right now the README says Docker must be installed and running, but the shown command specifically depends on the Compose v2 plugin and the self-hosted stack also has fairly heavy memory expectations. That can turn the first local setup attempt into trial-and-error even when users are otherwise following the docs carefully.

What I Observed

  • The README self-hosted path shows npx simstudio and docker compose -f docker-compose.prod.yml up -d as the main entry points.
  • The README note only says that Docker must be installed and running; it does not explicitly call out a Compose v2 requirement.
  • On one Linux host I checked, docker --version succeeds, but docker compose is unavailable while only legacy docker-compose is installed.
  • docker-compose.prod.yml sets an 8G memory limit for simstudio and a 1G limit for realtime, so the self-hosted path is not especially lightweight even before accounting for PostgreSQL and Docker overhead.
  • The more explicit needs 12GB+ RAM guidance currently appears in the generated Cursor setup badge text, not in the main self-hosted quickstart itself.

Possible Direction

It may help to add a short prerequisites block near the self-hosted quickstart that explicitly says the Docker path expects the Compose v2 plugin and that users should plan for roughly 10GB+ of container memory headroom for the default stack.

Context

This looks like a first-run setup clarity issue rather than an application bug. It is especially relevant for people trying the self-hosted path on ordinary laptops or workstations before deciding whether to use the cloud-hosted option.

If I misread the intended setup or this is already tracked elsewhere, feel free to point me to the right place or close this. I wanted to surface it because it looked concrete and potentially actionable.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions