Skip to content

Commit

Permalink
[DOCS]Clarify that by default server.host only allows local connectio…
Browse files Browse the repository at this point in the history
…ns (#52802) (#53302)

* [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]>
  • Loading branch information
Melori Arellano and gchaps authored Dec 17, 2019
1 parent d89bd90 commit c91797e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 16 deletions.
Binary file added docs/images/kibana-status-page-7_5_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/kibana-status-page.png
Binary file not shown.
9 changes: 5 additions & 4 deletions docs/setup/access.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 (\*).
Expand 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`
22 changes: 10 additions & 12 deletions docs/setup/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ 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 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.

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -131,11 +129,11 @@ 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
be lowercase, and conform to {es} {ref}/indices-create-index.html[index name limitations].
+
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
to grant access to {kib}.
You must create custom roles that authorize the user for that specific tenant.
Although multi-tenant installations are supported, the recommended approach
When running multiple tenants of {kib} by changing the `kibana.index` in your `kibana.yml`,
you cannot use the `kibana_user` or `kibana_dashboard_only_user` roles
to grant access to {kib}.
You must create custom roles that authorize the user for that specific tenant.
Although multi-tenant installations are supported, the recommended approach
to securing access to {kib} segments is to grant users access to specific spaces.

`logging.dest:`:: *Default: `stdout`* Enables you specify a file where Kibana
Expand Down Expand Up @@ -265,7 +263,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.
Expand All @@ -278,7 +276,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.
Expand Down

0 comments on commit c91797e

Please sign in to comment.