Skip to content

README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

This project demonstrates a **proof of concept** for using a custom JupyterLab plugin to connect to a **remote Jupyter server's kernel manager** using a shared token. It shows how one JupyterLab frontend (Server B) can start and interact with kernels running on another backend Jupyter server (Server A).

![Demo](demo.gif)

---

## 🧩 What This Demo Does
Expand Down Expand Up @@ -52,6 +54,8 @@ Then open your browser at **http://localhost:8889/lab**. The kernel plugin will

You can confirm the kernel was created by checking **http://localhost:8888/api/kernels**.

💡 If prompted for a token in the browser, enter: abc123

## 🐳 Run with Docker

This project comes with a ready-to-use Docker and Docker Compose setup.
Expand All @@ -68,6 +72,8 @@ This launches:
- **http://localhost:8888** → Server A (backend kernel server)
- **http://localhost:8889** → Server B (JupyterLab frontend with plugin)

💡 If prompted for a token in the browser, enter: abc123

After going to **http://localhost:8889/lab**, Server B will start a kernel on Server A when loaded and you can see it in **http://localhost:8888/api/kernels**.

## 💡 Notes
Expand Down
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.