Skip to content

docs: add Edge standalone deployment instructions #1223

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
HTHou merged 1 commit into from
Sep 14, 2026
Merged

docs: add Edge standalone deployment instructions #1223

Show file tree
Hide file tree
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
28 changes: 25 additions & 3 deletions ...rGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,29 @@ Set the following parameters in `conf/iotdb-system.properties`. Refer to `conf/i
| dn_schema_region_consensus_port | Port used for metadata replica consensus protocol communication | 10760 | 10760 | This parameter cannot be modified after the first startup. |
| dn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Use `cn_internal_address:cn_internal_port` | This parameter cannot be modified after the first startup. |

### 2.4 Start ConfigNode
### 2.4 Start and Stop the Edge Edition

Starting from V2.0.11, IoTDB provides an Edge edition package for edge deployment scenarios. The Edge edition uses simplified startup and shutdown scripts, so you do not need to start or stop ConfigNode and DataNode separately.

Run the following commands from the IoTDB root directory:

```shell
# Linux/macOS: start the Edge edition
./sbin/start-edge.sh

# Linux/macOS: stop the Edge edition
./sbin/stop-edge.sh

# Windows: start the Edge edition
.\sbin\windows\start-edge.bat

# Windows: stop the Edge edition
.\sbin\windows\stop-edge.bat
```

If you are using the Edge edition package, skip the steps below for starting ConfigNode and DataNode separately.

### 2.5 Start ConfigNode

Navigate to the `sbin` directory and start ConfigNode:

Expand All @@ -166,7 +188,7 @@ If the startup fails, refer to the [Common Issues](#3-common-issues)。 section



### 2.5 Start DataNode
### 2.6 Start DataNode

Navigate to the `sbin` directory of IoTDB and start the DataNode:

Expand All @@ -182,7 +204,7 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
.\sbin\windows\start-datanode.bat
```

### 2.6 Start CLI
### 2.7 Start CLI

Enter the IoTDB CLI.

Expand Down
28 changes: 25 additions & 3 deletions ...erGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,29 @@ Open the DataNode configuration file (./conf/iotdb-system. properties file) and

> ❗️Attention: Editors such as VSCode Remote do not have automatic configuration saving function. Please ensure that the modified files are saved persistently, otherwise the configuration items will not take effect

### 2.4 Start ConfigNode
### 2.4 Start and Stop the Edge Edition

Starting from V2.0.11, IoTDB provides an Edge edition package for edge deployment scenarios. The Edge edition uses simplified startup and shutdown scripts, so you do not need to start or stop ConfigNode and DataNode separately.

Run the following commands from the IoTDB root directory:

```shell
# Linux/macOS: start the Edge edition
./sbin/start-edge.sh

# Linux/macOS: stop the Edge edition
./sbin/stop-edge.sh

# Windows: start the Edge edition
.\sbin\windows\start-edge.bat

# Windows: stop the Edge edition
.\sbin\windows\stop-edge.bat
```

If you are using the Edge edition package, skip the steps below for starting ConfigNode and DataNode separately.

### 2.5 Start ConfigNode

Enter the sbin directory of iotdb and start confignode

Expand All @@ -154,7 +176,7 @@ Enter the sbin directory of iotdb and start confignode
```
If the startup fails, please refer to [Common Questions](#common-questions).

### 2.5 Start DataNode
### 2.6 Start DataNode

Enter the sbin directory of iotdb and start datanode:

Expand All @@ -171,7 +193,7 @@ cd sbin
.\windows\start-datanode.bat
```

### 2.6 Verify Deployment
### 2.7 Verify Deployment

Can be executed directly/ Cli startup script in sbin directory:

Expand Down
28 changes: 25 additions & 3 deletions ...rGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,29 @@ Set the following parameters in `conf/iotdb-system.properties`. Refer to `conf/i
| dn_schema_region_consensus_port | Port used for metadata replica consensus protocol communication | 10760 | 10760 | This parameter cannot be modified after the first startup. |
| dn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Use `cn_internal_address:cn_internal_port` | This parameter cannot be modified after the first startup. |

### 2.4 Start ConfigNode
### 2.4 Start and Stop the Edge Edition

Starting from V2.0.11, IoTDB provides an Edge edition package for edge deployment scenarios. The Edge edition uses simplified startup and shutdown scripts, so you do not need to start or stop ConfigNode and DataNode separately.

Run the following commands from the IoTDB root directory:

```shell
# Linux/macOS: start the Edge edition
./sbin/start-edge.sh

# Linux/macOS: stop the Edge edition
./sbin/stop-edge.sh

# Windows: start the Edge edition
.\sbin\windows\start-edge.bat

