nersc/jupyterhub

NERSC/JupyterHub镜像说明

镜像概述

本镜像为NERSC分支的JupyterHub，包含本地修改。JupyterHub是Project Jupyter推出的多用户Hub系统，可生成、管理并代理多个单用户Jupyter笔记本服务器，支持教学、企业数据科学团队、科研项目或高性能计算组等场景。

核心功能

1. 多用户Hub: 基于Tornado进程的Hub，处理用户登录并按需生成单用户服务器。
2. 可配置HTTP代理: 使用node-http-proxy转发请求至Hub或单用户服务器。
3. 单用户服务器: 支持多个Python/IPython/Tornado笔记本服务器实例。
4. REST API: 提供Hub及用户管理的REST接口，便于系统集成。

使用场景

• 教学场景: 为学生提供统一的笔记本环境，支持课堂互动与作业提交。
• 企业协作: 数据科学团队共享计算资源，协同分析数据。
• 科研项目: 研究人员快速搭建共享分析平台，加速科研进程。
• 高性能计算: HPC群组管理笔记本服务，整合计算资源。

配置说明

前置条件

• Linux/Unix系统。
• Python 3.4+、nodejs/npm（建议安装最新版本）。
• TLS证书和密钥（用于HTTPS通信）。
• 域名（公网部署时需配置）。

安装步骤

1. 安装代理与JupyterHub：

   bash
   npm install -g configurable-http-proxy
   pip3 install jupyterhub
   

2. 本地运行笔记本服务器需安装Jupyter Notebook：

   bash
   pip3 install --upgrade notebook
   

3. 启动Hub服务：

   bash
   jupyterhub
   

   访问https://localhost:8000，使用Unix PAM凭据登录。

生成配置文件

生成包含默认设置的配置文件：

bash
jupyterhub --generate-config

HTTPS启动示例

指定IP、端口及SSL证书启动：

bash
jupyterhub --ip 10.0.1.2 --port 443 --ssl-key my_ssl.key --ssl-cert my_ssl.cert

认证器与Spawner

• 认证器: PAMAuthenticator（默认）、OAuthenticator（OAuth集成）、LDAPAuthenticator（LDAP认证）等。
• Spawner: LocalProcessSpawner（默认本地进程）、DockerSpawner（Docker容器）、KubeSpawner（Kubernetes集群）等。

Docker部署示例

基础运行

启动容器并运行JupyterHub：

bash
docker run -d --name jupyterhub nersc/jupyterhub jupyterhub

Hub服务监听容器8000端口，可通过docker stop/start jupyterhub管理容器。

持久化数据

挂载主机目录保存用户数据（避免容器删除后数据丢失）：

bash
docker run -d --name jupyterhub -v /host/user_data:/home nersc/jupyterhub jupyterhub

创建系统用户

进入容器创建用于登录的系统用户：

bash
docker exec -it jupyterhub bash
# 示例：创建testuser用户
useradd -m testuser
passwd testuser

许可协议

本镜像基于BSD修订版许可证，详情参见JupyterHub官方文档。