Skip to content

Commit f84f46f

Browse files
Melori Arellanogchaps
andauthored
[DOCS]Clarify that by default server.host only allows local connections (#52802) (#52947)
* [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 e447134 commit f84f46f

File tree

4 files changed

+21
-22
lines changed

4 files changed

+21
-22
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: 16 additions & 18 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
@@ -171,19 +169,19 @@ The following example shows a valid logging rotate configuration:
171169
enable log rotation. If you do not have a `logging.dest` set that is different from `stdout`
172170
that feature would not take any effect.
173171

174-
`logging.rotate.everyBytes:`:: [experimental] *Default: 10485760* The maximum size of a log file (that is `not an exact` limit). After the
172+
`logging.rotate.everyBytes:`:: [experimental] *Default: 10485760* The maximum size of a log file (that is `not an exact` limit). After the
175173
limit is reached, a new log file is generated. The default size limit is 10485760 (10 MB) and
176174
this option should be at least greater than 1024.
177175

178-
`logging.rotate.keepFiles:`:: [experimental] *Default: 7* The number of most recent rotated log files to keep
179-
on disk. Older files are deleted during log rotation. The default value is 7. The `logging.rotate.keepFiles`
176+
`logging.rotate.keepFiles:`:: [experimental] *Default: 7* The number of most recent rotated log files to keep
177+
on disk. Older files are deleted during log rotation. The default value is 7. The `logging.rotate.keepFiles`
180178
option has to be in the range of 2 to 1024 files.
181179

182-
`logging.rotate.pollingInterval:`:: [experimental] *Default: 10000* The number of milliseconds for the polling strategy in case
180+
`logging.rotate.pollingInterval:`:: [experimental] *Default: 10000* The number of milliseconds for the polling strategy in case
183181
the `logging.rotate.usePolling` is enabled. That option has to be in the range of 5000 to 3600000 milliseconds.
184182

185-
`logging.rotate.usePolling:`:: [experimental] *Default: false* By default we try to understand the best way to monitoring
186-
the log file. However, there is some systems where it could not be always accurate. In those cases, if needed,
183+
`logging.rotate.usePolling:`:: [experimental] *Default: false* By default we try to understand the best way to monitoring
184+
the log file. However, there is some systems where it could not be always accurate. In those cases, if needed,
187185
the `polling` method could be used enabling that option.
188186

189187
`logging.silent:`:: *Default: false* Set the value of this setting to `true` to
@@ -311,7 +309,7 @@ This setting may not be used when `server.compression.enabled` is set to `false`
311309
send on all responses to the client from the Kibana server.
312310

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

316314
`server.keepaliveTimeout:`:: *Default: "120000"* The number of milliseconds to wait for additional data before restarting
317315
the `server.socketTimeout` counter.
@@ -364,15 +362,15 @@ supported protocols with versions. Valid protocols: `TLSv1`, `TLSv1.1`, `TLSv1.2
364362
setting this to `true` enables unauthenticated users to access the Kibana server
365363
status API and status page.
366364

367-
`telemetry.allowChangingOptInStatus`:: *Default: true*. If `true`,
368-
users are able to change the telemetry setting at a later time in
369-
<<advanced-options, Advanced Settings>>. If `false`,
370-
{kib} looks at the value of `telemetry.optIn` to determine whether to send
365+
`telemetry.allowChangingOptInStatus`:: *Default: true*. If `true`,
366+
users are able to change the telemetry setting at a later time in
367+
<<advanced-options, Advanced Settings>>. If `false`,
368+
{kib} looks at the value of `telemetry.optIn` to determine whether to send
371369
telemetry data or not. `telemetry.allowChangingOptInStatus` and `telemetry.optIn`
372370
cannot be `false` at the same time.
373371

374-
`telemetry.optIn`:: *Default: true* If `true`, telemetry data is sent to Elastic.
375-
If `false`, collection of telemetry data is disabled.
372+
`telemetry.optIn`:: *Default: true* If `true`, telemetry data is sent to Elastic.
373+
If `false`, collection of telemetry data is disabled.
376374
To enable telemetry and prevent users from disabling it,
377375
set `telemetry.allowChangingOptInStatus` to `false` and `telemetry.optIn` to `true`.
378376

0 commit comments

Comments
 (0)