Skip to content

Improve Quick Start documentation for system resource limits #17213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JackieTien97 merged 1 commit into from
Feb 24, 2026
Merged

Improve Quick Start documentation for system resource limits #17213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,29 @@ To use IoTDB, you need to have:
# FreeBSD or Darwin
> sudo sysctl -w kern.ipc.somaxconn=65535
```

> ⚠️ **Important: System Resource Limits**
>
> IoTDB requires sufficient system resource limits to start correctly.
> If these limits are not configured, IoTDB may fail to start or emit warnings such as
> `"too many open files"` or `"connection reset"` in the logs.
>
> **Linux / macOS**
> ```bash
> ulimit -n 65535
> sudo sysctl -w net.core.somaxconn=65535
> ```
>
> **Docker Users**
> When running IoTDB in Docker, these limits must be applied on the **host machine**
> or explicitly passed to the container:
> ```bash
> docker run --ulimit nofile=65535:65535 ...
> ```
>
> **Windows Users**
> These commands are not applicable on Windows.
> Please follow the Windows installation steps below and ensure sufficient system resources.
### Linux

(This guide is based on an installation of Ubuntu 22.04.)
Expand Down
Loading