Branding Name and Logo Configuration Guide

This document explains how users can configure the branding name and logo for their Sunbird application using the sunbird_tenant_cdn_url .

The configuration allows customization of various branding assets such as logos, app logos, favicons, and posters.

i. Brand Logo

ii) Brand favicon

iii) Poster

---

Configuration overview

The branding assets are served through a Content Delivery Network (CDN) and follow a specific URL structure. The assets must be stored under a tenant directory with predefined image names. If no custom branding is provided, default branding assets for Sunbird will be used.

The CDN URL must follow the structure: sunbird_tenant_cdn_url/tenant_id/image_name

Example:http://sunbirded/NCF/logo.png

Here:

• sunbird_tenant_cdn_url: The base URL of the CDN (e.g., `http://sunbirded`).

• tenant_id: The tenant identifier (e.g., `NCF`). Configured as sunbird_default_channel

• image_name: The predefined name of the branding asset (e.g., `logo.png`).

---

Predefined Image Names

To properly configure branding, the following image names must be used:

Asset	Image Name	Description
Logo	logo.png	The primary logo displayed on the application.
App Logo	appLogo.png	The logo specifically used for the mobile app
Favicon	favicon.ico	The small icon displayed in the browser tab or address bar
Poster	poster.png	A poster image for informational displays [Optional]

Default Branding

If no custom branding is provided, the application will fall back to the default Sunbird branding. The default branding assets include:

• Logo: A generic Sunbird logo.

• App Logo: Same as the default Sunbird logo for mobile application.

• Favicon: A Sunbird-themed favicon.

• Poster: A default poster image for Sunbird.

---

Steps to Configure Branding

1. Prepare the Branding Assets:

   1. Ensure that the images are in the correct formats:

      1. logo.png and appLogo.png: PNG format.

      2. favicon.ico: ICO format.

      3. poster.png: PNG format.

   2. Use the exact file names as specified above.

2. Upload Assets to the CDN:

   1. Place the assets in the appropriate tenant directory under the CDN.

   2. For example:

      1. http://sunbirded/NCF/logo.png

      2. http://sunbirded/NCF/appLogo.png

      3. http://sunbirded/NCF/favicon.ico

      4. http://sunbirded/NCF/poster.png

3. Update the Configuration:

   1. Set the sunbird_tenant_cdn_url to the base URL of the CDN in the environment configuration.

   2. Example:

      1. sunbird_tenant_cdn_url=http://sunbirded

      2. sunbird_default_channel=NCF

4. Verify the Branding:

   1. Access the application and ensure that the branding assets are correctly displayed.

   2. If any asset is missing or not configured, the default branding will be used.

---

Troubleshooting

1. Missing or Incorrect Branding:

   1. Verify the URL structure and ensure the assets are correctly named and placed in the tenant directory.

   2. Check the sunbird_tenant_cdn_url and sunbird_default_channel configurations.

2. Fallback to Default Branding:

   1. If the custom asset is not found, the application will use the default Sunbird branding.

   2. Ensure that the asset exists in the CDN with the correct file name.