Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit ae48fc1

Browse files
committed
Merge pull request #24 from Asquera/feature/update_readme
Feature/update readme
2 parents 007421b + dcafa18 commit ae48fc1

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

‎README.md‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,29 @@ Download the current version from https://github.com/Asquera/elasticsearch-http-
2020

2121
## Configuration
2222

23-
The plugin is enabled by default. Enabling basic authorization will disable the default HTTP Transport module.
23+
Once the plugin is installed it can be configured in the [elasticsearch modules configuration file](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup-configuration.html#settings). See the [elasticserach directory layout information](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/setup-dir-layout.html) for more information about the default paths of an ES installation.
2424

25-
```
26-
http.basic.enabled: true
27-
http.basic.user: "my_username"
28-
http.basic.password: "my_password"
29-
```
25+
| Setting key | Default value | Notes |
26+
|-----------------------------|------------------------------|-------------------------------------------------------------------------|
27+
| `http.basic.enabled` | true | **true** disables the default ES HTTP Transport module |
28+
| `http.basic.user` | "admin" | |
29+
| `http.basic.pasword` | "admin_pw" | |
30+
| `http.basic.whitelist` | ["localhost", "127.0.0.1"] | |
31+
| `http.basic.log` | false | enables pugin logging to ES log |
32+
| `http.basic.xforward` | "" | example [X-Forwarded-For](http://en.wikipedia.org/wiki/X-Forwarded-For) |
3033

3134
Be aware that the password is stored in plain text.
3235

36+
### configuration example
37+
38+
The following code enables plugin logging, and sets user and password:
39+
40+
```
41+
http.basic.log: true
42+
http.basic.user: "some_user"
43+
http.basic.password: "some_password"
44+
```
45+
3346
## Testing
3447

3548
```
@@ -38,10 +51,6 @@ $ curl -v --user my_username:my_password localhost:9200/foo # works
3851
$ curl -v --user my_username:password localhost:9200/foo # sends 401
3952
```
4053

41-
## Problems
42-
43-
This will not send WWW-Authorize headers - this is due to elasticsearch not allowing to add custom headers to responses.
44-
4554
## Issues
4655

4756
Please file your issue here: https://github.com/Asquera/elasticsearch-http-basic/issues

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /