diff --git a/README.md b/README.md index bf05931..fd73eec 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ There is no way to configure this on a per index basis. | Http Basic Plugin | elasticsearch | |-----------------------------|------------------------------| -| v1.0.0 | 6.3.2 | +| v1.0.0 | 6.2.4+ | ## Installation @@ -30,9 +30,11 @@ Once the plugin is installed it can be configured in the [elasticsearch modules | Setting key | Default value | Notes | |-----------------------------------|------------------------------|-------------------------------------------------------------------------| | `http.basic.enabled` | true | **true** disables the default ES HTTP Transport module | -| `http.basic.user` | "admin" | | +| `http.basic.username` | "admin" | | | `http.basic.password` | "admin_pw" | -| `http.basic.log` | false | enables plugin logging to ES log. Unauthenticated requests are always logged. | +| `http.basic.log` | false | enables plugin logging to ES log. Unauthenticated requests are +| `http.basic.ipwhitelist` | IP白名单 | 在此列表中的ip,可以不输入带入用户名密码即可访问es服务,用英文逗号,分割 +always logged. | **Be aware that the password is stored in plain text.** @@ -42,12 +44,12 @@ see [this article](https://en.wikipedia.org/wiki/Basic_access_authentication) ## Configuration example -The following code enables plugin logging, sets user and password. +The following code enables plugin logging, sets user and password.提醒:属性的:后面需要加一个空格!!! ``` http.basic.enable: true http.basic.log: true -http.basic.user: "some_user" +http.basic.username: "some_user" http.basic.password: "some_password" http.basic.ipwhitelist: ip1,ip2,ip3 ```