Merge pull request #80 from superrxan/branch-3.4-jran

docs: cli command modified

en_US/admin/conf-management.md

@@ -1,6 +1,6 @@
 # Configuration Management
 
-NeuronEX supports modifying Neuron's configuration parameters through `command line`, `environment variables`, and `configuration files`, which can provide a more flexible way of starting and running. If `command line`, `environment variables`, and `configuration files` are configured at the same time, the priority relationship between the three is: environment variable > command line > configuration file
+NeuronEX supports modifying Neuron's configuration parameters through `command line`, `environment variables`, and `configuration files`, which can provide a more flexible way of starting and running. If `command line`, `environment variables`, and `configuration files` are configured at the same time, the priority relationship between the three is: command line > environment variable > configuration file
 
 ## Command Line
 
@@ -10,33 +10,24 @@ The `run` command is used to run NeuronEX on the console.This command starts Neu
 
 ```shell
 -c, --config string   config file path (default "etc/neuronex.yaml")
--e, --disable_auth    select whether to enable authentication
--h, --help            help for run
--m, --manage          manage the lifecycle of eKuiper and Neuron (default true)
+-k, --disable_kuiper    select whether to disable ekuiper
 ```
 Eg:
 
 ```shell
-./bin/neuronex run -c etc/neuronex.yaml -m false -e false
+./bin/neuronex run -c etc/neuronex.yaml -k true
 ```
 
-This command starts NeuronEX as a process and displays its output in the terminal. The NeuronEX will not manage the lifecycle of Neuron and Ekuiper and will not turn on privilege authentication.
+This command starts NeuronEX as a process and displays its output in the terminal. The NeuronEX will not manage the lifecycle of Ekuiper.
 
 ### `start` command
 
 The `start` command is used to start NeuronEX in daemon mode.This command starts NeuronEX as a daemon and runs it in the background.
 
-```
--c, --config string   config file path (default "etc/neuronex.yaml")
--e, --disable_auth    select whether to enable authentication
--h, --help            help for run
--m, --manage          manage the lifecycle of eKuiper and Neuron (default true)
-```
-
 Eg:
 
 ```sh
-./bin/neuronex start -c etc/neuronex.yaml -m false -e false
+./bin/neuronex start 
 ```
 
 This command starts NeuronEX as a daemon and runs it in the background. The NeuronEX will not manage the lifecycle of Neuron and Ekuiper and will not turn on privilege authentication.
@@ -92,6 +83,10 @@ NeuronEX provides a YAML format file to configure personalized parameters relate
 The `server` section defines the port number of the NeuronEX server.
 
 - `port`: port number of the NeuronEX server, default value is 8085.
+- `disableAuth`: whether to disable TOKEN authentication.
+- `disableKuiper`: whether to disable eKuiper.
+- `certFile`: the certificate file location when enable TLS.
+- `keyFile`: the key file location when enable TLS.
 
 ### neuron
 
@@ -139,6 +134,8 @@ The `official` section defines ecosy license official server address information
 ```yaml
 server:
   port: 8085
+  disableAuth: false
+  disableKuiper: false
 
 neuron:
   version: 2.6.0

zh_CN/admin/conf-management.md

@@ -1,41 +1,32 @@
 # 配置管理
 
 NeuronEX 支持通过`命令行`、`环境变量`、`配置文件`的方式，对 NeuronEX 的配置参数进行修改，可以提供更加灵活的启动和运行方式。
-如果同时配置了`命令行`、`环境变量`、`配置文件`，三者的优先级关系为：环境变量 > 命令行 > 配置文件
+如果同时配置了`命令行`、`环境变量`、`配置文件`，三者的优先级关系为：命令行 > 环境变量 > 配置文件 
 
 ## 命令行
 
 NeuronEX 的命令行位于 `/bin/neuronex`，它提供了以下的常用选项：
-```shell
--c, --config 配置文件路径（默认为 "etc/neuronex.yaml"）
--e, --disable_auth 选择是否启用身份验证（默认为 true）
--h, --help 运行帮助
--m, --manage 管理 eKuiper 和 Neuron 的生命周期（默认为 true）
-```
 
 ### `run` 命令
 
 `run`  命令用于在控制台上运行 NeuronEX。该命令将 NeuronEX 作为一个进程启动，并在终端中显示其输出。
 
+```shell
+-c, --config 配置文件路径, 默认为 "etc/neuronex.yaml"
+-k, --disable_kuiper 选择是否停用 eKuiper, 默认为 false, 即启用
+```
+
 例如：
 ```sh
-./bin/neuronex run -c etc/neuronex.yaml -m false -e false
+./bin/neuronex run -c etc/neuronex.yaml -k true
 ```
 
-该命令将 NeuronEX 作为进程启动，并在终端中显示其输出。NeuronEX 不会管理 Neuron 和 eKuiper 的生命周期，也不会开启权限验证。
+该命令将 NeuronEX 作为进程启动，并在终端中显示其输出, NeuronEX 不会启动 eKuiper
 
 ### `start` 命令
 
 `start ` 命令用于在守护进程模式下启动 NeuronEX，该命令将 NeuronEX 作为守护进程启动并在后台运行。
 
-例如
-
-```sh
-./bin/neuronex start -c etc/neuronex.yaml -m false -e false
-```
-
-该命令将 NeuronEX 作为守护进程启动，并在后台运行。NeuronEX 不会管理 Neuron 和 eKuiper 的生命周期，也不会开启权限验证。
-
 ### `stop` 命令
 
 `stop` 命令用于停止运行 NeuronEX。该命令将杀死 NeuronEX 进程。
@@ -88,6 +79,10 @@ NeuronEX 提供 YAML 格式文件，用于配置与 NeuronEX 相关的个性化
 ` server`  部分定义了 NeuronEX 服务器的端口号。
 
 - ` port`：NeuronEX 服务器的端口号，默认值为 8085。
+- ` disableAuth`：NeuronEX 是否关闭 Token 认证。
+- ` disableKuiper`：NeuronEX 是否停用 eKuiper
+- `certFile`: 开启 TLS 认证后，证书文件位置
+- `keyFile`: 开启 TLS 认证后，密钥文件位置
 
 ### neuron
 
@@ -136,6 +131,8 @@ NeuronEX 提供 YAML 格式文件，用于配置与 NeuronEX 相关的个性化
 ```yaml
 server:
   port: 8085
+  disableAuth: false
+  disableKuiper: false
 
 neuron:
   version: 2.6.0