Skip to content

Commit

Permalink
Add suggested font packages in troubleshooting tips (opensearch-proje…
Browse files Browse the repository at this point in the history
…ct#189)

* add suggested font packages in troubleshooting tips
Signed-off-by: David Cui <[email protected]>

* add links to package documentation in README for font packages
Signed-off-by: David Cui <[email protected]>

* add more descriptive title under Troubleshooting

Signed-off-by: David Cui <[email protected]>

* add link to headless-chrome installation and add ipa-gothic-fonts link to centos 7

Signed-off-by: David Cui <[email protected]>
  • Loading branch information
davidcui1225 authored Nov 10, 2021
1 parent 5f01a02 commit 1fdbadc
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,35 @@ OpenSearch Dashboards Reports integration with [Notifications](https://github.co

## Troubleshooting

#### Fail to launch Chromium
### Fail to launch Chromium

There could be two reasons for this problem

1. You are not having the correct version of headless-chrome matching to the OS that your OpenSearch Dashboards is running. Different versions of headless-chrome can be found [here](https://github.com/opensearch-project/dashboards-reports/releases/tag/chromium-1.12.0.0)

2. Missing additional dependencies. Please refer to [additional dependencies section](./dashboards-reports/rendering-engine/headless-chrome/README.md#additional-libaries) to install required dependencies according to your operating system.

### Missing Font Dependencies
Chromium may not have all of the dependencies you may require to be able to view all of the content of your reports.

If you are using a CentOS/RHEL system, install the following packages:
* [`ipa-gothic-fonts`](https://centos.pkgs.org/7/centos-x86_64/ipa-gothic-fonts-003.03-5.el7.noarch.rpm.html)
* [`xorg-x11-fonts-100dpi`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-100dpi-7.5-9.el7.noarch.rpm.html)
* [`xorg-x11-fonts-75dpi`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-75dpi-7.5-9.el7.noarch.rpm.html)
* [`xorg-x11-utils`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-utils-7.5-23.el7.x86_64.rpm.html)
* [`xorg-x11-fonts-cyrillic`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-cyrillic-7.5-9.el7.noarch.rpm.html)
* [`xorg-x11-fonts-Type1`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-Type1-7.5-9.el7.noarch.rpm.html)
* [`xorg-x11-fonts-misc`](https://centos.pkgs.org/7/centos-x86_64/xorg-x11-fonts-misc-7.5-9.el7.noarch.rpm.html)
* [`fontconfig`](https://www.freedesktop.org/wiki/Software/fontconfig/)
* [`freetype`](https://freetype.org/)


If you are using a Ubuntu/Debian system, install the following packages:
* [`fonts-liberation`](https://packages.debian.org/search?keywords=fonts-liberation)
* [`libfontconfig1`](https://packages.debian.org/sid/libfontconfig1)

The installation command for both systems can be found [here](./dashboards-reports/rendering-engine/headless-chrome/README.md).

## Code of Conduct

This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ sudo apt install -y libnss3-dev fonts-liberation libfontconfig1
```
- RedHat/CentOS/Amazon Linux 2 needs additional dependencies to run chromium
```
sudo yum install -y libnss3.so 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
sudo yum install -y libnss3.so 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 ipa-gothic-fonts
```

0 comments on commit 1fdbadc

Please sign in to comment.