|
1 | 1 | [](https://ghit.me/repo/sscarduzio/elasticsearch-readonlyrest-plugin)
|
2 | 2 | [](https://www.codacy.com/app/scarduzio/elasticsearch-readonlyrest-plugin)
|
3 | 3 | [](https://travis-ci.org/sscarduzio/elasticsearch-readonlyrest-plugin)
|
4 |
| -[](https://gitter.im/sscarduzio/elasticsearch-readonlyrest-plugin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
5 | 4 |
|
6 | 5 | # Readonly REST Elasticsearch Plugin
|
7 |
| - |
8 | 6 | Expose the high performance HTTP server embedded in Elasticsearch directly to the public, safely blocking any attempt to delete or modify your data.
|
9 | 7 |
|
10 | 8 | In other words... no more proxies! Yay Ponies!
|
@@ -114,25 +112,16 @@ Build your ACL from simple building blocks (rules) i.e.:
|
114 | 112 | * ```methods``` a list of HTTP methods
|
115 | 113 | * ```accept_x-forwarded-for_header``` interpret the ```X-Forwarded-For``` header as origin host (useful for AWS ELB and other reverse proxies)
|
116 | 114 | * ```auth_key``` HTTP Basic auth.
|
| 115 | +* ```indices``` indices (aliases and wildcards work) |
| 116 | +* ```actions`` list of ES actions (e.g. "cluster:*" , "indices:data/write/*", "indices:data/read*") |
117 | 117 |
|
118 | 118 | See the (full list of supported rules)[Supported-Rules] for more info on how to use them.
|
119 | 119 |
|
120 | 120 |
|
121 | 121 | #### Custom response body
|
122 | 122 | Optionally provide a string to be returned as the body of 403 (FORBIDDEN) HTTP response. If not provided, the descriptive "name" field of the matched block will be shown (good for debug!).
|
123 | 123 |
|
124 |
| -## What is this read only mode? |
125 |
| -When the plugin is activated and properly configured, Elasticsearch REST API responds with a "403 FORBIDDEN" error whenever the request meets the following parameters: |
126 |
| - |
127 |
| -* Any HTTP method other than GET is requested |
128 |
| -* GET request has a body (according to HTTP specs it never should!) |
129 |
| - |
130 |
| -This is enough to keep public users from changing the data (see relevant [ES REST API documentation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/docs.html)). |
131 |
| - |
132 |
| -You're free to expand the ACL further if you need more fine grained access control. |
133 |
| - |
134 | 124 | ## Extra
|
135 |
| -* [Install, Uninstall, Build this plugin](https://github.com/sscarduzio/elasticsearch-readonlyrest-plugin/wiki/Install,-Uninstall,-Build) |
136 | 125 | * [List of ACL block rules supported](https://github.com/sscarduzio/elasticsearch-readonlyrest-plugin/wiki/Supported-Rules)
|
137 | 126 |
|
138 | 127 | ## History
|
|
0 commit comments