Skip to content

Commit 2218d6d

Browse files
Melori Arellanogchaps
andauthored
[DOCS]Clarify that by default server.host only allows local connections (#52802) (#52954)
* [DOCS]Clarify that by default server.host only allows local connections * Update docs/setup/access.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> * Update docs/setup/settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com> * Update docs/setup/settings.asciidoc Co-Authored-By: gchaps <33642766+gchaps@users.noreply.github.com>
1 parent 0909af8 commit 2218d6d

File tree

4 files changed

+20
-21
lines changed

4 files changed

+20
-21
lines changed
93.4 KB
Loading

docs/images/kibana-status-page.png

-248 KB
Binary file not shown.

docs/setup/access.asciidoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
== Accessing Kibana
33

44
Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
5-
machine where Kibana is running and specify the port number. For example, `localhost:5601` or
6-
`http://YOURDOMAIN.com:5601`.
5+
machine where Kibana is running and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`.
6+
If you want to allow remote users to connect, set the parameter `server.host` in `kibana.yml` to a non-loopback address.
77

88
When you access Kibana, the <<discover,Discover>> page loads by default with the default index pattern selected. The
99
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
1515
[[status]]
1616
=== Checking Kibana Status
1717

18-
You can reach the Kibana server's status page by navigating to `localhost:5601/status`. The status page displays
18+
You can reach the Kibana server's status page by navigating to the status endpoint, for example, `localhost:5601/status`. The status page displays
1919
information about the server's resource usage and lists the installed plugins.
2020

21-
image::images/kibana-status-page.png[]
21+
[role="screenshot"]
22+
image::images/kibana-status-page-7_5_0.png[]
2223

2324
NOTE: For JSON-formatted server status details, use the API endpoint at `localhost:5601/api/status`

docs/setup/settings.asciidoc

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
77
default it is in `$KIBANA_HOME/config`. By default, with package distributions
88
(Debian or RPM), it is in `/etc/kibana`.
99

10-
The default settings configure Kibana to run on `localhost:5601`. To change the
11-
host or port number, or connect to Elasticsearch running on a different machine,
12-
you'll need to update your `kibana.yml` file. You can also enable SSL and set a
10+
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
1311
variety of other options. Finally, environment variables can be injected into
1412
configuration using `${MY_ENV_VAR}` syntax.
1513

@@ -32,7 +30,7 @@ strongly recommend that you keep the default CSP rules that ship with Kibana.
3230

3331
`csp.strict:`:: *Default: `false`* Blocks access to Kibana to any browser that
3432
does not enforce even rudimentary CSP rules. In practice, this will disable
35-
support for older, less safe browsers like Internet Explorer.
33+
support for older, less safe browsers like Internet Explorer.
3634
See <<csp-strict-mode, Content Security Policy>> for more information.
3735

3836
`csp.warnLegacyBrowsers:`:: *Default: `true`* Shows a warning message after
@@ -65,7 +63,7 @@ connects to this Kibana instance.
6563
`elasticsearch.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List
6664
of Kibana client-side headers to send to Elasticsearch. To send *no* client-side
6765
headers, set this value to [] (an empty list).
68-
Removing the `authorization` header from being whitelisted means that you cannot
66+
Removing the `authorization` header from being whitelisted means that you cannot
6967
use <<basic-authentication, basic authentication>> in Kibana.
7068

7169
`elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait
@@ -129,11 +127,11 @@ store saved searches, visualizations, and dashboards. Kibana creates a new index
129127
if the index doesn’t already exist. If you configure a custom index, the name must
130128
be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
131129
+
132-
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
133-
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
134-
to grant access to {kib}.
135-
You must create custom roles that authorize the user for that specific tenant.
136-
Although multi-tenant installations are supported, the recommended approach
130+
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
131+
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
132+
to grant access to {kib}.
133+
You must create custom roles that authorize the user for that specific tenant.
134+
Although multi-tenant installations are supported, the recommended approach
137135
to securing access to {kib} segments is to grant users access to specific spaces.
138136

139137
`kibana.autocompleteTimeout:`:: *Default: "1000"* Time in milliseconds to wait
@@ -281,7 +279,7 @@ This setting may not be used when `server.compression.enabled` is set to `false`
281279
send on all responses to the client from the Kibana server.
282280

283281
`server.host:`:: *Default: "localhost"* This setting specifies the host of the
284-
back end server.
282+
back end server. To allow remote users to connect, set the value to the IP address or DNS name of the {kib} server.
285283

286284
`server.keepaliveTimeout:`:: *Default: "120000"* The number of milliseconds to wait for additional data before restarting
287285
the `server.socketTimeout` counter.
@@ -334,15 +332,15 @@ supported protocols with versions. Valid protocols: `TLSv1`, `TLSv1.1`, `TLSv1.2
334332
setting this to `true` enables unauthenticated users to access the Kibana server
335333
status API and status page.
336334

337-
`telemetry.allowChangingOptInStatus`:: *Default: true*. If `true`,
338-
users are able to change the telemetry setting at a later time in
339-
<<advanced-options, Advanced Settings>>. If `false`,
340-
{kib} looks at the value of `telemetry.optIn` to determine whether to send
335+
`telemetry.allowChangingOptInStatus`:: *Default: true*. If `true`,
336+
users are able to change the telemetry setting at a later time in
337+
<<advanced-options, Advanced Settings>>. If `false`,
338+
{kib} looks at the value of `telemetry.optIn` to determine whether to send
341339
telemetry data or not. `telemetry.allowChangingOptInStatus` and `telemetry.optIn`
342340
cannot be `false` at the same time.
343341

344-
`telemetry.optIn`:: *Default: true* If `true`, telemetry data is sent to Elastic.
345-
If `false`, collection of telemetry data is disabled.
342+
`telemetry.optIn`:: *Default: true* If `true`, telemetry data is sent to Elastic.
343+
If `false`, collection of telemetry data is disabled.
346344
To enable telemetry and prevent users from disabling it,
347345
set `telemetry.allowChangingOptInStatus` to `false` and `telemetry.optIn` to `true`.
348346

0 commit comments

Comments
 (0)