tijmenvandenbrink/jupyter

Jupyter镜像文档

镜像概述和主要用途

这是一个包含SSL支持的简单Jupyter镜像，旨在快速部署Jupyter Notebook环境。通过挂载主机目录实现笔记本内容和配置的持久化管理，支持自定义配置文件和SSL安全访问，适用于需要安全运行Jupyter Notebook的场景。

核心功能和特性

• SSL支持：可通过放置证书和私钥文件启用HTTPS安全访问
• 自定义配置：支持外部挂载配置目录，方便管理Jupyter配置文件
• 持久化存储：笔记本内容可通过挂载主机目录持久化保存
• 快速部署：简单命令即可启动容器，无需复杂配置

使用场景和适用范围

• 数据科学家和研究人员需要快速启动Jupyter Notebook进行数据分析
• 开发者需要在安全环境中运行Jupyter Notebook并自定义配置
• 需要持久化保存笔记本内容和配置的场景

详细使用方法和配置说明

构建镜像

使用以下命令构建镜像：

bash
docker build -t jupyter:latest .

运行容器

在Linux系统上

bash
docker run -p 8888:8888 -v "<主机绝对路径>/notebooks:/notebooks" -v "<主机绝对路径>/config:/config" docker.xuanyuan.run/jupyter:latest

在Windows系统上

bash
docker run -p 8888:8888 -v "<主机绝对路径>\notebooks:/notebooks" -v "<主机绝对路径>\config:/config" docker.xuanyuan.run/jupyter:latest

启用SSL保护容器

1. 在主机的config/ssl目录下放置证书文件（certfile）和私钥文件（privkey）
2. 运行容器时添加以下环境变量参数：

bash
-e certfile_arg="--certfile=/config/ssl/fullchain.pem" -e keyfile_arg="--keyfile=/config/ssl/privkey.pem"

使用自定义配置文件并设置密码

通过临时容器生成配置文件

1. 启动临时容器：

bash
docker run --name tmp-jupyter-container -d docker.xuanyuan.run/jupyter:latest

2. 在临时容器中生成配置文件：

bash
docker exec tmp-jupyter-container jupyter notebook --allow-root --generate-config

3. 将配置文件复制到主机的config目录：

bash
docker cp tmp-jupyter-container:/root/.jupyter /<主机绝对路径>/config/

生成用于Web认证的哈希密码

在Python/IPython shell中执行以下命令生成哈希密码：

python
from docker.xuanyuan.run/notebook.auth import passwd; passwd()

生成的字符串格式为type:salt:hashed-password，将其保存到配置文件中。

指定自定义配置文件

运行容器时添加以下环境变量，确保Jupyter使用自定义配置文件：

bash
-e configfile_arg="--config=/config/.jupyter/jupyter_notebook_config.py"