Skip to content

Improve visibility and platform-specific instructions for System Resource Limits in Quick Start #17028

@Jai-76

Description

@Jai-76

Description: Problem: New users frequently encounter startup warnings or failures related to system resource limits (e.g., "max open files" or "somaxconn") when following the Quick Start guide. While these requirements are mentioned, they are easily overlooked or lack clarity for different deployment methods.

Current Behavior: The "Prerequisites" section lists commands like sudo sysctl -w net.core.somaxconn=65535 and ulimit -n 65535. However:

These are strictly Linux-centric and may confuse Windows or macOS users.

Users deploying via Docker often miss that these settings must be applied to the host machine or explicitly handled in the Docker run command/compose file.

The warnings appear in logs after a failed start, but the troubleshooting link in the documentation is not always obvious.

Suggested Improvement:

Create a dedicated "System Configuration" subsection in the Quick Start guide that is visually distinct (e.g., using a Warning or Tip block).

Add Docker-specific instructions: Explain that ulimit settings might need to be passed to the container

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