🧒
Sunbird ED
new release -7.0.0 (Jun 2024)Askdot
latest
latest
  • Learn
    • Overview
    • Capabilities
      • Learning Apps
      • Asset Sourcing
      • Organised Collections
      • Discover Content - Digital & Phygital
      • User Engagement
      • Rich and diverse content
      • Versatile Question Bank
      • Observability
      • Launch Course
      • Verifiable Credentials
      • Multi-Channel Chatbot
      • Targeted Programs
      • Manage Learn
        • Overview
        • What is an entity?
        • What is a Program?
        • What is a Project?
        • What is Observation?
        • What is a Survey?
        • What is Observation as a task inside a Project?
      • Product and Developer's Guide
        • Learning apps
          • Workflows
            • Onboarding of Users
            • Discovery of Content
            • Play content
            • Track progress and Earn credentials
            • Interacting / Collaborating
        • Asset Sourcing
        • Organised Collections
        • Discover Content - Digital & Phygital
        • User Engagement
        • Rich and Diverse Content
        • Versatile Question Bank
        • Observability
        • Launch Courses
        • Verifiable Credentials
        • Multi-Channel Chatbot
        • Targeted Programs
        • Manage Learn
          • Overview
          • Component Diagram
          • ML Core Service
          • ML Project Service
          • ML Survey Service
          • ML Report Service
          • ML Analytics Service
    • Tech Overview
      • Design Principles
      • Technical Architecture Diagram
      • Tech Stack
    • Adopters
      • DIKSHA
    • Roadmap
      • Plan for 2025-2026
      • Releases and Dates
  • USE
    • Getting Started - Setup
      • Pre-requisites
      • Install
      • Functional Configurations
    • Developer Guide - Overview
      • Architecture - Component Diagram
      • System Requirements
        • Learning Apps
      • Install Locally
        • SunbirdED Mobile
        • SunbirdED Portal
      • Easy Installer
        • Adding Support for a New Cloud Provider
      • Configuration
        • SunbirdEd Portal
        • Sunbird Mobile
      • Portal
        • Component Diagram
        • I18N (Resource Bundles)
        • Branding Name and Logo Configuration Guide
      • Desktop
        • Component Diagram
      • Mobile
        • Component Diagram
        • sunbird-mobile-sdk
        • Sunbird-mobile-app plugins
        • Configurations to setup mobile app
        • I18N (Resource Bundles)
      • Form service
        • Component Diagram
        • Data model
        • API's
      • Manage Learn
        • ML Core Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Project Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Survey Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Report Service
          • Overview
          • User Flow Diagram
          • Component Diagram
          • Data Model
          • Folder Structure
          • API's
          • Deployment Overview
          • Local Service Setup Guide
        • ML Analytics Service
          • Overview
          • Component Diagram
          • Data Model
          • Setup Guide
            • ENV Variables ( Config.ini)
          • Ingestions
          • Folder Structure
          • Report creation and Updation Scripts
          • Deployment Overview
      • UI (User interface)
        • Angular Material
          • Overview
          • Installation
          • Material Icons
          • Components Usage
          • Theming
          • Theme Setup
          • Customazion
            • Palette
            • Theme
            • Accessibility
            • Colors
            • Typography
            • Components
              • Buttons
              • CC Components
        • Component Style Guide Version 1
          • Accordion
          • Buttons
          • Cards
          • Forms
          • Grid & Layout
          • Labels
          • Modals
          • Pagination
          • Rating
          • Search Box
          • Select Box
          • Tables
          • Tabs
          • Toast messages
          • Tooltip
          • Typography
        • SB-Styles: A Comprehensive Design Resource
        • SB-Themes Repository: Unifying Design Across Platforms
          • Classical Theme in Sunbird-Ed portal
          • Joyful Theme in Sunbird-Ed portal:
      • Reference Apps
        • Independent Libraries
          • Common Consumption Components
          • SunbirdEd Forms
          • Sunbird Client Services
          • Sunbird Styles
          • Sunbird Themes
          • Sunbird Tag Manager
      • API's
      • CSP changes
      • Cloud-Store SDK Maven Deployment Guide
      • Other
        • Building Images
        • Minimal forms
        • Telemetry
          • Trackable Collection
        • Platform
        • Learning Apps
    • Learn More
      • Dependencies
      • Specifications
        • SOFIE
        • SOFIE Implementation
  • SB Ed Releases
    • Sunbird v7.6.0 (Latest)
    • Sunbird v7.5.1
    • Release - SB 7.5
    • SB Release - 7.0.0
      • Release notes
      • Updating Sunbird Releases
        • 6.0.1 to 7.0.0
      • Release Calendar 7.0.0
      • Demo of released items
  • Engage
    • Discuss
    • Contribute to Sunbird ED
    • Extend / Contribute to Sunbird
    • Issue tracker/ Create Issue
  • Misc
    • Templates
      • Upgrade Sunbird release document
      • Release Notes
    • Misc Pages
      • Portal - Manage Learn - Reports
      • App - Manage Learn - component diagram
        • Projects
        • Observation & Survey
        • Program
      • Portal - Manage Learn - component diagram
      • Mobile form configurations
      • Content Indexing Flow
      • What are multiple databases used for
      • Course completion, reports and certificate issue
      • How to access Flink UI
      • What are all the flink jobs for
      • How does data flow into Druid
      • Minimal build properties
      • Delete User Functionality
    • Archived
      • High Level Capabilities
      • Workflows
      • Where Sunbird ED helps you
      • ED - Mobile App (going to archive)
        • 4.10.3 to 5.0.0
        • 5.0.0 to 5.1.0
      • Setting up Sunbird ED
      • Developer Documentation
      • API Reference Documentation
      • Detailed Documentation
      • Source Code
      • Actors & Actions
      • Detailed Capabilities
      • Data
      • Terminology
      • 5.1.0-hotfix (OCI )
      • Getting started (v7)
        • Deployment Overview
        • Pre-requisites
        • Install
          • Provision Cloud Infrastructure
          • Setup Jenkins
          • Update Ansible Variables
          • Build, Provision and Deploy
          • Functional Configurations
Powered by GitBook
On this page
  • Configuration overview
  • Predefined Image Names
  • Default Branding
  • Steps to Configure Branding
  • Troubleshooting
  1. USE
  2. Developer Guide - Overview
  3. Portal

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 .

Last updated 5 months ago

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

i. Brand Logo
ii) Brand favicon

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

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:

  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.

iii) Poster

Example:

http://sunbirded/NCF/logo.png
http://sunbirded/NCF/logo.png
http://sunbirded/NCF/appLogo.png
http://sunbirded/NCF/favicon.ico
http://sunbirded/NCF/poster.png