jupyterlab-branding-extension 1.0.5

Jupyterlab extension to use custom logo for the jupyterlab main logo

jupyterlab_branding_extension

JupyterLab branding extension that replaces the default main area logo with a custom image. Supports SVG (inline embedding) and raster formats via a configurable logo URI.

Features

• Custom main area logo - replace the default JupyterLab 3-dot logo with any SVG or raster image
• Configurable via traitlets - set logo_uri in jupyter_lab_config.py or read from JUPYTERLAB_MAIN_ICON_URI environment variable
• Local and remote logos - supports file:// paths, https:// URLs, and local filesystem paths
• Inline SVG embedding - SVG logos are embedded directly in the DOM, matching JupyterLab's native approach
• Server extension - serves local logo files through an authenticated HTTP endpoint, bypassing browser file:// restrictions

Requirements

• JupyterLab >= 4.0.0
• jupyter_server >= 2.0.0

Install

pip install jupyterlab_branding_extension

Configuration

Add to your jupyter_lab_config.py:

import os

# From environment variable (set by JupyterHub or manually)
c.Branding.logo_uri = os.environ.get("JUPYTERLAB_MAIN_ICON_URI", "")

# Or set directly - local file path
c.Branding.logo_uri = "/path/to/your/logo.svg"

# Or set directly - file:// URI
c.Branding.logo_uri = "file:///path/to/your/logo.svg"

# Or set directly - remote URL
c.Branding.logo_uri = "https://example.com/logo.svg"

When no protocol is specified, the path is treated as a local filesystem path.

How It Works

The extension has two components:

• Server extension - exposes /jupyterlab-branding/config (returns the configured logo URL) and /jupyterlab-branding/logo (serves local logo files with correct MIME type)
• Frontend plugin - fetches configuration on startup, retrieves logo content, and replaces the #jp-MainLogo element. SVG logos are embedded inline, raster images use <img> tags

Uninstall

pip uninstall jupyterlab_branding_extension