Skip to content

Commit e3db287

Browse files
Melori Arellanogchaps
andauthored
[DOCS]Clarify that by default server.host only allows local connections (#52802) (#53702)
* [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> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
1 parent d12243f commit e3db287

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
@@ -1,15 +1,13 @@
11
[[settings]]
22
== Configuring Kibana
33

4-
The Kibana server reads properties from the `kibana.yml` file on startup. The
5-
location of this file differs depending on how you installed {kib}. For example,
6-
if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
7-
default it is in `$KIBANA_HOME/config`. By default, with package distributions
8-
(Debian or RPM), it is in `/etc/kibana`.
9-
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
4+
The Kibana server reads properties from the `kibana.yml` file on startup. The
5+
location of this file differs depending on how you installed {kib}. For example,
6+
if you installed {kib} from an archive distribution (`.tar.gz` or `.zip`), by
7+
default it is in `$KIBANA_HOME/config`. By default, with package distributions
8+
(Debian or RPM), it is in `/etc/kibana`.
9+
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

@@ -34,7 +32,7 @@ with Kibana.
3432

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

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

7371
`elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait
@@ -128,15 +126,15 @@ Visualize.
128126

129127
`kibana.index:`:: *Default: ".kibana"* Kibana uses an index in Elasticsearch to
130128
store saved searches, visualizations and dashboards. Kibana creates a new index
131-
if the index doesn’t already exist. If you configure a custom index, the name must
129+
if the index doesn’t already exist. If you configure a custom index, the name must
132130
be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
133131

134132
`logging.dest:`:: *Default: `stdout`* Enables you specify a file where Kibana
135133
stores log output.
136134

137-
`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
138-
logs will be formatted as JSON strings that include timestamp, log level, context, message
139-
text and any other metadata that may be associated with the log message itself.
135+
`logging.json:`:: *Default: false* Logs output as JSON. When set to `true`, the
136+
logs will be formatted as JSON strings that include timestamp, log level, context, message
137+
text and any other metadata that may be associated with the log message itself.
140138
If `logging.dest.stdout` is set and there is no interactive terminal ("TTY"), this setting
141139
will default to `true`.
142140

@@ -162,7 +160,7 @@ will be included.
162160
[[regionmap-settings]] `map.regionmap:`:: Specifies additional vector layers for
163161
use in <<regionmap, Region Map>> visualizations. Supported on {ece}. Each layer
164162
object points to an external vector file that contains a geojson
165-
FeatureCollection. The file must use the
163+
FeatureCollection. The file must use the
166164
https://en.wikipedia.org/wiki/World_Geodetic_System[WGS84 coordinate reference system]
167165
and only include polygons. If the file is hosted on a separate domain from
168166
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
253251
modify the landing page when opening Kibana. Supported on {ece}.
254252

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

258256
`server.maxPayloadBytes:`:: *Default: 1048576* The maximum payload size in bytes
259257
for incoming server requests.
@@ -266,7 +264,7 @@ setting specifies the port to use.
266264

267265
`server.rewriteBasePath:`:: *Default: false* Deprecated setting that specifies if Kibana should
268266
rewrite requests that are prefixed with `server.basePath`, or require that they
269-
are rewritten by your reverse proxy.
267+
are rewritten by your reverse proxy.
270268

271269
`server.socketTimeout:`:: *Default: "120000"* The number of milliseconds to wait before closing an
272270
inactive socket.

0 commit comments

Comments
 (0)