diff --git a/openmetadata-docs/content/how-to-guides/custom-logo/how-to-add-custom-logo.md b/openmetadata-docs/content/how-to-guides/custom-logo/how-to-add-custom-logo.md new file mode 100644 index 00000000000..9842fb19db7 --- /dev/null +++ b/openmetadata-docs/content/how-to-guides/custom-logo/how-to-add-custom-logo.md @@ -0,0 +1,48 @@ +--- +title: How to change the Login Page and Nav Bar Logo +slug: /how-to-guides/custom-logo/how-to-add-custom-logo +--- + +To change the Logo for the application, we need to update logo at two locations. + +1. Login Page + +loginPage-image + +2. Navigation Bar + +navBar-image + +# How to add a custom logo for the application + +### Step 1: Get the image size as per the following formats. + +- Login Page (1 px x 2px) +- Navigation Bar (1 px x 2px) + +### Step 2: Configure 'openmetadata.yaml' or the corresponding environment variables + +```yaml +applicationConfig: + logoConfig: + logoLocationType: ${OM_LOGO_LOCATION_TYPE:-openmetadata} #either "openmetadata' or { "url" or "filePath" , based on this specify either '*AbsoluteFilePath' or '*LogoUrlPath' } + loginPageLogoAbsoluteFilePath: ${OM_LOGO_LOGIN_LOCATION_FILE_PATH:-""} #login page logo , work in "filePath" mode + loginPageLogoUrlPath: ${OM_LOGO_LOGIN_LOCATION_URL_PATH:-""} #login page logo , work in "url" mode + navBarLogoAbsoluteFilePath: ${OM_LOGO_NAVBAR_LOCATION_FILE_PATH:-""} #nav bar logo , work in "filePath" mode + navBarLogoUrlPath: ${OM_LOGO_NAVBAR_LOCATION_URL_PATH:-""} #nav bar logo , work in "url" mode +``` +1. `logoLocationType` set to 'openmetadata' + + - In this case it will take the default OM logo, we don't need to configure anything else. + +2. `logoLocationType` set to 'filePath' + + - In this case it will take the custom logo from the specified absolute paths, need to configure following as well. + - `loginPageLogoAbsoluteFilePath` -> This is the path for Login Page Logo Image. + - `navBarLogoAbsoluteFilePath` -> This is the path for Navigation Bar Logo Image. + +3. `logoLocationType` set to 'url' + + - In this case it will take the custom logo from the specified url, need to configure following as well. + - `loginPageLogoUrlPath` -> This is the url for Login Page Logo Image. + - `navBarLogoUrlPath` -> This is the url for Navigation Bar Logo Image. diff --git a/openmetadata-docs/content/menu.md b/openmetadata-docs/content/menu.md index 7f9e496a232..dcdd8fd51f6 100644 --- a/openmetadata-docs/content/menu.md +++ b/openmetadata-docs/content/menu.md @@ -575,6 +575,8 @@ site_menu: url: /how-to-guides/teams-and-users/how-to-organise-teams-and-users - category: How to guides / How to add a custom property to an entity url: /how-to-guides/how-to-add-custom-property-to-an-entity + - category: How to guides / How to add Custom Logo + url: /how-to-guides/custom-logo/how-to-add-custom-logo - category: Features url: /openmetadata diff --git a/openmetadata-docs/images/how-to-guides/custom-logo/login-Page-Logo.png b/openmetadata-docs/images/how-to-guides/custom-logo/login-Page-Logo.png new file mode 100644 index 00000000000..6c2f78a3698 Binary files /dev/null and b/openmetadata-docs/images/how-to-guides/custom-logo/login-Page-Logo.png differ diff --git a/openmetadata-docs/images/how-to-guides/custom-logo/nav-Bar-Logo.png b/openmetadata-docs/images/how-to-guides/custom-logo/nav-Bar-Logo.png new file mode 100644 index 00000000000..dad0d7ae20e Binary files /dev/null and b/openmetadata-docs/images/how-to-guides/custom-logo/nav-Bar-Logo.png differ