Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] [Docs] Update publicBaseUrl and rewriteBasePath settings (#195465) #195520

Merged
merged 1 commit into from
Oct 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions docs/setup/settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ deprecation warning at startup. This setting cannot end in a slash (`/`).
[[server-publicBaseUrl]] `server.publicBaseUrl`::
The publicly available URL that end-users access Kibana at. Must include the protocol, hostname, port
(if different than the defaults for `http` and `https`, 80 and 443 respectively), and the
<<server-basePath, `server.basePath`>> (if configured). This setting cannot end in a slash (`/`).
<<server-basePath,`server.basePath`>> (when that setting is configured explicitly). This setting cannot end in a slash (`/`).

[[server-compression]] `server.compression.enabled`::
Set to `false` to disable HTTP compression for all responses. *Default: `true`*
Expand Down Expand Up @@ -487,11 +487,8 @@ Sets whether or not the `X-Opaque-Id` header should be trusted from any IP addre
A list of IPv4 and IPv6 address which the `X-Opaque-Id` header should be trusted from. Normally this would be set to the IP addresses of the load balancers or reverse-proxy that end users use to access Kibana. If any are set, <<server-requestId-allowFromAnyIp, `server.requestId.allowFromAnyIp`>> must also be set to `false.`

[[server-rewriteBasePath]] `server.rewriteBasePath`::
Specifies whether {kib} should
rewrite requests that are prefixed with <<server-basePath, `server.basePath`>> or require that they
are rewritten by your reverse proxy. In {kib} 6.3 and earlier, the default is
`false`. In {kib} 7.x, the setting is deprecated. In {kib} 8.0 and later, the
default is `true`. *Default: `deprecated`*
Specifies whether {kib} should rewrite requests that are prefixed with <<server-basePath,`server.basePath`>> or require that they
are rewritten by your reverse proxy. *Default: `false`*

[[server-socketTimeout]] `server.socketTimeout`::
The number of milliseconds to wait before closing an
Expand Down