Bump to 5.0.0b1

changelog for 5.0, add migration doc

.dockerignore

@@ -5,6 +5,5 @@ jupyterhub.sqlite
 jupyterhub_config.py
 node_modules
 docs
-.git
 dist
 build

.github/dependabot.yaml

@@ -1,4 +1,4 @@
-# dependabot.yml reference: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+# dependabot.yaml reference: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
 #
 # Notes:
 # - Status and logs from dependabot are provided at
@@ -8,8 +8,9 @@ version: 2
 updates:
   # Maintain dependencies in our GitHub Workflows
   - package-ecosystem: github-actions
-    directory: "/"
+    directory: /
+    labels: [ci]
     schedule:
-      interval: weekly
+      interval: monthly
       time: "05:00"
-      timezone: "Etc/UTC"
+      timezone: Etc/UTC

.github/workflows/registry-overviews.yml

@@ -0,0 +1,54 @@
+name: Update Registry overviews
+
+env:
+  OWNER: ${{ github.repository_owner }}
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/registry-overviews.yml"
+
+      - "README.md"
+      - "onbuild/README.md"
+      - "demo-image/README.md"
+      - "singleuser/README.md"
+  workflow_dispatch:
+
+jobs:
+  update-overview:
+    runs-on: ubuntu-latest
+    name: update-overview (${{matrix.image}})
+    if: github.repository_owner == 'jupyterhub'
+
+    steps:
+      - name: Checkout Repo ⚡️
+        uses: actions/checkout@v4
+
+      - name: Push README to Registry 🐳
+        uses: christian-korneck/update-container-description-action@d36005551adeaba9698d8d67a296bd16fa91f8e8 # v1
+        env:
+          DOCKER_USER: ${{ secrets.DOCKERHUB_USERNAME }}
+          DOCKER_PASS: ${{ secrets.DOCKERHUB_TOKEN }}
+        with:
+          destination_container_repo: ${{ env.OWNER }}/${{ matrix.image }}
+          provider: dockerhub
+          short_description: ${{ matrix.description }}
+          readme_file: ${{ matrix.readme_file }}
+
+    strategy:
+      matrix:
+        include:
+          - image: jupyterhub
+            description: "JupyterHub: multi-user Jupyter notebook server"
+            readme_file: README.md
+          - image: jupyterhub-onbuild
+            description: onbuild version of JupyterHub images
+            readme_file: onbuild/README.md
+          - image: jupyterhub-demo
+            description: Demo JupyterHub Docker image with a quick overview of what JupyterHub is and how it works
+            readme_file: demo-image/README.md
+          - image: singleuser
+            description: "single-user docker images for use with JupyterHub and DockerSpawner see also: jupyter/docker-stacks"
+            readme_file: singleuser/README.md

.github/workflows/release.yml

@@ -30,16 +30,16 @@ on:
 
 jobs:
   build-release:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.9"
+          python-version: "3.11"
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: "14"
+          node-version: "20"
 
       - name: install build requirements
         run: |
@@ -67,7 +67,7 @@ jobs:
           docker run --rm -v $PWD/dist:/dist:ro docker.io/library/python:3.9-slim-bullseye bash -c 'pip install /dist/jupyterhub-*.tar.gz'
 
       # ref: https://github.com/actions/upload-artifact#readme
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: jupyterhub-${{ github.sha }}
           path: "dist/*"
@@ -83,7 +83,8 @@ jobs:
           twine upload --skip-existing dist/*
 
   publish-docker:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    timeout-minutes: 30
 
     services:
       # So that we can test this in PRs/branches
@@ -96,39 +97,35 @@ jobs:
       - name: Should we push this image to a public registry?
         run: |
           if [ "${{ startsWith(github.ref, 'refs/tags/') || (github.ref == 'refs/heads/main') }}" = "true" ]; then
-              # Empty => Docker Hub
-              echo "REGISTRY=" >> $GITHUB_ENV
+              echo "REGISTRY=quay.io/" >> $GITHUB_ENV
           else
               echo "REGISTRY=localhost:5000/" >> $GITHUB_ENV
           fi
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       # Setup docker to build for multiple platforms, see:
       # https://github.com/docker/build-push-action/tree/v2.4.0#usage
       # https://github.com/docker/build-push-action/blob/v2.4.0/docs/advanced/multi-platform.md
       - name: Set up QEMU (for docker buildx)
-        uses: docker/setup-qemu-action@e81a89b1732b9c48d79cd809d8d81d79c4647a18 # associated tag: v1.0.2
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx (for multi-arch builds)
-        uses: docker/setup-buildx-action@8c0edbc76e98fa90f69d9a2c020dcb50019dc325
+        uses: docker/setup-buildx-action@v3
         with:
           # Allows pushing to registry on localhost:5000
           driver-opts: network=host
 
       - name: Setup push rights to Docker Hub
         # This was setup by...
-        # 1. Creating a Docker Hub service account "jupyterhubbot"
-        # 2. Creating a access token for the service account specific to this
-        #    repository: https://hub.docker.com/settings/security
-        # 3. Making the account part of the "bots" team, and granting that team
-        #    permissions to push to the relevant images:
-        #    https://hub.docker.com/orgs/jupyterhub/teams/bots/permissions
-        # 4. Registering the username and token as a secret for this repo:
-        #    https://github.com/jupyterhub/jupyterhub/settings/secrets/actions
+        # 1. Creating a [Robot Account](https://quay.io/organization/jupyterhub?tab=robots) in the JupyterHub
+        # .  Quay.io org
+        # 2. Giving it enough permissions to push to the jupyterhub and singleuser images
+        # 3. Putting the robot account's username and password in GitHub actions environment
         if: env.REGISTRY != 'localhost:5000/'
         run: |
-          docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" -p "${{ secrets.DOCKERHUB_TOKEN }}"
+          docker login -u "${{ secrets.QUAY_USERNAME }}" -p "${{ secrets.QUAY_PASSWORD }}" "${{ env.REGISTRY }}"
+          docker login -u "${{ secrets.DOCKERHUB_USERNAME }}" -p "${{ secrets.DOCKERHUB_TOKEN }}" docker.io
 
       # image: jupyterhub/jupyterhub
       #
@@ -141,15 +138,17 @@ jobs:
       # If GITHUB_TOKEN isn't available (e.g. in PRs) returns no tags [].
       - name: Get list of jupyterhub tags
         id: jupyterhubtags
-        uses: jupyterhub/action-major-minor-tag-calculator@v2
+        uses: jupyterhub/action-major-minor-tag-calculator@v3
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
-          prefix: "${{ env.REGISTRY }}jupyterhub/jupyterhub:"
+          prefix: >-
+            ${{ env.REGISTRY }}jupyterhub/jupyterhub:
+            jupyterhub/jupyterhub:
           defaultTag: "${{ env.REGISTRY }}jupyterhub/jupyterhub:noref"
           branchRegex: ^\w[\w-.]*$
 
       - name: Build and push jupyterhub
-        uses: docker/build-push-action@c56af957549030174b10d6867f20e78cfd7debc5
+        uses: docker/build-push-action@v5
         with:
           context: .
           platforms: linux/amd64,linux/arm64
@@ -162,15 +161,17 @@ jobs:
       #
       - name: Get list of jupyterhub-onbuild tags
         id: onbuildtags
-        uses: jupyterhub/action-major-minor-tag-calculator@v2
+        uses: jupyterhub/action-major-minor-tag-calculator@v3
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
-          prefix: "${{ env.REGISTRY }}jupyterhub/jupyterhub-onbuild:"
+          prefix: >-
+            ${{ env.REGISTRY }}jupyterhub/jupyterhub-onbuild:
+            jupyterhub/jupyterhub-onbuild:
           defaultTag: "${{ env.REGISTRY }}jupyterhub/jupyterhub-onbuild:noref"
           branchRegex: ^\w[\w-.]*$
 
       - name: Build and push jupyterhub-onbuild
-        uses: docker/build-push-action@c56af957549030174b10d6867f20e78cfd7debc5
+        uses: docker/build-push-action@v5
         with:
           build-args: |
             BASE_IMAGE=${{ fromJson(steps.jupyterhubtags.outputs.tags)[0] }}
@@ -183,15 +184,17 @@ jobs:
       #
       - name: Get list of jupyterhub-demo tags
         id: demotags
-        uses: jupyterhub/action-major-minor-tag-calculator@v2
+        uses: jupyterhub/action-major-minor-tag-calculator@v3
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
-          prefix: "${{ env.REGISTRY }}jupyterhub/jupyterhub-demo:"
+          prefix: >-
+            ${{ env.REGISTRY }}jupyterhub/jupyterhub-demo:
+            jupyterhub/jupyterhub-demo:
           defaultTag: "${{ env.REGISTRY }}jupyterhub/jupyterhub-demo:noref"
           branchRegex: ^\w[\w-.]*$
 
       - name: Build and push jupyterhub-demo
-        uses: docker/build-push-action@c56af957549030174b10d6867f20e78cfd7debc5
+        uses: docker/build-push-action@v5
         with:
           build-args: |
             BASE_IMAGE=${{ fromJson(steps.onbuildtags.outputs.tags)[0] }}
@@ -207,15 +210,17 @@ jobs:
       #
       - name: Get list of jupyterhub/singleuser tags
         id: singleusertags
-        uses: jupyterhub/action-major-minor-tag-calculator@v2
+        uses: jupyterhub/action-major-minor-tag-calculator@v3
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
-          prefix: "${{ env.REGISTRY }}jupyterhub/singleuser:"
+          prefix: >-
+            ${{ env.REGISTRY }}jupyterhub/singleuser:
+            jupyterhub/singleuser:
           defaultTag: "${{ env.REGISTRY }}jupyterhub/singleuser:noref"
           branchRegex: ^\w[\w-.]*$
 
       - name: Build and push jupyterhub/singleuser
-        uses: docker/build-push-action@c56af957549030174b10d6867f20e78cfd7debc5
+        uses: docker/build-push-action@v5
         with:
           build-args: |
             JUPYTERHUB_VERSION=${{ github.ref_type == 'tag' && github.ref_name || format('git:{0}', github.sha) }}

.github/workflows/support-bot.yml

@@ -12,7 +12,7 @@ jobs:
   action:
     runs-on: ubuntu-latest
     steps:
-      - uses: dessant/support-requests@v2
+      - uses: dessant/support-requests@v4
         with:
           github-token: ${{ github.token }}
           support-label: "support"
@@ -25,7 +25,7 @@ jobs:
 
             Our goal is to sustain a positive experience for both users and developers. We use GitHub issues for specific discussions related to changing a repository's content, and let the forum be where we can more generally help and inspire each other.
 
-            Thanks you for being an active member of our community! :heart:
+            Thank you for being an active member of our community! :heart:
           close-issue: true
           lock-issue: false
           issue-lock-reason: "off-topic"

.github/workflows/test-docs.yml

@@ -36,27 +36,76 @@ env:
 
 jobs:
   validate-rest-api-definition:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: npm
 
       - name: Validate REST API definition
-        uses: char0n/swagger-editor-validate@v1.3.2
-        with:
-          definition-file: docs/source/_static/rest-api.yml
+        run: |
+          npx @redocly/cli lint
 
   test-docs:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
         with:
-          python-version: "3.9"
+          # make rediraffecheckdiff requires git history to compare current
+          # commit with the main branch and previous releases.
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
 
       - name: Install requirements
         run: |
-          pip install -r docs/requirements.txt pytest
+          pip install -e . -r docs/requirements.txt pytest
 
       - name: pytest docs/
         run: |
           pytest docs/
+
+      # readthedocs doesn't halt on warnings,
+      # so raise any warnings here
+      - name: build docs
+        run: |
+          cd docs
+          make html
+
+      - name: check links
+        run: |
+          cd docs
+          make linkcheck
+
+      # make rediraffecheckdiff compares files for different changesets
+      # these diff targets aren't always available
+      # - compare with base ref (usually 'main', always on 'origin') for pull requests
+      # - only compare with tags when running against jupyterhub/jupyterhub
+      #   to avoid errors on forks, which often lack tags
+      - name: check redirects for this PR
+        if: github.event_name == 'pull_request'
+        run: |
+          cd docs
+          export REDIRAFFE_BRANCH=origin/${{ github.base_ref }}
+          make rediraffecheckdiff
+
+      # this should check currently published 'stable' links for redirects
+      - name: check redirects since last release
+        if: github.repository == 'jupyterhub/jupyterhub'
+        run: |
+          cd docs
+          export REDIRAFFE_BRANCH=$(git describe --tags --abbrev=0)
+          make rediraffecheckdiff
+
+      # longer-term redirect check (fixed version) for older links
+      - name: check redirects since 3.0.0
+        if: github.repository == 'jupyterhub/jupyterhub'
+        run: |
+          cd docs
+          export REDIRAFFE_BRANCH=3.0.0
+          make rediraffecheckdiff

.github/workflows/test-jsx.yml

@@ -25,28 +25,24 @@ permissions:
 jobs:
   # The ./jsx folder contains React based source code files that are to compile
   # to share/jupyterhub/static/js/admin-react.js. The ./jsx folder includes
-  # tests also has tests that this job is meant to run with `yarn test`
+  # tests also has tests that this job is meant to run with `npm test`
   # according to the documentation in jsx/README.md.
   test-jsx-admin-react:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: "14"
+          node-version: "20"
 
-      - name: Install yarn
-        run: |
-          npm install -g yarn
-
-      - name: yarn
+      - name: install jsx
         run: |
           cd jsx
-          yarn
+          npm ci
 
-      - name: yarn test
+      - name: test
         run: |
           cd jsx
-          yarn test
+          npm test

.github/workflows/test.yml

@@ -28,7 +28,7 @@ on:
 env:
   # UTF-8 content may be interpreted as ascii and causes errors without this.
   LANG: C.UTF-8
-  PYTEST_ADDOPTS: "--verbose --color=yes"
+  SQLALCHEMY_WARN_20: "1"
 
 permissions:
   contents: read
@@ -36,7 +36,7 @@ permissions:
 jobs:
   # Run "pytest jupyterhub/tests" in various configurations
   pytest:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 15
 
     strategy:
@@ -65,7 +65,7 @@ jobs:
         #   unencrypted HTTP
         #
         # main_dependencies:
-        #   Tests everything when the we use the latest available dependencies
+        #   Tests everything when we use the latest available dependencies
         #   from: traitlets.
         #
         # NOTE: Since only the value of these parameters are presented in the
@@ -74,22 +74,39 @@ jobs:
         # Python versions available at:
         #   https://github.com/actions/python-versions/blob/HEAD/versions-manifest.json
         include:
-          - python: "3.7"
+          - python: "3.8"
             oldest_dependencies: oldest_dependencies
             legacy_notebook: legacy_notebook
           - python: "3.8"
-            legacy_notebook: legacy_notebook
+            jupyter_server: "1.*"
+            subset: singleuser
           - python: "3.9"
             db: mysql
           - python: "3.10"
             db: postgres
-          - python: "3.11"
+          - python: "3.12"
             subdomain: subdomain
+            serverextension: serverextension
           - python: "3.11"
             ssl: ssl
+            serverextension: serverextension
           - python: "3.11"
-            selenium: selenium
+            jupyverse: jupyverse
+            subset: singleuser
           - python: "3.11"
+            subdomain: subdomain
+            noextension: noextension
+            subset: singleuser
+          - python: "3.11"
+            ssl: ssl
+            noextension: noextension
+            subset: singleuser
+          - python: "3.11"
+            browser: browser
+          - python: "3.11"
+            subdomain: subdomain
+            browser: browser
+          - python: "3.12"
             main_dependencies: main_dependencies
 
     steps:
@@ -103,7 +120,7 @@ jobs:
           fi
           if [ "${{ matrix.db }}" == "mysql" ]; then
               echo "MYSQL_HOST=127.0.0.1" >> $GITHUB_ENV
-              echo "JUPYTERHUB_TEST_DB_URL=mysql+mysqlconnector://root@127.0.0.1:3306/jupyterhub" >> $GITHUB_ENV
+              echo "JUPYTERHUB_TEST_DB_URL=mysql+mysqldb://root@127.0.0.1:3306/jupyterhub" >> $GITHUB_ENV
           fi
           if [ "${{ matrix.ssl }}" == "ssl" ]; then
               echo "SSL_ENABLED=1" >> $GITHUB_ENV
@@ -114,55 +131,72 @@ jobs:
               echo "PGPASSWORD=hub[test/:?" >> $GITHUB_ENV
               echo "JUPYTERHUB_TEST_DB_URL=postgresql://test_user:hub%5Btest%2F%3A%3F@127.0.0.1:5432/jupyterhub" >> $GITHUB_ENV
           fi
-          if [ "${{ matrix.jupyter_server }}" != "" ]; then
-              echo "JUPYTERHUB_SINGLEUSER_APP=jupyterhub.tests.mockserverapp.MockServerApp" >> $GITHUB_ENV
+          if [ "${{ matrix.serverextension }}" != "" ]; then
+              echo "JUPYTERHUB_SINGLEUSER_EXTENSION=1" >> $GITHUB_ENV
+          elif [ "${{ matrix.noextension }}" != "" ]; then
+              echo "JUPYTERHUB_SINGLEUSER_EXTENSION=0" >> $GITHUB_ENV
           fi
-      - uses: actions/checkout@v3
-      # NOTE: actions/setup-node@v3 make use of a cache within the GitHub base
+          if [ "${{ matrix.jupyverse }}" != "" ]; then
+              echo "JUPYTERHUB_SINGLEUSER_APP=jupyverse" >> $GITHUB_ENV
+          fi
+      - uses: actions/checkout@v4
+      # NOTE: actions/setup-node@v4 make use of a cache within the GitHub base
       #       environment and setup in a fraction of a second.
-      - name: Install Node v14
-        uses: actions/setup-node@v3
+      - name: Install Node
+        uses: actions/setup-node@v4
         with:
-          node-version: "14"
+          node-version: "20"
       - name: Install Javascript dependencies
         run: |
           npm install
           npm install -g configurable-http-proxy yarn
           npm list
 
-      # NOTE: actions/setup-python@v4 make use of a cache within the GitHub base
+      # NOTE: actions/setup-python@v5 make use of a cache within the GitHub base
       #       environment and setup in a fraction of a second.
       - name: Install Python ${{ matrix.python }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "${{ matrix.python }}"
 
       - name: Install Python dependencies
         run: |
           pip install --upgrade pip
-          pip install ".[test]"
 
           if [ "${{ matrix.oldest_dependencies }}" != "" ]; then
-            # take any dependencies in requirements.txt such as tornado>=5.0
-            # and transform them to tornado==5.0 so we can run tests with
-            # the earliest-supported versions
-            cat requirements.txt | grep '>=' | sed -e 's@>=@==@g' > oldest-requirements.txt
-            pip install -r oldest-requirements.txt
+            # frozen env with oldest dependencies
+            # make sure our `>=` pins really do express our minimum supported versions
+            pip install -r ci/oldest-dependencies/requirements.old -e .
+          else
+            pip install -e ".[test]"
           fi
 
           if [ "${{ matrix.main_dependencies }}" != "" ]; then
-              pip install git+https://github.com/ipython/traitlets#egg=traitlets --force
+              # Tests are broken:
+              # https://github.com/jupyterhub/jupyterhub/issues/4418
+              # pip install git+https://github.com/ipython/traitlets#egg=traitlets --force
+              pip install --upgrade --pre sqlalchemy
           fi
           if [ "${{ matrix.legacy_notebook }}" != "" ]; then
               pip uninstall jupyter_server --yes
               pip install 'notebook<7'
           fi
+          if [ "${{ matrix.jupyter_server }}" != "" ]; then
+              pip install "jupyter_server==${{ matrix.jupyter_server }}"
+          fi
+          if [ "${{ matrix.jupyverse }}" != "" ]; then
+              pip install "jupyverse[jupyterlab,auth-jupyterhub]"
+              pip install -e .
+          fi
           if [ "${{ matrix.db }}" == "mysql" ]; then
-              pip install mysql-connector-python
+              pip install mysqlclient
           fi
           if [ "${{ matrix.db }}" == "postgres" ]; then
               pip install psycopg2-binary
           fi
+          if [ "${{ matrix.serverextension }}" != "" ]; then
+            pip install 'jupyter-server>=2'
+          fi
 
           pip freeze
 
@@ -206,38 +240,32 @@ jobs:
               DB=postgres bash ci/docker-db.sh
               DB=postgres bash ci/init-db.sh
           fi
-      - name: Setup Firefox
-        if: matrix.selenium
-        uses: browser-actions/setup-firefox@latest
-        with:
-          firefox-version: latest
 
-      - name: Setup Geckodriver
-        if: matrix.selenium
-        uses: browser-actions/setup-geckodriver@latest
+      - name: Configure browser tests
+        if: matrix.browser
+        run: echo "PYTEST_ADDOPTS=$PYTEST_ADDOPTS -m browser" >> "${GITHUB_ENV}"
 
-      - name: Configure selenium tests
-        if: matrix.selenium
-        run: echo "PYTEST_ADDOPTS=$PYTEST_ADDOPTS -m selenium" >> "${GITHUB_ENV}"
+      - name: Ensure browsers are installed for playwright
+        if: matrix.browser
+        run: python -m playwright install --with-deps
 
       - name: Run pytest
         run: |
-          pytest --maxfail=2 --cov=jupyterhub jupyterhub/tests
+          pytest -k "${{ matrix.subset }}" --maxfail=2 --cov=jupyterhub jupyterhub/tests
 
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
 
   docker-build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: build images
         run: |
-          docker build -t jupyterhub/jupyterhub .
+          DOCKER_BUILDKIT=1 docker build -t jupyterhub/jupyterhub .
           docker build -t jupyterhub/jupyterhub-onbuild onbuild
-          docker build -t jupyterhub/jupyterhub:alpine -f dockerfiles/Dockerfile.alpine .
           docker build -t jupyterhub/singleuser singleuser
 
       - name: smoke test jupyterhub

.gitignore

@@ -9,15 +9,21 @@ docs/_build
 docs/build
 docs/source/_static/rest-api
 docs/source/rbac/scope-table.md
+docs/source/reference/metrics.md
+
 .ipynb_checkpoints
+.virtual_documents
+
 jsx/build/
 # ignore config file at the top-level of the repo
 # but not sub-dirs
 /jupyterhub_config.py
 jupyterhub_cookie_secret
 jupyterhub.sqlite
-package-lock.json
+jupyterhub.sqlite*
 share/jupyterhub/static/components
+share/jupyterhub/static/css/style.css
+share/jupyterhub/static/css/style.css.map
 share/jupyterhub/static/css/style.min.css
 share/jupyterhub/static/css/style.min.css.map
 share/jupyterhub/static/js/admin-react.js*
@@ -34,3 +40,5 @@ docs/source/reference/metrics.rst
 oldest-requirements.txt
 jupyterhub-proxy.pid
 examples/server-api/service-token
+
+*.hot-update*

.pre-commit-config.yaml

@@ -8,54 +8,50 @@
 # - Run on all files:   pre-commit run --all-files
 # - Register git hooks: pre-commit install --install-hooks
 #
+
+ci:
+  # pre-commit.ci will open PRs updating our hooks once a month
+  autoupdate_schedule: monthly
+
 repos:
-  # Autoformat: Python code, syntax patterns are modernized
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.2.2
+  # autoformat and lint Python code
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
     hooks:
-      - id: pyupgrade
-        args:
-          - --py36-plus
-
-  # Autoformat: Python code
-  - repo: https://github.com/PyCQA/autoflake
-    rev: v2.0.0
-    hooks:
-      - id: autoflake
-        # args ref: https://github.com/PyCQA/autoflake#advanced-usage
-        args:
-          - --in-place
-
-  # Autoformat: Python code
-  - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
-    hooks:
-      - id: isort
-
-  # Autoformat: Python code
-  - repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-      - id: black
+      - id: ruff
+        types_or:
+          - python
+          - jupyter
+        args: ["--fix", "--show-fixes"]
+      - id: ruff-format
+        types_or:
+          - python
+          - jupyter
 
   # Autoformat: markdown, yaml, javascript (see the file .prettierignore)
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0-alpha.4
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
+        exclude: .*/templates/.*
+
+  # autoformat HTML templates
+  - repo: https://github.com/djlint/djLint
+    rev: v1.34.1
+    hooks:
+      - id: djlint-reformat-jinja
+        files: ".*templates/.*.html"
+        types_or: ["html"]
+      - id: djlint-jinja
+        files: ".*templates/.*.html"
+        types_or: ["html"]
 
   # Autoformat and linting, misc. details
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: end-of-file-fixer
         exclude: share/jupyterhub/static/js/admin-react.js
       - id: requirements-txt-fixer
       - id: check-case-conflict
       - id: check-executables-have-shebangs
-
-  # Linting: Python code (see the file .flake8)
-  - repo: https://github.com/PyCQA/flake8
-    rev: "6.0.0"
-    hooks:
-      - id: flake8

.prettierignore

@@ -1,2 +1,4 @@
 share/jupyterhub/templates/
 share/jupyterhub/static/js/admin-react.js
+jupyterhub/singleuser/templates/
+docs/source/_templates/

.readthedocs.yaml

@@ -8,13 +8,14 @@ sphinx:
   configuration: docs/source/conf.py
 
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    nodejs: "16"
-    python: "3.9"
+    nodejs: "20"
+    python: "3.11"
 
 python:
   install:
+    - path: .
     - requirements: docs/requirements.txt
 
 formats:

Dockerfile

@@ -6,7 +6,7 @@
 #
 # Option 1:
 #
-# FROM jupyterhub/jupyterhub:latest
+# FROM quay.io/jupyterhub/jupyterhub:latest
 #
 # And put your configuration file jupyterhub_config.py in /srv/jupyterhub/jupyterhub_config.py.
 #
@@ -14,90 +14,133 @@
 #
 # Or you can create your jupyterhub config and database on the host machine, and mount it with:
 #
-# docker run -v $PWD:/srv/jupyterhub -t jupyterhub/jupyterhub
+# docker run -v $PWD:/srv/jupyterhub -t quay.io/jupyterhub/jupyterhub
 #
 # NOTE
-# If you base on jupyterhub/jupyterhub-onbuild
+# If you base on quay.io/jupyterhub/jupyterhub-onbuild
 # your jupyterhub_config.py will be added automatically
 # from your docker directory.
 
+######################################################################
+# This Dockerfile uses multi-stage builds with optimisations to build
+# the JupyterHub wheel on the native architecture only
+# https://www.docker.com/blog/faster-multi-platform-builds-dockerfile-cross-compilation-guide/
+
 ARG BASE_IMAGE=ubuntu:22.04
-FROM $BASE_IMAGE AS builder
 
-USER root
 
-ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update \
- && apt-get install -yq --no-install-recommends \
+######################################################################
+# The JupyterHub wheel is pure Python so can be built for any platform
+# on the native architecture (avoiding QEMU emulation)
+FROM --platform=${BUILDPLATFORM:-linux/amd64} $BASE_IMAGE AS jupyterhub-builder
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+# Don't clear apt cache, and don't combine RUN commands, so that cached layers can
+# be reused in other stages
+
+RUN apt-get update -qq \
+ && apt-get install -yqq --no-install-recommends \
     build-essential \
     ca-certificates \
+    curl \
+    git \
+    gnupg \
     locales \
     python3-dev \
     python3-pip \
     python3-pycurl \
     python3-venv \
