diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 645f64c105..d7ce73f109 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -93,7 +93,7 @@ *** xref:configuring-default-editor.adoc[] *** xref:concealing-editors.adoc[] *** xref:configuring-editors-download-urls.adoc[] -*** xref:customizing-openshift-che-consolelink-icon.adoc[] +*** xref:customizing-openshift-che-branding-images.adoc[] ** xref:managing-identities-and-authorizations.adoc[] *** xref:configuring-oauth-for-git-providers.adoc[] **** xref:configuring-oauth-2-for-github.adoc[] diff --git a/modules/administration-guide/pages/configuring-dashboard.adoc b/modules/administration-guide/pages/configuring-dashboard.adoc index e65d549efe..56047f6105 100644 --- a/modules/administration-guide/pages/configuring-dashboard.adoc +++ b/modules/administration-guide/pages/configuring-dashboard.adoc @@ -19,5 +19,5 @@ * xref:concealing-editors.adoc[] -* xref:customizing-openshift-che-consolelink-icon.adoc[] +* xref:customizing-openshift-che-branding-images.adoc[] diff --git a/modules/administration-guide/pages/customizing-openshift-che-branding-images.adoc b/modules/administration-guide/pages/customizing-openshift-che-branding-images.adoc new file mode 100644 index 0000000000..31a81b476d --- /dev/null +++ b/modules/administration-guide/pages/customizing-openshift-che-branding-images.adoc @@ -0,0 +1,64 @@ +:_content-type: PROCEDURE +:description: Customizing OpenShift Eclipse Che branding images +:keywords: administration guide, customizing, branding, images +:navtitle: Customizing OpenShift Eclipse Che branding images +:page-aliases: installation-guide:customizing-openshift-che-consolelink-icon.adoc, customizing-openshift-che-consolelink-icon.adoc + +[id="customizing-openshift-che-branding-images"] += Customizing {ocp} {prod} branding images + +Customize the branding images for the {prod} dashboard by overriding the default images in the `assets/branding` directory. The following images can be customized: + +* `che-logo.svg` — the logo displayed in the dashboard header. +* `loader.svg` — the loader icon displayed during dashboard loading. The loader image supports the following formats, in priority order: `jpg`, `jpeg`, `png`, `gif`, `webp`, `svg`. The `svg` format is used as the default fallback. +* `favicon.ico` — the browser tab icon. + +.Prerequisites + +* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}. + +.Procedure + +. Create a Secret that mounts custom branding images into the dashboard: ++ +[source,shell,subs="+quotes,+attributes"] +---- +{orch-cli} apply -f - <__ <1> + loader.svg: ____ <2> + favicon.ico: ____ <3> +type: Opaque +EOF +---- +<1> The dashboard logo. Replace `che-logo.svg` with the Base64-encoded content of your custom logo with disabled line wrapping. +<2> The loader icon. Replace `loader.svg` with the filename matching your image format (for example, `loader.png`, `loader.webp`). The value is the Base64-encoded content of the image with disabled line wrapping. +<3> The favicon. The value is the Base64-encoded content of the `.ico` file with disabled line wrapping. ++ +NOTE: You can override one or all images from the `/public/dashboard/assets/branding` directory in the dashboard pod. Only the images specified in the Secret `data` section are overridden; unspecified images remain unchanged. + +. Verify that the rollout completes: ++ +[source,shell,subs="+attributes"] +---- +{orch-cli} rollout status deployment/{prod-deployment}-dashboard -n {prod-namespace} +---- + +.Verification + +* Open the {prod} dashboard in a browser and confirm that the custom branding images are displayed. + +.Additional resources + +* link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/customizing-the-web-console.html#creating-custom-links_customizing-web-console[Creating custom links in the web console] diff --git a/modules/administration-guide/pages/customizing-openshift-che-consolelink-icon.adoc b/modules/administration-guide/pages/customizing-openshift-che-consolelink-icon.adoc deleted file mode 100644 index b9bfbab583..0000000000 --- a/modules/administration-guide/pages/customizing-openshift-che-consolelink-icon.adoc +++ /dev/null @@ -1,45 +0,0 @@ -:_content-type: PROCEDURE -:description: Customizing OpenShift Eclipse Che ConsoleLink icon -:keywords: administration guide, customizing, consolelink, icon -:navtitle: Customizing OpenShift Eclipse Che ConsoleLink icon -:page-aliases: installation-guide:customizing-openshift-che-consolelink-icon.adoc - -[id="customizing-openshift-che-consolelink-icon"] -= Customizing {ocp} {prod} ConsoleLink icon - -This procedure describes how to customize {prod} link:https://docs.openshift.com/container-platform/{ocp4-ver}/rest_api/console_apis/consolelink-console-openshift-io-v1.html[ConsoleLink] icon. - -.Prerequisites - -* An active `{orch-cli}` session with administrative permissions to the {orch-name} cluster. See {orch-cli-link}. - -.Procedure - -. Create a Secret: -+ -[source,shell,subs="+quotes,+attributes"] ----- -{orch-cli} apply -f - <__ <1> -type: Opaque -EOF ----- -<1> Base64 encoding with disabled line wrapping. - -. Wait until the rollout of {prod-deployment}-dashboard finishes. - -.Additional resources - -* link:https://docs.openshift.com/container-platform/{ocp4-ver}/web_console/customizing-the-web-console.html#creating-custom-links_customizing-web-console[Creating custom links in the web console] \ No newline at end of file