Repolode
jupyterhub

jupyterhub/jupyter-server-proxy

Jupyter 服务器扩展,可将 RStudio、Code Server 等外部 Web 服务经认证后通过路径代理访问。

Star
405
Fork
155
未关闭 Issue
95
最近提交
5天前

这是什么?

Jupyter Server Proxy 允许 Notebook 服务器启动 RStudio、Shiny Server、Code Server、PostgreSQL 等任意外部进程,并把它们的 Web 界面挂载到 /rstudio 之类的路径下,与 /lab 并列。访问经过 Jupyter 服务器的身份认证,用户无需单独开放端口。

它主要配合 JupyterHub 或 Binder 使用,让用户直接进入与 Jupyter 无关的 Web 工具,如 RStudio、Shiny 或 OpenRefine。随包提供的 JupyterLab 扩展还会在启动器中为已注册的服务添加按钮。

此外,Notebook 或 JupyterLab 扩展中的前端 JavaScript 也可以通过服务器访问本地进程的 Web API。项目建议确保被代理的进程无法被直接访问,例如将服务器运行在容器中。

核心功能

  • 01将外部进程的 Web 服务以路径形式挂载在 Notebook 界面旁。
  • 02代理访问沿用 Jupyter 服务器的身份认证。
  • 03随包提供 JupyterLab 扩展,为已注册的服务添加启动按钮。
  • 04可通过 pip 或 conda-forge 安装。
  • 05适用于 JupyterHub 和 Binder 部署。

适用场景

  • 在 JupyterHub 部署中为用户启动 RStudio 或 Shiny。
  • 让 Notebook 用户访问 OpenRefine、Code Server 等 Web 工具。
  • 让 JupyterLab 扩展调用本地进程的 Web API,例如 dask-labextension 的场景。

快速上手

  1. 1

    使用 pip 安装 Python 包

    pip install jupyter-server-proxy
  2. 2

    或从 conda-forge 安装

    conda install -c conda-forge jupyter-server-proxy

使用前须知

  • 被代理的进程需要单独做安全防护,否则其他用户可能绕过 Jupyter 服务器直接访问它们,例如可将服务器运行在容器中以限制网络访问。

标签

常见问题

jupyter-server-proxy 是什么?
Jupyter 服务器扩展,可将 RStudio、Code Server 等外部 Web 服务经认证后通过路径代理访问。 Jupyter Server Proxy 允许 Notebook 服务器启动 RStudio、Shiny Server、Code Server、PostgreSQL 等任意外部进程,并把它们的 Web 界面挂载到 /rstudio 之类的路径下,与 /lab 并列。访问经过 Jupyter 服务器的身份认证,用户无需单独开放端口。
jupyter-server-proxy 可以免费使用吗?用的什么许可证?
jupyter-server-proxy 以 BSD-3-Clause 许可证开源。用于商业产品前,请先确认许可证条款。
jupyter-server-proxy 还在维护吗?
活跃维护中。jupyter-server-proxy 最近一次提交是在 2026年11月2日。
jupyter-server-proxy 适合用来做什么?
在 JupyterHub 部署中为用户启动 RStudio 或 Shiny。 让 Notebook 用户访问 OpenRefine、Code Server 等 Web 工具。 让 JupyterLab 扩展调用本地进程的 Web API,例如 dask-labextension 的场景。
jupyter-server-proxy 怎么安装和运行?
使用 pip 安装 Python 包: pip install jupyter-server-proxy 或从 conda-forge 安装: conda install -c conda-forge jupyter-server-proxy
在哪里获取 jupyter-server-proxy?
源代码和安装说明在 GitHub 上:https://github.com/jupyterhub/jupyter-server-proxy

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目