Branding the Web Console

Branding the Web Consle mainly concerns hooking into the looks of the Web Console providing vendor-provided setup like

• CSS
• Logo
• Main Title
• Vendor URL

Branding support is currently work in progress tracked by FELIX-1015.

Branding for the Web Console can be provided in two ways: By registering a BrandingPlugin service or by providing a branding properties files. The Web Console uses the branding from the BrandingPlugin service registered with the highest ranking.

If no BrandingPlugin service is registered, the DefaultBrandingPlugin is used.

The DefaultBrandingPlugin reads the /META-INF/webconsole.properties from the web console bundle to setup the branding using the following properties:

Property Name	Default Value	Description
webconsole.product.name	Apache Felix	The name of the product installed in the framework
webconsole.product.url	http://felix.apache.org	The URL at which more information about the product is available
webconsole.product.image	/res/imgs/logo.png	A logo representing the product
webconsole.vendor.name	The Apache Software Foundation	The name of the product vendor
webconsole.vendor.url	http://www.apache.org	The URL of the product vendor
webconsole.vendor.image	/res/imgs/logo.png	A logo representing the product vendor
webconsole.favicon	/res/imgs/favicon.ico	A favicon for the web console
webconsole.stylesheet	/res/ui/webconsole.css	A CSS file containing style-sheet formatting

Note: The /META-INF/webconsole.properties file is not contained in the Apache Felix Web Console bundle itself. It may be provided by a Fragment Bundle attaching to the Apache Felix Web Console bundle. For an example of such a fragment bundle see prototype Sling Web Console Branding Bundle