在独立服务器或本地部署 JupyterLite#

部署 JupyterLite 网站需要

  • JupyterLite 网站资产的副本

    • 通常由 pip 可安装的 Python 包 jupyterlite-core 提供

  • 一组可选的网站和不同应用程序配置

    • 不同的选项在可重复性、构建速度、部署大小以及最终用户性能、隐私和安全性之间提供了权衡

获取空的 JupyterLite 网站#

最小的可部署网站存档包含运行所有默认 应用程序 的必要内容,但没有内容。

提示

CLI 的使用是可选的,但建议使用。它提供了与其他 Jupyter 工具的更好集成。

要从 PyPI 获取 Python CLIAPI

python -m pip install jupyterlite-core

您也可以使用 condaconda forge 安装 CLI

conda install -c conda-forge jupyterlite-core

mamba

mamba install -c conda-forge jupyterlite-core

要构建一个空的网站(只有 JupyterLite 静态资产)

jupyter lite init

默认情况下,JupyterLite 网站将放置在 _output 文件夹中。您可以使用 --output-dir 参数指定不同的位置。例如

jupyter lite build --output-dir dist

注意

默认情况下,jupyterlite-core 包不提供任何内核。如果您想在环境中安装一个内核,则需要在构建环境中安装它。例如,要为 JupyterLite 安装 Pyodide 内核

python -m pip install jupyterlite-pyodide-kernel

然后确保重新运行 jupyter lite build 命令。

自定义网站#

默认情况下,JupyterLite 网站将为空,但您可以通过添加自己的内容和配置来对其进行自定义。

文档包含几个关于自定义网站的操作指南

查看 操作指南 列表以获取更多信息。

独立服务器#

现在静态资产已经构建完成,您可以使用一个简单的 HTTP 服务器来提供它们,并从 Web 浏览器访问 JupyterLite。

适用于本地开发,许多语言提供了易于使用的服务器,可以在您按照自己的意愿进行配置时,在本地提供 JupyterLite。

警告

提供某些内核需要您的 Web 服务器支持使用正确的标头提供 application/wasm 文件

提示

建议使用支持 HTTPS 的服务器,除了最简单的 localhost 案例。

jupyter lite serve#

命令 jupyter lite serve 提供了两种 Web 服务器,一种是基于 Python 内置的 http.server,另一种是 tornado,如果安装了其他 Jupyter 工具,则很可能可以使用 tornado

在同一目录下,运行以下命令启动服务器

jupyter lite serve

注意

还有其他选项可用,例如更改端口和日志级别。使用 jupyter lite serve --help 查看帮助以了解更多信息。

Jupyter#

如果您已经在运行 Jupyter Server 驱动的应用程序(例如 JupyterLab),则您的文件将在例如 https://127.0.0.1:8888/files 上正确提供。

Python#

http.server#

Python 标准库中的 http 模块是一个非常有效的本地服务器。

python -m http.server -b 127.0.0.1

如果您使用的是最近发布的 Python 3.7+,它将为 WebAssembly 内核正确提供 application/wasm 文件。

NodeJS#

大多数基于 nodejs 的服务器都可以毫无问题地托管 JupyterLite。但是请注意,http-server 不支持 application/wasm MIME 类型。

使用发布存档#

作为使用 jupyter-lite CLI 的替代方法,您还可以从 GitHub Releases 页面下载发布存档。

下载并解压缩它,然后使用上面提到的方法之一启动服务器。

您还可以从 GitHub actions 获取 nightly 和正在开发的存档。