[7.x] Add server.publicBaseUrl config (#85075) (#85361)

Author: joshdover

config/kibana.yml

@@ -18,6 +18,10 @@
 # default to `true` starting in Kibana 7.0.
 #server.rewriteBasePath: false
 
+# Specifies the public URL at which Kibana is available for end users. If
+# `server.basePath` is configured this URL should end with the same basePath.
+#server.publicBaseUrl: ""
+
 # The maximum payload size in bytes for incoming server requests.
 #server.maxPayloadBytes: 1048576
 

docs/development/core/public/kibana-plugin-core-public.ibasepath.md

@@ -18,6 +18,7 @@ export interface IBasePath
 |  --- | --- | --- |
 |  [get](./kibana-plugin-core-public.ibasepath.get.md) | <code>() =&gt; string</code> | Gets the <code>basePath</code> string. |
 |  [prepend](./kibana-plugin-core-public.ibasepath.prepend.md) | <code>(url: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
+|  [publicBaseUrl](./kibana-plugin-core-public.ibasepath.publicbaseurl.md) | <code>string</code> | The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md)<!-- -->. |
 |  [remove](./kibana-plugin-core-public.ibasepath.remove.md) | <code>(url: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
 |  [serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md) | <code>string</code> | Returns the server's root basePath as configured, without any namespace prefix.<!-- -->See  for getting the basePath value for a specific request |
 

docs/development/core/public/kibana-plugin-core-public.ibasepath.publicbaseurl.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [IBasePath](./kibana-plugin-core-public.ibasepath.md) &gt; [publicBaseUrl](./kibana-plugin-core-public.ibasepath.publicbaseurl.md)
+
+## IBasePath.publicBaseUrl property
+
+The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [IBasePath.serverBasePath](./kibana-plugin-core-public.ibasepath.serverbasepath.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+readonly publicBaseUrl?: string;
+```
+
+## Remarks
+
+Should be used for generating external URL links back to this Kibana instance.
+

docs/development/core/server/kibana-plugin-core-server.basepath.md

@@ -22,6 +22,7 @@ The constructor for this class is marked as internal. Third-party code should no
 |  --- | --- | --- | --- |
 |  [get](./kibana-plugin-core-server.basepath.get.md) |  | <code>(request: KibanaRequest &#124; LegacyRequest) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
 |  [prepend](./kibana-plugin-core-server.basepath.prepend.md) |  | <code>(path: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
+|  [publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md) |  | <code>string</code> | The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md)<!-- -->. |
 |  [remove](./kibana-plugin-core-server.basepath.remove.md) |  | <code>(path: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
 |  [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) |  | <code>string</code> | returns the server's basePath<!-- -->See [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request |
 |  [set](./kibana-plugin-core-server.basepath.set.md) |  | <code>(request: KibanaRequest &#124; LegacyRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |

docs/development/core/server/kibana-plugin-core-server.basepath.publicbaseurl.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-core-server](./kibana-plugin-core-server.md) &gt; [BasePath](./kibana-plugin-core-server.basepath.md) &gt; [publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md)
+
+## BasePath.publicBaseUrl property
+
+The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+readonly publicBaseUrl?: string;
+```
+
+## Remarks
+
+Should be used for generating external URL links back to this Kibana instance.
+

docs/development/core/server/kibana-plugin-core-server.httpserverinfo.md

@@ -4,6 +4,7 @@
 
 ## HttpServerInfo interface
 
+Information about what hostname, port, and protocol the server process is running on. Note that this may not match the URL that end-users access Kibana at. For the public URL, see [BasePath.publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md)<!-- -->.
 
 <b>Signature:</b>
 

docs/development/core/server/kibana-plugin-core-server.md

@@ -86,7 +86,7 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
 |  [HttpResourcesRenderOptions](./kibana-plugin-core-server.httpresourcesrenderoptions.md) | Allows to configure HTTP response parameters |
 |  [HttpResourcesServiceToolkit](./kibana-plugin-core-server.httpresourcesservicetoolkit.md) | Extended set of [KibanaResponseFactory](./kibana-plugin-core-server.kibanaresponsefactory.md) helpers used to respond with HTML or JS resource. |
 |  [HttpResponseOptions](./kibana-plugin-core-server.httpresponseoptions.md) | HTTP response parameters |
-|  [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) |  |
+|  [HttpServerInfo](./kibana-plugin-core-server.httpserverinfo.md) | Information about what hostname, port, and protocol the server process is running on. Note that this may not match the URL that end-users access Kibana at. For the public URL, see [BasePath.publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md)<!-- -->. |
 |  [HttpServiceSetup](./kibana-plugin-core-server.httpservicesetup.md) | Kibana HTTP Service provides own abstraction for work with HTTP stack. Plugins don't have direct access to <code>hapi</code> server and its primitives anymore. Moreover, plugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood. This gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins. If the HTTP Service lacks functionality you need, we are happy to discuss and support your needs. |
 |  [HttpServiceStart](./kibana-plugin-core-server.httpservicestart.md) |  |
 |  [I18nServiceSetup](./kibana-plugin-core-server.i18nservicesetup.md) |  |

docs/setup/settings.asciidoc

@@ -442,6 +442,11 @@ running behind a proxy. Use the <<server-rewriteBasePath, `server.rewriteBasePat
 if it should remove the basePath from requests it receives, and to prevent a
 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-compression]] `server.compression.enabled:`
  | Set to `false` to disable HTTP compression for all responses. *Default: `true`*
 

packages/kbn-config/src/legacy/__snapshots__/legacy_object_to_config_adapter.test.ts.snap

@@ -90,6 +90,7 @@ describe('#get', () => {
         keepaliveTimeout: 5000,
         socketTimeout: 2000,
         port: 1234,
+        publicBaseUrl: 'https://myhost.com/abc',
         rewriteBasePath: false,
         ssl: { enabled: true, keyPassphrase: 'some-phrase', someNewValue: 'new' },
         compression: { enabled: true },
@@ -113,6 +114,7 @@ describe('#get', () => {
         keepaliveTimeout: 5000,
         socketTimeout: 2000,
         port: 1234,
+        publicBaseUrl: 'http://myhost.com/abc',
         rewriteBasePath: false,
         ssl: { enabled: false, certificate: 'cert', key: 'key' },
         compression: { enabled: true },