[DOCS]Clarify that by default server.host only allows local connectio…

…ns (elastic#52802) * [DOCS]Clarify that by default server.host only allows local connections * Update docs/setup/access.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/setup/settings.asciidoc Co-Authored-By: gchaps <[email protected]> * Update docs/setup/settings.asciidoc Co-Authored-By: gchaps <[email protected]>
mellieA · Dec 20, 2019 · 5bfb0da · 5bfb0da
1 parent e1fa641
commit 5bfb0da
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 22 deletions.
diff --git a/docs/images/kibana-status-page-7_5_0.png b/docs/images/kibana-status-page-7_5_0.png
diff --git a/docs/images/kibana-status-page.png b/docs/images/kibana-status-page.png
diff --git a/docs/setup/access.asciidoc b/docs/setup/access.asciidoc
@@ -2,8 +2,8 @@
 == Accessing Kibana
 
 Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
-machine where Kibana is running and specify the port number. For example, `localhost:5601` or
-`http://YOURDOMAIN.com:5601`.
+machine where Kibana is running and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`.
+If you want to allow remote users to connect, set the parameter `server.host` in `kibana.yml` to a non-loopback address.
 
 When you access Kibana, the <<discover,Discover>> page loads by default with the default index pattern selected. The
 time filter is set to the last 15 minutes and the search query is set to match-all (\*).
@@ -15,9 +15,10 @@ If you still don't see any results, it's possible that you don't *have* any docu
 [[status]]
 === Checking Kibana Status
 
-You can reach the Kibana server's status page by navigating to `localhost:5601/status`. The status page displays
+You can reach the Kibana server's status page by navigating to the status endpoint, for example, `localhost:5601/status`. The status page displays
 information about the server's resource usage and lists the installed plugins.
 
-image::images/kibana-status-page.png[]
+[role="screenshot"]
+image::images/kibana-status-page-7_5_0.png[]
 
 NOTE: For JSON-formatted server status details, use the API endpoint at `localhost:5601/api/status`
diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc
@@ -1,15 +1,13 @@
 [[settings]]
 == Configuring Kibana
 
-The Kibana server reads properties from the `kibana.yml` file on startup. The 
-location of this file differs depending on how you installed {kib}. For example, 
-if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by 
-default it is in `$KIBANA_HOME/config`. By default, with package distributions 
-(Debian or RPM), it is in `/etc/kibana`. 
-
-The default settings configure Kibana to run on `localhost:5601`. To change the
-host or port number, or connect to Elasticsearch running on a different machine,
-you'll need to update your `kibana.yml` file. You can also enable SSL and set a
+The Kibana server reads properties from the `kibana.yml` file on startup. The
+location of this file differs depending on how you installed {kib}. For example,
+if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
+default it is in `$KIBANA_HOME/config`. By default, with package distributions
+(Debian or RPM), it is in `/etc/kibana`.
+
+The default host and port settings configure {kib} to run on `localhost:5601`. To change this behavior and allow remote users to connect, you'll need to update your `kibana.yml` file. You can also enable SSL and set a
 variety of other options. Finally, environment variables can be injected into
 configuration using `${MY_ENV_VAR}` syntax.
 
@@ -34,7 +32,7 @@ with Kibana.
 
 `csp.strict:`:: *Default: `false`* Blocks access to Kibana to any browser that
 does not enforce even rudimentary CSP rules. In practice, this will disable
-support for older, less safe browsers like Internet Explorer. 
+support for older, less safe browsers like Internet Explorer.
 See <<csp-strict-mode, Content Security Policy>> for more information.
 
 `csp.warnLegacyBrowsers:`:: *Default: `true`* Shows a warning message after
@@ -67,7 +65,7 @@ connects to this Kibana instance.
 `elasticsearch.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List
 of Kibana client-side headers to send to Elasticsearch. To send *no* client-side
 headers, set this value to [] (an empty list).
-Removing the `authorization` header from being whitelisted means that you cannot 
+Removing the `authorization` header from being whitelisted means that you cannot
 use <<basic-authentication, basic authentication>> in Kibana.
 
 `elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait
@@ -128,15 +126,15 @@ Visualize.
 
 `kibana.index:`:: *Default: ".kibana"* Kibana uses an index in Elasticsearch to
 store saved searches, visualizations and dashboards. Kibana creates a new index
-if the index doesn’t already exist. If you configure a custom index, the name must 
+if the index doesn’t already exist. If you configure a custom index, the name must
 be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
 
 `logging.dest:`:: *Default: `stdout`* Enables you specify a file where Kibana
 stores log output.
 
-`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the 
-logs will be formatted as JSON strings that include timestamp, log level, context, message 
-text and any other metadata that may be associated with the log message itself. 
+`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
+logs will be formatted as JSON strings that include timestamp, log level, context, message
+text and any other metadata that may be associated with the log message itself.
 If `logging.dest.stdout` is set and there is no interactive terminal ("TTY"), this setting
 will default to `true`.
 
@@ -162,7 +160,7 @@ will be included.
 [[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for
 use in <<regionmap, Region Map>> visualizations. Supported on {ece}. Each layer
 object points to an external vector file that contains a geojson
-FeatureCollection. The file must use the 
+FeatureCollection. The file must use the
 https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system]
 and only include polygons. If the file is hosted on a separate domain from
 Kibana, the server needs to be CORS-enabled so Kibana can download the file. The
@@ -253,7 +251,7 @@ specifies the default route when opening Kibana. You can use this setting to
 modify the landing page when opening Kibana. Supported on {ece}.
 
 `server.host:`:: *Default: "localhost"* This setting specifies the host of the
-back end server.
+back end server. To allow remote users to connect, set the value to the IP address or DNS name of the {kib} server.
 
 `server.maxPayloadBytes:`:: *Default: 1048576* The maximum payload size in bytes
 for incoming server requests.
@@ -266,7 +264,7 @@ setting specifies the port to use.
 
 `server.rewriteBasePath:`:: *Default: false* Deprecated setting that specifies if Kibana should
 rewrite requests that are prefixed with `server.basePath`, or require that they
-are rewritten by your reverse proxy. 
+are rewritten by your reverse proxy.
 
 `server.socketTimeout:`:: *Default: "120000"* The number of milliseconds to wait before closing an
 inactive socket.