This is an automated email from the ASF dual-hosted git repository.
jackietien pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 8cfb49d1eb6 Improve Quick Start documentation for system resource
limits (#17213)
8cfb49d1eb6 is described below
commit 8cfb49d1eb6334375d6bfe1c5702dbb5addf9f1e
Author: ShauryaChauhan1411 <[email protected]>
AuthorDate: Tue Feb 24 12:47:10 2026 +0530
Improve Quick Start documentation for system resource limits (#17213)
---
README.md | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/README.md b/README.md
index 6f6526c53df..0e93c9b7ede 100644
--- a/README.md
+++ b/README.md
@@ -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.)
