Repolode
Submit
timkpaine

timkpaine/jupyterlab-iframe

A JupyterLab extension that opens websites or local HTML files in an iframe widget and can add quicklinks to the launcher.

View on GitHub
Stars
118
Forks
22
Open issues
4
Last commit
5 days ago

What is it?

jupyterlab_iframe lets JupyterLab users view web pages and local HTML files inside an embedded iframe panel, without leaving the notebook environment. Sites are defined as a list in the Jupyter configuration file, each with a path that can be an http or https URL or a local:// path to an HTML file on disk.

Each configured site can be set to open automatically when JupyterLab first loads, which suits landing pages, and can also be given a tile in the launcher. Launcher tiles use a custom icon URL if provided, otherwise the site's favicon. By default any local file can be opened through the local:// scheme, and setting allow_any_local to False restricts access to only the explicitly listed sites.

The project is installed with pip and enabled as a labextension and server extension. It is also used in Binder setups to present a landing page when a notebook environment starts.

Key features

  • 01Embeds web pages and local HTML files in a JupyterLab iframe widget.
  • 02Configures sites as a list with auto-open and launcher options.
  • 03Supports custom launcher icons, falling back to the site favicon.
  • 04Can restrict local file access to explicitly listed sites.

Use cases

  • Keeping project dashboards or documentation pages open alongside notebooks.
  • Showing a landing page or instructions when a Binder environment starts.
  • Opening local HTML reports or visualizations from within JupyterLab.

Quick start

  1. 1

    Install the Python package

    pip install jupyterlab_iframe
  2. 2

    Install the JupyterLab extension

    jupyter labextension install jupyterlab_iframe
  3. 3

    Enable the server extension

    jupyter serverextension enable --py jupyterlab_iframe
  4. 4

    Add the sites list to jupyter_notebook_config.py

Things to know

  • By default any local file on the filesystem can be opened via the local:// scheme unless allow_any_local is set to False.
  • The README's install steps use the older labextension and serverextension commands, which may not match current JupyterLab versions.

Topics

#jupyterlab#jupyter#jupyterlab-extension#iframe#html#web-embedding#jlab

FAQ

What is jupyterlab-iframe?
A JupyterLab extension that opens websites or local HTML files in an iframe widget and can add quicklinks to the launcher. jupyterlab_iframe lets JupyterLab users view web pages and local HTML files inside an embedded iframe panel, without leaving the notebook environment. Sites are defined as a list in the Jupyter configuration file, each with a path that can be an http or https URL or a local:// path to an HTML file on disk.
Is jupyterlab-iframe free to use? What license does it have?
jupyterlab-iframe is open source under the Apache-2.0 license. Check the license terms before using it in commercial products.
Is jupyterlab-iframe still maintained?
Actively maintained. The last commit to jupyterlab-iframe was on Nov 2, 2026.
What can I use jupyterlab-iframe for?
Keeping project dashboards or documentation pages open alongside notebooks. Showing a landing page or instructions when a Binder environment starts. Opening local HTML reports or visualizations from within JupyterLab.
How do I install jupyterlab-iframe?
Install the Python package: pip install jupyterlab_iframe Install the JupyterLab extension: jupyter labextension install jupyterlab_iframe Enable the server extension: jupyter serverextension enable --py jupyterlab_iframe Add the sites list to jupyter_notebook_config.py
Where can I get jupyterlab-iframe?
The source code and installation instructions are on GitHub: https://github.com/timkpaine/jupyterlab-iframe

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects