illumidesk/jupyterhub

IllumiDesk容器

IllumiDesk容器相关的所有内容！除了Dockerfile源码外，本仓库还包含使用docker和docker-compose运行容器的基本示例。不过，grader-setup服务依赖kubectl Python客户端，因此配置为与Kubernetes配合使用。未来版本可能包含基于Kubernetes的基本设置，但对于此类场景，建议使用https://github.com/illumidesk/helm-chart%E3%80%82

环境要求

对于基于docker-compose的设置：

• https://docs.docker.com/get-docker/
• https://docs.docker.com/compose/install/

注意：有关Kubernetes POC说明，请参考kubernetes文件夹中的README。

Docker-Compose

此设置使用docker-compose启动配置了Postgres的JupyterHub实例，有助于验证自定义配置和资源（如自定义HTML模板）。

构建、启动与测试

安装依赖

1. 安装https://docs.docker.com/compose/install/

2. 定义环境变量

   • 将.env.example复制为.env
   • 更新.env中的值。提供了合理的默认值以支持基本启动。

3. 构建：

bash
docker-compose build --no-cache

注意：与docker-compose版本配合运行的illumidesk/jupyterhub:chp镜像包含CHP - 可配置HTTP代理。标准版本的illumidesk/jupyterhub:latest配置用于Kubernetes，因此无法与标准docker镜像一起运行。

4. 启动：

bash
docker-compose up -d

• 编辑jupyterhub/jupyterhub_config.py配置文件以更新JupyterHub的配置。然后使用以下命令重启jupyterhub容器：

bash
docker-compose restart jupyterhub

自定义选项

1. 使用您的值更新.env文件：
   • JUPYTERHUB_HOST：JupyterHub的外部访问URL，默认为http://localhost:8000。
   • JUPYTERHUB_CRYPT_KEY：JupyterHub加密密钥，用于在启用JupyterHub.auth_state_enabled = True时加密从认证器持久化到生成器的auth_state。可通过终端执行openssl rand -hex 32生成安全随机字符串。如无openssl，任何随机值均可，但生产环境请使用安全值！
   • POSTGRES_DB：数据库名称，默认为jupyterhub。
   • POSTGRES_USER：数据库用户名，默认为jupyterhub。
   • POSTGRES_PASSWORD：数据库密码，默认为password。
   • POSTGRES_HOST：数据库主机，默认为postgres-hub。
   • OAUTH_CLIENT_ID：OAuth2客户端ID。
   • OAUTH_CLIENT_SECRET：OIDC/OAuth2授权服务器设置客户端时创建的安全随机密钥。
   • OAUTH_CALLBACK_URL：默认为${JUPYTERHUB_HOST}/hub/oauth_callback，是继承自OAuthenticator类的认证器的标准URL。
   • OAUTH2_AUTHORIZE_URL：默认为None。
   • OAUTH2_TOKEN_URL：默认为None。
   • OAUTH2_TLS_VERIFY：默认为False。
   • GENERICAUTH_LOGIN_SERVICE_NAME：默认为Custom。
   • GENERICAUTH_USERDATA_URL：默认为None。
   • GENERICAUTH_USERDATA_METHOD：默认为GET。
   • GENERICAUTH_USERNAME_KEY：默认为preferred_username。

许可证

MIT