github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Reporting] update logs and docs on headless browser connection (#179882)

Browse source 
## Summary

This resolves some issues we've seen over confusion on configuration and
refused access to Kibana while generating a PNG/PDF report.
This commit is contained in:
Tim Sullivan 2024-04-03 08:15:12 -07:00 • committed by GitHub
parent 43de4b5d57
commit 982303882e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 44 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

71
docs/setup/configuring-reporting.asciidoc
View file

@ -10,39 +10,13 @@ For security, you grant users access to the {report-features} and secure the rep
with TLS/SSL encryption. Additionally, you can install graphical packages into the operating system
to enable the {kib} server to have screenshotting capabilities.
* <<install-reporting-packages>>
* <<grant-user-access>>
* <<reporting-roles-user-api>>
* <<grant-user-access-basic>>
* <<grant-user-access-external-provider>>
* <<securing-reporting>>
[float]
[[install-reporting-packages]]
=== Install the reporting packages
Make sure the {kib} server operating system has the appropriate packages installed for the distribution.
If you are using RHEL operating systems, install the following packages:
* `ipa-gothic-fonts`
* `xorg-x11-fonts-100dpi`
* `xorg-x11-fonts-75dpi`
* `xorg-x11-utils`
* `xorg-x11-fonts-cyrillic`
* `xorg-x11-fonts-Type1`
* `xorg-x11-fonts-misc`
* `fontconfig`
* `freetype`
If you are using Ubuntu/Debian systems, install the following packages:
* `fonts-liberation`
* `libfontconfig1`
* `libnss3`
The reporting plugin has a built-in utility to check for common issues, such as missing dependencies. See
<<reporting-diagnostics>> for more information.
* <<install-reporting-packages>>
* <<set-reporting-server-host>>
[float]
[[grant-user-access]]
@ -231,3 +205,44 @@ For more information, see {ref}/notification-settings.html#ssl-notification-sett
Once you've enabled SSL for {kib}, all requests to the reporting endpoints must include valid credentials.
For more information on sharing reports, direct links, and more, refer to <<reporting-getting-started, Reporting and sharing>>.
[float]
[[install-reporting-packages]]
=== Install the dependencies for the headless browser
If using PNG/PDF {report-features}, make sure the {kib} server operating system has the appropriate packages installed for the distribution.
If you are using RHEL operating systems, install the following packages:
* `ipa-gothic-fonts`
* `xorg-x11-fonts-100dpi`
* `xorg-x11-fonts-75dpi`
* `xorg-x11-utils`
* `xorg-x11-fonts-cyrillic`
* `xorg-x11-fonts-Type1`
* `xorg-x11-fonts-misc`
* `fontconfig`
* `freetype`
If you are using Ubuntu/Debian systems, install the following packages:
* `fonts-liberation`
* `libfontconfig1`
* `libnss3`
The screenshotting plugin used for {reporting-features} has a built-in utility to check for common issues, such as missing dependencies. See
<<reporting-diagnostics>> for more information.
[float]
[[set-reporting-server-host]]
=== Set the `server.host` for the headless browser
If using PNG/PDF {report-features} in a production environment, it is preferred to use the setting of
`server.host: 0.0.0.0` in the `kibana.yml` configuration file. This allows the headless browser used for
PDF/PNG reporting to reach {kib} over a local interface, while also allowing the {kib} server to listen on
outward-facing network interfaces, as it makes the {kib} server accessible from any network interface on the
machine. Make sure that no firewall rules or other routing rules prevent local services from accessing this
address.
For the most reliable configuration of PDF/PNG {report-features}, consider installing {kib} using <<docker, Docker>>, or
using <<set-up-on-cloud, Elastic Cloud>>.

5
x-pack/plugins/reporting/server/config/create_config.ts
View file

@ -45,10 +45,7 @@ export function createConfig(
ipaddr.isValid(kibanaServerHostname) &&
!sum(ipaddr.parse(kibanaServerHostname).toByteArray())
) {
logger.info(
`Overriding server host address "0.0.0.0" in Reporting runtime config,` +
` using "xpack.reporting.kibanaServer.hostname: localhost".`
);
// A silent override to use "localhost" instead of "0.0.0.0" for connection of the headless browser
kibanaServerHostname = 'localhost';
}
// kibanaServer.port, default to server.port