Skip to content

Commit

Permalink
Update description in UserGuide (apache#7328)
Browse files Browse the repository at this point in the history
  • Loading branch information
krystal-xiao authored Sep 15, 2022
1 parent 94b5a5f commit bfd3609
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/UserGuide/API/RestService.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ RESTful services are disabled by default.

* User

Find the `conf/iotdb.properties` file under the IoTDB installation directory and set `enable_rest_service` to `true` to enable the module.
Find the `conf/iotdb.rest.properties` file under the IoTDB installation directory and set `enable_rest_service` to `true` to enable the module.

```properties
enable_rest_service=true
Expand Down Expand Up @@ -780,7 +780,7 @@ Parameter Description:

|parameter name |parameter type |parameter describe|
|:--- | :--- | :---|
| sql | string | query content |
| sql | string | query content |

Example request:
```shell
Expand Down Expand Up @@ -815,7 +815,7 @@ Request path: http://ip:port/rest/v1/insertTablet
Parameter Description:

|parameter name |parameter type |is required|parameter describe|
|:--- | :--- | :---| :---|
|:--- | :--- | :---| :---|
| timestamps | array | yes | Time column |
| measurements | array | yes | The name of the measuring point |
| dataTypes | array | yes | The data type |
Expand Down
2 changes: 1 addition & 1 deletion docs/UserGuide/QuickStart/Command-Line-Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO
Openid connect (oidc) uses keycloack as the authority authentication service of oidc service

#### configuration
The configuration is located in iotdb-engines.properties , set the author_provider_class is org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer Openid service is enabled, and the default value is org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer Indicates that the openid service is not enabled.
The configuration is located in iotdb-datanode.properties(iotdb-confignode.properties) , set the author_provider_class is org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer Openid service is enabled, and the default value is org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer Indicates that the openid service is not enabled.

```
authorizer_provider_class=org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/UserGuide/API/Programming-MQTT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ MQTT 主题与 IoTDB 时间序列相对应。
<img style="width:100%; max-width:800px; max-height:600px; margin-left:auto; margin-right:auto; display:block;" src="https://user-images.githubusercontent.com/6711230/78357469-1bf11880-75e4-11ea-978f-a53996667a0d.png">

### MQTT 配置
默认情况下,IoTDB MQTT 服务从`${IOTDB_HOME}/${IOTDB_CONF}/iotdbengine.properties`加载配置。
默认情况下,IoTDB MQTT 服务从`${IOTDB_HOME}/${IOTDB_CONF}/iotdb-datanode.properties`加载配置。

配置如下:

Expand Down
8 changes: 4 additions & 4 deletions docs/zh/UserGuide/API/RestService.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ RESTful 服务默认情况是关闭的
* 开发者

找到sever模块中`org.apache.iotdb.db.conf.rest` 下面的`IoTDBRestServiceConfig`类,修改`enableRestService=true`即可。

* 使用者

找到IoTDB安装目录下面的`conf/iotdb.properties`文件,将 `enable_rest_service` 设置为 `true` 以启用该模块。
找到IoTDB安装目录下面的`conf/iotdb-rest.properties`文件,将 `enable_rest_service` 设置为 `true` 以启用该模块。

```properties
enable_rest_service=true
```
```

### 鉴权
除了检活接口 `/ping`,RESTful 服务使用了基础(basic)鉴权,每次 URL 请求都需要在 header 中携带 `'Authorization': 'Basic ' + base64.encode(username + ':' + password)`
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO
OpenID Connect (OIDC) 使用 keycloack 作为 OIDC 服务权限认证服务。

#### 配置
配置位于 iotdb-engines.properties,设定 authorizer_provider_class 为 org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer 则开启了 openID 服务,默认情况下值为 org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer 表示没有开启 openID 服务。
配置位于 iotdb-datanode.properties(iotdb-confignode.properties),设定 authorizer_provider_class 为 org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer 则开启了 openID 服务,默认情况下值为 org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer 表示没有开启 openID 服务。

```
authorizer_provider_class=org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer
Expand Down

0 comments on commit bfd3609

Please sign in to comment.