pierrotsmnrd / jupyter-auth

🛡️ Authentication and Authorization for Jupyter

🛡️ Jupyter Auth

To use this library with GitHub authentication, you need to create a OAuth application in your GitHub profile and export in your shell environement the provided GitHub client id and client secret as variable:

export GITHUB_CLIENT_ID=<oauth-app-client-id>
export GITHUB_CLIENT_SECRET=<oauth-app-client-secret>

Set the Callback URL to http://localhost:8888/login, assuming you are running the Jupyter Server on port 8888.

Environment

conda deactivate && \
  conda remove -y --all -n jupyter-auth
# Create your conda environment.
conda env create -f environment.yml
conda activate jupyter-auth
# Install jupyter_auth.
pip install -e .
# Build the extension and link.
jupyter labextension develop --overwrite
# List the jupyterlab extensions.
jupyter labextension list
pip list | grep jupyter-auth

# Run and watch the extension in shell 1.
conda activate jupyter-auth
yarn watch

# Run and watch jupyterlab in shell 2.
conda activate jupyter-auth
jupyter lab \
  --watch \
  --ServerApp.jpserver_extensions="{'jupyter_auth': True}" \
  --ServerApp.login_handler_class=jupyter_auth.github.LoginHandler \
  ./examples