Skip to content

Deploying Custom html pages and images

Jump to bottom
Rayulu edited this page Oct 16, 2017 · 7 revisions

Sunbird supports configuration of multiple tenants (or channels) in a single instance. Each tenant can configure the home page, logo and favicon to be displayed in portal and mobile app for users of that tenant.

  • The home page html file should be named "index.html". All the dependent files (like js, css and images) used by the home page should be either
    • within the package and referred using relative paths from "index.html"
    • or hosted in a CDN and referred by the full CDN URL from the html files
  • The logo of the tenant should be with the name "logo.png"
  • Optionally, tenants can also configure the following:
    • an icon (to be displayed as browser favicon) which should be named as "favicon.ico"
    • poster image (to be used as flash screen in the mobile app) which should be named as "poster.png"

Sunbird supports overriding of default home page and configuring a custom home page, logo, favicon, poster and dependency files. It should contain package containing the following files for customising the home page:

  • The home page html file should be named "index.html". All the dependent files (like js, css and images) used by the home page should be within the package and referred using relative paths from the "index.html".
  • The logo of the tenant which should be with the name "logo.png" optionally, tenants can also configure the following: an icon (to be displayed as browser favicon) which should be named as "favicon.ico"
  • A poster image (to be used as flash screen in the mobile app) which should be named as "poster.png" All the above files should be placed within a folder whose name is same as the "channel" value of the tenant.

The above package should be placed inside <APP-FOLDER>/tenant/

Find below Example package structure which is having sunbird_1 as one of the tenant

open web page in browser with /sunbird_1 after web site url, for example: http://www.sunbird.org/sunbird_1

By changing sunbird_default_tenant variable in environment to sunbird_1 this tenant becomes default home page and on opening url (example : http://www.sunbird.org) it will open sunbird_1 as home page without adding /sunbird_1 at the end of the url.

Clone this wiki locally