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.

Sign up for GitHub

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

RHIDP-3504: Update the doc on changing RHDH logo #1033

Merged
merged 4 commits into from
Apr 3, 2025
Merged

RHIDP-3504: Update the doc on changing RHDH logo #1033

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5bc6b3c
Update the doc on changing RHDH logo
invalid-email-address Mar 31, 2025
8bca66b
Update the doc on changing RHDH logo
invalid-email-address Mar 31, 2025
cb97e4a
Update the doc on changing RHDH logo
invalid-email-address Apr 2, 2025
2020e64
Update the doc on changing RHDH logo
invalid-email-address Apr 2, 2025
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
20 changes: 18 additions & 2 deletions modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
[id="proc-customize-rhdh-branding-logo_{context}"]
= Customizing the branding logo of your {product-short} instance

You can customize the branding logo of your {product-short} instance by configuring the `branding` section the `{my-app-config-file}` file, as shown in the following example:
You can customize the branding logo of your {product-short} instance by configuring the `branding` section in the `{my-app-config-file}` file, as shown in the following example:

[source,yaml]
[source,yaml,subs="+quotes"]
----
app:
branding:
Expand All @@ -19,6 +19,22 @@ where:

<1> `fullLogo` is the logo on the expanded (pinned) sidebar and expects a base64 encoded image.
<2> `iconLogo` is the logo on the collapsed (unpinned) sidebar and expects a base64 encoded image.
+
You can format the `BASE64_EMBEDDED_FULL_LOGO` environment variable as follows:
+
[source,yaml,subs="+quotes"]
----
BASE64_EMBEDDED_FULL_LOGO: "data:_<media_type>_;base64,_<base64_data>_"
----
+
The following example demonstrates how to customize the `BASE64_EMBEDDED_FULL_LOGO` using the `data:_<media_type>_;base64,_<base64_data>_` format:
+
[source,yaml,subs="+quotes"]
----
SVGLOGOBASE64=$(base64 -i logo.svg)
BASE64_EMBEDDED_FULL_LOGO="data:image/svg+xml;base64,$SVGLOGOBASE64"
----
Replace `image/svg+xml` with the correct media type for your image (for example, `image/png` and `image/jpeg`), and adjust the file extension accordingly. As a result, you can embed the logo directly without referencing an external file.

You can also customize the width of the branding logo by setting a value for the `fullLogoWidth` field in the `branding` section, as shown in the following example:

Expand Down