# Windows: stop the Edge edition
.\sbin\windows\stop-edge.bat
```

If you are using the Edge edition package, skip the steps below for starting ConfigNode and DataNode separately.

### 2.5 Start ConfigNode

Navigate to the `sbin` directory and start ConfigNode:

Expand All @@ -166,7 +188,7 @@ If the startup fails, refer to the [Common Issues](#3-common-issues)。 section



### 2.5 Start DataNode
### 2.6 Start DataNode

Navigate to the `sbin` directory of IoTDB and start the DataNode:

Expand All @@ -182,7 +204,7 @@ Navigate to the `sbin` directory of IoTDB and start the DataNode:
.\sbin\windows\start-datanode.bat
```

### 2.6 Start CLI
### 2.7 Start CLI

Enter the IoTDB CLI.

Expand Down
28 changes: 25 additions & 3 deletions src/UserGuide/latest/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,29 @@ Open the DataNode configuration file (./conf/iotdb-system. properties file) and

> ❗️Attention: Editors such as VSCode Remote do not have automatic configuration saving function. Please ensure that the modified files are saved persistently, otherwise the configuration items will not take effect

### 2.4 Start ConfigNode
### 2.4 Start and Stop the Edge Edition

Starting from V2.0.11, IoTDB provides an Edge edition package for edge deployment scenarios. The Edge edition uses simplified startup and shutdown scripts, so you do not need to start or stop ConfigNode and DataNode separately.

Run the following commands from the IoTDB root directory:

```shell
# Linux/macOS: start the Edge edition
./sbin/start-edge.sh

# Linux/macOS: stop the Edge edition
./sbin/stop-edge.sh

# Windows: start the Edge edition
.\sbin\windows\start-edge.bat

# Windows: stop the Edge edition
.\sbin\windows\stop-edge.bat
```

If you are using the Edge edition package, skip the steps below for starting ConfigNode and DataNode separately.

### 2.5 Start ConfigNode

Enter the sbin directory of iotdb and start confignode

Expand All @@ -154,7 +176,7 @@ Enter the sbin directory of iotdb and start confignode
```
If the startup fails, please refer to [Common Questions](#common-questions).

### 2.5 Start DataNode
### 2.6 Start DataNode

Enter the sbin directory of iotdb and start datanode:

Expand All @@ -171,7 +193,7 @@ cd sbin
.\windows\start-datanode.bat
```

### 2.6 Verify Deployment
### 2.7 Verify Deployment

Can be executed directly/ Cli startup script in sbin directory:

Expand Down
28 changes: 25 additions & 3 deletions ...rGuide/Master/Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,29 @@ DataNode 配置
| dn_schema_region_consensus_port | DataNode用于元数据副本共识协议通信使用的端口 | 10760 | 10760 | 首次启动后不能修改 |
| dn_seed_config_node | 节点注册加入集群时连接的ConfigNode地址,即cn_internal_address:cn_internal_port | 127.0.0.1:10710 | cn_internal_address:cn_internal_port | 首次启动后不能修改 |

### 2.4 启动 ConfigNode 节点
### 2.4 Edge 版启动与停止

自 V2.0.11 起，IoTDB 提供面向边缘部署场景的 Edge 版安装包。Edge 版使用精简的启停脚本，无需分别启动或停止 ConfigNode 和 DataNode。

在 IoTDB 根目录下执行以下命令：

```shell
# Linux/macOS：启动 Edge 版
./sbin/start-edge.sh

# Linux/macOS：停止 Edge 版
./sbin/stop-edge.sh

# Windows：启动 Edge 版
.\sbin\windows\start-edge.bat

# Windows：停止 Edge 版
.\sbin\windows\stop-edge.bat
```

如果使用 Edge 版安装包，请跳过下方分别启动 ConfigNode 和 DataNode 的步骤。

### 2.5 启动 ConfigNode 节点

进入iotdb的sbin目录下，启动confignode

Expand All @@ -148,7 +170,7 @@ DataNode 配置

