Merge pull request #32 from yuxi311/main

docs: display rpm and deb installation instructions
emqx · Dec 24, 2023 · bc2cdcf · bc2cdcf
2 parents a2eb251 + 00c3d08
commit bc2cdcf
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 62 deletions.
diff --git a/directory.json b/directory.json
@@ -32,6 +32,14 @@
           "title": "使用 .tar.gz 包安装",
           "path": "installation/tar.gz"
         },
+        {
+          "title": "使用 rpm 包安装",
+          "path": "installation/centos"
+        },
+        {
+          "title": "使用 deb 包安装",
+          "path": "installation/ubuntu"
+        },
         {
           "title": "通过 Docker 部署",
           "path": "installation/docker"
@@ -852,6 +860,14 @@
           "title": "Installation with .tar.gz Package",
           "path": "installation/tar.gz"
         },
+        {
+          "title": "Installation with rpm Package",
+          "path": "installation/centos"
+        },
+        {
+          "title": "Installation with deb Package",
+          "path": "installation/ubuntu"
+        },
         {
           "title": "Docker",
           "path": "installation/docker"

diff --git a/en_US/installation/centos.md b/en_US/installation/centos.md
@@ -4,13 +4,13 @@
 Download the installation package according to different versions and architectures, E.g:
 
 ```bash
-$ wget https://www.emqx.com/en/downloads/neuronex/3.0.1/neuronex-3.0.1-linux-amd64.rpm
+$ wget https://www.emqx.com/en/downloads/neuronex/3.1.0/neuronex-3.1.0-linux-amd64.rpm
 ```
 
 ## Install
 
 ```bash
-$ sudo rpm -ivh neuronex-3.0.1-linux-amd64.rpm
+$ sudo rpm -ivh neuronex-3.1.0-linux-amd64.rpm
 ```
 
 ## Start

diff --git a/en_US/installation/introduction.md b/en_US/installation/introduction.md
@@ -1,11 +1,10 @@
 # Install NeuronEX
 
-NeuronEX supports 64-bit ARM and 64-bit X86 architectures on Linux-based operating systems. It provides the following installation package formats:
+NeuronEX supports 32-bit/64-bit ARM and 64-bit X86 architectures on Linux-based operating systems. It provides the following installation package formats:
 
 - tar package: Suitable for all Linux operating systems.
-- zip package: Suitable for all Linux operating systems.
-<!-- - Debian package (.deb) format: Used for Debian and Ubuntu Linux-based operating systems (coming soon).
-- Redhat Package Manager (.rpm) format: Suitable for RedHat and CentOS Linux-based operating systems (coming soon). -->
+- Debian package (.deb) format: Used for Debian and Ubuntu Linux-based operating systems.
+- Redhat Package Manager (.rpm) format: Suitable for RedHat and CentOS Linux-based operating systems.
 
 ## Download the installation package
 
@@ -15,7 +14,7 @@ Neuron software packages can be downloaded from the [Website](https://www.emqx.c
 
 The NeuronEX supports the following operating systems:
 
-- CentOS 8.0 and above, Ubuntu 20.04 and above, and other operating systems based on the Linux kernel.
+- CentOS 7.0 and above, Ubuntu 18.04 and above, and other operating systems based on the Linux kernel.
 
 :::tip
 For Windows operating systems, the following installation methods are supported:
@@ -31,12 +30,12 @@ NeuronEX supports running on x86, ARM and other hardware architectures as well a
 
 The following table lists the hardware conditions required for the minimum demand of NeuronEX at different number of tags.
 
-|Tag Limits|Minimum Memory Recommendation|Hardware Architecture|Remarks|
-| :-------------------- | :------------------------------ | :---------------------------------- | :----------------------------------- |
-| 100 tags    | 128M memory | 64-bit ARM and 64-bit x86 architectures | Raspberry Pi 3 |
-| 1,000 tags  | 256M memory | 64-bit ARM and 64-bit x86 architectures | Raspberry Pi 4 |
-| 10,000 tags | 512M memory | 64-bit ARM and 64-bit x86 architectures | Industrial PC, etc |
-| More than 10,000 tags | 1G memory | 64-bit x86 architectures | Powerful Industrial PC, Server, etc |
+|Tag Limits             | Minimum Memory Recommendation| Hardware Architecture  | Remarks                             |
+| :-------------------- | :---------  | :-------------------------------------- | :---------------------------------- |
+| 100 tags              | 128M memory | 64-bit ARM and 64-bit x86 architectures | Raspberry Pi 3                      |
+| 1,000 tags            | 256M memory | 64-bit ARM and 64-bit x86 architectures | Raspberry Pi 4                      |
+| 10,000 tags           | 512M memory | 64-bit ARM and 64-bit x86 architectures | Industrial PC, etc                  |
+| More than 10,000 tags | 1G memory   | 64-bit x86 architectures                | Powerful Industrial PC, Server, etc |
 
 :::tip
 NeuronEX has no upper limitation on the number of tags. It depends on the allocated CPU and memory resources. The following figures are the results of Neuron performance test for your reference and these benchmark results are still not the upper limits. A more powerful server can be used for more tags.
@@ -53,31 +52,30 @@ CPU Usage                        : 90%<br>
 
 :::
 
-<!-- ## Debian 软件包
+## Debian 软件包
 
 | Download files                 | Architecture  |
 | ------------------------------ | ------------- |
 | neuronex-x.y.z-linux-amd64.deb | AMD64         |
-| neuronex-x.y.z-linux-armhf.deb | ARMHF         |
-| neuronex-x.y.z-linux-arm64.deb | ARM64         |
+| neuronex-x.y.z-linux-arm.deb   | ARM           |
+| neuronex-x.y.z-linux-arm64.deb | ARM           |
 
 
 ## Redhat 软件包管理工具
 
 | Download files                 | Architecture  |
 | ------------------------------ | ------------- |
 | neuronex-x.y.z-linux-amd64.rpm | AMD64         |
-| neuronex-x.y.z-linux-armhf.rpm | ARMHF         |
-| neuronex-x.y.z-linux-arm64.rpm | ARM64         |
+| neuronex-x.y.z-linux-arm64.rpm | ARM           |
 
 
 ## Tape Archive（tar）
 
-| Download files                 | Architecture  |
-| ------------------------------ | ------------- |
-| neuronex-x.y.z-linux-amd64.rpm | AMD64         |
-| neuronex-x.y.z-linux-armhf.rpm | ARMHF         |
-| neuronex-x.y.z-linux-arm64.rpm | ARM64         | -->
+| Download files                     | Architecture  |
+| ---------------------------------- | ------------- |
+| neuronex-x.y.z-linux-amd64.tar.gz  | AMD64         |
+| neuronex-x.y.z-linux-armhf.tar.gz  | ARM           |
+| neuronex-x.y.z-linux-arm64.tar.gz  | ARM           |
 
 ## Docker Image
 

diff --git a/en_US/installation/tar.gz.md b/en_US/installation/tar.gz.md
@@ -5,14 +5,14 @@
 Download the installation package according to different versions and architectures, for example:
 
 ```bash
-$ wget https://www.emqx.com/en/downloads/neuronex/3.0.1/neuronex-3.0.1-linux-amd64.tar.gz
+$ wget https://www.emqx.com/en/downloads/neuronex/3.1.0/neuronex-3.1.0-linux-amd64.tar.gz
 ```
 
 ## Install
 
 ```bash
-$ tar -zxvf neuronex-3.0.1-linux-amd64.tar.gz
-$ cd neuronex-3.0.1-linux-amd64
+$ tar -zxvf neuronex-3.1.0-linux-amd64.tar.gz
+$ cd neuronex-3.1.0-linux-amd64
 ```
 
 ::: tip 

diff --git a/en_US/installation/ubuntu.md b/en_US/installation/ubuntu.md
@@ -5,13 +5,13 @@
 Download the installation package according to different versions and architectures, E.g:
 
 ```bash
-$ wget https://www.emqx.com/en/downloads/neuronex/3.0.1/neuronex-3.0.1-linux-amd64.deb
+$ wget https://www.emqx.com/en/downloads/neuronex/3.1.0/neuronex-3.1.0-linux-amd64.deb
 ```
 
 ## Install
 
 ```bash
-$ sudo dpkg -i neuronex-3.0.1-linux-amd64.deb
+$ sudo dpkg -i neuronex-3.1.0-linux-amd64.deb
 ```
 
 ## Start

diff --git a/zh_CN/installation/centos.md b/zh_CN/installation/centos.md
@@ -5,15 +5,15 @@
 根据不同版本及架构下载安装包，例如：
 
 ```bash
-$ wget https://www.emqx.com/zh/downloads/neuronex/3.0.1/neuronex-3.0.1-linux-amd64.rpm
+$ wget https://www.emqx.com/zh/downloads/neuronex/3.1.0/neuronex-3.1.0-linux-amd64.rpm
 ```
 
 ## 安装
 
 根据不同版本及架构安装，例如：
 
 ```bash
-$ sudo rpm -ivh neuronex-3.0.1-linux-amd64.rpm
+$ sudo rpm -ivh neuronex-3.1.0-linux-amd64.rpm
 ```
 
 ## 运行

diff --git a/zh_CN/installation/introduction.md b/zh_CN/installation/introduction.md
@@ -1,10 +1,9 @@
 # 安装 NeuronEX
 
-NeuronEX 在基于 Linux 的操作系统上支持 64位 ARM 和 64位 X86 架构，并提供以下安装包格式：
+NeuronEX 在基于 Linux 的操作系统上支持 32/64位 ARM 和 64位 X86 架构，并提供以下安装包格式：
 - tar 软件包方式，适用于所有 Linux 操作系统
-- zip 软件包方式，适用于所有 Linux 操作系统
-<!-- - Debian 软件包（.deb）格式，用于基于 Debian、Ubuntu Linux 的操作系统（即将支持）
-- Redhat 包管理器（.rpm）格式，适用于基于 RedHat、CentOS Linux 的操作系统（即将支持） -->
+- Debian 软件包（.deb）格式，用于基于 Debian、Ubuntu Linux 的操作系统
+- Redhat 包管理器（.rpm）格式，适用于基于 RedHat、CentOS Linux 的操作系统
 
 ## 下载安装包
 
@@ -13,10 +12,11 @@ NeuronEX 软件包可从 [官网](https://www.emqx.com/zh/try?product=neuronex)
 ## NeuronEX 支持的操作系统
 
 NeuronEX 支持以下操作系统：
-- CentOS 8.0 及以上版本，Ubuntu 20.04 及以上版本，其他基于 Linux 内核的操作系统
+- CentOS 7.0 及以上版本，Ubuntu 18.04 及以上版本，其他基于 Linux 内核的操作系统
 
 :::tip 提示
 如果是 Windows 操作系统，支持以下几种安装方式:
+
 - 使用 Virtual Box安装相应的 Linux 系统
 - 使用 WSL 安装相应的 Linux 系统
 - 使用 Docker Desktop，以 Docker 的方式安装和运行 NeuronEX
@@ -28,12 +28,12 @@ NeuronEX 支持运行在 X86，ARM 等硬件架构的设备上以及支持容器
 
 下表列出了 NeuronEX 在不同点位数量下的完成数采功能最低硬件要求（对采集的数据进行数据处理与计算，会额外消耗系统资源）。
 
-| 点位数                | 建议最小内存 | 硬件架构                             | 备注                              |
-| --------------------- | ------------ | ------------------------------------ | --------------------------------- |
-| 100 tags              | 128M   | 64-bit ARM 和 64-bit x86 架构         | Raspberry Pi 3                    |
-| 1,000 tags            | 256M   | 64-bit ARM 和 64-bit x86 架构         | Raspberry Pi 4                    |
-| 10,000 tags           | 512M   | 64-bit ARM 和 64-bit x86 架构         | Industrial PC 等                  |
-| 超过 10,000 tags | 1G     | 64-bit x86 架构                       | Powerful Industrial PC, Server 等 |
+| 点位数                | 建议最小内存 | 硬件架构                           | 备注                              |
+| --------------------- | --------- | ---------------------------------| --------------------------------- |
+| 100 tags              | 128M      | 64-bit ARM 和 64-bit x86 架构     | Raspberry Pi 3                    |
+| 1,000 tags            | 256M      | 64-bit ARM 和 64-bit x86 架构     | Raspberry Pi 4                    |
+| 10,000 tags           | 512M      | 64-bit ARM 和 64-bit x86 架构     | Industrial PC 等                  |
+| 超过 10,000 tags       | 1G       | 64-bit x86 架构                    | Powerful Industrial PC, Server 等 |
 
 :::tip
 NeuronEX 没有点位数量上限。取决于分配的 CPU 和内存资源。以下提供一些 NeuronEX 的性能测试结果供用户参考，这些测试数据仍然不是上限。更强大的服务器支持配置更多的数据点位。
@@ -50,38 +50,37 @@ CPU Usage                        : 90%<br>
 
 :::
 
-<!-- ## Debian 软件包
+## Debian 软件包
 
-| 下载文件                       | 架构  |
+| 下载文件                         | 架构  |
 | ------------------------------ | ----- |
 | neuronex-x.y.z-linux-amd64.deb | AMD64 |
-| neuronex-x.y.z-linux-armhf.deb | ARMHF |
-| neuronex-x.y.z-linux-arm64.deb | ARM64 |
+| neuronex-x.y.z-linux-arm.deb   | ARM   |
+| neuronex-x.y.z-linux-arm64.deb | ARM   |
 
 
 ## Redhat 软件包管理工具
 
-| 下载文件                       | 架构  |
+| 下载文件                        | 架构  |
 | ------------------------------ | ----- |
 | neuronex-x.y.z-linux-amd64.rpm | AMD64 |
-| neuronex-x.y.z-linux-armhf.rpm | ARMHF |
-| neuronex-x.y.z-linux-arm64.rpm | ARM64 |
+| neuronex-x.y.z-linux-arm64.rpm | ARM   |
 
 
 ## Tape Archive（tar）
 
-| 下载文件                       | 架构  |
-| ------------------------------ | ----- |
-| neuronex-x.y.z-linux-amd64.rpm | AMD64 |
-| neuronex-x.y.z-linux-armhf.rpm | ARMHF |
-| neuronex-x.y.z-linux-arm64.rpm | ARM64 | -->
+| 下载文件                           | 架构  |
+| --------------------------------- | ----- |
+| neuronex-x.y.z-linux-amd64.tar.gz | AMD64 |
+| neuronex-x.y.z-linux-arm.tar.gz   | ARM   |
+| neuronex-x.y.z-linux-arm64.tar.gz | ARM   |
 
 
 ## Docker 镜像
 
-| 下载文件              | 架构   |
-| --------------------- | ------ |
-| emqx/neuronex:x.y.z       | Docker |
+| 下载文件                           | 架构   |
+| -------------------------------- | ------ |
+| emqx/neuronex:x.y.z              | Docker |
 | emqx/neuronex:x.y.z-python       | Docker |
 
 ## 版本号说明

diff --git a/zh_CN/installation/tar.gz.md b/zh_CN/installation/tar.gz.md
@@ -5,14 +5,14 @@
 根据不同版本及架构下载安装包，例如：
 
 ```bash
-$ wget https://www.emqx.com/zh/downloads/neuronex/3.0.1/neuronex-3.0.1-linux-amd64.tar.gz
+$ wget https://www.emqx.com/zh/downloads/neuronex/3.1.0/neuronex-3.1.0-linux-amd64.tar.gz
 ```
 
 ## 安装
 
 ```bash
-$ tar -zxvf neuronex-3.0.1-linux-amd64.tar.gz
-$ cd neuronex-3.0.1-linux-amd64
+$ tar -zxvf neuronex-3.1.0-linux-amd64.tar.gz
+$ cd neuronex-3.1.0-linux-amd64
 ```
 
 ::: tip 

diff --git a/zh_CN/installation/ubuntu.md b/zh_CN/installation/ubuntu.md
@@ -5,15 +5,15 @@
 根据不同版本及架构下载安装包，例如：
 
 ```bash
-$ wget https://www.emqx.com/zh/downloads/neuronex/3.0.1/neuronex-3.0.1-linux-amd64.deb
+$ wget https://www.emqx.com/zh/downloads/neuronex/3.1.0/neuronex-3.1.0-linux-amd64.deb
 ```
 
 ## 安装
 
 根据不同版本及架构安装，例如：
 
 ```bash
-$ sudo dpkg -i neuronex-3.0.1-linux-amd64.deb
+$ sudo dpkg -i neuronex-3.1.0-linux-amd64.deb
 ```
 
 ## 运行

diff --git a/zh_CN/quick-start/quick-start.md b/zh_CN/quick-start/quick-start.md
@@ -17,7 +17,7 @@ $ docker pull emqx/neuronex:latest
 启动 Docker 容器
 
 ```
-$ docker run -d --name neuronex -p 8085:8085  emqx/neuronex:latest
+$ docker run -d --name neuronex -p 8085:8085 --log-opt max-size=100m emqx/neuronex:latest
 ```
 
 ## 安装 Modbus 模拟器