-    nodejs \
-    npm \
- && apt-get clean \
- && rm -rf /var/lib/apt/lists/*
-
-RUN python3 -m pip install --upgrade setuptools pip build wheel
-RUN npm install --global yarn
+ && python3 -m pip install --no-cache-dir --upgrade setuptools pip build wheel
+# Ubuntu 22.04 comes with Nodejs 12 which is too old for building JupyterHub JS
+# It's fine at runtime though (used only by configurable-http-proxy)
+ARG NODE_MAJOR=20
+RUN mkdir -p /etc/apt/keyrings \
+ && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
+ && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list \
+ && apt-get update \
+ && apt-get install -yqq --no-install-recommends \
+    nodejs
 
+WORKDIR /src/jupyterhub
 # copy everything except whats in .dockerignore, its a
 # compromise between needing to rebuild and maintaining
 # what needs to be part of the build
-COPY . /src/jupyterhub/
-WORKDIR /src/jupyterhub
+COPY . .
 
-# Build client component packages (they will be copied into ./share and
-# packaged with the built wheel.)
-RUN python3 -m build --wheel
-RUN python3 -m pip wheel --wheel-dir wheelhouse dist/*.whl
+ARG PIP_CACHE_DIR=/tmp/pip-cache
+RUN --mount=type=cache,target=${PIP_CACHE_DIR} \
+    python3 -m build --wheel
 
+# verify installed files
+RUN --mount=type=cache,target=${PIP_CACHE_DIR} \
+    python3 -m pip install ./dist/*.whl \
+ && cd ci \
+ && python3 check_installed_data.py
 
-FROM $BASE_IMAGE
-
-USER root
+######################################################################
+# All other wheels required by JupyterHub, some are platform specific
+FROM $BASE_IMAGE AS wheel-builder
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt-get update \
- && apt-get install -yq --no-install-recommends \
+RUN apt-get update -qq \
+ && apt-get install -yqq --no-install-recommends \
+    build-essential \
     ca-certificates \
     curl \
-    gnupg \
     locales \
+    python3-dev \
     python3-pip \
     python3-pycurl \
-    nodejs \
-    npm \
- && apt-get clean \
- && rm -rf /var/lib/apt/lists/*
+    python3-venv \
+ && python3 -m pip install --no-cache-dir --upgrade setuptools pip build wheel
 
-ENV SHELL=/bin/bash \
+WORKDIR /src/jupyterhub
+
+COPY --from=jupyterhub-builder /src/jupyterhub/dist/*.whl /src/jupyterhub/dist/
+ARG PIP_CACHE_DIR=/tmp/pip-cache
+RUN --mount=type=cache,target=${PIP_CACHE_DIR} \
+    python3 -m pip wheel --wheel-dir wheelhouse dist/*.whl
+
+
+######################################################################
+# The final JupyterHub image, platform specific
+FROM $BASE_IMAGE AS jupyterhub
+
+ENV DEBIAN_FRONTEND=noninteractive \
+    SHELL=/bin/bash \
     LC_ALL=en_US.UTF-8 \
     LANG=en_US.UTF-8 \
-    LANGUAGE=en_US.UTF-8
-
-RUN  locale-gen $LC_ALL
-
-# always make sure pip is up to date!
-RUN python3 -m pip install --no-cache --upgrade setuptools pip
-
-RUN npm install -g configurable-http-proxy@^4.2.0 \
- && rm -rf ~/.npm
-
-# install the wheels we built in the first stage
-COPY --from=builder /src/jupyterhub/wheelhouse /tmp/wheelhouse
-RUN python3 -m pip install --no-cache /tmp/wheelhouse/*
-
-RUN mkdir -p /srv/jupyterhub/
-WORKDIR /srv/jupyterhub/
+    LANGUAGE=en_US.UTF-8 \
+    PYTHONDONTWRITEBYTECODE=1
 
 EXPOSE 8000
 
 LABEL maintainer="Jupyter Project <jupyter@googlegroups.com>"
 LABEL org.jupyter.service="jupyterhub"
 
+WORKDIR /srv/jupyterhub
+
+RUN apt-get update -qq \
+ && apt-get install -yqq --no-install-recommends \
+    ca-certificates \
+    curl \
+    gnupg \
+    locales \
+    python-is-python3 \
+    python3-pip \
+    python3-pycurl \
+    nodejs \
+    npm \
+ && locale-gen $LC_ALL \
+ && npm install -g configurable-http-proxy@^4.2.0 \
+ # clean cache and logs
+ && rm -rf /var/lib/apt/lists/* /var/log/* /var/tmp/* ~/.npm
+# install the wheels we built in the previous stage
+RUN --mount=type=cache,from=wheel-builder,source=/src/jupyterhub/wheelhouse,target=/tmp/wheelhouse \
+    # always make sure pip is up to date!
+    python3 -m pip install --no-compile --no-cache-dir --upgrade setuptools pip \
+ && python3 -m pip install --no-compile --no-cache-dir /tmp/wheelhouse/*
+
 CMD ["jupyterhub"]

MANIFEST.in

@@ -1,29 +1,13 @@
-include README.md
-include COPYING.md
-include setupegg.py
-include bower-lite
-include package.json
+# using setuptools-scm means we only need to handle _non-tracked files here_
+
 include package-lock.json
-include *requirements.txt
-include Dockerfile
 
-graft onbuild
-graft jsx
-graft jupyterhub
-graft scripts
+# include untracked js/css artifacts, components
 graft share
-graft singleuser
-graft ci
 
-# Documentation
-graft docs
-prune docs/node_modules
-
-# Intermediate javascript files
-prune jsx/node_modules
-prune jsx/build
-
-# prune some large unused files from components
+# prune some large unused files from components.
+# these patterns affect source distributions (sdists)
+# we have stricter exclusions from installation in setup.py:get_data_files
 prune share/jupyterhub/static/components/bootstrap/dist/css
 exclude share/jupyterhub/static/components/bootstrap/dist/fonts/*.svg
 prune share/jupyterhub/static/components/font-awesome/css
@@ -33,11 +17,3 @@ prune share/jupyterhub/static/components/jquery/external
 prune share/jupyterhub/static/components/jquery/src
 prune share/jupyterhub/static/components/moment/lang
 prune share/jupyterhub/static/components/moment/min
-
-# Patterns to exclude from any directory
-global-exclude *~
-global-exclude *.pyc
-global-exclude *.pyo
-global-exclude .git
-global-exclude .ipynb_checkpoints
-global-exclude .bower.json

README.md

@@ -8,22 +8,12 @@
 
 ---
 
-Please note that this repository is participating in a study into the sustainability of open source projects. Data will be gathered about this repository for approximately the next 12 months, starting from 2021-06-11.
-
-Data collected will include the number of contributors, number of PRs, time taken to close/merge these PRs, and issues closed.
-
-For more information, please visit
-[our informational page](https://sustainable-open-science-and-software.github.io/) or download our [participant information sheet](https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf).
-
----
-
 # [JupyterHub](https://github.com/jupyterhub/jupyterhub)
 
 [![Latest PyPI version](https://img.shields.io/pypi/v/jupyterhub?logo=pypi)](https://pypi.python.org/pypi/jupyterhub)
 [![Latest conda-forge version](https://img.shields.io/conda/vn/conda-forge/jupyterhub?logo=conda-forge)](https://anaconda.org/conda-forge/jupyterhub)
 [![Documentation build status](https://img.shields.io/readthedocs/jupyterhub?logo=read-the-docs)](https://jupyterhub.readthedocs.org/en/latest/)
 [![GitHub Workflow Status - Test](https://img.shields.io/github/workflow/status/jupyterhub/jupyterhub/Test?logo=github&label=tests)](https://github.com/jupyterhub/jupyterhub/actions)
-[![DockerHub build status](https://img.shields.io/docker/build/jupyterhub/jupyterhub?logo=docker&label=build)](https://hub.docker.com/r/jupyterhub/jupyterhub/tags)
 [![Test coverage of code](https://codecov.io/gh/jupyterhub/jupyterhub/branch/main/graph/badge.svg)](https://codecov.io/gh/jupyterhub/jupyterhub)
 [![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/jupyterhub/issues)
 [![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)
@@ -66,7 +56,7 @@ for administration of the Hub and its users.
 ### Check prerequisites
 
 - A Linux/Unix based system
-- [Python](https://www.python.org/downloads/) 3.6 or greater
+- [Python](https://www.python.org/downloads/) 3.8 or greater
 - [nodejs/npm](https://www.npmjs.com/)
 
   - If you are using **`conda`**, the nodejs and npm dependencies will be installed for
@@ -127,7 +117,7 @@ more configuration of the system.
 
 ## Configuration
 
-The [Getting Started](https://jupyterhub.readthedocs.io/en/latest/getting-started/index.html) section of the
+The [Getting Started](https://jupyterhub.readthedocs.io/en/latest/tutorial/index.html#getting-started) section of the
 documentation explains the common steps in setting up JupyterHub.
 
 The [**JupyterHub tutorial**](https://github.com/jupyterhub/jupyterhub-tutorial)
@@ -169,10 +159,10 @@ To start the Hub on a specific url and port `10.0.1.2:443` with **https**:
 
 ## Docker
 
-A starter [**docker image for JupyterHub**](https://hub.docker.com/r/jupyterhub/jupyterhub/)
+A starter [**docker image for JupyterHub**](https://quay.io/repository/jupyterhub/jupyterhub)
 gives a baseline deployment of JupyterHub using Docker.
 
-**Important:** This `jupyterhub/jupyterhub` image contains only the Hub itself,
+**Important:** This `quay.io/jupyterhub/jupyterhub` image contains only the Hub itself,
 with no configuration. In general, one needs to make a derivative image, with
 at least a `jupyterhub_config.py` setting up an Authenticator and/or a Spawner.
 To run the single-user servers, which may be on the same system as the Hub or
@@ -180,7 +170,7 @@ not, Jupyter Notebook version 4 or greater must be installed.
 
 The JupyterHub docker image can be started with the following command:
 
-    docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub
+    docker run -p 8000:8000 -d --name jupyterhub quay.io/jupyterhub/jupyterhub jupyterhub
 
 This command will create a container named `jupyterhub` that you can
 **stop and resume** with `docker stop/start`.
@@ -239,9 +229,9 @@ You can also talk with us on our JupyterHub [Gitter](https://gitter.im/jupyterhu
 
 - [Reporting Issues](https://github.com/jupyterhub/jupyterhub/issues)
 - [JupyterHub tutorial](https://github.com/jupyterhub/jupyterhub-tutorial)
-- [Documentation for JupyterHub](https://jupyterhub.readthedocs.io/en/latest/) | [PDF (latest)](https://media.readthedocs.org/pdf/jupyterhub/latest/jupyterhub.pdf) | [PDF (stable)](https://media.readthedocs.org/pdf/jupyterhub/stable/jupyterhub.pdf)
+- [Documentation for JupyterHub](https://jupyterhub.readthedocs.io/en/latest/)
 - [Documentation for JupyterHub's REST API][rest api]
-- [Documentation for Project Jupyter](http://jupyter.readthedocs.io/en/latest/index.html) | [PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)
+- [Documentation for Project Jupyter](http://jupyter.readthedocs.io/en/latest/index.html)
 - [Project Jupyter website](https://jupyter.org)
 - [Project Jupyter community](https://jupyter.org/community)
 

bower-lite

@@ -7,6 +7,7 @@ bower-lite
 Since Bower's on its way out,
 stage frontend dependencies from node_modules into components
 """
+
 import json
 import os
 import shutil

ci/check_installed_data.py

@@ -2,19 +2,35 @@
 # Check that installed package contains everything we expect
 
 
-import os
+from pathlib import Path
 
+import jupyterhub
 from jupyterhub._data import DATA_FILES_PATH
 
-print("Checking jupyterhub._data")
-print(f"DATA_FILES_PATH={DATA_FILES_PATH}")
-assert os.path.exists(DATA_FILES_PATH), DATA_FILES_PATH
+print("Checking jupyterhub._data", end=" ")
+print(f"DATA_FILES_PATH={DATA_FILES_PATH}", end=" ")
+DATA_FILES_PATH = Path(DATA_FILES_PATH)
+assert DATA_FILES_PATH.is_dir(), DATA_FILES_PATH
 for subpath in (
-    "templates/page.html",
+    "templates/spawn.html",
     "static/css/style.min.css",
     "static/components/jquery/dist/jquery.js",
     "static/js/admin-react.js",
 ):
-    path = os.path.join(DATA_FILES_PATH, subpath)
-    assert os.path.exists(path), path
+    path = DATA_FILES_PATH / subpath
+    assert path.is_file(), path
+
+print("OK")
+
+print("Checking package_data", end=" ")
+jupyterhub_path = Path(jupyterhub.__file__).parent.resolve()
+for subpath in (
+    "alembic.ini",
+    "alembic/versions/833da8570507_rbac.py",
+    "event-schemas/server-actions/v1.yaml",
+    "singleuser/templates/page.html",
+):
+    path = jupyterhub_path / subpath
+    assert path.is_file(), path
+
 print("OK")

ci/init-db.sh

@@ -21,7 +21,7 @@ fi
 # Configure a set of databases in the database server for upgrade tests
 # this list must be in sync with versions in test_db.py:test_upgrade
 set -x
-for SUFFIX in '' _upgrade_110 _upgrade_122 _upgrade_130 _upgrade_150 _upgrade_211; do
+for SUFFIX in '' _upgrade_110 _upgrade_122 _upgrade_130 _upgrade_150 _upgrade_211 _upgrade_311; do
     $SQL_CLIENT "DROP DATABASE jupyterhub${SUFFIX};" 2>/dev/null || true
     $SQL_CLIENT "CREATE DATABASE jupyterhub${SUFFIX} ${EXTRA_CREATE_DATABASE_ARGS:-};"
 done

ci/oldest-dependencies/oldest-dependencies.txt

@@ -0,0 +1,13 @@
+alembic==1.4
+async_generator==1.9
+certipy==0.1.2
+importlib_metadata==3.6; python_version < '3.10'
+jinja2==2.11.0
+jupyter_telemetry==0.1.0
+oauthlib==3.0
+pamela==1.1.0; sys_platform != 'win32'
+prometheus_client==0.5.0
+psutil==5.6.5; sys_platform == 'win32'
+SQLAlchemy==1.4.1
+tornado==5.1
+traitlets==4.3.2

ci/oldest-dependencies/requirements.in

@@ -0,0 +1,20 @@
+# oldest-dependencies.txt is autogenerated.
+# recreate with:
+#     cat requirements.txt | grep '>=' | sed -e 's@>=@==@g' > ci/legacy-env/oldest-dependencies.txt
+-r ./oldest-dependencies.txt
+# then `pip-compile` with Python 3.8
+# below are additional pins to make this a working test env
+# these are extracted from jupyterhub[test]
+beautifulsoup4
+coverage
+playwright
+pytest
+pytest-cov
+pytest-asyncio==0.17.*
+requests-mock
+virtualenv
+
+# and any additional pins to make this a working test env
+# e.g. pinning down a transitive dependency
+notebook==6.*
+markupsafe==2.0.*

ci/oldest-dependencies/requirements.old

@@ -0,0 +1,285 @@
+#
+# This file is autogenerated by pip-compile with Python 3.8
+# by the following command:
+#
+#    pip-compile --output-file=requirements.old
+#
+alembic==1.4.0
+    # via -r ./oldest-dependencies.txt
+appnope==0.1.3
+    # via
+    #   ipykernel
+    #   ipython
+argon2-cffi==23.1.0
+    # via notebook
+argon2-cffi-bindings==21.2.0
+    # via argon2-cffi
+async-generator==1.9
+    # via -r ./oldest-dependencies.txt
+attrs==23.1.0
+    # via
+    #   jsonschema
+    #   referencing
+backcall==0.2.0
+    # via ipython
+beautifulsoup4==4.12.2
+    # via -r requirements.in
+bleach==6.0.0
+    # via nbconvert
+certifi==2023.7.22
+    # via requests
+certipy==0.1.2
+    # via -r ./oldest-dependencies.txt
+cffi==1.15.1
+    # via
+    #   argon2-cffi-bindings
+    #   cryptography
+charset-normalizer==3.2.0
+    # via requests
+coverage[toml]==7.3.1
+    # via
+    #   -r requirements.in
+    #   pytest-cov
+cryptography==41.0.4
+    # via pyopenssl
+debugpy==1.8.0
+    # via ipykernel
+decorator==5.1.1
+    # via
+    #   ipython
+    #   traitlets
+defusedxml==0.7.1
+    # via nbconvert
+distlib==0.3.7
+    # via virtualenv
+entrypoints==0.4
+    # via
+    #   jupyter-client
+    #   nbconvert
+exceptiongroup==1.1.3
+    # via pytest
+fastjsonschema==2.18.0
+    # via nbformat
+filelock==3.12.4
+    # via virtualenv
+greenlet==2.0.2
+    # via
+    #   playwright
+    #   sqlalchemy
+idna==3.4
+    # via requests
+importlib-metadata==3.6.0 ; python_version < "3.10"
+    # via -r ./oldest-dependencies.txt
+importlib-resources==6.1.0
+    # via
+    #   jsonschema
+    #   jsonschema-specifications
+iniconfig==2.0.0
+    # via pytest
+ipykernel==6.4.2
+    # via notebook
+ipython==7.34.0
+    # via ipykernel
+ipython-genutils==0.2.0
+    # via
+    #   ipykernel
+    #   notebook
+    #   traitlets
+jedi==0.19.0
+    # via ipython
+jinja2==2.11.0
+    # via
+    #   -r ./oldest-dependencies.txt
+    #   nbconvert
+    #   notebook
+jsonschema==4.19.1
+    # via
+    #   jupyter-telemetry
+    #   nbformat
+jsonschema-specifications==2023.7.1
+    # via jsonschema
+jupyter-client==7.2.0
+    # via
+    #   ipykernel
+    #   nbclient
+    #   notebook
+jupyter-core==5.0.0
+    # via
+    #   jupyter-client
+    #   nbconvert
+    #   nbformat
+    #   notebook
+jupyter-telemetry==0.1.0
+    # via -r ./oldest-dependencies.txt
+jupyterlab-pygments==0.2.2
+    # via nbconvert
+mako==1.2.4
+    # via alembic
+markupsafe==2.0.1
+    # via
+    #   -r requirements.in
+    #   jinja2
+    #   mako
+matplotlib-inline==0.1.6
+    # via
+    #   ipykernel
+    #   ipython
+mistune==0.8.4
+    # via nbconvert
+nbclient==0.5.11
+    # via nbconvert
+nbconvert==6.0.7
+    # via notebook
+nbformat==5.3.0
+    # via
+    #   nbclient
+    #   nbconvert
+    #   notebook
+nest-asyncio==1.5.8
+    # via
+    #   jupyter-client
+    #   nbclient
+notebook==6.1.6
+    # via -r requirements.in
+oauthlib==3.0.0
+    # via -r ./oldest-dependencies.txt
+packaging==23.1
+    # via pytest
+pamela==1.1.0 ; sys_platform != "win32"
+    # via -r ./oldest-dependencies.txt
+pandocfilters==1.5.0
+    # via nbconvert
+parso==0.8.3
+    # via jedi
+pexpect==4.8.0
+    # via ipython
+pickleshare==0.7.5
+    # via ipython
+pkgutil-resolve-name==1.3.10
+    # via jsonschema
+platformdirs==3.10.0
+    # via
+    #   jupyter-core
+    #   virtualenv
+playwright==1.38.0
+    # via -r requirements.in
+pluggy==1.3.0
+    # via pytest
+prometheus-client==0.5.0
+    # via
+    #   -r ./oldest-dependencies.txt
+    #   notebook
+prompt-toolkit==3.0.39
+    # via ipython
+ptyprocess==0.7.0
+    # via
+    #   pexpect
+    #   terminado
+pycparser==2.21
+    # via cffi
+pyee==9.0.4
+    # via playwright
+pygments==2.16.1
+    # via
+    #   ipython
+    #   nbconvert
+pyopenssl==23.2.0
+    # via certipy
+pytest==7.4.2
+    # via
+    #   -r requirements.in
+    #   pytest-asyncio
+    #   pytest-cov
+pytest-asyncio==0.17.2
+    # via -r requirements.in
+pytest-cov==4.1.0
+    # via -r requirements.in
+python-dateutil==2.8.2
+    # via
+    #   alembic
+    #   jupyter-client
+python-editor==1.0.4
+    # via alembic
+python-json-logger==2.0.7
+    # via jupyter-telemetry
+pyzmq==25.1.1
+    # via
+    #   jupyter-client
+    #   notebook
+referencing==0.30.2
+    # via
+    #   jsonschema
+    #   jsonschema-specifications
+requests==2.31.0
+    # via requests-mock
+requests-mock==1.11.0
+    # via -r requirements.in
+rpds-py==0.10.3
+    # via
+    #   jsonschema
+    #   referencing
+ruamel-yaml==0.17.32
+    # via jupyter-telemetry
+ruamel-yaml-clib==0.2.7
+    # via ruamel-yaml
+send2trash==1.8.2
+    # via notebook
+six==1.16.0
+    # via
+    #   bleach
+    #   python-dateutil
+    #   requests-mock
+    #   traitlets
+soupsieve==2.5
+    # via beautifulsoup4
+sqlalchemy==1.4.1
+    # via
+    #   -r ./oldest-dependencies.txt
+    #   alembic
+terminado==0.13.3
+    # via notebook
+testpath==0.6.0
+    # via nbconvert
+tomli==2.0.1
+    # via
+    #   coverage
+    #   pytest
+tornado==5.1
+    # via
+    #   -r ./oldest-dependencies.txt
+    #   ipykernel
+    #   jupyter-client
+    #   notebook
+    #   terminado
+traitlets==4.3.2
+    # via
+    #   -r ./oldest-dependencies.txt
+    #   ipykernel
+    #   ipython
+    #   jupyter-client
+    #   jupyter-core
+    #   jupyter-telemetry
+    #   matplotlib-inline
+    #   nbclient
+    #   nbconvert
+    #   nbformat
+    #   notebook
+typing-extensions==4.8.0
+    # via
+    #   playwright
+    #   pyee
+urllib3==2.0.5
+    # via requests
+virtualenv==20.24.5
+    # via -r requirements.in
+wcwidth==0.2.6
+    # via prompt-toolkit
+webencodings==0.5.1
+    # via bleach
+zipp==3.17.0
+    # via
+    #   importlib-metadata
+    #   importlib-resources
+
+# The following packages are considered to be unsafe in a requirements file:
+# setuptools

demo-image/Dockerfile

@@ -3,7 +3,7 @@
 # This should only be used for demo or testing and not as a base image to build on.
 #
 # It includes the notebook package and it uses the DummyAuthenticator and the SimpleLocalProcessSpawner.
-ARG BASE_IMAGE=jupyterhub/jupyterhub-onbuild
+ARG BASE_IMAGE=quay.io/jupyterhub/jupyterhub-onbuild
 FROM ${BASE_IMAGE}
 
 # Install the notebook package

demo-image/jupyterhub_config.py

@@ -1,6 +1,6 @@
 # Configuration file for jupyterhub-demo
 
-c = get_config()
+c = get_config()  # noqa
 
 # Use DummyAuthenticator and SimpleSpawner
 c.JupyterHub.spawner_class = "simple"

dockerfiles/Dockerfile.alpine

@@ -1,14 +0,0 @@
-FROM alpine:3.13
-ENV LANG=en_US.UTF-8
-RUN apk add --no-cache \
-        python3 \
-        py3-pip \
-        py3-ruamel.yaml \
-        py3-cryptography \
-        py3-sqlalchemy
-
-ARG JUPYTERHUB_VERSION=1.3.0
-RUN pip3 install --no-cache jupyterhub==${JUPYTERHUB_VERSION}
-
-USER nobody
-CMD ["jupyterhub"]

dockerfiles/README.md

@@ -1,22 +0,0 @@
-## What is Dockerfile.alpine
-
-Dockerfile.alpine contains the base image for jupyterhub. It does not work independently, but only as part of a full jupyterhub cluster
-
-## How to use it?
-
-You will need:
-
-1. A running configurable-http-proxy, whose API is accessible.
-2. A jupyterhub_config file.
-3. Authentication and other libraries required by the specific jupyterhub_config file.
-
-## Steps to test it outside a cluster
-
-- start configurable-http-proxy in another container
-- specify CONFIGPROXY_AUTH_TOKEN env in both containers
-- put both containers on the same network (e.g. docker network create jupyterhub; docker run ... --net jupyterhub)
-- tell jupyterhub where CHP is (e.g. c.ConfigurableHTTPProxy.api_url = 'http://chp:8001')
-- tell jupyterhub not to start the proxy itself (c.ConfigurableHTTPProxy.should_start = False)
-- Use a dummy authenticator for ease of testing. Update following in jupyterhub_config file
-  - c.JupyterHub.authenticator_class = 'dummyauthenticator.DummyAuthenticator'
-  - c.DummyAuthenticator.password = "your strong password"

docs/Makefile

@@ -1,212 +1,62 @@
-# Makefile for Sphinx documentation
-#
+# Makefile for Sphinx documentation generated by sphinx-quickstart
+# ----------------------------------------------------------------------------
 
-# You can set these variables from the command line.
-SPHINXOPTS    = "-W"
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= --color -W --keep-going
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = _build
 
+# Put it first so that "make" without argument is like "make help".
 help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  applehelp  to make an Apple Help Book"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  texinfo    to make Texinfo files"
-	@echo "  info       to make Texinfo files and run them through makeinfo"
-	@echo "  gettext    to make PO message catalogs"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  xml        to make Docutils-native XML files"
-	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-	@echo "  coverage   to run coverage check of the documentation (if enabled)"
-	@echo "  spelling   to run spell check on documentation"
-	@echo "  metrics    to generate documentation for metrics by inspecting the source code"
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
 
-clean:
-	rm -rf $(BUILDDIR)/*
+.PHONY: help Makefile metrics scopes
 
-metrics: source/reference/metrics.rst
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.
+#
+# Several sphinx-build commands can be used through this, for example:
+#
+# - make clean
+# - make linkcheck
+# - make spelling
+#
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
 
-source/reference/metrics.rst: generate-metrics.py
-	python3 generate-metrics.py
 
-scopes: source/rbac/scope-table.md
+# Manually added targets - related to code generation
+# ----------------------------------------------------------------------------
 
-source/rbac/scope-table.md: source/rbac/generate-scope-table.py
-	python3 source/rbac/generate-scope-table.py
-
-# If the pre-requisites for the html target is updated, also update the Read The
-# Docs section in docs/source/conf.py.
+# For local development:
+# - builds the html
+# - NOTE: If the pre-requisites for the html target is updated, also update the
+#         Read The Docs section in docs/source/conf.py.
 #
 html: metrics scopes
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html" $(SPHINXOPTS)
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+metrics: source/reference/metrics.md
+source/reference/metrics.md:
+	python3 generate-metrics.py
 
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+scopes: source/rbac/scope-table.md
+source/rbac/scope-table.md:
+	python3 source/rbac/generate-scope-table.py
 
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
 
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
+# Manually added targets - related to development
+# ----------------------------------------------------------------------------
 
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JupyterHub.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JupyterHub.qhc"
-
-applehelp:
-	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
-	@echo
-	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
-	@echo "N.B. You won't be able to view it unless you put it in" \
-	      "~/Library/Documentation/Help or install it in your application" \
-	      "bundle."
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/JupyterHub"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/JupyterHub"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through platex and dvipdfmx..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo
-	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
-	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
-
-info:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo "Running Texinfo files through makeinfo..."
-	make -C $(BUILDDIR)/texinfo info
-	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
-	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-	@echo
-	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-spelling:
-	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
-	@echo
-	@echo "Spell check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/spelling/output.txt."
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-
-coverage:
-	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
-	@echo "Testing of coverage in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/coverage/python.txt."
-
-xml:
-	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
-	@echo
-	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
-	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
-	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+# For local development:
+# - requires sphinx-autobuild, see
+#   https://sphinxcontrib-spelling.readthedocs.io/en/latest/
+# - builds and rebuilds html on changes to source, but does not re-generate
+#   metrics/scopes files
+# - starts a livereload enabled webserver and opens up a browser
+devenv: html
+	sphinx-autobuild -b html --open-browser "$(SOURCEDIR)" "$(BUILDDIR)/html"

docs/generate-metrics.py

@@ -1,7 +1,6 @@
 import os
 
-from pytablewriter import RstSimpleTableWriter
-from pytablewriter.style import Style
+from pytablewriter import MarkdownTableWriter
 
 import jupyterhub.metrics
 
@@ -11,12 +10,11 @@ HERE = os.path.abspath(os.path.dirname(__file__))
 class Generator:
     @classmethod
     def create_writer(cls, table_name, headers, values):
-        writer = RstSimpleTableWriter()
+        writer = MarkdownTableWriter()
         writer.table_name = table_name
         writer.headers = headers
         writer.value_matrix = values
         writer.margin = 1
-        [writer.set_style(header, Style(align="center")) for header in headers]
         return writer
 
     def _parse_metrics(self):
@@ -33,18 +31,17 @@ class Generator:
         if not os.path.exists(generated_directory):
             os.makedirs(generated_directory)
 
-        filename = f"{generated_directory}/metrics.rst"
+        filename = f"{generated_directory}/metrics.md"
         table_name = ""
         headers = ["Type", "Name", "Description"]
         values = self._parse_metrics()
         writer = self.create_writer(table_name, headers, values)
 
-        title = "List of Prometheus Metrics"
-        underline = "============================"
-        content = f"{title}\n{underline}\n{writer.dumps()}"
         with open(filename, 'w') as f:
-            f.write(content)
-        print(f"Generated {filename}.")
+            f.write("# List of Prometheus Metrics\n\n")
+            f.write(writer.dumps())
+            f.write("\n")
+        print(f"Generated {filename}")
 
 
 def main():

docs/make.bat

@@ -1,263 +1,49 @@
 @ECHO OFF
 
+pushd %~dp0
+
 REM Command file for Sphinx documentation
 
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=--color -W --keep-going
+)
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set BUILDDIR=build
-set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
-set I18NSPHINXOPTS=%SPHINXOPTS% source
-if NOT "%PAPER%" == "" (
-	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
-	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
-)
+set SOURCEDIR=source
+set BUILDDIR=_build
 
 if "%1" == "" goto help
-
-if "%1" == "help" (
-	:help
-	echo.Please use `make ^<target^>` where ^<target^> is one of
-	echo.  html       to make standalone HTML files
-	echo.  dirhtml    to make HTML files named index.html in directories
-	echo.  singlehtml to make a single large HTML file
-	echo.  pickle     to make pickle files
-	echo.  json       to make JSON files
-	echo.  htmlhelp   to make HTML files and a HTML help project
-	echo.  qthelp     to make HTML files and a qthelp project
-	echo.  devhelp    to make HTML files and a Devhelp project
-	echo.  epub       to make an epub
-	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-	echo.  text       to make text files
-	echo.  man        to make manual pages
-	echo.  texinfo    to make Texinfo files
-	echo.  gettext    to make PO message catalogs
-	echo.  changes    to make an overview over all changed/added/deprecated items
-	echo.  xml        to make Docutils-native XML files
-	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
-	echo.  linkcheck  to check all external links for integrity
-	echo.  doctest    to run all doctests embedded in the documentation if enabled
-	echo.  coverage   to run coverage check of the documentation if enabled
-	goto end
-)
-
-if "%1" == "clean" (
-	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
-	del /q /s %BUILDDIR%\*
-	goto end
-)
+if "%1" == "devenv" goto devenv
+goto default
 
 
-REM Check if sphinx-build is available and fallback to Python version if any
-%SPHINXBUILD% 1>NUL 2>NUL
-if errorlevel 9009 goto sphinx_python
-goto sphinx_ok
-
-:sphinx_python
-
-set SPHINXBUILD=python -m sphinx.__init__
-%SPHINXBUILD% 2> nul
+:default
+%SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
+	echo.The 'sphinx-build' command was not found. Open and read README.md!
 	exit /b 1
 )
-
-:sphinx_ok
-
-
-if "%1" == "html" (
-	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+%SPHINXBUILD% -M %1 "%SOURCEDIR%" "%BUILDDIR%" %SPHINXOPTS%
 goto end
-)
 
-if "%1" == "dirhtml" (
-	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
-	goto end
-)
 
-if "%1" == "singlehtml" (
-	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+:help
+%SPHINXBUILD% -M help "%SOURCEDIR%" "%BUILDDIR%" %SPHINXOPTS%
 goto end
-)
 
-if "%1" == "pickle" (
-	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can process the pickle files.
-	goto end
-)
 
-if "%1" == "json" (
-	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
-	if errorlevel 1 exit /b 1
+:devenv
+sphinx-autobuild >NUL 2>NUL
+if errorlevel 9009 (
 	echo.
-	echo.Build finished; now you can process the JSON files.
-	goto end
+	echo.The 'sphinx-autobuild' command was not found. Open and read README.md!
+	exit /b 1
 )
+sphinx-autobuild -b html --open-browser "%SOURCEDIR%" "%BUILDDIR%/html"
+goto end
 
-if "%1" == "htmlhelp" (
-	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run HTML Help Workshop with the ^
-.hhp project file in %BUILDDIR%/htmlhelp.
-	goto end
-)
-
-if "%1" == "qthelp" (
-	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; now you can run "qcollectiongenerator" with the ^
-.qhcp project file in %BUILDDIR%/qthelp, like this:
-	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\JupyterHub.qhcp
-	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\JupyterHub.ghc
-	goto end
-)
-
-if "%1" == "devhelp" (
-	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished.
-	goto end
-)
-
-if "%1" == "epub" (
-	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The epub file is in %BUILDDIR%/epub.
-	goto end
-)
-
-if "%1" == "latex" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "latexpdf" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	cd %BUILDDIR%/latex
-	make all-pdf
-	cd %~dp0
-	echo.
-	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "latexpdfja" (
-	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
-	cd %BUILDDIR%/latex
-	make all-pdf-ja
-	cd %~dp0
-	echo.
-	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
-	goto end
-)
-
-if "%1" == "text" (
-	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The text files are in %BUILDDIR%/text.
-	goto end
-)
-
-if "%1" == "man" (
-	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The manual pages are in %BUILDDIR%/man.
-	goto end
-)
-
-if "%1" == "texinfo" (
-	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
-	goto end
-)
-
-if "%1" == "gettext" (
-	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
-	goto end
-)
-
-if "%1" == "changes" (
-	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.The overview file is in %BUILDDIR%/changes.
-	goto end
-)
-
-if "%1" == "linkcheck" (
-	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Link check complete; look for any errors in the above output ^
-or in %BUILDDIR%/linkcheck/output.txt.
-	goto end
-)
-
-if "%1" == "doctest" (
-	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Testing of doctests in the sources finished, look at the ^
-results in %BUILDDIR%/doctest/output.txt.
-	goto end
-)
-
-if "%1" == "coverage" (
-	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Testing of coverage in the sources finished, look at the ^
-results in %BUILDDIR%/coverage/python.txt.
-	goto end
-)
-
-if "%1" == "xml" (
-	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The XML files are in %BUILDDIR%/xml.
-	goto end
-)
-
-if "%1" == "pseudoxml" (
-	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
-	if errorlevel 1 exit /b 1
-	echo.
-	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
-	goto end
-)
 
 :end
+popd

docs/requirements.txt

@@ -1,17 +1,10 @@
-# We install the jupyterhub package to help autodoc-traits inspect it and
-# generate documentation.
-#
-# FIXME: If there is a way for this requirements.txt file to pass a flag that
-#        the build system can intercept to not build the javascript artifacts,
-#        then do so so. That would mean that installing the documentation can
-#        avoid needing node/npm installed.
-#
---editable .
-
+# docs also require jupyterhub itself to be installed
+# don't depend on it here, as that often results in a duplicate
+# installation of jupyterhub that's already installed
 autodoc-traits
-myst-parser
+jupyterhub-sphinx-theme
+myst-parser>=0.19
 pre-commit
-pydata-sphinx-theme
 pytablewriter>=0.56
 ruamel.yaml
 sphinx>=4

docs/source/_templates/page.html

@@ -0,0 +1,2 @@
+{%- set _meta = meta | default({}) %}
+{%- extends _meta.page_template | default('!page.html') %}

docs/source/_templates/redoc.html

@@ -0,0 +1,36 @@
+{%- extends "!layout.html" %}
+{# not sure why, but theme CSS prevents scrolling within redoc content
+ # If this were fixed, we could keep the navbar and footer
+ #}
+{% block css %}
+{% endblock css %}
+{% block docs_navbar %}
+{% endblock docs_navbar %}
+{% block footer %}
+{% endblock footer %}
+{# djlint: off #}
+{%- block body_tag -%}<body>{%- endblock body_tag %}
+{# djlint: on #}
+{%- block extrahead %}
+  {{ super() }}
+  <link href="{{ pathto('_static/redoc-fonts.css', 1) }}" rel="stylesheet" />
+  <script src="{{ pathto('_static/redoc.js', 1) }}"></script>
+{%- endblock extrahead %}
+{%- block content %}
+  <redoc id="redoc-spec"></redoc>
+  <script>
+    if (location.protocol === "file:") {
+      document.body.innerText = "Rendered API specification doesn't work with file: protocol. Use sphinx-autobuild to do local builds of the docs, served over HTTP."
+    } else {
+      Redoc.init(
+        "{{ pathto('_static/rest-api.yml', 1) }}", {
+          {
+            meta.redoc_options |
+              default ({})
+          }
+        },
+        document.getElementById("redoc-spec"),
+      );
+    }
+  </script>
+{%- endblock content %}

docs/source/admin/upgrading.rst

@@ -1,155 +0,0 @@
-====================
-Upgrading JupyterHub
-====================
-
-JupyterHub offers easy upgrade pathways between minor versions. This
-document describes how to do these upgrades.
-
-If you are using :ref:`a JupyterHub distribution <index/distributions>`, you
-should consult the distribution's documentation on how to upgrade. This documentation is 
-for those who have set up their JupyterHub without using a distribution.
-
-This documentation is lengthy because it is quite detailed. Most likely, upgrading
-JupyterHub is painless, quick and with minimal user interruption.
-
-The steps are discussed in detail, so if you get stuck at any step you can always refer to this guide. 
-
-Read the Changelog
-==================
-
-The `changelog <../changelog.md>`_ contains information on what has
-changed with the new JupyterHub release and any deprecation warnings.
-Read these notes to familiarize yourself with the coming changes. There
-might be new releases of the authenticators & spawners you use, so
-read the changelogs for those too!
-
-Notify your users
-=================
-
-If you use the default configuration where ``configurable-http-proxy``
-is managed by JupyterHub, your users will see service disruption during
-the upgrade process. You should notify them, and pick a time to do the
-upgrade where they will be least disrupted.
-
-If you use a different proxy or run ``configurable-http-proxy``
-independent of JupyterHub, your users will be able to continue using notebook
-servers they had already launched, but will not be able to launch new servers or sign in.
-
-
-Backup database & config
-========================
-
-Before doing an upgrade, it is critical to back up:
-
-#. Your JupyterHub database (SQLite by default, or MySQL / Postgres if you used those). 
-   If you use SQLite (the default), you should backup the ``jupyterhub.sqlite`` file.
-
-#. Your ``jupyterhub_config.py`` file.
-
-#. Your users' home directories. This is unlikely to be affected directly by
-   a JupyterHub upgrade, but we recommend a backup since user data is critical.
-
-
-Shut down JupyterHub
-====================
-
-Shut down the JupyterHub process. This would vary depending on how you
-have set up JupyterHub to run. It is most likely using a process
-supervisor of some sort (``systemd`` or ``supervisord`` or even ``docker``).
-Use the supervisor-specific command to stop the JupyterHub process.
-
-Upgrade JupyterHub packages
-===========================
-
-There are two environments where the ``jupyterhub`` package is installed:
-
-#. The *hub environment*: where the JupyterHub server process
-   runs. This is started with the ``jupyterhub`` command, and is what
-   people generally think of as JupyterHub.
-
-#. The *notebook user environments*: where the user notebook
-   servers are launched from, and is probably custom to your own
-   installation. This could be just one environment (different from the
-   hub environment) that is shared by all users, one environment
-   per user, or the same environment as the hub environment. The hub
-   launched the ``jupyterhub-singleuser`` command in this environment,
-   which in turn starts the notebook server.
-
-You need to make sure the version of the ``jupyterhub`` package matches
-in both these environments. If you installed ``jupyterhub`` with pip,
-you can upgrade it with:
-
-.. code-block:: bash
-
-   python3 -m pip install --upgrade jupyterhub==<version>
-
-Where ``<version>`` is the version of JupyterHub you are upgrading to.
-
-If you used ``conda`` to install ``jupyterhub``, you should upgrade it
-with:
-
-.. code-block:: bash
-
-   conda install -c conda-forge jupyterhub==<version>
-
-You should also check for new releases of the authenticator & spawner you
-are using. You might wish to upgrade those packages, too, along with JupyterHub
-or upgrade them separately.
-
-Upgrade JupyterHub database
-===========================
-
-Once new packages are installed, you need to upgrade the JupyterHub
-database. From the hub environment, in the same directory as your
-``jupyterhub_config.py`` file, you should run:
-
-.. code-block:: bash
-
-   jupyterhub upgrade-db
-
-This should find the location of your database, and run the necessary upgrades
-for it.
-
-SQLite database disadvantages
------------------------------
-
-SQLite has some disadvantages when it comes to upgrading JupyterHub. These
-are:
-
--  ``upgrade-db`` may not work, and you may need to delete your database
-   and start with a fresh one.
--  ``downgrade-db`` **will not** work if you want to rollback to an
-   earlier version, so backup the ``jupyterhub.sqlite`` file before
-   upgrading.
-
-What happens if I delete my database?
--------------------------------------
-
-Losing the Hub database is often not a big deal. Information that
-resides only in the Hub database includes:
-
--  active login tokens (user cookies, service tokens)
--  users added via JupyterHub UI, instead of config files
--  info about running servers
-
-If the following conditions are true, you should be fine clearing the
-Hub database and starting over:
-
--  users specified in the config file, or login using an external
-   authentication provider (Google, GitHub, LDAP, etc)
--  user servers are stopped during the upgrade
--  don't mind causing users to log in again after the upgrade
-
-Start JupyterHub
-================
-
-Once the database upgrade is completed, start the ``jupyterhub``
-process again.
-
-#. Log in and start the server to make sure things work as
-   expected.
-#. Check the logs for any errors or deprecation warnings. You
-   might have to update your ``jupyterhub_config.py`` file to
-   deal with any deprecated options.
-
-Congratulations, your JupyterHub has been upgraded!

docs/source/api/app.rst

@@ -1,15 +0,0 @@
-=========================
-Application configuration
-=========================
-
-Module: :mod:`jupyterhub.app`
-=============================
-
-.. automodule:: jupyterhub.app
-
-.. currentmodule:: jupyterhub.app
-
-:class:`JupyterHub`
--------------------
-
-.. autoconfigurable:: JupyterHub

docs/source/api/auth.rst

@@ -1,32 +0,0 @@
-==============
-Authenticators
-==============
-
-Module: :mod:`jupyterhub.auth`
-==============================
-
-.. automodule:: jupyterhub.auth
-
-.. currentmodule:: jupyterhub.auth
-
-:class:`Authenticator`
-----------------------
-
-.. autoconfigurable:: Authenticator
-    :members:
-
-:class:`LocalAuthenticator`
----------------------------
-
-.. autoconfigurable:: LocalAuthenticator
-    :members:
-
-:class:`PAMAuthenticator`
--------------------------
-
-.. autoconfigurable:: PAMAuthenticator
-
-:class:`DummyAuthenticator`
----------------------------
-
-.. autoconfigurable:: DummyAuthenticator

docs/source/api/index.rst

@@ -1,33 +0,0 @@
-.. _api-index:
-
-##############
-JupyterHub API
-##############
-
-:Release: |release|
-:Date: |today|
-
-JupyterHub also provides a REST API for administration of the Hub and users.
-The documentation on `Using JupyterHub's REST API <../reference/rest.html>`_ provides
-information on:
-
-- what you can do with the API
-- creating an API token
-- adding API tokens to the config files
-- making an API request programmatically using the requests library
-- learning more about JupyterHub's API
-
-JupyterHub API Reference:
-
-.. toctree::
-
-    app
-    auth
-    spawner
-    proxy
-    user
-    service
-    services.auth
-
-
-.. _OpenAPI Initiative: https://www.openapis.org/

docs/source/api/proxy.rst

@@ -1,22 +0,0 @@
-=======
-Proxies
-=======
-
-Module: :mod:`jupyterhub.proxy`
-===============================
-
-.. automodule:: jupyterhub.proxy
-
-.. currentmodule:: jupyterhub.proxy
-
-:class:`Proxy`
---------------
-
-.. autoconfigurable:: Proxy
-    :members:
-
-:class:`ConfigurableHTTPProxy`
-------------------------------
-
-.. autoconfigurable:: ConfigurableHTTPProxy
-    :members: debug, auth_token, check_running_interval, api_url, command

docs/source/api/service.rst

@@ -1,16 +0,0 @@
-========
-Services
-========
-
-Module: :mod:`jupyterhub.services.service`
-==========================================
-
-.. automodule:: jupyterhub.services.service
-
-.. currentmodule:: jupyterhub.services.service
-
-:class:`Service`
-----------------
-
-.. autoconfigurable:: Service
-    :members: name, admin, url, api_token, managed, kind, command, cwd, environment, user, oauth_client_id, server, prefix, proxy_spec

docs/source/api/services.auth.rst

@@ -1,40 +0,0 @@
-=======================
-Services Authentication
-=======================
-
-Module: :mod:`jupyterhub.services.auth`
-=======================================
-
-.. automodule:: jupyterhub.services.auth
-
-.. currentmodule:: jupyterhub.services.auth
-
-
-:class:`HubAuth`
-----------------
-
-.. autoconfigurable:: HubAuth
-    :members:
-
-:class:`HubOAuth`
------------------
-
-.. autoconfigurable:: HubOAuth
-    :members:
-
-
-:class:`HubAuthenticated`
--------------------------
-
-.. autoclass:: HubAuthenticated
-    :members:
-
-:class:`HubOAuthenticated`
---------------------------
-
-.. autoclass:: HubOAuthenticated
-
-:class:`HubOAuthCallbackHandler`
---------------------------------
-
-.. autoclass:: HubOAuthCallbackHandler

docs/source/api/spawner.rst

@@ -1,21 +0,0 @@
-========
-Spawners
-========
-
-Module: :mod:`jupyterhub.spawner`
-=================================
-
-.. automodule:: jupyterhub.spawner
-
-.. currentmodule:: jupyterhub.spawner
-
-:class:`Spawner`
-----------------
-
-.. autoconfigurable:: Spawner
-    :members: options_from_form, poll, start, stop, get_args, get_env, get_state, template_namespace, format_string, create_certs, move_certs
-
-:class:`LocalProcessSpawner`
-----------------------------
-
-.. autoconfigurable:: LocalProcessSpawner

docs/source/api/user.rst

@@ -1,36 +0,0 @@
-=====
-Users
-=====
-
-Module: :mod:`jupyterhub.user`
-==============================
-
-.. automodule:: jupyterhub.user
-
-.. currentmodule:: jupyterhub.user
-
-:class:`UserDict`
------------------
-
-.. autoclass:: UserDict
-    :members:
-
-
-:class:`User`
--------------
-
-.. autoclass:: User
-    :members: escaped_name
-    
-    .. attribute:: name
-    
-      The user's name
-    
-    .. attribute:: server
-    
-        The user's Server data object if running, None otherwise.
-        Has ``ip``, ``port`` attributes.
-
-    .. attribute:: spawner
-    
-        The user's :class:`~.Spawner` instance.

docs/source/conf.py

@@ -6,22 +6,26 @@ import contextlib
 import datetime
 import io
 import os
+import re
 import subprocess
+from pathlib import Path
+from urllib.request import urlretrieve
 
 from docutils import nodes
+from ruamel.yaml import YAML
 from sphinx.directives.other import SphinxDirective
+from sphinx.util import logging
 
 import jupyterhub
 from jupyterhub.app import JupyterHub
 
+logger = logging.getLogger(__name__)
 # -- Project information -----------------------------------------------------
 # ref: https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 #
 project = "JupyterHub"
 author = "Project Jupyter Contributors"
 copyright = f"{datetime.date.today().year}, {author}"
-version = "%i.%i" % jupyterhub.version_info[:2]
-release = jupyterhub.__version__
 
 
 # -- General Sphinx configuration --------------------------------------------
@@ -36,23 +40,41 @@ extensions = [
     "sphinx-jsonschema",
     "sphinxext.opengraph",
     "sphinxext.rediraffe",
+    "jupyterhub_sphinx_theme",
     "myst_parser",
 ]
 root_doc = "index"
-source_suffix = [".md", ".rst"]
+source_suffix = [".md"]
 # default_role let's use use `foo` instead of ``foo`` in rST
 default_role = "literal"
 
+docs = Path(__file__).parent.parent.absolute()
+docs_source = docs / "source"
+rest_api_yaml = docs_source / "_static" / "rest-api.yml"
+
 
 # -- MyST configuration ------------------------------------------------------
 # ref: https://myst-parser.readthedocs.io/en/latest/configuration.html
 #
 myst_heading_anchors = 2
+
 myst_enable_extensions = [
+    # available extensions: https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
+    "attrs_inline",
     "colon_fence",
     "deflist",
+    "fieldlist",
+    "substitution",
 ]
 
+myst_substitutions = {
+    # date example: Dev 07, 2022
+    "date": datetime.date.today().strftime("%b %d, %Y").title(),
+    "node_min": "12",
+    "python_min": "3.8",
+    "version": jupyterhub.__version__,
+}
+
 
 # -- Custom directives to generate documentation -----------------------------
 # ref: https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html
@@ -109,10 +131,102 @@ class HelpAllDirective(SphinxDirective):
         return [par]
 
 
+class RestAPILinksDirective(SphinxDirective):
+    """Directive to populate link targets for the REST API
+
+    The resulting nodes resolve xref targets,
+    but are not actually rendered in the final result
+    which is handled by a custom template.
+    """
+
+    has_content = False
+    required_arguments = 0
+    optional_arguments = 0
+    final_argument_whitespace = False
+    option_spec = {}
+
+    def run(self):
+        targets = []
+        yaml = YAML(typ="safe")
+        with rest_api_yaml.open() as f:
+            api = yaml.load(f)
+        for path, path_spec in api["paths"].items():
+            for method, operation in path_spec.items():
+                operation_id = operation.get("operationId")
+                if not operation_id:
+                    logger.warning(f"No operation id for {method} {path}")
+                    continue
+                # 'id' is the id on the page (must match redoc anchor)
+                # 'name' is the name of the ref for use in our documents
+                target = nodes.target(
+                    ids=[f"operation/{operation_id}"],
+                    names=[f"rest-api-{operation_id}"],
+                )
+                targets.append(target)
+                self.state.document.note_explicit_target(target, target)
+
+        return targets
+
+
+templates_path = ["_templates"]
+
+
+def stage_redoc_js(app, exception):
+    """Download redoc.js to our static files"""
+    if app.builder.name != "html":
+        logger.info(f"Skipping redoc download for builder: {app.builder.name}")
+        return
+
+    out_static = Path(app.builder.outdir) / "_static"
+
+    redoc_version = "2.1.3"
+    redoc_url = (
+        f"https://cdn.redoc.ly/redoc/v{redoc_version}/bundles/redoc.standalone.js"
+    )
+    dest = out_static / "redoc.js"
+    if not dest.exists():
+        logger.info(f"Downloading {redoc_url} -> {dest}")
+        urlretrieve(redoc_url, dest)
+
+    # stage fonts for redoc from google fonts
+    fonts_css_url = "https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
+    fonts_css_file = out_static / "redoc-fonts.css"
+    fonts_dir = out_static / "fonts"
+    fonts_dir.mkdir(exist_ok=True)
+    if not fonts_css_file.exists():
+        logger.info(f"Downloading {fonts_css_url} -> {fonts_css_file}")
+        urlretrieve(fonts_css_url, fonts_css_file)
+
+    # For each font external font URL,
+    # download the font and rewrite to a local URL
+    # The downloaded TTF fonts have license info in their metadata
+    with open(fonts_css_file) as f:
+        fonts_css = f.read()
+
+    fonts_css_changed = False
+    for font_url in re.findall(r'url\((https?[^\)]+)\)', fonts_css):
+        fonts_css_changed = True
+        filename = font_url.rpartition("/")[-1]
+        dest = fonts_dir / filename
+        local_url = str(dest.relative_to(fonts_css_file.parent))
+        fonts_css = fonts_css.replace(font_url, local_url)
+        if not dest.exists():
+            logger.info(f"Downloading {font_url} -> {dest}")
+            urlretrieve(font_url, dest)
+
+    if fonts_css_changed:
+        # rewrite font css with local URLs
+        with open(fonts_css_file, "w") as f:
+            logger.info(f"Rewriting URLs in {fonts_css_file}")
+            f.write(fonts_css)
+
+
 def setup(app):
+    app.connect("build-finished", stage_redoc_js)
     app.add_css_file("custom.css")
     app.add_directive("jupyterhub-generate-config", ConfigDirective)
     app.add_directive("jupyterhub-help-all", HelpAllDirective)
+    app.add_directive("jupyterhub-rest-api-links", RestAPILinksDirective)
 
 
 # -- Read The Docs -----------------------------------------------------------
@@ -121,8 +235,7 @@ def setup(app):
 # pre-requisite steps for "make html" from here if needed.
 #
 if os.environ.get("READTHEDOCS"):
-    docs = os.path.dirname(os.path.dirname(__file__))
-    subprocess.check_call(["make", "metrics", "scopes"], cwd=docs)
+    subprocess.check_call(["make", "metrics", "scopes"], cwd=str(docs))
 
 
 # -- Spell checking ----------------------------------------------------------
@@ -146,18 +259,13 @@ html_logo = "_static/images/logo/logo.png"
 html_favicon = "_static/images/logo/favicon.ico"
 html_static_path = ["_static"]
 
-html_theme = "pydata_sphinx_theme"
+html_theme = "jupyterhub_sphinx_theme"
 html_theme_options = {
     "icon_links": [
         {
             "name": "GitHub",
             "url": "https://github.com/jupyterhub/jupyterhub",
-            "icon": "fab fa-github-square",
-        },
-        {
-            "name": "Discourse",
-            "url": "https://discourse.jupyter.org/c/jupyterhub/10",
-            "icon": "fab fa-discourse",
+            "icon": "fa-brands fa-github",
         },
     ],
     "use_edit_page_button": True,
@@ -177,23 +285,30 @@ html_context = {
 linkcheck_ignore = [
     r"(.*)github\.com(.*)#",  # javascript based anchors
     r"(.*)/#%21(.*)/(.*)",  # /#!forum/jupyter - encoded anchor edge case
+    r"https?://(.*\.)?example\.(org|com)(/.*)?",  # example links
     r"https://github.com/[^/]*$",  # too many github usernames / searches in changelog
     "https://github.com/jupyterhub/jupyterhub/pull/",  # too many PRs in changelog
     "https://github.com/jupyterhub/jupyterhub/compare/",  # too many comparisons in changelog
+    r"https?://(localhost|127.0.0.1).*",  # ignore localhost references in auto-links
+    r"https://linux.die.net/.*",  # linux.die.net seems to block requests from CI with 403 sometimes
+    # don't check links to unpublished advisories
+    r"https://github.com/jupyterhub/jupyterhub/security/advisories/.*",
 ]
 linkcheck_anchors_ignore = [
     "/#!",
     "/#%21",
 ]
 
-
 # -- Intersphinx -------------------------------------------------------------
 # ref: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
 #
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3/", None),
     "tornado": ("https://www.tornadoweb.org/en/stable/", None),
+    "jupyter-server": ("https://jupyter-server.readthedocs.io/en/stable/", None),
+    "nbgitpuller": ("https://nbgitpuller.readthedocs.io/en/latest", None),
 }
+
 # -- Options for the opengraph extension -------------------------------------
 # ref: https://github.com/wpilibsuite/sphinxext-opengraph#options
 #
@@ -205,11 +320,33 @@ ogp_use_first_image = True
 # -- Options for the rediraffe extension -------------------------------------
 # ref: https://github.com/wpilibsuite/sphinxext-rediraffe#readme
 #
-# This extensions help us relocated content without breaking links. If a
-# document is moved internally, a redirect like should be configured below to
+# This extension helps us relocate content without breaking links. If a
+# document is moved internally, a redirect link should be configured as below to
 # help us not break links.
 #
-rediraffe_branch = "main"
-rediraffe_redirects = {
+# The workflow for adding redirects can be as follows:
+# 1. Change "rediraffe_branch" below to point to the commit/ branch you
+#    want to base off the changes.
+# 2. Option 1: run "make rediraffecheckdiff"
+#       a. Analyze the output of this command.
+#       b. Manually add the redirect entries to the "redirects.txt" file.
+#    Option 2: run "make rediraffewritediff"
+#       a. rediraffe will then automatically add the obvious redirects to redirects.txt.
+#       b. Analyze the output of the command for broken links.
+#       c. Check the "redirects.txt" file for any files that were moved/ renamed but are not listed.
+#       d. Manually add the redirects that have been mised by the automatic builder to "redirects.txt".
+#    Option 3: Do not use the commands above and, instead, do everything manually - by taking
+#    note of the files you have moved or renamed and adding them to the "redirects.txt" file.
+#
+# If you are basing changes off another branch/ commit, always change back
+# rediraffe_branch to main before pushing your changes upstream.
+#
+rediraffe_branch = os.environ.get("REDIRAFFE_BRANCH", "main")
+rediraffe_redirects = "redirects.txt"
+
+# allow 80% match for autogenerated redirects
+rediraffe_auto_redirect_perc = 80
+
+# rediraffe_redirects = {
 # "old-file": "new-folder/new-file-name",
-}
+# }

docs/source/contributing/community.md

@@ -19,7 +19,7 @@ We use [our Gitter channel](https://gitter.im/jupyterhub/jupyterhub) for online,
 [Github issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) are used for most long-form project discussions, bug reports and feature requests.
 
 - Issues related to a specific authenticator or spawner should be opened in the appropriate repository for the authenticator or spawner.
-- If you are using a specific JupyterHub distribution (such as [Zero to JupyterHub on Kubernetes](http://github.com/jupyterhub/zero-to-jupyterhub-k8s) or [The Littlest JupyterHub](http://github.com/jupyterhub/the-littlest-jupyterhub/)), you should open issues directly in their repository.
+- If you are using a specific JupyterHub distribution (such as [Zero to JupyterHub on Kubernetes](https://github.com/jupyterhub/zero-to-jupyterhub-k8s) or [The Littlest JupyterHub](https://github.com/jupyterhub/the-littlest-jupyterhub/)), you should open issues directly in their repository.
 - If you cannot find a repository to open your issue in, do not worry! Open the issue in the [main JupyterHub repository](https://github.com/jupyterhub/jupyterhub/) and our community will help you figure it out.
 
 ```{note}

docs/source/contributing/docs.md

@@ -0,0 +1,76 @@
+(contributing-docs)=
+
+# Contributing Documentation
+
+Documentation is often more important than code. This page helps
+you get set up on how to contribute to JupyterHub's documentation.
+
+## Building documentation locally
+
+We use [sphinx](https://www.sphinx-doc.org) to build our documentation. It takes
+our documentation source files (written in [markdown](https://daringfireball.net/projects/markdown/) or [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) &
+stored under the `docs/source` directory) and converts it into various
+formats for people to read. To make sure the documentation you write or
+change renders correctly, it is good practice to test it locally.
+
+1. Make sure you have successfully completed {ref}`contributing/setup`.
+
+2. Install the packages required to build the docs.
+
+   ```bash
+   python3 -m pip install -r docs/requirements.txt
+   ```
+
+3. Build the html version of the docs. This is the most commonly used
+   output format, so verifying it renders correctly is usually good
+   enough.
+
+   ```bash
+   cd docs
+   make html
+   ```
+
+   This step will display any syntax or formatting errors in the documentation,
+   along with the filename / line number in which they occurred. Fix them,
+   and re-run the `make html` command to re-render the documentation.
+
+4. View the rendered documentation by opening `_build/html/index.html` in
+   a web browser.
+
+   :::{tip}
+   **On Windows**, you can open a file from the terminal with `start <path-to-file>`.
+
+   **On macOS**, you can do the same with `open <path-to-file>`.
+
+   **On Linux**, you can do the same with `xdg-open <path-to-file>`.
+
+   After opening index.html in your browser you can just refresh the page whenever
+   you rebuild the docs via `make html`
+   :::
+
+(contributing-docs-conventions)=
+
+## Documentation conventions
+
+This section lists various conventions we use in our documentation. This is a
+living document that grows over time, so feel free to add to it / change it!
+
+Our entire documentation does not yet fully conform to these conventions yet,
+so help in making it so would be appreciated!
+
+### `pip` invocation
+
+There are many ways to invoke a `pip` command, we recommend the following
+approach:
+
+```bash
+python3 -m pip
+```
+
+This invokes pip explicitly using the python3 binary that you are
+currently using. This is the **recommended way** to invoke pip
+in our documentation, since it is least likely to cause problems
+with python3 and pip being from different environments.
+
+For more information on how to invoke `pip` commands, see
+[the pip documentation](https://pip.pypa.io/en/stable/).

docs/source/contributing/docs.rst

@@ -1,84 +0,0 @@
-.. _contributing/docs:
-
-==========================
-Contributing Documentation
-==========================
-
-Documentation is often more important than code. This page helps
-you get set up on how to contribute to JupyterHub's documentation.
-
-Building documentation locally
-==============================
-
-We use `sphinx <http://sphinx-doc.org>`_ to build our documentation. It takes
-our documentation source files (written in `markdown
-<https://daringfireball.net/projects/markdown/>`_ or `reStructuredText
-<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ &
-stored under the ``docs/source`` directory) and converts it into various
-formats for people to read. To make sure the documentation you write or
-change renders correctly, it is good practice to test it locally.
-
-#. Make sure you have successfully completed :ref:`contributing/setup`.
-
-#. Install the packages required to build the docs.
-
-   .. code-block:: bash
-
-      python3 -m pip install -r docs/requirements.txt
-
-#. Build the html version of the docs. This is the most commonly used
-   output format, so verifying it renders correctly is usually good
-   enough.
-
-   .. code-block:: bash
-
-      cd docs
-      make html
-
-   This step will display any syntax or formatting errors in the documentation,
-   along with the filename / line number in which they occurred. Fix them,
-   and re-run the ``make html`` command to re-render the documentation.
-
-#. View the rendered documentation by opening ``build/html/index.html`` in
-   a web browser.
-
-   .. tip::
-
-      **On Windows**, you can open a file from the terminal with ``start <path-to-file>``.
-      
-      **On macOS**, you can do the same with ``open <path-to-file>``.
-      
-      **On Linux**, you can do the same with ``xdg-open <path-to-file>``.
-
-      After opening index.html in your browser you can just refresh the page whenever
-      you rebuild the docs via ``make html``
-
-
-.. _contributing/docs/conventions:
-
-Documentation conventions
-=========================
-
-This section lists various conventions we use in our documentation. This is a
-living document that grows over time, so feel free to add to it / change it!
-
-Our entire documentation does not yet fully conform to these conventions yet,
-so help in making it so would be appreciated!
-
-``pip`` invocation
-------------------
-
-There are many ways to invoke a ``pip`` command, we recommend the following
-approach:
-
-.. code-block:: bash
-
-   python3 -m pip
-
-This invokes pip explicitly using the python3 binary that you are
-currently using. This is the **recommended way** to invoke pip
-in our documentation, since it is least likely to cause problems
-with python3 and pip being from different environments.
-
-For more information on how to invoke ``pip`` commands, see
-`the pip documentation <https://pip.pypa.io/en/stable/>`_.

docs/source/contributing/index.md

@@ -0,0 +1,22 @@
+# Contributing
+
+We want you to contribute to JupyterHub in ways that are most exciting
+and useful to you. We value documentation, testing, bug reporting & code equally,
+and are glad to have your contributions in whatever form you wish.
+
+Be sure to first check our [Code of Conduct](https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md)
+([reporting guidelines](https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md)), which help keep our community welcoming to as many people as possible.
+
+This section covers information about our community, as well as ways that you can connect and get involved.
+
+```{toctree}
+:maxdepth: 2
+
+contributor-list
+community
+setup
+docs
+tests
+roadmap
+security
+```

docs/source/contributing/index.rst

@@ -1,21 +0,0 @@
-============
-Contributing
-============
-
-We want you to contribute to JupyterHub in ways that are most exciting
-& useful to you. We value documentation, testing, bug reporting & code equally,
-and are glad to have your contributions in whatever form you wish :)
-
-Our `Code of Conduct <https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md>`_
-(`reporting guidelines <https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md>`_)
-helps keep our community welcoming to as many people as possible.
-
-.. toctree::
-   :maxdepth: 2
-
-   community
-   setup
-   docs
-   tests
-   roadmap
-   security

docs/source/contributing/security.md

@@ -0,0 +1,9 @@
+# Reporting security issues in Jupyter or JupyterHub
+
+If you find a security vulnerability in Jupyter or JupyterHub,
+whether it is a failure of the security model described in [Security Overview](web-security)
+or a failure in implementation,
+please report it to <mailto:security@ipython.org>.
+
+If you prefer to encrypt your security reports,
+you can use {download}`this PGP public key </ipython_security.asc>`.

docs/source/contributing/security.rst

@@ -1,10 +0,0 @@
-Reporting security issues in Jupyter or JupyterHub
-==================================================
-
-If you find a security vulnerability in Jupyter or JupyterHub,
-whether it is a failure of the security model described in :doc:`../reference/websecurity`
-or a failure in implementation,
-please report it to security@ipython.org.
-
-If you prefer to encrypt your security reports,
-you can use :download:`this PGP public key </ipython_security.asc>`.

docs/source/contributing/setup.md

@@ -0,0 +1,242 @@
+(contributing/setup)=
+
+# Setting up a development install
+
+## System requirements
+
+JupyterHub can only run on macOS or Linux operating systems. If you are
+using Windows, we recommend using [VirtualBox](https://virtualbox.org)
+or a similar system to run [Ubuntu Linux](https://ubuntu.com) for
+development.
+
+### Install Python
+
+JupyterHub is written in the [Python](https://python.org) programming language and
+requires you have at least version {{python_min}} installed locally. If you haven’t
+installed Python before, the recommended way to install it is to use
+[Miniforge](https://github.com/conda-forge/miniforge#download).
+
+### Install nodejs
+
+[NodeJS {{node_min}}+](https://nodejs.org/en/) is required for building some JavaScript components.
+`configurable-http-proxy`, the default proxy implementation for JupyterHub, is written in Javascript.
+If you have not installed NodeJS before, we recommend installing it in the `miniconda` environment you set up for Python.
+You can do so with `conda install nodejs`.
+
+Many in the Jupyter community use [`nvm`](https://github.com/nvm-sh/nvm) to
+managing node dependencies.
+
+### Install git
+
+JupyterHub uses [Git](https://git-scm.com) & [GitHub](https://github.com)
+for development & collaboration. You need to [install git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) to work on
+JupyterHub. We also recommend getting a free account on GitHub.com.
+
+## Setting up a development install
+
+When developing JupyterHub, you would need to make changes and be able to instantly view the results of the changes. To achieve that, a developer install is required.
+
+:::{note}
+This guide does not attempt to dictate _how_ development
+environments should be isolated since that is a personal preference and can
+be achieved in many ways, for example, `tox`, `conda`, `docker`, etc. See this
+[forum thread](https://discourse.jupyter.org/t/thoughts-on-using-tox/3497) for
+a more detailed discussion.
+:::
+
+1. Clone the [JupyterHub git repository](https://github.com/jupyterhub/jupyterhub)
+   to your computer.
+
+   ```bash
+   git clone https://github.com/jupyterhub/jupyterhub
+   cd jupyterhub
+   ```
+
+2. Make sure the `python` you installed and the `npm` you installed
+   are available to you on the command line.
+
+   ```bash
+   python -V
+   ```
+
+   This should return a version number greater than or equal to {{python_min}}.
+
+   ```bash
+   npm -v
+   ```
+
+   This should return a version number greater than or equal to 5.0.
+
+3. Install `configurable-http-proxy` (required to run and test the default JupyterHub configuration):
+
+   ```bash
+   npm install -g configurable-http-proxy
+   ```
+
+   If you get an error that says `Error: EACCES: permission denied`, you might need to prefix the command with `sudo`.
+   `sudo` may be required to perform a system-wide install.
+   If you do not have access to sudo, you may instead run the following commands:
+
+   ```bash
+   npm install configurable-http-proxy
+   export PATH=$PATH:$(pwd)/node_modules/.bin
+   ```
+
+   The second line needs to be run every time you open a new terminal.
+
+   If you are using conda you can instead run:
+
+   ```bash
+   conda install configurable-http-proxy
+   ```
+
+4. Install an editable version of JupyterHub and its requirements for
+   development and testing. This lets you edit JupyterHub code in a text editor
+   & restart the JupyterHub process to see your code changes immediately.
+
+   ```bash
+   python3 -m pip install --editable ".[test]"
+   ```
+
+5. You are now ready to start JupyterHub!
+
+   ```bash
+   jupyterhub
+   ```
+
+6. You can access JupyterHub from your browser at
+   `http://localhost:8000` now.
+
+Happy developing!
+
+## Using DummyAuthenticator & SimpleLocalProcessSpawner
+
+To simplify testing of JupyterHub, it is helpful to use
+{class}`~jupyterhub.auth.DummyAuthenticator` instead of the default JupyterHub
+authenticator and SimpleLocalProcessSpawner instead of the default spawner.
+
+There is a sample configuration file that does this in
+`testing/jupyterhub_config.py`. To launch JupyterHub with this
+configuration:
+
+```bash
+jupyterhub -f testing/jupyterhub_config.py
+```
+
+The test configuration enables a few things to make testing easier:
+
+- use 'dummy' authentication and 'simple' spawner
+- named servers are enabled
+- listen only on localhost
+- 'admin' is an admin user, if you want to test the admin page
+- disable caching of static files
+
+The default JupyterHub [authenticator](PAMAuthenticator)
+& [spawner](LocalProcessSpawner)
+require your system to have user accounts for each user you want to log in to
+JupyterHub as.
+
+DummyAuthenticator allows you to log in with any username & password,
+while SimpleLocalProcessSpawner allows you to start servers without having to
+create a Unix user for each JupyterHub user. Together, these make it
+much easier to test JupyterHub.
+
+Tip: If you are working on parts of JupyterHub that are common to all
+authenticators & spawners, we recommend using both DummyAuthenticator &
+SimpleLocalProcessSpawner. If you are working on just authenticator-related
+parts, use only SimpleLocalProcessSpawner. Similarly, if you are working on
+just spawner-related parts, use only DummyAuthenticator.
+
+## Building frontend components
+
+The testing configuration file also disables caching of static files,
+which allows you to edit and rebuild these files without restarting JupyterHub.
+
+If you are working on the admin react page, which is in the `jsx` directory, you can run:
+
+```bash
+cd jsx
+npm install
+npm run build:watch
+```
+
+to continuously rebuild the admin page, requiring only a refresh of the page.
+
+If you are working on the frontend SCSS files, you can run the same `build:watch` command
+in the _top level_ directory of the repo:
+
+```bash
+npm install
+npm run build:watch
+```
+
+## Troubleshooting
+
+This section lists common ways setting up your development environment may
+fail, and how to fix them. Please add to the list if you encounter yet
+another way it can fail!
+
+### `lessc` not found
+
+If the `python3 -m pip install --editable .` command fails and complains about
+`lessc` being unavailable, you may need to explicitly install some
+additional JavaScript dependencies:
+
+```bash
+npm install
+```
+
+This will fetch client-side JavaScript dependencies necessary to compile
+CSS.
+
+You may also need to manually update JavaScript and CSS after some
+development updates, with:
+
+```bash
+python3 setup.py js    # fetch updated client-side js
+python3 setup.py css   # recompile CSS from LESS sources
+python3 setup.py jsx   # build React admin app
+```
+
+### Failed to bind XXX to `http://127.0.0.1:<port>/<path>`
+
+This error can happen when there's already an application or a service using this
+port.
+
+Use the following command to find out which service is using this port.
+
+```bash
+lsof -P -i TCP:<port> -sTCP:LISTEN
+```
+
+If nothing shows up, it likely means there's a system service that uses it but
+your current user cannot list it. Reuse the same command with sudo.
+
+```bash
+sudo lsof -P -i TCP:<port> -sTCP:LISTEN
+```
+
+Depending on the result of the above commands, the most simple solution is to
+configure JupyterHub to use a different port for the service that is failing.
+
+As an example, the following is a frequently seen issue:
+
+`Failed to bind hub to http://127.0.0.1:8081/hub/`
+
+Using the procedure described above, start with:
+
+```bash
+lsof -P -i TCP:8081 -sTCP:LISTEN
+```
+
+and if nothing shows up:
+
+```bash
+sudo lsof -P -i TCP:8081 -sTCP:LISTEN
+```
+
+Finally, depending on your findings, you can apply the following change and start JupyterHub again:
+
+```python
+c.JupyterHub.hub_port = 9081 # Or any other free port
+```

docs/source/contributing/setup.rst

@@ -1,187 +0,0 @@
-.. _contributing/setup:
-
-================================
-Setting up a development install
-================================
-
-System requirements
-===================
-
-JupyterHub can only run on macOS or Linux operating systems. If you are
-using Windows, we recommend using `VirtualBox <https://virtualbox.org>`_
-or a similar system to run `Ubuntu Linux <https://ubuntu.com>`_ for
-development.
-
-Install Python
---------------
-
-JupyterHub is written in the `Python <https://python.org>`_ programming language and
-requires you have at least version 3.6 installed locally. If you haven’t
-installed Python before, the recommended way to install it is to use
-`Miniconda <https://conda.io/miniconda.html>`_. Remember to get the ‘Python 3’ version,
-and **not** the ‘Python 2’ version!
-
-Install nodejs
---------------
-
-`NodeJS 12+ <https://nodejs.org/en/>`_ is required for building some JavaScript components.
-``configurable-http-proxy``, the default proxy implementation for JupyterHub, is written in Javascript.
-If you have not installed NodeJS before, we recommend installing it in the ``miniconda`` environment you set up for Python.
-You can do so with ``conda install nodejs``.
-
-Many in the Jupyter community use [``nvm``](https://github.com/nvm-sh/nvm) to
-managing node dependencies.
-
-Install git
------------
-
-JupyterHub uses `Git <https://git-scm.com>`_ & `GitHub <https://github.com>`_
-for development & collaboration. You need to `install git
-<https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_ to work on
-JupyterHub. We also recommend getting a free account on GitHub.com.
-
-Setting up a development install
-================================
-
-When developing JupyterHub, you would need to make changes and be able to instantly view the results of the changes. To achieve that, a developer install is required.
-
-.. note:: This guide does not attempt to dictate *how* development
-   environments should be isolated since that is a personal preference and can
-   be achieved in many ways, for example, `tox`, `conda`, `docker`, etc. See this
-   `forum thread <https://discourse.jupyter.org/t/thoughts-on-using-tox/3497>`_ for
-   a more detailed discussion.
-
-1. Clone the `JupyterHub git repository <https://github.com/jupyterhub/jupyterhub>`_
-   to your computer.
-
-   .. code:: bash
-
-      git clone https://github.com/jupyterhub/jupyterhub
-      cd jupyterhub
-
-2. Make sure the ``python`` you installed and the ``npm`` you installed
-   are available to you on the command line.
-
-   .. code:: bash
-
-      python -V
-
-   This should return a version number greater than or equal to 3.6.
-
-   .. code:: bash
-
-      npm -v
-
-   This should return a version number greater than or equal to 5.0.
-
-3. Install ``configurable-http-proxy`` (required to run and test the default JupyterHub configuration) and ``yarn`` (required to build some components):
-
-   .. code:: bash
-
-      npm install -g configurable-http-proxy yarn
-
-   If you get an error that says ``Error: EACCES: permission denied``, you might need to prefix the command with ``sudo``.
-   ``sudo`` may be required to perform a system-wide install.
-   If you do not have access to sudo, you may instead run the following commands:
-
-   .. code:: bash
-
-      npm install configurable-http-proxy yarn
-      export PATH=$PATH:$(pwd)/node_modules/.bin
-
-   The second line needs to be run every time you open a new terminal.
-
-   If you are using conda you can instead run:
-
-   .. code:: bash
-
-      conda install configurable-http-proxy yarn
-
-4. Install an editable version of JupyterHub and its requirements for
-   development and testing. This lets you edit JupyterHub code in a text editor
-   & restart the JupyterHub process to see your code changes immediately.
-
-   .. code:: bash
-
-      python3 -m pip install --editable ".[test]"
-
-5. Set up a database.
-
-   The default database engine is ``sqlite`` so if you are just trying
-   to get up and running quickly for local development that should be
-   available via `Python <https://docs.python.org/3.5/library/sqlite3.html>`__.
-   See :doc:`/reference/database` for details on other supported databases.
-
-6. You are now ready to start JupyterHub!
-
-   .. code:: bash
-
-      jupyterhub
-
-7. You can access JupyterHub from your browser at
-   ``http://localhost:8000`` now.
-
-Happy developing!
-
-Using DummyAuthenticator & SimpleLocalProcessSpawner
-====================================================
-
-To simplify testing of JupyterHub, it is helpful to use
-:class:`~jupyterhub.auth.DummyAuthenticator` instead of the default JupyterHub
-authenticator and SimpleLocalProcessSpawner instead of the default spawner.
-
-There is a sample configuration file that does this in
-``testing/jupyterhub_config.py``. To launch JupyterHub with this
-configuration:
-
-.. code:: bash
-
-   jupyterhub -f testing/jupyterhub_config.py
-
-The default JupyterHub `authenticator
-<https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html#the-default-pam-authenticator>`_
-& `spawner
-<https://jupyterhub.readthedocs.io/en/stable/api/spawner.html#localprocessspawner>`_
-require your system to have user accounts for each user you want to log in to
-JupyterHub as.
-
-DummyAuthenticator allows you to log in with any username & password,
-while SimpleLocalProcessSpawner allows you to start servers without having to
-create a Unix user for each JupyterHub user. Together, these make it
-much easier to test JupyterHub.
-
-Tip: If you are working on parts of JupyterHub that are common to all
-authenticators & spawners, we recommend using both DummyAuthenticator &
-SimpleLocalProcessSpawner. If you are working on just authenticator-related
-parts, use only SimpleLocalProcessSpawner. Similarly, if you are working on
-just spawner-related parts, use only DummyAuthenticator.
-
-Troubleshooting
-===============
-
-This section lists common ways setting up your development environment may
-fail, and how to fix them. Please add to the list if you encounter yet
-another way it can fail!
-
-``lessc`` not found
--------------------
-
-If the ``python3 -m pip install --editable .`` command fails and complains about
-``lessc`` being unavailable, you may need to explicitly install some
-additional JavaScript dependencies:
-
-.. code:: bash
-
-   npm install
-
-This will fetch client-side JavaScript dependencies necessary to compile
-CSS.
-
-You may also need to manually update JavaScript and CSS after some
-development updates, with:
-
-.. code:: bash
-
-   python3 setup.py js    # fetch updated client-side js
-   python3 setup.py css   # recompile CSS from LESS sources
-   python3 setup.py jsx   # build React admin app

docs/source/contributing/tests.md

@@ -0,0 +1,157 @@
+(contributing-tests)=
+
+# Testing JupyterHub and linting code
+
+Unit testing helps to validate that JupyterHub works the way we think it does,
+and continues to do so when changes occur. They also help communicate
+precisely what we expect our code to do.
+
+JupyterHub uses [pytest](https://pytest.org) for all the tests. You
+can find them under the [jupyterhub/tests](https://github.com/jupyterhub/jupyterhub/tree/main/jupyterhub/tests) directory in the git repository.
+
+## Running the tests
+
+1. Make sure you have completed {ref}`contributing/setup`.
+   Once you are done, you would be able to run `jupyterhub` from the command line and access it from your web browser.
+   This ensures that the dev environment is properly set up for tests to run.
+
+2. You can run all tests in JupyterHub
+
+   ```bash
+   pytest -v jupyterhub/tests
+   ```
+
+   This should display progress as it runs all the tests, printing
+   information about any test failures as they occur.
+
+   If you wish to confirm test coverage the run tests with the `--cov` flag:
+
+   ```bash
+   pytest -v --cov=jupyterhub jupyterhub/tests
+   ```
+
+3. You can also run tests in just a specific file:
+
+   ```bash
+   pytest -v jupyterhub/tests/<test-file-name>
+   ```
+
+4. To run a specific test only, you can do:
+
+   ```bash
+   pytest -v jupyterhub/tests/<test-file-name>::<test-name>
+   ```
+
+   This runs the test with function name `<test-name>` defined in
+   `<test-file-name>`. This is very useful when you are iteratively
+   developing a single test.
+
+   For example, to run the test `test_shutdown` in the file `test_api.py`,
+   you would run:
+
+   ```bash
+   pytest -v jupyterhub/tests/test_api.py::test_shutdown
+   ```
+
+   For more details, refer to the [pytest usage documentation](https://pytest.readthedocs.io/en/latest/usage.html).
+
+## Test organisation
+
+The tests live in `jupyterhub/tests` and are organized roughly into:
+
+1. `test_api.py` tests the REST API
+2. `test_pages.py` tests loading the HTML pages
+
+and other collections of tests for different components.
+When writing a new test, there should usually be a test of
+similar functionality already written and related tests should
+be added nearby.
+
+The fixtures live in `jupyterhub/tests/conftest.py`. There are
+fixtures that can be used for JupyterHub components, such as:
+
+- `app`: an instance of JupyterHub with mocked parts
+- `auth_state_enabled`: enables persisting auth_state (like authentication tokens)
+- `db`: a sqlite in-memory DB session
+- `` io_loop` ``: a Tornado event loop
+- `event_loop`: a new asyncio event loop
+- `user`: creates a new temporary user
+- `admin_user`: creates a new temporary admin user
+- single user servers
+  \- `cleanup_after`: allows cleanup of single user servers between tests
+- mocked service
+  \- `MockServiceSpawner`: a spawner that mocks services for testing with a short poll interval
+  \- `` mockservice` ``: mocked service with no external service url
+  \- `mockservice_url`: mocked service with a url to test external services
+
+And fixtures to add functionality or spawning behavior:
+
+- `admin_access`: grants admin access
+- `` no_patience` ``: sets slow-spawning timeouts to zero
+- `slow_spawn`: enables the SlowSpawner (a spawner that takes a few seconds to start)
+- `never_spawn`: enables the NeverSpawner (a spawner that will never start)
+- `bad_spawn`: enables the BadSpawner (a spawner that fails immediately)
+- `slow_bad_spawn`: enables the SlowBadSpawner (a spawner that fails after a short delay)
+
+Refer to the [pytest fixtures documentation](https://pytest.readthedocs.io/en/latest/fixture.html) to learn how to use fixtures that exists already and to create new ones.
+
+### The Pytest-Asyncio Plugin
+
+When testing the various JupyterHub components and their various implementations, it sometimes becomes necessary to have a running instance of JupyterHub to test against.
+The [`app`](https://github.com/jupyterhub/jupyterhub/blob/270b61992143b29af8c2fab90c4ed32f2f6fe209/jupyterhub/tests/conftest.py#L60) fixture mocks a JupyterHub application for use in testing by:
+
+- enabling ssl if internal certificates are available
+- creating an instance of [MockHub](https://github.com/jupyterhub/jupyterhub/blob/270b61992143b29af8c2fab90c4ed32f2f6fe209/jupyterhub/tests/mocking.py#L221) using any provided configurations as arguments
+- initializing the mocked instance
+- starting the mocked instance
+- finally, a registered finalizer function performs a cleanup and stops the mocked instance
+
+The JupyterHub test suite uses the [pytest-asyncio plugin](https://pytest-asyncio.readthedocs.io/en/latest/) that handles [event-loop](https://docs.python.org/3/library/asyncio-eventloop.html) integration in [Tornado](https://www.tornadoweb.org/en/stable/) applications. This allows for the use of top-level awaits when calling async functions or [fixtures](https://docs.pytest.org/en/6.2.x/fixture.html#what-fixtures-are) during testing. All test functions and fixtures labelled as `async` will run on the same event loop.
+
+```{note}
+With the introduction of [top-level awaits](https://piccolo-orm.com/blog/top-level-await-in-python/), the use of the `io_loop` fixture of the [pytest-tornado plugin](https://www.tornadoweb.org/en/stable/ioloop.html) is no longer necessary. It was initially used to call coroutines. With the upgrades made to `pytest-asyncio`, this usage is now deprecated. It is now, only utilized within the JupyterHub test suite to ensure complete cleanup of resources used during testing such as open file descriptors. This is demonstrated in this [pull request](https://github.com/jupyterhub/jupyterhub/pull/4332).
+More information is provided below.
+```
+
+One of the general goals of the [JupyterHub Pytest Plugin project](https://github.com/jupyterhub/pytest-jupyterhub) is to ensure the MockHub cleanup fully closes and stops all utilized resources during testing so the use of the `io_loop` fixture for teardown is not necessary. This was highlighted in this [issue](https://github.com/jupyterhub/pytest-jupyterhub/issues/30)
+
+For more information on asyncio and event-loops, here are some resources:
+
+- **Read**: [Introduction to the Python event loop](https://www.pythontutorial.net/python-concurrency/python-event-loop)
+- **Read**: [Overview of Async IO in Python 3.7](https://stackabuse.com/overview-of-async-io-in-python-3-7)
+- **Watch**: [Asyncio: Understanding Async / Await in Python](https://www.youtube.com/watch?v=bs9tlDFWWdQ)
+- **Watch**: [Learn Python's AsyncIO #2 - The Event Loop](https://www.youtube.com/watch?v=E7Yn5biBZ58)
+
+## Troubleshooting Test Failures
+
+### All the tests are failing
+
+Make sure you have completed all the steps in {ref}`contributing/setup` successfully, and are able to access JupyterHub from your browser at http://localhost:8000 after starting `jupyterhub` in your command line.
+
+## Code formatting and linting
+
+JupyterHub automatically enforces code formatting. This means that pull requests
+with changes breaking this formatting will receive a commit from pre-commit.ci
+automatically.
+
+To automatically format code locally, you can install pre-commit and register a
+_git hook_ to automatically check with pre-commit before you make a commit if
+the formatting is okay.
+
+```bash
+pip install pre-commit
+pre-commit install --install-hooks
+```
+
+To run pre-commit manually you would do:
+
+```bash
+# check for changes to code not yet committed
+pre-commit run
+
+# check for changes also in already committed code
+pre-commit run --all-files
+```
+
+You may also install [black integration](https://github.com/psf/black#editor-integration)
+into your text editor to format code automatically.

docs/source/contributing/tests.rst

@@ -1,138 +0,0 @@
-.. _contributing/tests:
-
-===================================
-Testing JupyterHub and linting code
-===================================
-
-Unit testing helps to validate that JupyterHub works the way we think it does,
-and continues to do so when changes occur. They also help communicate
-precisely what we expect our code to do. 
-
-JupyterHub uses `pytest <https://pytest.org>`_ for all the tests. You
-can find them under the `jupyterhub/tests <https://github.com/jupyterhub/jupyterhub/tree/main/jupyterhub/tests>`_ directory in the git repository.
-
-Running the tests
-==================
-
-#. Make sure you have completed :ref:`contributing/setup`.
-   Once you are done, you would be able to run ``jupyterhub`` from the command line and access it from your web browser.
-   This ensures that the dev environment is properly set up for tests to run.
-
-#. You can run all tests in JupyterHub
-
-   .. code-block:: bash
-
-      pytest -v jupyterhub/tests
-
-   This should display progress as it runs all the tests, printing
-   information about any test failures as they occur.
-
-   If you wish to confirm test coverage the run tests with the `--cov` flag:
-
-   .. code-block:: bash
-
-      pytest -v --cov=jupyterhub jupyterhub/tests
-
-#. You can also run tests in just a specific file:
-
-   .. code-block:: bash
-
-      pytest -v jupyterhub/tests/<test-file-name>
-
-#. To run a specific test only, you can do:
-
-   .. code-block:: bash
-
-      pytest -v jupyterhub/tests/<test-file-name>::<test-name>
-
-   This runs the test with function name ``<test-name>`` defined in
-   ``<test-file-name>``. This is very useful when you are iteratively
-   developing a single test.
-
-   For example, to run the test ``test_shutdown`` in the file ``test_api.py``,
-   you would run:
-
-   .. code-block:: bash
-
-      pytest -v jupyterhub/tests/test_api.py::test_shutdown
-
-   For more details, refer to the `pytest usage documentation <https://pytest.readthedocs.io/en/latest/usage.html>`_.
-
-Test organisation
-=================
-
-The tests live in ``jupyterhub/tests`` and are organized roughly into:
-
-#. ``test_api.py`` tests the REST API
-#. ``test_pages.py`` tests loading the HTML pages
-
-and other collections of tests for different components.
-When writing a new test, there should usually be a test of
-similar functionality already written and related tests should
-be added nearby.
-
-The fixtures live in ``jupyterhub/tests/conftest.py``. There are
-fixtures that can be used for JupyterHub components, such as:
-
-- ``app``: an instance of JupyterHub with mocked parts
-- ``auth_state_enabled``: enables persisting auth_state (like authentication tokens)
-- ``db``: a sqlite in-memory DB session
-- ``io_loop```: a Tornado event loop
-- ``event_loop``: a new asyncio event loop
-- ``user``: creates a new temporary user
-- ``admin_user``: creates a new temporary admin user
-- single user servers
-  - ``cleanup_after``: allows cleanup of single user servers between tests
-- mocked service
-  - ``MockServiceSpawner``: a spawner that mocks services for testing with a short poll interval
-  - ``mockservice```: mocked service with no external service url
-  - ``mockservice_url``: mocked service with a url to test external services
-
-And fixtures to add functionality or spawning behavior:
-
-- ``admin_access``: grants admin access
-- ``no_patience```: sets slow-spawning timeouts to zero
-- ``slow_spawn``: enables the SlowSpawner (a spawner that takes a few seconds to start)
-- ``never_spawn``: enables the NeverSpawner (a spawner that will never start)
-- ``bad_spawn``: enables the BadSpawner (a spawner that fails immediately)
-- ``slow_bad_spawn``: enables the SlowBadSpawner (a spawner that fails after a short delay)
-
-Refer to the `pytest fixtures documentation <https://pytest.readthedocs.io/en/latest/fixture.html>`_  to learn how to use fixtures that exists already and to create new ones.
-
-Troubleshooting Test Failures
-=============================
-
-All the tests are failing
--------------------------
-
-Make sure you have completed all the steps in :ref:`contributing/setup` successfully, and are able to access JupyterHub from your browser at http://localhost:8000 after starting ``jupyterhub`` in your command line.
-
-
-Code formatting and linting
-===========================
-
-JupyterHub automatically enforces code formatting. This means that pull requests
-with changes breaking this formatting will receive a commit from pre-commit.ci
-automatically.
-
-To automatically format code locally, you can install pre-commit and register a
-*git hook* to automatically check with pre-commit before you make a commit if
-the formatting is okay.
-
-.. code:: bash
-
-   pip install pre-commit
-   pre-commit install --install-hooks
-
-To run pre-commit manually you would do:
-
-.. code:: bash
-
-   # check for changes to code not yet committed
-   pre-commit run
-
-   # check for changes also in already committed code
-   pre-commit run --all-files
-
-You may also install `black integration <https://github.com/psf/black#editor-integration>`_
-into your text editor to format code automatically.

docs/source/events/index.rst

@@ -1,46 +0,0 @@
-Event logging and telemetry
-===========================
-
-JupyterHub can be configured to record structured events from a running server using Jupyter's `Telemetry System`_. The types of events that JupyterHub emits are defined by `JSON schemas`_ listed at the bottom of this page_.
-
-.. _logging: https://docs.python.org/3/library/logging.html
-.. _`Telemetry System`: https://github.com/jupyter/telemetry
-.. _`JSON schemas`: https://json-schema.org/
-
-How to emit events
-------------------
-
-Event logging is handled by its ``Eventlog`` object. This leverages Python's standing logging_ library to emit, filter, and collect event data. 
-
-
-To begin recording events, you'll need to set two configurations:
-
-    1. ``handlers``: tells the EventLog *where* to route your events. This trait is a list of Python logging handlers that route events to the event log file.  
-    2. ``allows_schemas``: tells the EventLog *which* events should be recorded. No events are emitted by default; all recorded events must be listed here.
-
-Here's a basic example:
-
-.. code-block::
-
-    import logging
-
-    c.EventLog.handlers = [
-        logging.FileHandler('event.log'),
-    ]
-
-    c.EventLog.allowed_schemas = [
-        'hub.jupyter.org/server-action'
-    ]
-
-The output is a file, ``"event.log"``, with events recorded as JSON data.
-
-
-.. _page:
-
-Event schemas
--------------
-
-.. toctree::
-    :maxdepth: 2
-
-    server-actions.rst

docs/source/explanation/capacity-planning.md

@@ -40,7 +40,7 @@ The rest is going to be up to your users.
 Per-user overhead from JupyterHub is typically negligible
 up to at least a few hundred concurrent active users.
 
-```[figure} ../images/mybinder-hub-components-cpu-memory.png
+```{figure} /images/mybinder-hub-components-cpu-memory.png
 JupyterHub component resource usage for mybinder.org.
 ```
 
@@ -68,7 +68,7 @@ but which are **less predictable**.
 
 [the-littlest-jupyterhub]: https://the-littlest-jupyterhub.readthedocs.io
 
-[zero-to-jupyterhub]: https://zero-to-jupyterhub.readthedocs.io
+[zero-to-jupyterhub]: https://z2jh.jupyter.org
 
 (limits-requests)=
 
@@ -200,7 +200,7 @@ The limit here is actually Kubernetes' pods per node, not memory _or_ CPU.
 This is likely a extreme case, as many Binder users come from clicking links on webpages
 without any actual intention of running code.
 
-```[figure} ../images/mybinder-load5.png
+```{figure} /images/mybinder-load5.png
 mybinder.org node CPU usage is low with 50-150 users sharing just 8 cores
 ```
 
@@ -277,7 +277,7 @@ showing >90% of users using less than 10% CPU and 200MB,
 but a few outliers near the limit of 1 CPU and 2GB of RAM.
 This is the kind of information you can use to tune your requests and limits.
 
-![Snapshot from JupyterHub's Grafana dashboards on mybinder.org](../images/mybinder-user-resources.png)
+![Snapshot from JupyterHub's Grafana dashboards on mybinder.org](/images/mybinder-user-resources.png)
 
 [prometheus]: https://prometheus.io
 [grafana]: https://grafana.com
@@ -299,10 +299,10 @@ There are lots of other resources for cost and capacity planning that may be spe
 
 Here are some useful links to other resources
 
-- [Zero to JupyterHub](https://zero-to-jupyterhub.readthedocs.io) documentation on
-  - [projecting costs](https://zero-to-jupyterhub.readthedocs.io/en/latest/administrator/cost.html)
-  - [configuring user resources](https://zero-to-jupyterhub.readthedocs.io/en/latest/jupyterhub/customizing/user-resources.html)
+- [Zero to JupyterHub](https://z2jh.jupyter.org) documentation on
+  - [projecting costs](https://z2jh.jupyter.org/en/latest/administrator/cost.html)
+  - [configuring user resources](https://z2jh.jupyter.org/en/latest/jupyterhub/customizing/user-resources.html)
 - Cloud platform cost calculators:
   - [Google Cloud](https://cloud.google.com/products/calculator/)
-  - [Amazon AWS](https://calculator.s3.amazonaws.com)
+  - [Amazon AWS](https://calculator.aws)
   - [Microsoft Azure](https://azure.microsoft.com/en-us/pricing/calculator/)

docs/source/explanation/database.md

@@ -0,0 +1,183 @@
+(hub-database)=
+
+# The Hub's Database
+
+JupyterHub uses a database to store information about users, services, and other data needed for operating the Hub.
+This is the **state** of the Hub.
+
+## Why does JupyterHub have a database?
+
+JupyterHub is a **stateful** application (more on that 'state' later).
+Updating JupyterHub's configuration or upgrading the version of JupyterHub requires restarting the JupyterHub process to apply the changes.
+We want to minimize the disruption caused by restarting the Hub process, so it can be a mundane, frequent, routine activity.
+Storing state information outside the process for later retrieval is necessary for this, and one of the main thing databases are for.
+
+A lot of the operations in JupyterHub are also **relationships**, which is exactly what SQL databases are great at.
+For example:
+
+- Given an API token, what user is making the request?
+- Which users don't have running servers?
+- Which servers belong to user X?
+- Which users have not been active in the last 24 hours?
+
+Finally, a database allows us to have more information stored without needing it all loaded in memory,
+e.g. supporting a large number (several thousands) of inactive users.
+
+## What's in the database?
+
+The short answer of what's in the JupyterHub database is "everything."
+JupyterHub's **state** lives in the database.
+That is, everything JupyterHub needs to be aware of to function that _doesn't_ come from the configuration files, such as
+
+- users, roles, role assignments
+- state, urls of running servers
+- Hashed API tokens
+- Short-lived state related to OAuth flow
+- Timestamps for when users, tokens, and servers were last used
+
+### What's _not_ in the database
+
+Not _quite_ all of JupyterHub's state is in the database.
+This mostly involves transient state, such as the 'pending' transitions of Spawners (starting, stopping, etc.).
+Anything not in the database must be reconstructed on Hub restart, and the only sources of information to do that are the database and JupyterHub configuration file(s).
+
+## How does JupyterHub use the database?
+
+JupyterHub makes some _unusual_ choices in how it connects to the database.
+These choices represent trade-offs favoring single-process simplicity and performance at the expense of horizontal scalability (multiple Hub instances).
+
+We often say that the Hub 'owns' the database.
+This ownership means that we assume the Hub is the only process that will talk to the database.
+This assumption enables us to make several caching optimizations that dramatically improve JupyterHub's performance (i.e. data written recently to the database can be read from memory instead of fetched again from the database) that would not work if multiple processes could be interacting with the database at the same time.
+
+Database operations are also synchronous, so while JupyterHub is waiting on a database operation, it cannot respond to other requests.
+This allows us to avoid complex locking mechanisms, because transaction races can only occur during an `await`, so we only need to make sure we've completed any given transaction before the next `await` in a given request.
+
+:::{note}
+We are slowly working to remove these assumptions, and moving to a more traditional db session per-request pattern.
+This will enable multiple Hub instances and enable scaling JupyterHub, but will significantly reduce the number of active users a single Hub instance can serve.
+:::
+
+### Database performance in a typical request
+
+Most authenticated requests to JupyterHub involve a few database transactions:
+
+1. look up the authenticated user (e.g. look up token by hash, then resolve owner and permissions)
+2. record activity
+3. perform any relevant changes involved in processing the request (e.g. create the records for a running server when starting one)
+
+This means that the database is involved in almost every request, but only in quite small, simple queries, e.g.:
+
+- lookup one token by hash
+- lookup one user by name
+- list tokens or servers for one user (typically 1-10)
+- etc.
+
+### The database as a limiting factor
+
+As a result of the above transactions in most requests, database performance is the _leading_ factor in JupyterHub's baseline requests-per-second performance, but that cost does not scale significantly with the number of users, active or otherwise.
+However, the database is _rarely_ a limiting factor in JupyterHub performance in a practical sense, because the main thing JupyterHub does is start, stop, and monitor whole servers, which take far more time than any small database transaction, no matter how many records you have or how slow your database is (within reason).
+Additionally, there is usually _very_ little load on the database itself.
+
+By far the most taxing activity on the database is the 'list all users' endpoint, primarily used by the [idle-culling service](https://github.com/jupyterhub/jupyterhub-idle-culler).
+Database-based optimizations have been added to make even these operations feasible for large numbers of users:
+
+1. State filtering on [GET /hub/api/users?state=active](rest-api-get-users),
+   which limits the number of results in the query to only the relevant subset (added in JupyterHub 1.3), rather than all users.
+2. [Pagination](api-pagination) of all list endpoints, allowing the request of a large number of resources to be more fairly balanced with other Hub activities across multiple requests (added in 2.0).
+
+:::{note}
+It's important to note when discussing performance and limiting factors and that all of this only applies to requests to `/hub/...`.
+The Hub and its database are not involved in most requests to single-user servers (`/user/...`), which is by design, and largely motivated by the fact that the Hub itself doesn't _need_ to be fast because its operations are infrequent and large.
+:::
+
+## Database backends
+
+JupyterHub supports a variety of database backends via [SQLAlchemy][].
+The default is sqlite, which works great for many cases, but you should be able to use many backends supported by SQLAlchemy.
+Usually, this will mean PostgreSQL or MySQL, both of which are officially supported and well tested with JupyterHub, but others may work as well.
+See [SQLAlchemy's docs][sqlalchemy-dialect] for how to connect to different database backends.
+Doing so generally involves:
+
+1. installing a Python package that provides a client implementation, and
+2. setting [](JupyterHub.db_url) to connect to your database with the specified implementation
+
+[sqlalchemy-dialect]: https://docs.sqlalchemy.org/en/20/dialects/
+[sqlalchemy]: https://www.sqlalchemy.org
+
+### Default backend: SQLite
+
+The default database backend for JupyterHub is [SQLite](https://sqlite.org).
+We have chosen SQLite as JupyterHub's default because it's simple (the 'database' is a single file) and ubiquitous (it is in the Python standard library).
+It works very well for testing, small deployments, and workshops.
+
+For production systems, SQLite has some disadvantages when used with JupyterHub:
+
+- `upgrade-db` may not always work, and you may need to start with a fresh database
+- `downgrade-db` **will not** work if you want to rollback to an earlier
+  version, so backup the `jupyterhub.sqlite` file before upgrading (JupyterHub automatically creates a date-stamped backup file when upgrading sqlite)
+
+The sqlite documentation provides a helpful page about [when to use SQLite and
+where traditional RDBMS may be a better choice](https://sqlite.org/whentouse.html).
+
+### Picking your database backend (PostgreSQL, MySQL)
+
+When running a long term deployment or a production system, we recommend using a full-fledged relational database, such as [PostgreSQL](https://www.postgresql.org) or [MySQL](https://www.mysql.com), that supports the SQL `ALTER TABLE` statement, which is used in some database upgrade steps.
+
+In general, you select your database backend with [](JupyterHub.db_url), and can further configure it (usually not necessary) with [](JupyterHub.db_kwargs).
+
+## Notes and Tips
+
+### SQLite
+
+The SQLite database should not be used on NFS. SQLite uses reader/writer locks
+to control access to the database. This locking mechanism might not work
+correctly if the database file is kept on an NFS filesystem. This is because
+`fcntl()` file locking is broken on many NFS implementations. Therefore, you
+should avoid putting SQLite database files on NFS since it will not handle well
+multiple processes which might try to access the file at the same time.
+
+### PostgreSQL
+
+We recommend using PostgreSQL for production if you are unsure whether to use
+MySQL or PostgreSQL or if you do not have a strong preference.
+There is additional configuration required for MySQL that is not needed for PostgreSQL.
+
+For example, to connect to a PostgreSQL database with psycopg2:
+
+1. install psycopg2: `pip install psycopg2` (or `psycopg2-binary` to avoid compilation, which is [not recommended for production][psycopg2-binary])
+2. set authentication via environment variables `PGUSER` and `PGPASSWORD`
+3. configure [](JupyterHub.db_url):
+
+   ```python
+   c.JupyterHub.db_url = "postgresql+psycopg2://my-postgres-server:5432/my-db-name"
+   ```
+
+[psycopg2-binary]: https://www.psycopg.org/docs/install.html#psycopg-vs-psycopg-binary
+
+### MySQL / MariaDB
+
+- You should probably use the `pymysql` or `mysqlclient` sqlalchemy provider, or another backend [recommended by sqlalchemy](https://docs.sqlalchemy.org/en/20/dialects/mysql.html#dialect-mysql)
+- You also need to set `pool_recycle` to some value (typically 60 - 300, JupyterHub will default to 60)
+  which depends on your MySQL setup. This is necessary since MySQL kills
+  connections serverside if they've been idle for a while, and the connection
+  from the hub will be idle for longer than most connections. This behavior
+  will lead to frustrating 'the connection has gone away' errors from
+  sqlalchemy if `pool_recycle` is not set.
+- If you use `utf8mb4` collation with MySQL earlier than 5.7.7 or MariaDB
+  earlier than 10.2.1 you may get an `1709, Index column size too large` error.
+  To fix this you need to set `innodb_large_prefix` to enabled and
+  `innodb_file_format` to `Barracuda` to allow for the index sizes jupyterhub
+  uses. `row_format` will be set to `DYNAMIC` as long as those options are set
+  correctly. Later versions of MariaDB and MySQL should set these values by
+  default, as well as have a default `DYNAMIC` `row_format` and pose no trouble
+  to users.
+
+For example, to connect to a mysql database with mysqlclient:
+
+1. install mysqlclient: `pip install mysqlclient`
+2. configure [](JupyterHub.db_url):
+
+   ```python
+   c.JupyterHub.db_url = "mysql+mysqldb://myuser:mypassword@my-sql-server:3306/my-db-name"
+   ```

docs/source/explanation/index.md

@@ -0,0 +1,14 @@
+# Explanation
+
+_Explanation_ documentation provide big-picture descriptions of how JupyterHub works. This section is meant to build your understanding of particular topics.
+
+```{toctree}
+:maxdepth: 1
+
+capacity-planning
+database
+websecurity
+oauth
+singleuser
+../rbac/index
+```

docs/source/explanation/oauth.md

@@ -1,3 +1,5 @@
+(jupyterhub-oauth)=
+
 # JupyterHub and OAuth
 
 JupyterHub uses [OAuth 2](https://oauth.net/2/) as an internal mechanism for authenticating users.
@@ -255,7 +257,7 @@ To authenticate this request, the single token stored in the encrypted cookie is
 
 If the user model matches who should be allowed (e.g. Danez),
 then the request is allowed.
-See {doc}`../rbac/scopes` for how JupyterHub uses scopes to determine authorized access to servers and services.
+See [Scopes in JupyterHub](jupyterhub-scopes) for how JupyterHub uses scopes to determine authorized access to servers and services.
 
 _the end_
 

docs/source/explanation/singleuser.md

@@ -0,0 +1,109 @@
+(singleuser)=
+
+# The JupyterHub single-user server
+
+When a user logs into JupyterHub, they get a 'server', which we usually call the **single-user server**, because it's a server that's meant for a single JupyterHub user.
+Each JupyterHub user gets a different one (or more than one!).
+
+A single-user server is a process running somewhere that is:
+
+1. accessible over http[s],
+2. authenticated via JupyterHub using OAuth 2.0,
+3. started by a [Spawner](spawners), and
+4. 'owned' by a single JupyterHub user
+
+## The single-user server command
+
+The Spawner's default single-user server startup command, `jupyterhub-singleuser`, launches `jupyter-server`, the same program used when you run `jupyter lab` on your laptop.
+(_It can also launch the legacy `jupyter-notebook` server_).
+That's why JupyterHub looks familiar to folks who are already using Jupyter at home or elsewhere.
+It's the same!
+`jupyterhub-singleuser` _customizes_ that program to change (approximately) one thing: **authenticate requests with JupyterHub**.
+
+(singleuser-auth)=
+
+## Single-user server authentication
+
+Implementation-wise, JupyterHub single-user servers are a special-case of {ref}`services`
+and as such use the same (OAuth) authentication mechanism (more on OAuth in JupyterHub at [](oauth)).
+This is primarily implemented in the {class}`~.HubOAuth` class.
+
+This code resides in `jupyterhub.singleuser` subpackage of JupyterHub.
+The main task of this code is to:
+
+1. resolve a JupyterHub token to a JupyterHub user (authenticate)
+2. check permissions (`access:servers`) for the token to make sure the request should be allowed (authorize)
+3. if not authorized, begin the OAuth process with a redirect to the Hub
+4. after login, store OAuth tokens in a cookie only used by this single-user server
+5. implement logout to clear the cookie
+
+Most of this is implemented in the {class}`~.HubOAuth` class. `jupyterhub.singleuser` is responsible for _adapting_ the base Jupyter Server to use HubOAuth for these tasks.
+
+### JupyterHub authentication extension
+
+By default, `jupyter-server` uses its own cookie to authenticate.
+If that cookie is not present, the server redirects you a login page and asks you to enter a password or token.
+
+Jupyter Server 2.0 introduces two new _APIs_ for customizing authentication: the [IdentityProvider](inv:jupyter-server#jupyter_server.auth.IdentityProvider) and the [Authorizer](inv:jupyter-server#jupyter_server.auth.Authorizer).
+More information can be found in the [Jupyter Server documentation](https://jupyter-server.readthedocs.io).
+
+JupyterHub implements these APIs in `jupyterhub.singleuser.extension`.
+
+The IdentityProvider is responsible for _authenticating_ requests.
+In JupyterHub, that means extracting OAuth tokens from the request and resolving them to a JupyterHub user.
+
+The Authorizer is a _separate_ API for _authorizing_ actions on particular resources.
+Because the JupyterHub IdentityProvider only allows _authenticating_ users who already have the necessary `access:servers` permission to access the server, the default Authorizer only contains a redundant check for this same permission, and ignores the resource inputs.
+However, specifying a _custom_ Authorizer allows for granular permissions, such as read-only access to subsets of a shared server.
+
+### JupyterHub authentication via subclass
+
+Prior to Jupyter Server 2 (i.e. Jupyter Server 1.x or the legacy `jupyter-notebook` server), JupyterHub authentication is applied via _subclass_.
+Originally a subclass of `NotebookApp`,
+this approach works with both `jupyter-server` and `jupyter-notebook`.
+Instead of using the extension mechanisms above,
+the server application is _subclassed_. This worked well in the `jupyter-notebook` days,
+but doesn't fit well with Jupyter Server's extension-based architecture.
+
+### Selecting jupyterhub-singleuser implementation
+
+Using the JupyterHub singleuser-server extension is the default behavior of JupyterHub 4 and Jupyter Server 2, otherwise the subclass approach is taken.
+
+You can opt-out of the extension by setting the environment variable `JUPYTERHUB_SINGLEUSER_EXTENSION=0`:
+
+```python
+c.Spawner.environment.update(
+    {
+        "JUPYTERHUB_SINGLEUSER_EXTENSION": "0",
+    }
+)
+```
+
+The subclass approach will also be taken if you've opted to use the classic notebook server with:
+
+```
+JUPYTERHUB_SINGLEUSER_APP=notebook
+```
+
+which was introduced in JupyterHub 2.
+
+## Other customizations
+
+`jupyterhub-singleuser` makes other small customizations to how the single-user server behaves:
+
+1. logs activity on the single-user server, used in [idle-culling](https://github.com/jupyterhub/jupyterhub-idle-culler).
+2. disables some features that don't make sense in JupyterHub (trash, retrying ports)
+3. loading options such as URLs and SSL configuration from the environment
+4. customize logging for consistency with JupyterHub logs
+
+## Running a single-user server that's not `jupyterhub-singleuser`
+
+By default, `jupyterhub-singleuser` is the same `jupyter-server` used by JupyterLab, Jupyter notebook (>= 7), etc.
+But technically, all JupyterHub cares about is that it is:
+
+1. an http server at the prescribed URL, accessible from the Hub and proxy, and
+2. authenticated via [OAuth](oauth) with the Hub (it doesn't even have to do this, if you want to do your own authentication, as is done in BinderHub)
+
+which means that you can customize JupyterHub to launch _any_ web application that meets these criteria, by following the specifications in {ref}`services`.
+
+Most of the time, though, it's easier to use [jupyter-server-proxy](https://jupyter-server-proxy.readthedocs.io) if you want to launch additional web applications in JupyterHub.

docs/source/explanation/websecurity.md

@@ -0,0 +1,274 @@
+(web-security)=
+
+# Security Overview
+
+The **Security Overview** section helps you learn about:
+
+- the design of JupyterHub with respect to web security
+- the semi-trusted user
+- the available mitigations to protect untrusted users from each other
+- the value of periodic security audits
+
+This overview also helps you obtain a deeper understanding of how JupyterHub
+works.
+
+## Semi-trusted and untrusted users
+
+JupyterHub is designed to be a _simple multi-user server for modestly sized
+groups_ of **semi-trusted** users. While the design reflects serving
+semi-trusted users, JupyterHub can also be suitable for serving **untrusted** users,
+but **is not suitable for untrusted users** in its default configuration.
+
+As a result, using JupyterHub with **untrusted** users means more work by the
+administrator, since much care is required to secure a Hub, with extra caution on
+protecting users from each other.
+
+One aspect of JupyterHub's _design simplicity_ for **semi-trusted** users is that
+the Hub and single-user servers are placed in a _single domain_, behind a
+[_proxy_][configurable-http-proxy]. If the Hub is serving untrusted
+users, many of the web's cross-site protections are not applied between
+single-user servers and the Hub, or between single-user servers and each
+other, since browsers see the whole thing (proxy, Hub, and single user
+servers) as a single website (i.e. single domain).
+
+## Protect users from each other
+
+To protect users from each other, a user must **never** be able to write arbitrary
+HTML and serve it to another user on the Hub's domain. This is prevented by JupyterHub's
+authentication setup because only the owner of a given single-user notebook server is
+allowed to view user-authored pages served by the given single-user notebook
+server.
+
+To protect all users from each other, JupyterHub administrators must
+ensure that:
+
+- A user **does not have permission** to modify their single-user notebook server,
+  including:
+  - the installation of new packages in the Python environment that runs
+    their single-user server;
+  - the creation of new files in any `PATH` directory that precedes the
+    directory containing `jupyterhub-singleuser` (if the `PATH` is used
+    to resolve the single-user executable instead of using an absolute path);
+  - the modification of environment variables (e.g. PATH, PYTHONPATH) for
+    their single-user server;
+  - the modification of the configuration of the notebook server
+    (the `~/.jupyter` or `JUPYTER_CONFIG_DIR` directory).
+  - unrestricted selection of the base environment (e.g. the image used in container-based Spawners)
+
+If any additional services are run on the same domain as the Hub, the services
+**must never** display user-authored HTML that is neither _sanitized_ nor _sandboxed_
+to any user that lacks authentication as the author of a file.
+
+### Sharing access to servers
+
+Because sharing access to servers (via `access:servers` scopes or the sharing feature in JupyterHub 5) by definition means users can serve each other files, enabling sharing is not suitable for untrusted users without also enabling per-user domains.
+
+JupyterHub does not enable any sharing by default.
+
+## Mitigate security issues
+
+The several approaches to mitigating security issues with configuration
+options provided by JupyterHub include:
+
+(subdomains)=
+
+### Enable user subdomains
+
+JupyterHub provides the ability to run single-user servers on their own
+domains. This means the cross-origin protections between servers has the
+desired effect, and user servers and the Hub are protected from each other.
+
+**Subdomains are the only way to reliably isolate user servers from each other.**
+
+To enable subdomains, set:
+
+```python
+c.JupyterHub.subdomain_host = "https://jupyter.example.org"
+```
+
+When subdomains are enabled, each user's single-user server will be at e.g. `https://username.jupyter.example.org`.
+This also requires all user subdomains to point to the same address,
+which is most easily accomplished with wildcard DNS, where a single A record points to your server and a wildcard CNAME record points to your A record:
+
+```
+A        jupyter.example.org  192.168.1.123
+CNAME  *.jupyter.example.org  jupyter.example.org
+```
+
+Since this spreads the service across multiple domains, you will likely need wildcard SSL as well,
+matching `*.jupyter.example.org`.
+
+Unfortunately, for many institutional domains, wildcard DNS and SSL may not be available.
+
+We also **strongly encourage** serving JupyterHub and user content on a domain that is _not_ a subdomain of any sensitive content.
+For reasoning, see [GitHub's discussion of moving user content to github.io from \*.github.com](https://github.blog/2013-04-09-yummy-cookies-across-domains/).
+
+**If you do plan to serve untrusted users, enabling subdomains is highly encouraged**,
+as it resolves many security issues, which are difficult to unavoidable when JupyterHub is on a single-domain.
+
+:::{important}
+JupyterHub makes no guarantees about protecting users from each other unless subdomains are enabled.
+
+If you want to protect users from each other, you **_must_** enable per-user domains.
+:::
+
+### Disable user config
+
+If subdomains are unavailable or undesirable, JupyterHub provides a
+configuration option `Spawner.disable_user_config = True`, which can be set to prevent
+the user-owned configuration files from being loaded. After implementing this
+option, `PATH`s and package installation are the other things that the
+admin must enforce.
+
+### Prevent spawners from evaluating shell configuration files
+
+For most Spawners, `PATH` is not something users can influence, but it's important that
+the Spawner should _not_ evaluate shell configuration files prior to launching the server.
+
+### Isolate packages in a read-only environment
+
+The user must not have permission to install packages into the environment where the singleuser-server runs.
+On a shared system, package isolation is most easily handled by running the single-user server in
+a root-owned virtualenv with disabled system-site-packages.
+The user must not have permission to install packages into this environment.
+The same principle extends to the images used by container-based deployments.
+If users can select the images in which their servers run, they can disable all security for their own servers.
+
+It is important to note that the control over the environment is only required for the
+single-user server, and not the environment(s) in which the users' kernel(s)
+may run. Installing additional packages in the kernel environment does not
+pose additional risk to the web application's security.
+
+### Encrypt internal connections with SSL/TLS
+
+By default, all communications within JupyterHub—between the proxy, hub, and single
+-user notebooks—are performed unencrypted. Setting the `internal_ssl` flag in
+`jupyterhub_config.py` secures the aforementioned routes. Turning this
+feature on does require that the enabled `Spawner` can use the certificates
+generated by the `Hub` (the default `LocalProcessSpawner` can, for instance).
+
+It is also important to note that this encryption **does not** cover the
+`zmq tcp` sockets between the Notebook client and kernel yet. While users cannot
+submit arbitrary commands to another user's kernel, they can bind to these
+sockets and listen. When serving untrusted users, this eavesdropping can be
+mitigated by setting `KernelManager.transport` to `ipc`. This applies standard
+Unix permissions to the communication sockets thereby restricting
+communication to the socket owner. The `internal_ssl` option will eventually
+extend to securing the `tcp` sockets as well.
+
+### Mitigating same-origin deployments
+
+While per-user domains are **required** for robust protection of users from each other,
+you can mitigate many (but not all) cross-user issues.
+First, it is critical that users cannot modify their server environments, as described above.
+Second, it is important that users do not have `access:servers` permission to any server other than their own.
+
+If users can access each others' servers, additional security measures must be enabled, some of which come with distinct user-experience costs.
+
+Without the [Same-Origin Policy] (SOP) protecting user servers from each other,
+each user server is considered a trusted origin for requests to each other user server (and the Hub itself).
+Servers _cannot_ meaningfully distinguish requests originating from other user servers,
+because SOP implies a great deal of trust, losing many restrictions applied to cross-origin requests.
+
+That means pages served from each user server can:
+
+1. arbitrarily modify the path in the Referer
+2. make fully authorized requests with cookies
+3. access full page contents served from the hub or other servers via popups
+
+JupyterHub uses distinct xsrf tokens stored in cookies on each server path to attempt to limit requests across.
+This has limitations because not all requests are protected by these XSRF tokens,
+and unless additional measures are taken, the XSRF tokens from other user prefixes may be retrieved.
+
+[Same-Origin Policy]: https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy
+
+For example:
+
+- `Content-Security-Policy` header must prohibit popups and iframes from the same origin.
+  The following Content-Security-Policy rules are _insecure_ and readily enable users to access each others' servers:
+
+  - `frame-ancestors: 'self'`
+  - `frame-ancestors: '*'`
+  - `sandbox allow-popups`
+
+- Ideally, pages should use the strictest `Content-Security-Policy: sandbox` available,
+  but this is not feasible in general for JupyterLab pages, which need at least `sandbox allow-same-origin allow-scripts` to work.
+
+The default Content-Security-Policy for single-user servers is
+
+```
+frame-ancestors: 'none'
+```
+
+which prohibits iframe embedding, but not pop-ups.
+
+A more secure Content-Security-Policy that has some costs to user experience is:
+
+```
+frame-ancestors: 'none'; sandbox allow-same-origin allow-scripts
+```
+
+`allow-popups` is not disabled by default because disabling it breaks legitimate functionality, like "Open this in a new tab", and the "JupyterHub Control Panel" menu item.
+To reiterate, the right way to avoid these issues is to enable per-user domains, where none of these concerns come up.
+
+Note: even this level of protection requires administrators maintaining full control over the user server environment.
+If users can modify their server environment, these methods are ineffective, as users can readily disable them.
+
+### Cookie tossing
+
+Cookie tossing is a technique where another server on a subdomain or peer subdomain can set a cookie
+which will be read on another domain.
+This is not relevant unless there are other user-controlled servers on a peer domain.
+
+"Domain-locked" cookies avoid this issue, but have their own restrictions:
+
+- JupyterHub must be served over HTTPS
+- All secure cookies must be set on `/`, not on sub-paths, which means they are shared by all JupyterHub components in a single-domain deployment.
+
+As a result, this option is only recommended when per-user subdomains are enabled,
+to prevent sending all jupyterhub cookies to all user servers.
+
+To enable domain-locked cookies, set:
+
+```python
+c.JupyterHub.cookie_host_prefix_enabled = True
+```
+
+```{versionadded} 4.1
+
+```
+
+### Forced-login
+
+Jupyter servers can share links with `?token=...`.
+JupyterHub prior to 5.0 will accept this request and persist the token for future requests.
+This is useful for enabling admins to create 'fully authenticated' links bypassing login.
+However, it also means users can share their own links that will log other users into their own servers,
+enabling them to serve each other notebooks and other arbitrary HTML, depending on server configuration.
+
+```{versionadded} 4.1
+Setting environment variable `JUPYTERHUB_ALLOW_TOKEN_IN_URL=0` in the single-user environment can opt out of accepting token auth in URL parameters.
+```
+
+```{versionadded} 5.0
+Accepting tokens in URLs is disabled by default, and `JUPYTERHUB_ALLOW_TOKEN_IN_URL=1` environment variable must be set to _allow_ token auth in URL parameters.
+```
+
+## Security audits
+
+We recommend that you do periodic reviews of your deployment's security. It's
+good practice to keep [JupyterHub](https://readthedocs.org/projects/jupyterhub/), [configurable-http-proxy][], and [nodejs
+versions](https://github.com/nodejs/Release) up to date.
+
+A handy website for testing your deployment is
+[Qualsys' SSL analyzer tool](https://www.ssllabs.com/ssltest/analyze.html).
+
+[configurable-http-proxy]: https://github.com/jupyterhub/configurable-http-proxy
+
+## Vulnerability reporting
+
+If you believe you have found a security vulnerability in JupyterHub, or any
+Jupyter project, please report it to
+[security@ipython.org](mailto:security@ipython.org). If you prefer to encrypt
+your security reports, you can use [this PGP public
+key](https://jupyter.org/assets/ipython_security.asc).

docs/source/faq/faq.md

@@ -0,0 +1,76 @@
+# Frequently asked questions
+
+## How do I share links to notebooks?
+
+Sharing links to notebooks is a common activity,
+and can look different depending on what you mean by 'share.'
+Your first instinct might be to copy the URL you see in the browser,
+e.g. `jupyterhub.example/user/yourname/notebooks/coolthing.ipynb`,
+but this usually won't work, depending on the permissions of the person you share the link with.
+
+Unfortunately, 'share' means at least a few things to people in a JupyterHub context.
+We'll cover 3 common cases here, when they are applicable, and what assumptions they make:
+
+1. sharing links that will open the same file on the visitor's own server
+2. sharing links that will bring the visitor to _your_ server (e.g. for real-time collaboration, or RTC)
+3. publishing notebooks and sharing links that will download the notebook into the user's server
+
+### link to the same file on the visitor's server
+
+This is for the case where you have JupyterHub on a shared (or sufficiently similar) filesystem, where you want to share a link that will cause users to login and start their _own_ server, to view or edit the file.
+
+**Assumption:** the same path on someone else's server is valid and points to the same file
+
+This is useful in e.g. classes where you know students have certain files in certain locations, or collaborations where you know you have a shared filesystem where everyone has access to the same files.
+
+A link should look like `https://jupyterhub.example/hub/user-redirect/lab/tree/foo.ipynb`.
+You can hand-craft these URLs from the URL you are looking at, where you see `/user/name/lab/tree/foo.ipynb` use `/hub/user-redirect/lab/tree/foo.ipynb` (replace `/user/name/` with `/hub/user-redirect/`).
+Or you can use JupyterLab's "copy shareable link" in the context menu in the file browser:
+
+![copy shareable link in JupyterLab](../images/shareable_link.webp)
+
+which will produce a correct URL with `/hub/user-redirect/` in it.
+
+### link to the file on your server
+
+This is for the case where you want to both be using _your_ server, e.g. for real-time collaboration (RTC).
+
+**Assumption:** the user has (or should have) access to your server.
+
+**Assumption:** your server is running _or_ the user has permission to start it.
+
+By default, JupyterHub users don't have access to each other's servers, but JupyterHub 2.0 administrators can grant users limited access permissions to each other's servers.
+If the visitor doesn't have access to the server, these links will result in a 403 Permission Denied error.
+
+In many cases, for this situation you can copy the link in your URL bar (`/user/yourname/lab`), or you can add `/tree/path/to/specific/notebook.ipynb` to open a specific file.
+
+The [jupyterlab-link-share] JupyterLab extension generates these links, and even can _grant_ other users access to your server.
+
+[jupyterlab-link-share]: https://github.com/jupyterlab-contrib/jupyterlab-link-share
+
+:::{warning}
+Note that the way the extension _grants_ access is handing over credentials to allow the other user to **_BECOME YOU_**.
+This is usually not appropriate in JupyterHub.
+:::
+
+### link to a published copy
+
+Another way to 'share' notebooks is to publish copies, e.g. pushing the notebook to a git repository and sharing a download link.
+This way is especially useful for course materials,
+where no assumptions are necessary about the user's environment,
+except for having one package installed.
+
+**Assumption:** The [nbgitpuller](inv:nbgitpuller#index) server extension is installed
+
+Unlike the other two methods, nbgitpuller doesn't provide an extension to copy a shareable link for the document you're currently looking at,
+but it does provide a [link generator](inv:nbgitpuller#link),
+which uses the `user-redirect` approach above.
+
+When visiting an nbgitpuller link:
+
+- The visitor will be directed to their own server
+- Your repo will be cloned (or updated if it's already been cloned)
+- and then the file opened when it's ready
+
+[nbgitpuller]: https://nbgitpuller.readthedocs.io
+[nbgitpuller-link]: https://nbgitpuller.readthedocs.io/en/latest/link.html

docs/source/faq/index.md

@@ -0,0 +1,11 @@
+# FAQs
+
+Find answers to some of the most frequently-asked questions around JupyterHub and how it works.
+
+```{toctree}
+:maxdepth: 2
+
+faq
+institutional-faq
+troubleshooting
+```

docs/source/faq/institutional-faq.md

@@ -66,12 +66,12 @@ Here is a sample of organizations that use JupyterHub:
 - **Universities and colleges**: UC Berkeley, UC San Diego, Cal Poly SLO, Harvard University, University of Chicago,
   University of Oslo, University of Sheffield, Université Paris Sud, University of Versailles
 - **Research laboratories**: NASA, NCAR, NOAA, the Large Synoptic Survey Telescope, Brookhaven National Lab,
-  Minnesota Supercomputing Institute, ALCF, CERN, Lawrence Livermore National Laboratory
+  Minnesota Supercomputing Institute, ALCF, CERN, Lawrence Livermore National Laboratory, HUNT
 - **Online communities**: Pangeo, Quantopian, mybinder.org, MathHub, Open Humans
 - **Computing infrastructure providers**: NERSC, San Diego Supercomputing Center, Compute Canada
 - **Companies**: Capital One, SANDVIK code, Globus
 
-See the [Gallery of JupyterHub deployments](../gallery-jhub-deployments.md) for
+See the [Gallery of JupyterHub deployments](gallery-of-deployments) for
 a more complete list of JupyterHub deployments at institutions.
 
 ### How does JupyterHub compare with hosted products, like Google Colaboratory, RStudio.cloud, or Anaconda Enterprise?
@@ -130,9 +130,9 @@ level for several years, and makes a number of "default" security decisions that
 users.
 
 - For security considerations in the base JupyterHub application,
-  [see the JupyterHub security page](https://jupyterhub.readthedocs.io/en/stable/reference/websecurity.html).
+  [see the JupyterHub security page](web-security).
 - For security considerations when deploying JupyterHub on Kubernetes, see the
-  [JupyterHub on Kubernetes security page](https://zero-to-jupyterhub.readthedocs.io/en/latest/security.html).
+  [JupyterHub on Kubernetes security page](https://z2jh.jupyter.org/en/latest/security.html).
 
 The longer answer: it depends on your deployment. Because JupyterHub is very flexible, it can be used
 in a variety of deployment setups. This often entails connecting your JupyterHub to **other** infrastructure

docs/source/faq/troubleshooting.md

@@ -1,3 +1,5 @@
+(troubleshooting)=
+
 # Troubleshooting
 
 When troubleshooting, you may see unexpected behaviors or receive an error
@@ -44,13 +46,13 @@ things like inspect other users' servers or modify the user list at runtime).
 ### JupyterHub Docker container is not accessible at localhost
 
 Even though the command to start your Docker container exposes port 8000
-(`docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub`),
+(`docker run -p 8000:8000 -d --name jupyterhub quay.io/jupyterhub/jupyterhub jupyterhub`),
 it is possible that the IP address itself is not accessible/visible. As a result,
 when you try http://localhost:8000 in your browser, you are unable to connect
 even though the container is running properly. One workaround is to explicitly
 tell Jupyterhub to start at `0.0.0.0` which is visible to everyone. Try this
 command:
-`docker run -p 8000:8000 -d --name jupyterhub jupyterhub/jupyterhub jupyterhub --ip 0.0.0.0 --port 8000`
+`docker run -p 8000:8000 -d --name jupyterhub quay.io/jupyterhub/jupyterhub jupyterhub --ip 0.0.0.0 --port 8000`
 
 ### How can I kill ports from JupyterHub-managed services that have been orphaned?
 
@@ -165,7 +167,7 @@ When your whole JupyterHub sits behind an organization proxy (_not_ a reverse pr
 
 ### Launching Jupyter Notebooks to run as an externally managed JupyterHub service with the `jupyterhub-singleuser` command returns a `JUPYTERHUB_API_TOKEN` error
 
-[JupyterHub services](https://jupyterhub.readthedocs.io/en/stable/reference/services.html) allow processes to interact with JupyterHub's REST API. Example use-cases include:
+{ref}`services` allow processes to interact with JupyterHub's REST API. Example use-cases include:
 
 - **Secure Testing**: provide a canonical Jupyter Notebook for testing production data to reduce the number of entry points into production systems.
 - **Grading Assignments**: provide access to shared Jupyter Notebooks that may be used for management tasks such as grading assignments.
@@ -345,12 +347,12 @@ In order to resolve this issue, there are two potential options.
 
 ### Where do I find Docker images and Dockerfiles related to JupyterHub?
 
-Docker images can be found at the [JupyterHub organization on DockerHub](https://hub.docker.com/u/jupyterhub/).
-The Docker image [jupyterhub/singleuser](https://hub.docker.com/r/jupyterhub/singleuser/)
+Docker images can be found at the [JupyterHub organization on Quay.io](https://quay.io/organization/jupyterhub).
+The Docker image [jupyterhub/singleuser](https://quay.io/repository/jupyterhub/singleuser)
 provides an example single-user notebook server for use with DockerSpawner.
 
 Additional single-user notebook server images can be found at the [Jupyter
-organization on DockerHub](https://hub.docker.com/r/jupyter/) and information
+organization on Quay.io](https://quay.io/organization/jupyter) and information
 about each image at the [jupyter/docker-stacks repo](https://github.com/jupyter/docker-stacks).
 
 ### How can I view the logs for JupyterHub or the user's Notebook servers when using the DockerSpawner?

docs/source/getting-started/authenticators-users-basics.md

@@ -1,131 +0,0 @@
-# Authentication and User Basics
-
-The default Authenticator uses [PAM][] (Pluggable Authentication Module) to authenticate system users with
-their username and password. With the default Authenticator, any user
-with an account and password on the system will be allowed to login.
-
-## Create a set of allowed users (`allowed_users`)
-
-You can restrict which users are allowed to login with a set,
-`Authenticator.allowed_users`:
-
-```python
-c.Authenticator.allowed_users = {'mal', 'zoe', 'inara', 'kaylee'}
-```
-
-Users in the `allowed_users` set are added to the Hub database when the Hub is
-started.
-
-```{warning}
-If this configuration value is not set, then **all authenticated users will be allowed into your hub**.
-```
-
-## Configure admins (`admin_users`)
-
-```{note}
-As of JupyterHub 2.0, the full permissions of `admin_users`
-should not be required.
-Instead, you can assign [roles](define-role-target) to users or groups
-with only the scopes they require.
-```
-
-Admin users of JupyterHub, `admin_users`, can add and remove users from
-the user `allowed_users` set. `admin_users` can take actions on other users'
-behalf, such as stopping and restarting their servers.
-
-A set of initial admin users, `admin_users` can be configured as follows:
-
-```python
-c.Authenticator.admin_users = {'mal', 'zoe'}
-```
-
-Users in the admin set are automatically added to the user `allowed_users` set,
-if they are not already present.
-
-Each Authenticator may have different ways of determining whether a user is an
-administrator. By default, JupyterHub uses the PAMAuthenticator which provides the
-`admin_groups` option and can set administrator status based on a user
-group. For example, we can let any user in the `wheel` group be an admin:
-
-```python
-c.PAMAuthenticator.admin_groups = {'wheel'}
-```
-
-## Give admin access to other users' notebook servers (`admin_access`)
-
-Since the default `JupyterHub.admin_access` setting is `False`, the admins
-do not have permission to log in to the single user notebook servers
-owned by _other users_. If `JupyterHub.admin_access` is set to `True`,
-then admins have permission to log in _as other users_ on their
-respective machines for debugging. **As a courtesy, you should make
-sure your users know if admin_access is enabled.**
-
-## Add or remove users from the Hub
-
-Users can be added to and removed from the Hub via the admin
-panel or the REST API. When a user is **added**, the user will be
-automatically added to the `allowed_users` set and database. Restarting the Hub
-will not require manually updating the `allowed_users` set in your config file,
-as the users will be loaded from the database.
-
-After starting the Hub once, it is not sufficient to **remove** a user
-from the allowed users set in your config file. You must also remove the user
-from the Hub's database, either by deleting the user from JupyterHub's
-admin page, or you can clear the `jupyterhub.sqlite` database and start
-fresh.
-
-## Use LocalAuthenticator to create system users
-
-The `LocalAuthenticator` is a special kind of Authenticator that has
-the ability to manage users on the local system. When you try to add a
-new user to the Hub, a `LocalAuthenticator` will check if the user
-already exists. If you set the configuration value, `create_system_users`,
-to `True` in the configuration file, the `LocalAuthenticator` has
-the ability to add users to the system. The setting in the config
-file is:
-
-```python
-c.LocalAuthenticator.create_system_users = True
-```
-
-Adding a user to the Hub that doesn't already exist on the system will
-result in the Hub creating that user via the system `adduser` command
-line tool. This option is typically used on hosted deployments of
-JupyterHub to avoid the need to manually create all your users before
-launching the service. This approach is not recommended when running
-JupyterHub in situations where JupyterHub users map directly onto the
-system's UNIX users.
-
-## Use OAuthenticator to support OAuth with popular service providers
-
-JupyterHub's [OAuthenticator][] currently supports the following
-popular services:
-
-- [Auth0](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.auth0.html#module-oauthenticator.auth0)
-- [Azure AD](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.azuread.html#module-oauthenticator.azuread)
-- [Bitbucket](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.bitbucket.html#module-oauthenticator.bitbucket)
-- [CILogon](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.cilogon.html#module-oauthenticator.cilogon)
-- [GitHub](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.github.html#module-oauthenticator.github)
-- [GitLab](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.gitlab.html#module-oauthenticator.gitlab)
-- [Globus](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.globus.html#module-oauthenticator.globus)
-- [Google](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.google.html#module-oauthenticator.google)
-- [MediaWiki](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.mediawiki.html#module-oauthenticator.mediawiki)
-- [Okpy](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.okpy.html#module-oauthenticator.okpy)
-- [OpenShift](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.openshift.html#module-oauthenticator.openshift)
-
-A [generic implementation](https://oauthenticator.readthedocs.io/en/latest/api/gen/oauthenticator.generic.html#module-oauthenticator.generic), which you can use for OAuth authentication
-with any provider, is also available.
-
-## Use DummyAuthenticator for testing
-
-The `DummyAuthenticator` is a simple Authenticator that
-allows for any username or password unless a global password has been set. If
-set, it will allow for any username as long as the correct password is provided.
-To set a global password, add this to the config file:
-
-```python
-c.DummyAuthenticator.password = "some_password"
-```
-
-[pam]: https://en.wikipedia.org/wiki/Pluggable_authentication_module
-[oauthenticator]: https://github.com/jupyterhub/oauthenticator

docs/source/getting-started/faq.md

@@ -1,36 +0,0 @@
-# Frequently asked questions
-
-## How do I share links to notebooks?
-
-In short, where you see `/user/name/notebooks/foo.ipynb` use `/hub/user-redirect/notebooks/foo.ipynb` (replace `/user/name` with `/hub/user-redirect`).
-
-Sharing links to notebooks is a common activity,
-and can look different based on what you mean.
-Your first instinct might be to copy the URL you see in the browser,
-e.g. `hub.jupyter.org/user/yourname/notebooks/coolthing.ipynb`.
-However, let's break down what this URL means:
-
-`hub.jupyter.org/user/yourname/` is the URL prefix handled by _your server_,
-which means that sharing this URL is asking the person you share the link with
-to come to _your server_ and look at the exact same file.
-In most circumstances, this is forbidden by permissions because the person you share with does not have access to your server.
-What actually happens when someone visits this URL will depend on whether your server is running and other factors.
-
-**But what is our actual goal?**
-
-A typical situation is that you have some shared or common filesystem,
-such that the same path corresponds to the same document
-(either the exact same document or another copy of it).
-Typically, what folks want when they do sharing like this
-is for each visitor to open the same file _on their own server_,
-so Breq would open `/user/breq/notebooks/foo.ipynb` and
-Seivarden would open `/user/seivarden/notebooks/foo.ipynb`, etc.
-
-JupyterHub has a special URL that does exactly this!
-It's called `/hub/user-redirect/...`.
-So if you replace `/user/yourname` in your URL bar
-with `/hub/user-redirect` any visitor should get the same
-URL on their own server, rather than visiting yours.
-
-In JupyterLab 2.0, this should also be the result of the "Copy Shareable Link"
-action in the file browser.

docs/source/getting-started/index.rst

@@ -1,19 +0,0 @@
-Get Started
-===========
-
-This section covers how to configure and customize JupyterHub for your
-needs. It contains information about authentication, networking, security, and
-other topics that are relevant to individuals or organizations deploying their
-own JupyterHub.
-
-.. toctree::
-   :maxdepth: 2
-
-   config-basics
-   networking-basics
-   security-basics
-   authenticators-users-basics
-   spawners-basics
-   services-basics
-   faq
-   institutional-faq

docs/source/getting-started/security-basics.rst

@@ -1,254 +0,0 @@
-Security settings
-=================
-
-.. important::
-
-   You should not run JupyterHub without SSL encryption on a public network.
-
-Security is the most important aspect of configuring Jupyter.
-Three (3) configuration settings are the main aspects of security configuration:
-
-1. :ref:`SSL encryption <ssl-encryption>` (to enable HTTPS)
-2. :ref:`Cookie secret <cookie-secret>` (a key for encrypting browser cookies)
-3. Proxy :ref:`authentication token <authentication-token>` (used for the Hub and
-   other services to authenticate to the Proxy)
-
-The Hub hashes all secrets (e.g. auth tokens) before storing them in its
-database. A loss of control over read-access to the database should have
-minimal impact on your deployment. If your database has been compromised, it
-is still a good idea to revoke existing tokens.
-
-.. _ssl-encryption:
-
-Enabling SSL encryption
------------------------
-
-Since JupyterHub includes authentication and allows arbitrary code execution,
-you should not run it without SSL (HTTPS).
-
-Using an SSL certificate
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-This will require you to obtain an official, trusted SSL certificate or create a
-self-signed certificate. Once you have obtained and installed a key and
-certificate, you need to specify their locations in the ``jupyterhub_config.py``
-configuration file as follows:
-
-.. code-block:: python
-
-    c.JupyterHub.ssl_key = '/path/to/my.key'
-    c.JupyterHub.ssl_cert = '/path/to/my.cert'
-
-
-Some cert files also contain the key, in which case only the cert is needed. It
-is important that these files be put in a secure location on your server, where
-they are not readable by regular users.
-
-If you are using a **chain certificate**, see also chained certificate for SSL
-in the JupyterHub `Troubleshooting FAQ <../troubleshooting.html>`_.
-
-Using letsencrypt
-~~~~~~~~~~~~~~~~~
-
-It is also possible to use `letsencrypt <https://letsencrypt.org/>`_ to obtain
-a free, trusted SSL certificate. If you run letsencrypt using the default
-options, the needed configuration is (replace ``mydomain.tld`` by your fully
-qualified domain name):
-
-.. code-block:: python
-
-    c.JupyterHub.ssl_key = '/etc/letsencrypt/live/{mydomain.tld}/privkey.pem'
-    c.JupyterHub.ssl_cert = '/etc/letsencrypt/live/{mydomain.tld}/fullchain.pem'
-
-If the fully qualified domain name (FQDN) is ``example.com``, the following
-would be the needed configuration:
-
-.. code-block:: python
-
-    c.JupyterHub.ssl_key = '/etc/letsencrypt/live/example.com/privkey.pem'
-    c.JupyterHub.ssl_cert = '/etc/letsencrypt/live/example.com/fullchain.pem'
-
-
-If SSL termination happens outside of the Hub
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-In certain cases, for example, if the hub is running behind a reverse proxy, and
-`SSL termination is being provided by NGINX <https://www.nginx.com/resources/admin-guide/nginx-ssl-termination/>`_,
-it is reasonable to run the hub without SSL.
-
-To achieve this, remove ``c.JupyterHub.ssl_key`` and ``c.JupyterHub.ssl_cert``
-from your configuration (setting them to ``None`` or an empty string does not
-have the same effect, and will result in an error).
-
-.. _authentication-token:
-
-Proxy authentication token
---------------------------
-
-The Hub authenticates its requests to the Proxy using a secret token that
-the Hub and Proxy agree upon. Note that this applies to the default
-``ConfigurableHTTPProxy`` implementation. Not all proxy implementations
-use an auth token.
-
-The value of this token should be a random string (for example, generated by
-``openssl rand -hex 32``). You can store it in the configuration file or an
-environment variable.
-
-Generating and storing token in the configuration file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can set the value in the configuration file, ``jupyterhub_config.py``:
-
-.. code-block:: python
-
-    c.ConfigurableHTTPProxy.api_token = 'abc123...' # any random string
-
-Generating and storing as an environment variable
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can pass this value of the proxy authentication token to the Hub and Proxy
-using the ``CONFIGPROXY_AUTH_TOKEN`` environment variable:
-
-.. code-block:: bash
-
-    export CONFIGPROXY_AUTH_TOKEN=$(openssl rand -hex 32)
-
-This environment variable needs to be visible to the Hub and Proxy.
-
-Default if token is not set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you do not set the Proxy authentication token, the Hub will generate a random
-key itself. This means that any time you restart the Hub, you **must also
-restart the Proxy**. If the proxy is a subprocess of the Hub, this should happen
-automatically (this is the default configuration).
-
-.. _cookie-secret:
-
-Cookie secret
--------------
-
-The cookie secret is an encryption key, used to encrypt the browser cookies,
-which are used for authentication. Three common methods are described for
-generating and configuring the cookie secret.
-
-Generating and storing as a cookie secret file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The cookie secret should be 32 random bytes, encoded as hex, and is typically
-stored in a ``jupyterhub_cookie_secret`` file. Below, is an example command to generate the
-``jupyterhub_cookie_secret`` file:
-
-.. code-block:: bash
-
-    openssl rand -hex 32 > /srv/jupyterhub/jupyterhub_cookie_secret
-
-In most deployments of JupyterHub, you should point this to a secure location on
-the file system, such as ``/srv/jupyterhub/jupyterhub_cookie_secret``.
-
-The location of the ``jupyterhub_cookie_secret`` file can be specified in the
-``jupyterhub_config.py`` file as follows:
-
-.. code-block:: python
-
-    c.JupyterHub.cookie_secret_file = '/srv/jupyterhub/jupyterhub_cookie_secret'
-
-If the cookie secret file doesn't exist when the Hub starts, a new cookie
-secret is generated and stored in the file. The file must not be readable by
-``group`` or ``other``, otherwise the server won't start. The recommended permissions
-for the cookie secret file are ``600`` (owner-only rw).
-
-Generating and storing as an environment variable
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If you would like to avoid the need for files, the value can be loaded in the
-Hub process from the ``JPY_COOKIE_SECRET`` environment variable, which is a
-hex-encoded string. You can set it this way:
-
-.. code-block:: bash
-
-    export JPY_COOKIE_SECRET=$(openssl rand -hex 32)
-
-For security reasons, this environment variable should only be visible to the
-Hub. If you set it dynamically as above, all users will be logged out each time
-the Hub starts.
-
-Generating and storing as a binary string
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can also set the cookie secret, as a binary string,
-in the configuration file (``jupyterhub_config.py``) itself:
-
-.. code-block:: python
-
-    c.JupyterHub.cookie_secret = bytes.fromhex('64 CHAR HEX STRING')
-
-.. _cookies:
-
-Cookies used by JupyterHub authentication
------------------------------------------
-
-The following cookies are used by the Hub for handling user authentication.
-
-This section was created based on this post_ from Discourse.
-
-.. _post: https://discourse.jupyter.org/t/how-to-force-re-login-for-users/1998/6
-
-jupyterhub-hub-login
-~~~~~~~~~~~~~~~~~~~~
-
-This is the login token used when visiting Hub-served pages that are
-protected by authentication, such as the main home, the spawn form, etc.
-If this cookie is set, then the user is logged in.
-
-Resetting the Hub cookie secret effectively revokes this cookie.
-
-This cookie is restricted to the path ``/hub/``.
-
-jupyterhub-user-<username>
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-This is the cookie used for authenticating with a single-user server.
-It is set by the single-user server, after OAuth with the Hub.
-
-Effectively the same as ``jupyterhub-hub-login``, but for the
-single-user server instead of the Hub. It contains an OAuth access token,
-which is checked with the Hub to authenticate the browser.
-
-Each OAuth access token is associated with a session id (see ``jupyterhub-session-id`` section
-below).
-
-To avoid hitting the Hub on every request, the authentication response is cached.
-The cache key is comprised of both the token and session id, to avoid a stale cache.
-
-Resetting the Hub cookie secret effectively revokes this cookie.
-
-This cookie is restricted to the path ``/user/<username>``,
-to ensure that only the user’s server receives it.
-
-jupyterhub-session-id
-~~~~~~~~~~~~~~~~~~~~~
-
-This is a random string, meaningless in itself, and the only cookie
-shared by the Hub and single-user servers.
-
-Its sole purpose is to coordinate the logout of the multiple OAuth cookies.
-
-This cookie is set to ``/`` so all endpoints can receive it, clear it, etc.
-
-jupyterhub-user-<username>-oauth-state
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-A short-lived cookie, used solely to store and validate OAuth state.
-It is only set while OAuth between the single-user server and the Hub
-is processing.
-
-If you use your browser development tools, you should see this cookie
-for a very brief moment before you are logged in,
-with an expiration date shorter than ``jupyterhub-hub-login`` or
-``jupyterhub-user-<username>``.
-
-This cookie should not exist after you have successfully logged in.
-
-This cookie is restricted to the path ``/user/<username>``, so that only
-the user’s server receives it.

docs/source/howto/configuration/config-proxy.md

@@ -79,7 +79,7 @@ server {
     location / {
         proxy_pass http://127.0.0.1:8000;
         proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header Host $host;
+        proxy_set_header Host $http_host;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 
         # websocket headers

docs/source/howto/configuration/config-sudo.md

@@ -6,14 +6,14 @@ Only do this if you are very sure you must.
 
 ## Overview
 
-There are many [Authenticators](../getting-started/authenticators-users-basics) and [Spawners](../getting-started/spawners-basics) available for JupyterHub. Some, such
+There are many [Authenticators](authenticators) and [Spawners](spawners) available for JupyterHub. Some, such
 as [DockerSpawner](https://github.com/jupyterhub/dockerspawner) or [OAuthenticator](https://github.com/jupyterhub/oauthenticator), do not need any elevated permissions. This
 document describes how to get the full default behavior of JupyterHub while
 running notebook servers as real system users on a shared system, without
 running the Hub itself as root.
 
 Since JupyterHub needs to spawn processes as other users, the simplest way
-is to run it as root, spawning user servers with [setuid](http://linux.die.net/man/2/setuid).
+is to run it as root, spawning user servers with [setuid](https://linux.die.net/man/2/setuid).
 But this isn't especially safe, because you have a process running on the
 public web as root.
 
@@ -114,7 +114,7 @@ sudo: a password is required
 
 ## Enable PAM for non-root
 
-By default, [PAM authentication](http://en.wikipedia.org/wiki/Pluggable_authentication_module)
+By default, [PAM authentication](https://en.wikipedia.org/wiki/Pluggable_authentication_module)
 is used by JupyterHub. To use PAM, the process may need to be able to read
 the shadow password database.
 
@@ -159,13 +159,13 @@ sudo setcap 'cap_net_bind_service=+ep' /usr/bin/node
 ```
 
 However, you may want to further understand the consequences of this.
-([Further reading](http://man7.org/linux/man-pages/man7/capabilities.7.html))
+([Further reading](https://man7.org/linux/man-pages/man7/capabilities.7.html))
 
 You may also be interested in limiting the amount of CPU any process can use
 on your server. `cpulimit` is a useful tool that is available for many Linux
 distributions' packaging system. This can be used to keep any user's process
 from using too much CPU cycles. You can configure it accoring to [these
-instructions](http://ubuntuforums.org/showthread.php?t=992706).
+instructions](https://ubuntuforums.org/showthread.php?t=992706).
 
 ### Shadow group (FreeBSD)
 

docs/source/howto/configuration/config-user-env.md

@@ -45,7 +45,7 @@ additional packages.
 
 ## Configuring Jupyter and IPython
 
-[Jupyter](https://jupyter-notebook.readthedocs.io/en/stable/config_overview.html)
+[Jupyter](https://jupyter-notebook.readthedocs.io/en/stable/configuring/config_overview.html)
 and [IPython](https://ipython.readthedocs.io/en/stable/development/config.html)
 have their own configuration systems.
 
@@ -57,6 +57,24 @@ The typical locations for these config files are:
 - **system-wide** in `/etc/{jupyter|ipython}`
 - **env-wide** (environment wide) in `{sys.prefix}/etc/{jupyter|ipython}`.
 
+### Jupyter environment configuration priority
+
+When Jupyter runs in an environment (conda or virtualenv), it prefers to load configuration from the environment over each user's own configuration (e.g. in `~/.jupyter`).
+This may cause issues if you use a _shared_ conda environment or virtualenv for users, because e.g. jupyterlab may try to write information like workspaces or settings to the environment instead of the user's own directory.
+This could fail with something like `Permission denied: $PREFIX/etc/jupyter/lab`.
+
+To avoid this issue, set `JUPYTER_PREFER_ENV_PATH=0` in the user environment:
+
+```python
+c.Spawner.environment.update(
+    {
+        "JUPYTER_PREFER_ENV_PATH": "0",
+    }
+)
+```
+
+which tells Jupyter to prefer _user_ configuration paths (e.g. in `~/.jupyter`) to configuration set in the environment.
+
 ### Example: Enable an extension system-wide
 
 For example, to enable the `cython` IPython extension for all of your users, create the file `/etc/ipython/ipython_config.py`:
@@ -153,11 +171,11 @@ c.JupyterHub.allow_named_servers = True
 Named servers were implemented in the REST API in JupyterHub 0.8,
 and JupyterHub 1.0 introduces UI for managing named servers via the user home page:
 
-![named servers on the home page](../images/named-servers-home.png)
+![named servers on the home page](/images/named-servers-home.png)
 
 as well as the admin page:
 
-![named servers on the admin page](../images/named-servers-admin.png)
+![named servers on the admin page](/images/named-servers-admin.png)
 
 Named servers can be accessed, created, started, stopped, and deleted
 from these pages. Activity tracking is now per server as well.
@@ -184,6 +202,8 @@ This can be useful for quota service implementations. The example above limits t
 
 If `named_server_limit_per_user` is set to `0`, no limit is enforced.
 
+When using named servers, Spawners may need additional configuration to take the `servername` into account. Whilst `KubeSpawner` takes the `servername` into account by default in [`pod_name_template`](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#kubespawner.KubeSpawner.pod_name_template), other Spawners may not. Check the documentation for the specific Spawner to see how singleuser servers are named, for example in `DockerSpawner` this involves modifying the [`name_template`](https://jupyterhub-dockerspawner.readthedocs.io/en/latest/api/index.html) setting to include `servername`, eg. `"{prefix}-{username}-{servername}"`.
+
 (classic-notebook-ui)=
 
 ## Switching back to the classic notebook
@@ -192,13 +212,31 @@ By default, the single-user server launches JupyterLab,
 which is based on [Jupyter Server][].
 
 This is the default server when running JupyterHub ≥ 2.0.
-To switch to using the legacy Jupyter Notebook server, you can set the `JUPYTERHUB_SINGLEUSER_APP` environment variable
+To switch to using the legacy Jupyter Notebook server (notebook < 7.0), you can set the `JUPYTERHUB_SINGLEUSER_APP` environment variable
 (in the single-user environment) to:
 
 ```bash
 export JUPYTERHUB_SINGLEUSER_APP='notebook.notebookapp.NotebookApp'
 ```
 
+:::{note}
+
+```
+JUPYTERHUB_SINGLEUSER_APP='notebook.notebookapp.NotebookApp'
+```
+
+is only valid for notebook < 7. notebook v7 is based on jupyter-server,
+and the default jupyter-server application must be used.
+Selecting the new notebook UI is no longer a matter of selecting the server app to launch,
+but only the default URL for users to visit.
+To use notebook v7 with JupyterHub, leave the default singleuser app config alone (or specify `JUPYTERHUB_SINGLEUSER_APP=jupyter-server`) and set the default _URL_ for user servers:
+
+```python
+c.Spawner.default_url = '/tree/'
+```
+
+:::
+
 [jupyter server]: https://jupyter-server.readthedocs.io
 [jupyter notebook]: https://jupyter-notebook.readthedocs.io
 

docs/source/howto/index.md

@@ -0,0 +1,34 @@
+# How-to
+
+The _How-to_ guides provide practical step-by-step details to help you achieve a particular goal. They are useful when you are trying to get something done but require you to understand and adapt the steps to your specific usecase.
+
+Use the following guides when:
+
+```{toctree}
+:maxdepth: 1
+
+api-only
+proxy
+rest
+separate-proxy
+templates
+upgrading
+log-messages
+
+```
+
+(config-examples)=
+
+## Configuration
+
+The following guides provide examples, including configuration files and tips, for the
+following:
+
+```{toctree}
+:maxdepth: 1
+
+configuration/config-user-env
+configuration/config-ghoauth
+configuration/config-proxy
+configuration/config-sudo
+```

docs/source/howto/rest.md

@@ -1,4 +1,4 @@
-(rest-api)=
+(using-jupyterhub-rest-api)=
 
 # Using JupyterHub's REST API
 
@@ -19,11 +19,12 @@ Hub.
 
 ## What you can do with the API
 
-Using the [JupyterHub REST API][], you can perform actions on the Hub,
+Using the [JupyterHub REST API](jupyterhub-rest-API), you can perform actions on the Hub,
 such as:
 
 - Checking which users are active
 - Adding or removing users
+- Adding or removing services
 - Stopping or starting single user notebook servers
 - Authenticating services
 - Communicating with an individual Jupyter server's REST API
@@ -33,36 +34,13 @@ such as:
 To send requests using the JupyterHub API, you must pass an API token with
 the request.
 
-The preferred way of generating an API token is by running:
-
-```bash
-openssl rand -hex 32
-```
-
-This `openssl` command generates a potential token that can then be
-added to JupyterHub using `.api_tokens` configuration setting in
-`jupyterhub_config.py`.
-
-```{note}
-The api_tokens configuration has been softly deprecated since the introduction of services.
-```
-
-Alternatively, you can use the `jupyterhub token` command to generate a token
-for a specific hub user by passing the **username**:
-
-```bash
-jupyterhub token <username>
-```
-
-This command generates a random string to use as a token and registers
-it for the given user with the Hub's database.
-
-In [version 0.8.0](../changelog.md), a token request page for
-generating an API token is available from the JupyterHub user interface:
+While JupyterHub is running, any JupyterHub user can request a token via the `token` page.
+This is accessible via a `token` link in the top nav bar from the JupyterHub home page,
+or at the URL `/hub/token`.
 
 :::{figure-md}
 
-![token request page](../images/token-request.png)
+![token request page](../images/token-page.png)
 
 JupyterHub's API token page
 :::
@@ -74,6 +52,40 @@ JupyterHub's token page after successfully requesting a token.
 
 :::
 
+### Register API tokens via configuration
+
+Sometimes, you'll want to pre-generate a token for access to JupyterHub,
+typically for use by external services,
+so that both JupyterHub and the service have access to the same value.
+
+First, you need to generate a good random secret.
+A good way of generating an API token is by running:
+
+```bash
+openssl rand -hex 32
+```
+
+This `openssl` command generates a random token that can be added to the JupyterHub configuration in `jupyterhub_config.py`.
+
+For external services, this would be registered with JupyterHub via configuration:
+
+```python
+c.JupyterHub.services = [
+    {
+        "name": "my-service",
+        "api_token": the_secret_value,
+    },
+]
+```
+
+At this point, requests authenticated with the token will be associated with The service `my-service`.
+
+```{note}
+You can also load additional tokens for users via the `JupyterHub.api_tokens` configuration.
+
+However, this option has been deprecated since the introduction of services.
+```
+
 ## Assigning permissions to a token
 
 Prior to JupyterHub 2.0, there were two levels of permissions:
@@ -87,9 +99,46 @@ In JupyterHub 2.0,
 specific permissions are now defined as '**scopes**',
 and can be assigned both at the user/service level,
 and at the individual token level.
+The previous behavior is represented by the scope `inherit`,
+and is still the default behavior for requesting a token if limited permissions are not specified.
 
 This allows e.g. a user with full admin permissions to request a token with limited permissions.
 
+In JupyterHub 5.0, you can specify scopes for a token when requesting it via the `/hub/tokens` page as a space-separated list.
+In JupyterHub 3.0 and later, you can also request tokens with limited scopes via the JupyterHub API (provided you already have a token!):
+
+```python
+import json
+from urllib.parse import quote
+
+import requests
+
+def request_token(
+    username, *, api_token, scopes=None, expires_in=0, hub_url="http://127.0.0.1:8081"
+):
+    """Request a new token for a user"""
+    request_body = {}
+    if expires_in:
+        request_body["expires_in"] = expires_in
+    if scopes:
+        request_body["scopes"] = scopes
+    url = hub_url.rstrip("/") + f"/hub/api/users/{quote(username)}/tokens"
+    r = requests.post(
+        url,
+        data=json.dumps(request_body),
+        headers={"Authorization": f"token {api_token}"},
+    )
+    if r.status_code >= 400:
+        # extract error message for nicer error messages
+        r.reason = r.json().get("message", r.text)
+    r.raise_for_status()
+    # response is a dict and will include the token itself in the 'token' field,
+    # as well as other fields about the token
+    return r.json()
+
+request_token("myusername", scopes=["list:users"], api_token="abc123")
+```
+
 ## Updating to admin services
 
 ```{note}
@@ -153,7 +202,7 @@ Authorization header.
 ### Use requests
 
 Using the popular Python [requests](https://docs.python-requests.org)
-library, an API GET request is made, and the request sends an API token for
+library, an API GET request is made to [/users](rest-api-get-users), and the request sends an API token for
 authorization. The response contains information about the users, here's example code to make an API request for the users of a JupyterHub deployment
 
 ```python
@@ -171,7 +220,7 @@ r.raise_for_status()
 users = r.json()
 ```
 
-This example provides a slightly more complicated request, yet the
+This example provides a slightly more complicated request (to [/groups/formgrade-data301/users](rest-api-post-group-users)), yet the
 process is very similar:
 
 ```python
@@ -205,7 +254,7 @@ provided by notebook servers managed by JupyterHub if it has the necessary `acce
 
 Pagination is available through the `offset` and `limit` query parameters on
 list endpoints, which can be used to return ideally sized windows of results.
-Here's example code demonstrating pagination on the `GET /users`
+Here's example code demonstrating pagination on the [`GET /users`](rest-api-get-users)
 endpoint to fetch the first 20 records.
 
 ```python
@@ -276,7 +325,7 @@ Pagination is enabled on the `GET /users`, `GET /groups`, and `GET /proxy` REST
 
 ## Enabling users to spawn multiple named-servers via the API
 
-Support for multiple servers per user was introduced in JupyterHub [version 0.8.](../changelog.md)
+Support for multiple servers per user was introduced in JupyterHub [version 0.8.](changelog)
 Prior to that, each user could only launch a single default server via the API
 like this:
 
@@ -294,7 +343,7 @@ First you must enable named-servers by including the following setting in the `j
 
 If you are using the [zero-to-jupyterhub-k8s](https://github.com/jupyterhub/zero-to-jupyterhub-k8s) set-up to run JupyterHub,
 then instead of editing the `jupyterhub_config.py` file directly, you could pass
-the following as part of the `config.yaml` file, as per the [tutorial](https://zero-to-jupyterhub.readthedocs.io/en/latest/):
+the following as part of the `config.yaml` file, as per the [tutorial](https://z2jh.jupyter.org/en/latest/):
 
 ```bash
 hub:
@@ -304,12 +353,18 @@ hub:
 
 With that setting in place, a new named-server is activated like this:
 
+```{parsed-literal}
+[POST /api/users/:username/servers/:servername](rest-api-post-user-server-name)
+```
+
+e.g.
+
 ```bash
 curl -X POST -H "Authorization: token <token>" "http://127.0.0.1:8081/hub/api/users/<user>/servers/<serverA>"
 curl -X POST -H "Authorization: token <token>" "http://127.0.0.1:8081/hub/api/users/<user>/servers/<serverB>"
 ```
 
-The same servers can be stopped by substituting `DELETE` for `POST` above.
+The same servers can be [stopped](rest-api-delete-user-server-name) by substituting `DELETE` for `POST` above.
 
 ### Some caveats for using named-servers
 
@@ -320,7 +375,7 @@ or kubernetes pods.
 
 ## Learn more about the API
 
-You can see the full [JupyterHub REST API][] for more details.
+You can see the full [JupyterHub REST API](jupyterhub-rest-api) for more details.
 
 [openapi initiative]: https://www.openapis.org/
 [jupyterhub rest api]: ./rest-api

docs/source/howto/separate-proxy.md

@@ -1,3 +1,5 @@
+(separate-proxy)=
+
 # Running proxy separately from the hub
 
 ## Background
@@ -68,7 +70,7 @@ need to configure the options there.
 ## Docker image
 
 You can use [jupyterhub configurable-http-proxy docker
-image](https://hub.docker.com/r/jupyterhub/configurable-http-proxy/)
+image](https://quay.io/repository/jupyterhub/configurable-http-proxy)
 to run the proxy.
 
 ## See also

docs/source/howto/upgrading-v5.md

@@ -0,0 +1,144 @@
+(upgrading-v5)=
+
+# Upgrading to JupyterHub 5
+
+This document describes the specific considerations.
+For general upgrading tips, see the [docs on upgrading jupyterhub](upgrading).
+
+You can see the [changelog](changelog) for more detailed information.
+
+## Python version
+
+JupyterHub 5 requires Python 3.8.
+Make sure you have at least Python 3.8 in your user and hub environments before upgrading.
+
+## Database upgrades
+
+JupyterHub 5 does have a database schema upgrade,
+so you should backup your database and run `jupyterhub upgrade-db` after upgrading and before starting JupyterHub.
+The updated schema only adds some columns, so is one that should be not too disruptive to roll back if you need to.
+
+## User subdomains
+
+All JupyterHub deployments which care about protecting users from each other are encouraged to enable per-user domains, if possible,
+as this provides the best isolation between user servers.
+
+To enable subdomains, set:
+
+```python
+c.JupyterHub.subdomain_host = "https://myjupyterhub.example.org"
+```
+
+If you were using subdomains before, some user servers and all services will be on different hosts in the default configuration.
+
+JupyterHub 5 allows complete customization of the subdomain scheme via the new {attr}`.JupyterHub.subdomain_hook`,
+and changes the default subdomain scheme.
+.
+
+You can provide a completely custom subdomain scheme, or select one of two default implementations by name: `idna` or `legacy`. `idna` is the default.
+
+The new default behavior can be selected explicitly via:
+
+```python
+c.JupyterHub.subdomain_hook = "idna"
+```
+
+Or to delay any changes to URLs for your users, you can opt-in to the pre-5.0 behavior with:
+
+```python
+c.JupyterHub.subdomain_hook = "legacy"
+```
+
+The key differences of the new `idna` scheme:
+
+- It should always produce valid domains, regardless of username (not true for the legacy scheme when using characters that might need escaping or usernames that are long)
+- each Service gets its own subdomain on `service--` rather than sharing `services.`
+
+Below is a table of examples of users and services with their domains with the old and new scheme, assuming the configuration:
+
+```python
+c.JupyterHub.subdomain_host = "https://jupyter.example.org"
+```
+
+| kind    | name               | legacy                                                     | idna                                                                                                  |
+| ------- | ------------------ | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| user    | laudna             | `laudna.jupyter.example.org`                               | `laudna.jupyter.example.org`                                                                          |
+| service | bells              | `services.jupyter.example.org`                             | `bells--service.jupyter.example.org`                                                                  |
+| user    | jester@mighty.nein | `jester_40mighty.nein.jupyter.example.org` (may not work!) | `u-jestermi--8037680.jupyter.example.org` (not as pretty, but guaranteed to be valid and not collide) |
+
+## Tokens in URLs
+
+JupyterHub 5 does not accept `?token=...` URLs by default in single-user servers.
+These URLs allow one user to force another to login as them,
+which can be the start of an inter-user attack.
+
+There is a valid use case for producing links which allow starting a fully authenticated session,
+so you may still opt in to this behavior by setting:
+
+```python
+c.Spawner.environment.update({"JUPYTERHUB_ALLOW_TOKEN_IN_URL": "1"})
+```
+
+if you are not concerned about protecting your users from each other.
+If you have subdomains enabled, the threat is substantially reduced.
+
+## Sharing
+
+The big new feature in JupyterHub 5.0 is sharing.
+Check it out in [the sharing docs](sharing-tutorial).
+
+## Authenticator.allow_all and allow_existing_users
+
+Prior to JupyterHub 5, JupyterHub Authenticators had the _implicit_ default behavior to allow any user who successfully authenticates to login **if no users are explicitly allowed** (i.e. `allowed_users` is empty on the base class).
+This behavior was considered a too-permissive default in Authenticators that source large user pools like OAuthenticator, which would accept e.g. all users with a Google account by default.
+As a result, OAuthenticator 16 introduced two configuration options: `allow_all` and `allow_existing_users`.
+
+JupyterHub 5 adopts these options for all Authenticators:
+
+1. `Authenticator.allow_all` (default: False)
+2. `Authenticator.allow_existing_users` (default: True if allowed_users is non-empty, False otherwise)
+
+having the effect that _some_ allow configuration is required for anyone to be able to login.
+If you want to preserve the pre-5.0 behavior with no explicit `allow` configuration, set:
+
+```python
+c.Authenticator.allow_all = True
+```
+
+`allow_existing_users` defaults are meant to be backward-compatible, but you can now _explicitly_ allow or not based on presence in the database by setting `Authenticator.allow_existing_users` to True or False.
+
+:::{seealso}
+
+[Authenticator config docs](authenticators) for details on these and other Authenticator options.
+:::
+
+## Bootstrap 5
+
+JupyterHub uses the CSS framework [bootstrap](https://getbootstrap.com), which is upgraded from 3.4 to 5.3.
+If you don't have any custom HTML templates, you are likely to only see relatively minor aesthetic changes.
+If you have custom HTML templates or spawner options forms, they may need some updating to look right.
+
+See the bootstrap documentation. Since we upgraded two major versions, you might need to look at both v4 and v5 documentation for what has changed since 3.x:
+
+- [migrating to v4](https://getbootstrap.com/docs/4.6/migration/)
+- [migrating to v5](https://getbootstrap.com/docs/5.3/migration/)
+
+If you customized the JupyterHub CSS by recompiling from LESS files, bootstrap migrated to SCSS.
+You can start by autoconverting your LESS to SCSS (it's not that different) with [less2sass](https://github.com/ekryski/less2sass):
+
+```bash
+npm install --global less2scss
+# converts less/foo.less to scss/foo.scss
+less2scss --src ./less --dst ./scss
+```
+
+Bootstrap also allows configuring things with [CSS variables](https://getbootstrap.com/docs/5.3/customize/css-variables/), so depending on what you have customized, you may be able to get away with just adding a CSS file defining variables without rebuilding the whole SCSS.
+
+## groups required with Authenticator.manage_groups
+
+Setting `Authenticator.manage_groups = True` allows the Authenticator to manage group membership by returning `groups` from the authentication model.
+However, this option is available even on Authenticators that do not support it, which led to confusion.
+Starting with JupyterHub 5, if `manage_groups` is True `authenticate` _must_ return a groups field, otherwise an error is raised.
+This prevents confusion when users enable managed groups that is not implemented.
+
+If an Authenticator _does_ support managing groups but was not providing a `groups` field in order to leave membership unmodified, it must specify `"groups": None` to make this explicit instead of implicit (this is backward-compatible).

docs/source/howto/upgrading.md

@@ -0,0 +1,149 @@
+(upgrading-jupyterhub)=
+
+# Upgrading JupyterHub
+
+JupyterHub offers easy upgrade pathways between minor versions. This
+document describes how to do these upgrades.
+
+If you are using {ref}`a JupyterHub distribution <index/distributions>`, you
+should consult the distribution's documentation on how to upgrade. This documentation is
+for those who have set up their JupyterHub without using a distribution.
+
+This documentation is lengthy because it is quite detailed. Most likely, upgrading
+JupyterHub is painless, quick and with minimal user interruption.
+
+The steps are discussed in detail, so if you get stuck at any step you can always refer to this guide.
+
+For specific version migrations:
+
+```{toctree}
+:maxdepth: 1
+
+./upgrading-v5
+```
+
+## Read the Changelog
+
+The [changelog](changelog) contains information on what has
+changed with the new JupyterHub release and any deprecation warnings.
+Read these notes to familiarize yourself with the coming changes. There
+might be new releases of the authenticators & spawners you use, so
+read the changelogs for those too!
+
+## Notify your users
+
+If you use the default configuration where `configurable-http-proxy`
+is managed by JupyterHub, your users will see service disruption during
+the upgrade process. You should notify them, and pick a time to do the
+upgrade where they will be least disrupted.
+
+If you use a different proxy or run `configurable-http-proxy`
+independent of JupyterHub, your users will be able to continue using notebook
+servers they had already launched, but will not be able to launch new servers or sign in.
+
+## Backup database & config
+
+Before doing an upgrade, it is critical to back up:
+
+1. Your JupyterHub database (SQLite by default, or MySQL / Postgres if you used those).
+   If you use SQLite (the default), you should backup the `jupyterhub.sqlite` file.
+2. Your `jupyterhub_config.py` file.
+3. Your users' home directories. This is unlikely to be affected directly by
+   a JupyterHub upgrade, but we recommend a backup since user data is critical.
+
+## Shut down JupyterHub
+
+Shut down the JupyterHub process. This would vary depending on how you
+have set up JupyterHub to run. It is most likely using a process
+supervisor of some sort (`systemd` or `supervisord` or even `docker`).
+Use the supervisor-specific command to stop the JupyterHub process.
+
+## Upgrade JupyterHub packages
+
+There are two environments where the `jupyterhub` package is installed:
+
+1. The _hub environment_: where the JupyterHub server process
+   runs. This is started with the `jupyterhub` command, and is what
+   people generally think of as JupyterHub.
+2. The _notebook user environments_: where the user notebook
+   servers are launched from, and is probably custom to your own
+   installation. This could be just one environment (different from the
+   hub environment) that is shared by all users, one environment
+   per user, or the same environment as the hub environment. The hub
+   launched the `jupyterhub-singleuser` command in this environment,
+   which in turn starts the notebook server.
+
+You need to make sure the version of the `jupyterhub` package matches
+in both these environments. If you installed `jupyterhub` with pip,
+you can upgrade it with:
+
+```bash
+python3 -m pip install --upgrade jupyterhub==<version>
+```
+
+Where `<version>` is the version of JupyterHub you are upgrading to.
+
+If you used `conda` to install `jupyterhub`, you should upgrade it
+with:
+
+```bash
+conda install -c conda-forge jupyterhub==<version>
+```
+
+You should also check for new releases of the authenticator & spawner you
+are using. You might wish to upgrade those packages, too, along with JupyterHub
+or upgrade them separately.
+
+## Upgrade JupyterHub database
+
+Once new packages are installed, you need to upgrade the JupyterHub
+database. From the hub environment, in the same directory as your
+`jupyterhub_config.py` file, you should run:
+
+```bash
+jupyterhub upgrade-db
+```
+
+This should find the location of your database, and run the necessary upgrades
+for it.
+
+### SQLite database disadvantages
+
+SQLite has some disadvantages when it comes to upgrading JupyterHub. These
+are:
+
+- `upgrade-db` may not work, and you may need to delete your database
+  and start with a fresh one.
+- `downgrade-db` **will not** work if you want to rollback to an
+  earlier version, so backup the `jupyterhub.sqlite` file before
+  upgrading.
+
+### What happens if I delete my database?
+
+Losing the Hub database is often not a big deal. Information that
+resides only in the Hub database includes:
+
+- active login tokens (user cookies, service tokens)
+- users added via JupyterHub UI, instead of config files
+- info about running servers
+
+If the following conditions are true, you should be fine clearing the
+Hub database and starting over:
+
+- users specified in the config file, or login using an external
+  authentication provider (Google, GitHub, LDAP, etc)
+- user servers are stopped during the upgrade
+- don't mind causing users to log in again after the upgrade
+
+## Start JupyterHub
+
+Once the database upgrade is completed, start the `jupyterhub`
+process again.
+
+1. Log in and start the server to make sure things work as
+   expected.
+2. Check the logs for any errors or deprecation warnings. You
+   might have to update your `jupyterhub_config.py` file to
+   deal with any deprecated options.
+
+Congratulations, your JupyterHub has been upgraded!

docs/source/index-about.rst

@@ -1,15 +0,0 @@
-=====
-About
-=====
-
-JupyterHub is an open source project and community. It is a part of the
-`Jupyter Project <https://jupyter.org>`_. JupyterHub is an open and inclusive
-community, and invites contributions from anyone. This section covers information
-about our community, as well as ways that you can connect and get involved.
-
-.. toctree::
-   :maxdepth: 1
-
-   contributor-list
-   changelog
-   gallery-jhub-deployments

docs/source/index-admin.rst

@@ -1,15 +0,0 @@
-=====================
-Administrator's Guide
-=====================
-
-This guide covers best-practices, tips, common questions and operations, as
-well as other information relevant to running your own JupyterHub over time.
-
-.. toctree::
-   :maxdepth: 2
-
-   troubleshooting
-   admin/capacity-planning
-   admin/upgrading
-   admin/log-messages
-   changelog

docs/source/index.md

@@ -0,0 +1,137 @@
+# JupyterHub
+
+[JupyterHub] is the best way to serve [Jupyter notebook] for multiple users.
+Because JupyterHub manages a separate Jupyter environment for each user,
+it can be used in a class of students, a corporate data science group, or a scientific
+research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
+instances of the single-user [Jupyter notebook] server.
+
+(index/distributions)=
+
+## Distributions
+
+JupyterHub can be used in a collaborative environment by both small (0-100 users) and
+large teams (more than 100 users) such as a class of students, corporate data science group
+or scientific research group.
+It has two main distributions which are developed to serve the needs of each of these teams respectively.
+
+1. [The Littlest JupyterHub](https://github.com/jupyterhub/the-littlest-jupyterhub) distribution is suitable if you need a small number of users (1-100) and a single server with a simple environment.
+2. [Zero to JupyterHub with Kubernetes](https://github.com/jupyterhub/zero-to-jupyterhub-k8s) allows you to deploy dynamic servers on the cloud if you need even more users.
+   This distribution runs JupyterHub on top of [Kubernetes](https://k8s.io).
+
+```{note}
+It is important to evaluate these distributions before you can continue with the
+configuration of JupyterHub.
+```
+
+## Subsystems
+
+JupyterHub is made up of four subsystems:
+
+- a **Hub** (tornado process) that is the heart of JupyterHub
+- a **configurable http proxy** (node-http-proxy) that receives the requests from the client's browser
+- multiple **single-user Jupyter notebook servers** (Python/IPython/tornado) that are monitored by Spawners
+- an **authentication class** that manages how users can access the system
+
+Additionally, optional configurations can be added through a `config.py` file and manage users
+kernels on an admin panel. A simplification of the whole system is displayed in the figure below:
+
+```{image} images/jhub-fluxogram.jpeg
+:align: center
+:alt: JupyterHub subsystems
+:width: 80%
+```
+
+JupyterHub performs the following functions:
+
+- The Hub launches a proxy
+- The proxy forwards all requests to the Hub by default
+- The Hub handles user login and spawns single-user servers on demand
+- The Hub configures the proxy to forward URL prefixes to the single-user
+  notebook servers
+
+For convenient administration of the Hub, its users, and services,
+JupyterHub also provides a {doc}`REST API <reference/rest-api>`.
+
+The JupyterHub team and Project Jupyter value our community, and JupyterHub
+follows the Jupyter [Community Guides](https://jupyter.readthedocs.io/en/latest/community/content-community.html).
+
+---
+
+## Documentation structure
+
+### Tutorials
+
+This section of the documentation contains step-by-step tutorials that help outline the capabilities of JupyterHub and how you can achieve specific aims, such as installing it. The tutorials are recommended if you do not have much experience with JupyterHub.
+
+```{toctree}
+:maxdepth: 2
+
+tutorial/index.md
+```
+
+### How-to guides
+
+The _How-to_ guides provide more in-depth details than the tutorials. They are recommended for those already familiar with JupyterHub and have a specific goal. The guides help answer the question _"How do I ...?"_ based on a particular topic.
+
+```{toctree}
+:maxdepth: 2
+
+howto/index.md
+```
+
+### Explanation
+
+The _Explanation_ section provides further details that can be used to better understand JupyterHub, such as how it can be used and configured. They are intended for those seeking to expand their knowledge of JupyterHub.
+
+```{toctree}
+:maxdepth: 2
+
+explanation/index.md
+```
+
+### Reference
+
+The _Reference_ section provides technical information about JupyterHub, such as monitoring the state of your installation and working with JupyterHub's API modules and classes.
+
+```{toctree}
+:maxdepth: 2
+
+reference/index.md
+```
+
+### Frequently asked questions
+
+Find answers to the most frequently asked questions about JupyterHub such as how to troubleshoot an issue.
+
+```{toctree}
+:maxdepth: 2
+
+faq/index.md
+```
+
+### Contributing
+
+JupyterHub welcomes all contributors, whether you are new to the project or know your way around. The _Contributing_ section provides information on how you can make your contributions.
+
+```{toctree}
+:maxdepth: 2
+
+contributing/index
+```
+
+---
+
+## Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`
+
+## Questions? Suggestions?
+
+All questions and suggestions are welcome. Please feel free to use our [Jupyter Discourse Forum](https://discourse.jupyter.org/) to contact our team.
+
+Looking forward to hearing from you!
+
+[jupyter notebook]: https://jupyter-notebook.readthedocs.io/en/latest/
+[jupyterhub]: https://github.com/jupyterhub/jupyterhub

docs/source/index.rst

@@ -1,161 +0,0 @@
-==========
-JupyterHub
-==========
-`JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users. 
-Because JupyterHub manages a separate Jupyter environment for each user,
-it can be used in a class of students, a corporate data science group, or a scientific
-research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
-instances of the single-user `Jupyter notebook`_ server.
-
-JupyterHub offers distributions for different use cases. As of now, you can find two main cases:
-
-1. `The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution is suitable if you need a small number of users (1-100) and a single server with a simple environment.
-2. `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ allows you to deploy dynamic servers on the cloud if you need even more users.
-
-
-JupyterHub can be used in a collaborative environment by both both small (0-100 users) and 
-large teams (more than 100 users) such as a class of students, corporate data science group 
-or scientific research group. It has distributions which are developed to serve the needs of 
-each of these teams respectively. 
-
-JupyterHub is made up of four subsystems:
-
-* a **Hub** (tornado process) that is the heart of JupyterHub
-* a **configurable http proxy** (node-http-proxy) that receives the requests from the client's browser
-* multiple **single-user Jupyter notebook servers** (Python/IPython/tornado) that are monitored by Spawners
-* an **authentication class** that manages how users can access the system
-
-Additionally, optional configurations can be added through a `config.py` file and manage users 
-kernels on an admin panel. A simplification of the whole system is displayed in the figure below:
-
-.. image:: images/jhub-fluxogram.jpeg
-   :alt: JupyterHub subsystems
-   :width: 80%
-   :align: center
-
-
-JupyterHub performs the following functions:
-
-- The Hub launches a proxy
-- The proxy forwards all requests to the Hub by default
-- The Hub handles user login and spawns single-user servers on demand
-- The Hub configures the proxy to forward URL prefixes to the single-user
-  notebook servers
-
-For convenient administration of the Hub, its users, and services,
-JupyterHub also provides a :doc:`REST API <reference/rest-api>`.
-
-The JupyterHub team and Project Jupyter value our community, and JupyterHub
-follows the Jupyter `Community Guides <https://jupyter.readthedocs.io/en/latest/community/content-community.html>`_.
-
-Contents
-========
-
-.. _index/distributions:
-
-Distributions
--------------
-
-A JupyterHub **distribution** is tailored 
-towards a particular set of use cases. These are generally easier 
-to set up than setting up JupyterHub from scratch, assuming they fit your use case.
-
-Today, you can find two main use cases:
-
-1. If you need a simple case for a small amount of users (0-100) and single server
-   take a look at
-   `The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution.
-2. If you need to allow for a larger number of machines and users, 
-   a dynamic amount of servers can be used on a cloud,
-   take a look at the `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ distribution.
-   This distribution runs JupyterHub on top of  `Kubernetes <https://k8s.io>`_.
-
-*It is important to evaluate these distributions before you can continue with the 
-configuration of JupyterHub*.
-
-Installation Guide
-------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   installation-guide
-
-Getting Started
----------------
-
-.. toctree::
-   :maxdepth: 2
-
-   getting-started/index
-
-Technical Reference
--------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   reference/index
-
-Administrators guide
---------------------
-
-.. toctree::
-   :maxdepth: 2
-
-   index-admin
-
-API Reference
--------------
-
-.. toctree::
-   :maxdepth: 2
-
-   api/index
-
-RBAC Reference
---------------
-
-.. toctree::
-   :maxdepth: 2
-
-   rbac/index
-
-Contributing
-------------
-
-We welcome you to contribute to JupyterHub in ways that are most exciting
-& useful to you. We value documentation, testing, bug reporting & code equally
-and are glad to have your contributions in whatever form you wish :)
-
-Our `Code of Conduct <https://github.com/jupyter/governance/blob/HEAD/conduct/code_of_conduct.md>`_ and `reporting guidelines <https://github.com/jupyter/governance/blob/HEAD/conduct/reporting_online.md>`_
-help keep our community welcoming to as many people as possible.
-
-.. toctree::
-   :maxdepth: 2
-
-   contributing/index
-
-About JupyterHub
-----------------
-
-.. toctree::
-   :maxdepth: 2
-
-   index-about
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-
-
-Questions? Suggestions?
-=======================
-All questions and suggestions are welcome. Please feel free to use our `Jupyter Discourse Forum <https://discourse.jupyter.org/>`_ to contact our team.
-
-Looking forward to hearing from you!
-
-.. _JupyterHub: https://github.com/jupyterhub/jupyterhub
-.. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/

docs/source/installation-guide-hard.md

@@ -0,0 +1,7 @@
+---
+orphan: true
+---
+
+# JupyterHub the hard way
+
+This guide has moved to <https://github.com/jupyterhub/jupyterhub-the-hard-way/blob/HEAD/docs/installation-guide-hard.md>

docs/source/installation-guide-hard.rst

@@ -1,6 +0,0 @@
-:orphan:
-
-JupyterHub the hard way
-=======================
-
-This guide has moved to https://github.com/jupyterhub/jupyterhub-the-hard-way/blob/HEAD/docs/installation-guide-hard.md

docs/source/installation-guide.rst

@@ -1,13 +0,0 @@
-Installation
-============
-
-These sections cover how to get up-and-running with JupyterHub. They cover
-some basics of the tools needed to deploy JupyterHub as well as how to get it
-running on your own infrastructure.
-
-.. toctree::
-   :maxdepth: 3
-
-   quickstart
-   quickstart-docker
-   installation-basics

docs/source/quickstart-docker.rst

@@ -1,69 +0,0 @@
-Install JupyterHub with Docker
-==============================
-
-
-The JupyterHub `docker image <https://hub.docker.com/r/jupyterhub/jupyterhub/>`_ is the fastest way to set up Jupyterhub in your local development environment.
-
-.. note::
-    This ``jupyterhub/jupyterhub`` docker image is only an image for running
-    the Hub service itself. It does not provide the other Jupyter components,
-    such as Notebook installation, which are needed by the single-user servers.
-    To run the single-user servers, which may be on the same system as the Hub or
-    not, `JupyterLab <https://jupyterlab.readthedocs.io/>`_ or Jupyter Notebook must be installed.
-
-
-.. important::
-    We strongly recommend that you follow the `Zero to JupyterHub`_ tutorial to
-    install JupyterHub.
-   
-   
-Prerequisites
--------------
-You should have `Docker`_ installed on a Linux/Unix based system.
-
-
-Run the Docker Image
---------------------
-
-To pull the latest JupyterHub image and start the `jupyterhub` container, run this command in your terminal.
-::
-   
-    docker run -d -p 8000:8000 --name jupyterhub jupyterhub/jupyterhub jupyterhub
-
-
-This command exposes the Jupyter container on port:8000. Navigate to `http://localhost:8000` in a web browser to access the JupyterHub console.
-
-You can stop and resume the container by running `docker stop` and `docker start` respectively.
-::
-
-    # find the container id
-    docker ps
-
-    # stop the running container
-    docker stop  <container-id>
-
-    # resume the paused container
-    docker start <container-id>
-
-
-If you want to run docker on a computer that has a public IP then you should
-(as in MUST) **secure it with ssl** by adding ssl options to your docker
-configuration or using an ssl enabled proxy.
-
-`Mounting volumes <https://docs.docker.com/engine/admin/volumes/volumes/>`_ 
-enables you to persist and store the data generated by the docker container, even when you stop the container. 
-The persistent data can be stored on the host system, outside the container.
-
-
-Create System Users
--------------------
-
-Spawn a root shell in your docker container by running this command in the terminal.::
-
-    docker exec -it jupyterhub bash
-
-The created accounts will be used for authentication in JupyterHub's default
-configuration.
-
-.. _Zero to JupyterHub: https://zero-to-jupyterhub.readthedocs.io/en/latest/
-.. _Docker: https://www.docker.com/

docs/source/rbac/generate-scope-table.py

@@ -13,6 +13,7 @@ The files are:
        This file is JupyterHub's REST API schema. Both a version and the RBAC
        scopes descriptions are updated in it.
 """
+
 import os
 from collections import defaultdict
 from pathlib import Path

docs/source/rbac/index.md

@@ -1,4 +1,9 @@
-(RBAC)=
+<!---
+RBAC docs are part of the Explanation section of the JupyterHub documentation.
+As a result, this index file is referenced in the toctree within the explanation/index.md file.
+--->
+
+(rbac)=
 
 # JupyterHub RBAC
 

docs/source/rbac/scopes.md

@@ -1,8 +1,10 @@
+(jupyterhub-scopes)=
+
 # Scopes in JupyterHub
 
 A scope has a syntax-based design that reveals which resources it provides access to. Resources are objects with a type, associated data, relationships to other resources, and a set of methods that operate on them (see [RESTful API](https://restful-api-design.readthedocs.io/en/latest/resources.html) documentation for more information).
 
-`<resource>` in the RBAC scope design refers to the resource name in the [JupyterHub's API](../reference/rest-api.rst) endpoints in most cases. For instance, `<resource>` equal to `users` corresponds to JupyterHub's API endpoints beginning with _/users_.
+`<resource>` in the RBAC scope design refers to the resource name in the [JupyterHub's API](jupyterhub-rest-API) endpoints in most cases. For instance, `<resource>` equal to `users` corresponds to JupyterHub's API endpoints beginning with _/users_.
 
 (scope-conventions-target)=
 
@@ -176,6 +178,57 @@ Note that only the {ref}`horizontal filtering <horizontal-filtering-target>` can
 Metascopes `self` and `all`, `<resource>`, `<resource>:<subresource>`, `read:<resource>`, `admin:<resource>`, and `access:<resource>` scopes are predefined and cannot be changed otherwise.
 ```
 
+(access-scopes)=
+
+### Access scopes
+
+An **access scope** is used to govern _access_ to a JupyterHub service or a user's single-user server.
+This means making API requests, or visiting via a browser using OAuth.
+Without the appropriate access scope, a user or token should not be permitted to make requests of the service.
+
+When you attempt to access a service or server authenticated with JupyterHub, it will begin the [oauth flow](jupyterhub-oauth) for issuing a token that can be used to access the service.
+If the user does not have the access scope for the relevant service or server, JupyterHub will not permit the oauth process to complete.
+If oauth completes, the token will have at least the access scope for the service.
+For minimal permissions, this is the _only_ scope granted to tokens issued during oauth by default,
+but can be expanded via {attr}`.Spawner.oauth_client_allowed_scopes` or a service's [`oauth_client_allowed_scopes`](service-credentials) configuration.
+
+:::{seealso}
+[Further explanation of OAuth in JupyterHub](jupyterhub-oauth)
+:::
+
+If a given service or single-user server can be governed by a single boolean "yes, you can use this service" or "no, you can't," or limiting via other existing scopes, access scopes are enough to manage access to the service.
+But you can also further control granular access to servers or services with [custom scopes](custom-scopes), to limit access to particular APIs within the service, e.g. read-only access.
+
+#### Example access scopes
+
+Some example access scopes for services:
+
+access:services
+: access to all services
+
+access:services!service=somename
+: access to the service named `somename`
+
+and for user servers:
+
+access:servers
+: access to all user servers
+
+access:servers!user
+: access to all of a user's _own_ servers (never in _resolved_ scopes, but may be used in configuration)
+
+access:servers!user=name
+: access to all of `name`'s servers
+
+access:servers!group=groupname
+: access to all servers owned by a user in the group `groupname`
+
+access:servers!server
+: access to only the issuing server (only relevant when applied to oauth tokens associated with a particular server, e.g. via the {attr}`Spawner.oauth_client_allowed_scopes` configuration.
+
+access:servers!server=username/
+: access to only `username`'s _default_ server.
+
 (custom-scopes)=
 
 ### Custom scopes
@@ -296,8 +349,24 @@ class MyHandler(HubOAuthenticated, BaseHandler):
 Existing scope filters (`!user=`, etc.) may be applied to custom scopes.
 Custom scope _filters_ are NOT supported.
 
+:::{warning}
+JupyterHub allows you to define custom scopes,
+but it does not enforce that your services apply them.
+
+For example, if you enable read-only access to servers via custom JupyterHub
+(as seen in the `read-only` example),
+it is the administrator's responsibility to enforce that they are applied.
+If you allow users to launch servers without that custom Authorizer,
+read-only permissions will not be enforced, and the default behavior of unrestricted access via the `access:servers` scope will be applied.
+:::
+
 ### Scopes and APIs
 
-The scopes are also listed in the [](../reference/rest-api.rst) documentation. Each API endpoint has a list of scopes which can be used to access the API; if no scopes are listed, the API is not authenticated and can be accessed without any permissions (i.e., no scopes).
+The scopes are also listed in the [](jupyterhub-rest-API) documentation.
+Each API endpoint has a list of scopes which can be used to access the API;
+if no scopes are listed, the API is not authenticated and can be accessed without any permissions (i.e., no scopes).
 
-Listed scopes by each API endpoint reflect the "lowest" permissions required to gain any access to the corresponding API. For example, posting user's activity (_POST /users/:name/activity_) needs `users:activity` scope. If scope `users` is passed during the request, the access will be granted as the required scope is a subscope of the `users` scope. If, on the other hand, `read:users:activity` scope is passed, the access will be denied.
+Listed scopes by each API endpoint reflect the "lowest" permissions required to gain any access to the corresponding API.
+For example, posting user's activity (_POST /users/:name/activity_) needs `users:activity` scope.
+If scope `users` is held by the request, the access will be granted as the required scope is a subscope of the `users` scope.
+If, on the other hand, `read:users:activity` scope is the only scope held, the request will be denied.