如果启动失败，请参考下方[常见问题](#常见问题)。

### 2.5 启动 DataNode 节点
### 2.6 启动 DataNode 节点

进入iotdb的sbin目录下，启动datanode：

Expand All @@ -163,7 +185,7 @@ DataNode 配置
# V2.0.4.x 版本及之后
.\sbin\windows\start-datanode.bat
```
### 2.6 启动 CLI
### 2.7 启动 CLI

表模型 CLI 进入命令：

Expand Down
28 changes: 25 additions & 3 deletions ...erGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,29 @@ cd apache-iotdb-{version}-all-bin

> ❗️注意：VSCode Remote等编辑器无自动保存配置功能，请确保修改的文件被持久化保存，否则配置项无法生效

### 2.4 启动ConfigNode 节点
### 2.4 Edge 版启动与停止

自 V2.0.11 起，IoTDB 提供面向边缘部署场景的 Edge 版安装包。Edge 版使用精简的启停脚本，无需分别启动或停止 ConfigNode 和 DataNode。

在 IoTDB 根目录下执行以下命令：

```shell
# Linux/macOS：启动 Edge 版
./sbin/start-edge.sh

# Linux/macOS：停止 Edge 版
./sbin/stop-edge.sh

# Windows：启动 Edge 版
.\sbin\windows\start-edge.bat

# Windows：停止 Edge 版
.\sbin\windows\stop-edge.bat
```

如果使用 Edge 版安装包，请跳过下方分别启动 ConfigNode 和 DataNode 的步骤。

### 2.5 启动ConfigNode 节点

进入iotdb的sbin目录下，启动confignode

Expand All @@ -151,7 +173,7 @@ cd apache-iotdb-{version}-all-bin
```
如果启动失败，请参考[常见问题](#常见问题)。

### 2.5 启动DataNode 节点
### 2.6 启动DataNode 节点

进入iotdb的sbin目录下，启动datanode：

Expand All @@ -168,7 +190,7 @@ cd sbin
.\windows\start-datanode.bat
```

### 2.6 验证部署
### 2.7 验证部署

可直接执行 ./sbin 目录下的 Cli 启动脚本：

Expand Down
28 changes: 25 additions & 3 deletions ...rGuide/latest-Table/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,29 @@ DataNode 配置
| dn_schema_region_consensus_port | DataNode用于元数据副本共识协议通信使用的端口 | 10760 | 10760 | 首次启动后不能修改 |
| dn_seed_config_node | 节点注册加入集群时连接的ConfigNode地址,即cn_internal_address:cn_internal_port | 127.0.0.1:10710 | cn_internal_address:cn_internal_port | 首次启动后不能修改 |

### 2.4 启动 ConfigNode 节点
### 2.4 Edge 版启动与停止

自 V2.0.11 起，IoTDB 提供面向边缘部署场景的 Edge 版安装包。Edge 版使用精简的启停脚本，无需分别启动或停止 ConfigNode 和 DataNode。

在 IoTDB 根目录下执行以下命令：

```shell
# Linux/macOS：启动 Edge 版
./sbin/start-edge.sh

# Linux/macOS：停止 Edge 版
./sbin/stop-edge.sh

# Windows：启动 Edge 版
.\sbin\windows\start-edge.bat

# Windows：停止 Edge 版
.\sbin\windows\stop-edge.bat
```

如果使用 Edge 版安装包，请跳过下方分别启动 ConfigNode 和 DataNode 的步骤。

### 2.5 启动 ConfigNode 节点

进入iotdb的sbin目录下，启动confignode

Expand All @@ -148,7 +170,7 @@ DataNode 配置

如果启动失败，请参考下方[常见问题](#常见问题)。

### 2.5 启动 DataNode 节点
### 2.6 启动 DataNode 节点

进入iotdb的sbin目录下，启动datanode：

Expand All @@ -163,7 +185,7 @@ DataNode 配置
# V2.0.4.x 版本及之后
.\sbin\windows\start-datanode.bat
```
### 2.6 启动 CLI
### 2.7 启动 CLI

表模型 CLI 进入命令：

Expand Down
28 changes: 25 additions & 3 deletions ...zh/UserGuide/latest/Deployment-and-Maintenance/Stand-Alone-Deployment_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,29 @@ cd apache-iotdb-{version}-all-bin

> ❗️注意：VSCode Remote等编辑器无自动保存配置功能，请确保修改的文件被持久化保存，否则配置项无法生效

### 2.4 启动ConfigNode 节点
### 2.4 Edge 版启动与停止

自 V2.0.11 起，IoTDB 提供面向边缘部署场景的 Edge 版安装包。Edge 版使用精简的启停脚本，无需分别启动或停止 ConfigNode 和 DataNode。

在 IoTDB 根目录下执行以下命令：

```shell
# Linux/macOS：启动 Edge 版
./sbin/start-edge.sh

# Linux/macOS：停止 Edge 版
./sbin/stop-edge.sh

# Windows：启动 Edge 版
.\sbin\windows\start-edge.bat

# Windows：停止 Edge 版
.\sbin\windows\stop-edge.bat
```

如果使用 Edge 版安装包，请跳过下方分别启动 ConfigNode 和 DataNode 的步骤。

### 2.5 启动ConfigNode 节点

进入iotdb的sbin目录下，启动confignode

Expand All @@ -151,7 +173,7 @@ cd apache-iotdb-{version}-all-bin
```
如果启动失败，请参考[常见问题](#常见问题)。

### 2.5 启动DataNode 节点
### 2.6 启动DataNode 节点

进入iotdb的sbin目录下，启动datanode：

Expand All @@ -168,7 +190,7 @@ cd sbin
.\windows\start-datanode.bat
```

### 2.6 验证部署
### 2.7 验证部署

可直接执行 ./sbin 目录下的 Cli 启动脚本：

Expand Down