Backport PR #8375

--------- **Commit 1:** Make expected server.basePath usage more clear * Original sha: 02c9030 * Authored by Matthew Bargar <[email protected]> on 2016-09-20T15:48:35Z
elastic · Sep 22, 2016 · 839cbd3 · 839cbd3
1 parent 1fcde22
commit 839cbd3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/config/kibana.yml b/config/kibana.yml
@@ -6,8 +6,9 @@
 # To allow connections from remote users, set this parameter to a non-loopback address.
 # server.host: "localhost"
 
-# Enables you to specify a path to mount Kibana at if you are running behind a proxy. This setting
-# cannot end in a slash.
+# Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects
+# the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests
+# to Kibana. This setting cannot end in a slash.
 # server.basePath: ""
 
 # The maximum payload size in bytes for incoming server requests.

diff --git a/docs/kibana-yml.asciidoc b/docs/kibana-yml.asciidoc
@@ -2,8 +2,9 @@
 [horizontal]
 `server.port:`:: *Default: 5601* Kibana is served by a back end server. This setting specifies the port to use.
 `server.host:`:: *Default: "localhost"* This setting specifies the host of the back end server.
-`server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. This setting
-cannot end in a slash (`/`).
+`server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects
+ the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests
+ to Kibana. This setting cannot end in a slash (`/`).
 `server.maxPayloadBytes:`:: *Default: 1048576* The maximum payload size in bytes for incoming server requests.
 `server.name:`:: *Default: "your-hostname"* A human-readable display name that identifies this Kibana instance.
 `elasticsearch.url:`:: *Default: "http://localhost:9200"* The URL of the Elasticsearch instance to use for all your