mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-21 07:28:44 +00:00
How to guide for custom logo (#10293)
* How to guide for custom logo * add to menu
This commit is contained in:
parent
0ba1882bc3
commit
61c896964e
@ -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
|
||||
|
||||
<Image src="/images/how-to-guides/custom-logo/login-Page-Logo.png" alt="loginPage-image"/>
|
||||
|
||||
2. Navigation Bar
|
||||
|
||||
<Image src="/images/how-to-guides/custom-logo/nav-Bar-Logo.png" alt="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.
|
@ -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
|
||||
|
Binary file not shown.
After Width: | Height: | Size: 2.5 MiB |
Binary file not shown.
After Width: | Height: | Size: 1.1 MiB |
Loading…
x
Reference in New Issue
Block a user