기술 개요 | 설치 | 구성 | 도커 | 기여 | 라이센스 | 도움말 및 리소스
JupyterHub를 사용하면 단일 사용자 Jupyter 노트북 서버의 여러 인스턴스를 생성, 관리 및 프록시하는 다중 사용자 허브를 생성할 수 있습니다.
Jupyter 프로젝트는 많은 사용자를 지원하기 위해 JupyterHub를 만들었습니다. 허브는 학생 클래스, 기업 데이터 과학 작업 그룹, 과학 연구 프로젝트 또는 고성능 컴퓨팅 그룹에 노트북 서버를 제공할 수 있습니다.
JupyterHub를 구성하는 세 명의 주요 배우:
작동의 기본 원칙은 다음과 같습니다.
JupyterHub는 허브 및 해당 사용자 관리를 위한 REST API도 제공합니다.
Linux/Unix 기반 시스템
파이썬 3.8 이상
nodejs/npm
conda
사용하는 경우 nodejs 및 npm 종속성은 conda에 의해 설치됩니다.
pip
사용하는 경우 nodejs/npm의 최신 버전(12.0 이상)을 설치하세요.
기본 PAM 인증자를 사용하는 경우 PAM(플러그형 인증 모듈)입니다.
HTTPS 통신을 위한 TLS 인증서 및 키
도메인 이름
conda
사용nodejs/npm을 포함한 종속 항목과 함께 JupyterHub를 설치하려면 다음 안내를 따르세요.
conda install -c conda-forge jupyterhub
노트북 서버를 로컬로 실행하려면 JupyterLab 또는 Jupyter 노트북을 설치하세요.
conda install jupyterlab
conda install notebook
pip
사용 JupyterHub는 pip
로 설치할 수 있고 프록시는 npm
으로 설치할 수 있습니다.
npm install -g configurable-http-proxy
python3 -m pip install jupyterhub
노트북 서버를 로컬에서 실행하려면 JupyterLab 또는 Jupyter 노트북을 설치해야 합니다.
python3 -m pip install --upgrade jupyterlab
python3 -m pip install --upgrade notebook
Hub 서버를 시작하려면 다음 명령을 실행합니다.
jupyterhub
브라우저에서 http://localhost:8000
방문하고 시스템 사용자 이름과 비밀번호로 로그인하십시오.
참고 : 여러 사용자가 서버에 로그인할 수 있도록 하려면 루트와 같은 권한이 있는 사용자 로 jupyterhub
명령을 실행해야 합니다. Wiki에서는 더 많은 시스템 구성이 필요한 권한이 낮은 사용자 로 서버를 실행하는 방법을 설명합니다.
설명서의 시작하기 섹션에서는 JupyterHub 설정의 일반적인 단계를 설명합니다.
JupyterHub 자습서는 JupyterHub에 대한 심층적인 비디오와 샘플 구성을 제공합니다.
설정 및 설명이 포함된 기본 구성 파일을 생성하려면 다음을 수행하세요.
jupyterhub --generate-config
https를 사용하여 특정 URL 및 포트 10.0.1.2:443
에서 허브를 시작하려면 다음을 수행하십시오.
jupyterhub --ip 10.0.1.2 --port 443 --ssl-key my_ssl.key --ssl-cert my_ssl.cert
인증자 | 설명 |
---|---|
PAM 인증기 | 기본 내장 인증자 |
O인증기 | OAuth + JupyterHub 인증자 = OAuthenticator |
LDAP인증자 | JupyterHub용 단순 LDAP 인증자 플러그인 |
kerberos인증기 | JupyterHub용 Kerberos 인증자 플러그인 |
생성기 | 설명 |
---|---|
로컬프로세스스포너 | 기본 내장 생성기는 단일 사용자 서버를 로컬 프로세스로 시작합니다. |
도커스포너 | Docker 컨테이너에서 단일 사용자 서버 생성 |
쿠베스포너 | JupyterHub용 Kubernetes 생성기 |
sudospawner | 루트가 아닌 단일 사용자 서버 생성 |
시스템 생성기 | systemd를 사용하여 단일 사용자 노트북 서버 생성 |
일괄 생성기 | 배치 예약 소프트웨어를 사용하는 클러스터용으로 설계됨 |
원사 생성기 | Hadoop 클러스터에 분산된 단일 사용자 노트북 서버 생성 |
랩스포너 | 스포너의 런타임 구성을 가능하게 하는 WrapSawner 및 ProfilesSpawner |
JupyterHub용 시작 Docker 이미지는 Docker를 사용하여 JupyterHub의 기본 배포를 제공합니다.
중요: 이 quay.io/jupyterhub/jupyterhub
이미지에는 구성 없이 허브 자체만 포함되어 있습니다. 일반적으로 인증자 및/또는 생성자를 설정하는 최소한 jupyterhub_config.py
를 사용하여 파생 이미지를 만들어야 합니다. 허브와 동일한 시스템에 있을 수도 있고 그렇지 않을 수도 있는 단일 사용자 서버를 실행하려면 Jupyter Notebook 버전 4 이상이 설치되어 있어야 합니다.
JupyterHub 도커 이미지는 다음 명령을 사용하여 시작할 수 있습니다.
docker run -p 8000:8000 -d --name jupyterhub quay.io/jupyterhub/jupyterhub jupyterhub
이 명령은 docker stop/start
사용하여 중지하고 재개 할 수 있는 jupyterhub
라는 컨테이너를 생성합니다.
Hub 서비스는 포트 8000의 모든 인터페이스를 수신 대기하므로 데스크톱이나 노트북에서 JupyterHub를 테스트하는 데 적합합니다.
공용 IP가 있는 컴퓨터에서 docker를 실행하려면 docker 구성에 SSL 옵션을 추가하거나 SSL 지원 프록시를 사용하여 SSL로 보안을 설정해야 합니다.
볼륨을 마운트하면 Docker 이미지(호스트 시스템) 외부에 데이터를 저장할 수 있으므로 새 이미지를 시작할 때에도 데이터가 지속됩니다 .
docker exec -it jupyterhub bash
명령은 docker 컨테이너에 루트 셸을 생성합니다. 루트 셸을 사용하여 컨테이너에 시스템 사용자를 생성할 수 있습니다. 이러한 계정은 JupyterHub의 기본 구성에서 인증에 사용됩니다.
프로젝트에 기여하고 싶다면 기여자 문서와 CONTRIBUTING.md
를 읽어보세요. CONTRIBUTING.md
파일은 개발 설치를 설정하는 방법, 테스트 스위트를 실행하는 방법, 문서에 기여하는 방법을 설명합니다.
프로젝트의 비전과 다음 방향을 개략적으로 알아보려면 JupyterHub 커뮤니티 로드맵을 참조하세요.
JupyterHub는 Linux/Unix 기반 시스템에서 지원됩니다.
JupyterHub는 공식적으로 Windows를 지원 하지 않습니다 . Windows에서 작동하는 Spawner 및 Authenticator를 사용하는 경우 Windows에서 JupyterHub를 사용할 수 있지만 JupyterHub 기본값은 그렇지 않습니다. Windows에서 보고된 버그는 허용되지 않으며 테스트 스위트는 Windows에서 실행되지 않습니다. 그러나 사소한 Windows 호환성 문제(예: 기본 설치)를 해결하는 작은 패치는 허용될 수 있습니다 . Windows 기반 시스템의 경우 Docker 컨테이너 또는 Linux VM에서 JupyterHub를 실행하는 것이 좋습니다.
추가 참조: Windows 플랫폼 지원에 대한 Tornado 문서
우리는 모든 기여자가 자신의 기여에 대한 저작권을 유지할 수 있도록 하는 공유 저작권 모델을 사용합니다.
모든 코드는 개정된 BSD 라이센스 조건에 따라 라이센스가 부여됩니다.
Jupyter 커뮤니티 포럼에서 질문하고 아이디어를 공유하는 것이 좋습니다. JupyterHub Gitter 채널에서도 대화하실 수 있습니다.
JupyterHub는 Jupyter 커뮤니티 가이드를 따릅니다.
기술 개요 | 설치 | 구성 | 도커 | 기여 | 라이센스 | 도움말 및 리소스