release 1.4.0

more changelog for 1.4

.circleci/config.yml

@@ -1,75 +0,0 @@
-# Python CircleCI 2.0 configuration file
-# Updating CircleCI configuration from v1 to v2
-# Check https://circleci.com/docs/2.0/language-python/ for more details
-#
-version: 2
-jobs:
-  build:
-    machine: true
-    steps:
-      - checkout
-      - run:
-          name: build images
-          command: |
-            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
-      - run:
-          name: smoke test jupyterhub
-          command: |
-            docker run --rm -it jupyterhub/jupyterhub jupyterhub --help
-
-  docs:
-    # This is the base environment that Circle will use
-    docker:
-      - image: circleci/python:3.6-stretch
-    steps:
-      # Get our data and merge with upstream
-      - run: sudo apt-get update
-      - checkout
-      # Update our path
-      - run: echo "export PATH=~/.local/bin:$PATH" >> $BASH_ENV
-      # Restore cached files to speed things up
-      - restore_cache:
-          keys:
-            - cache-pip
-      # Install the packages needed to build our documentation
-      - run:
-          name: Install NodeJS
-          command: |
-            # From https://github.com/nodesource/distributions/blob/master/README.md#debinstall
-            curl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash -
-            sudo apt-get install -y nodejs
-
-      - run:
-          name: Install dependencies
-          command: |
-            python3 -m pip install --user -r dev-requirements.txt
-            python3 -m pip install --user -r docs/requirements.txt
-            sudo npm install -g configurable-http-proxy
-            sudo python3 -m pip install --editable .
-
-      # Cache some files for a speedup in subsequent builds
-      - save_cache:
-          key: cache-pip
-          paths:
-            - ~/.cache/pip
-      # Build the docs
-      - run:
-          name: Build docs to store
-          command: |
-            cd docs
-            make html
-      # Tell Circle to store the documentation output in a folder that we can access later
-      - store_artifacts:
-          path: docs/build/html/
-          destination: html
-
-# Tell CircleCI to use this workflow when it builds the site
-workflows:
-  version: 2
-  default:
-    jobs:
-      - build
-      - docs

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,39 +0,0 @@
----
-name: Issue report
-about: Create a report to help us improve
-
----
-
-<!---
-Hi! Thanks for using JupyterHub.
-
-If you are reporting an issue with JupyterHub, please use the GitHub search feature to check if your issue has been asked already. If it has, please add your comments to the existing issue.
-
-Some tips:
-- Running `jupyter troubleshoot` from the command line, if possible, and posting
-its output would also be helpful.
-- Running JupyterHub in `--debug` mode (`jupyterhub --debug`) can also be helpful for troubleshooting.
---->
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-<!---Add description here--->
-
-**To Reproduce**
-<!---
-Please share the steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
---->
-
-**Expected behavior**
-<!---
-A clear and concise description of what you expected to happen.
---->
-
-**Compute Information**
- - Operating System
- - JupyterHub Version [e.g. 22]

.github/ISSUE_TEMPLATE/installation-and-configuration-issues.md

@@ -1,22 +0,0 @@
----
-name: Installation and configuration questions
-about: Installation and configuration assistance
-
----
-
-<!---
-If you are reading this message, you have probably already searched the existing
-GitHub issues for JupyterHub. If you haven't tried a search, we encourage you to do so.
-
-If you are unsure where to ask your question (Jupyter, JupyterHub, JupyterLab, etc.),
-please ask on our [Discourse Q&A channel](https://discourse.jupyter.org/c/questions).
-
-If you have a quick question about JupyterHub installation or configuratation, you
-may ask on the [JupyterHub gitter channel](https://gitter.im/jupyterhub/jupyterhub).
-
-:sunny: Please be patient. We are volunteers and will address your question when we are able. :sunny:
-
-If after trying the above steps, you still have an in-depth installation or
-configuration question, such as a possible bug, please file an issue below and include
-any relevant details.
---->

.github/workflows/release.yml

@@ -0,0 +1,180 @@
+# Build releases and (on tags) publish to PyPI
+name: Release
+
+# always build releases (to make sure wheel-building works)
+# but only publish to PyPI on tags
+on:
+  push:
+  pull_request:
+
+jobs:
+  build-release:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "14"
+
+      - name: install build package
+        run: |
+          pip install --upgrade pip
+          pip install build
+          pip freeze
+
+      - name: build release
+        run: |
+          python -m build --sdist --wheel .
+          ls -l dist
+
+      - name: verify wheel
+        run: |
+          cd dist
+          pip install ./*.whl
+          # verify data-files are installed where they are found
+          cat <<EOF | python
+          import os
+          from jupyterhub._data import DATA_FILES_PATH
+          print(f"DATA_FILES_PATH={DATA_FILES_PATH}")
+          assert os.path.exists(DATA_FILES_PATH), DATA_FILES_PATH
+          for subpath in (
+              "templates/page.html",
+              "static/css/style.min.css",
+              "static/components/jquery/dist/jquery.js",
+          ):
+              path = os.path.join(DATA_FILES_PATH, subpath)
+              assert os.path.exists(path), path
+          print("OK")
+          EOF
+
+      # ref: https://github.com/actions/upload-artifact#readme
+      - uses: actions/upload-artifact@v2
+        with:
+          name: jupyterhub-${{ github.sha }}
+          path: "dist/*"
+          if-no-files-found: error
+
+      - name: Publish to PyPI
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          pip install twine
+          twine upload --skip-existing dist/*
+
+  publish-docker:
+    runs-on: ubuntu-20.04
+
+    services:
+      # So that we can test this in PRs/branches
+      local-registry:
+        image: registry:2
+        ports:
+          - 5000:5000
+
+    steps:
+      - name: Should we push this image to a public registry?
+        run: |
+          if [ "${{ startsWith(github.ref, 'refs/tags/') || (github.ref == 'refs/heads/master') }}" = "true" ]; then
+              # Empty => Docker Hub
+              echo "REGISTRY=" >> $GITHUB_ENV
+          else
+              echo "REGISTRY=localhost:5000/" >> $GITHUB_ENV
+          fi
+
+      - uses: actions/checkout@v2
+
+      # Setup docker to build for multiple platforms (requires qemu).
+      # See:
+      # https://github.com/docker/build-push-action/tree/v2.3.0#usage
+      # https://github.com/docker/build-push-action/blob/v2.3.0/docs/advanced/multi-platform.md
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+        with:
+          # Allows pushing to registry on localhost:5000
+          driver-opts: network=host
+
+      # https://github.com/docker/login-action/tree/v1.8.0#docker-hub
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        if: env.REGISTRY != 'localhost:5000/'
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      # https://github.com/jupyterhub/action-major-minor-tag-calculator
+      # If this is a tagged build this will return additional parent tags.
+      # E.g. 1.2.3 is expanded to Docker tags
+      # [{prefix}:1.2.3, {prefix}:1.2, {prefix}:1, {prefix}:latest] unless
+      # this is a backported tag in which case the newer tags aren't updated.
+      # For branches this will return the branch name.
+      # 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@v1
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          prefix: "${{ env.REGISTRY }}jupyterhub/jupyterhub:"
+          defaultTag: "${{ env.REGISTRY }}jupyterhub/jupyterhub:noref"
+
+      - name: Build and push jupyterhub
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          # tags parameter must be a string input so convert `gettags` JSON
+          # array into a comma separated list of tags
+          tags: ${{ join(fromJson(steps.jupyterhubtags.outputs.tags)) }}
+
+      # jupyterhub-onbuild
+
+      - name: Get list of jupyterhub-onbuild tags
+        id: onbuildtags
+        uses: jupyterhub/action-major-minor-tag-calculator@v1
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          prefix: "${{ env.REGISTRY }}jupyterhub/jupyterhub-onbuild:"
+          defaultTag: "${{ env.REGISTRY }}jupyterhub/jupyterhub-onbuild:noref"
+
+      - name: Build and push jupyterhub-onbuild
+        uses: docker/build-push-action@v2
+        with:
+          build-args: |
+            BASE_IMAGE=${{ fromJson(steps.jupyterhubtags.outputs.tags)[0] }}
+          context: onbuild
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ join(fromJson(steps.onbuildtags.outputs.tags)) }}
+
+      # jupyterhub-demo
+
+      - name: Get list of jupyterhub-demo tags
+        id: demotags
+        uses: jupyterhub/action-major-minor-tag-calculator@v1
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          prefix: "${{ env.REGISTRY }}jupyterhub/jupyterhub-demo:"
+          defaultTag: "${{ env.REGISTRY }}jupyterhub/jupyterhub-demo:noref"
+
+      - name: Build and push jupyterhub-demo
+        uses: docker/build-push-action@v2
+        with:
+          build-args: |
+            BASE_IMAGE=${{ fromJson(steps.onbuildtags.outputs.tags)[0] }}
+          context: demo-image
+          # linux/arm64 currently fails:
+          # ERROR: Could not build wheels for argon2-cffi which use PEP 517 and cannot be installed directly
+          # ERROR: executor failed running [/bin/sh -c python3 -m pip install notebook]: exit code: 1
+          platforms: linux/amd64
+          push: true
+          tags: ${{ join(fromJson(steps.demotags.outputs.tags)) }}

.github/workflows/test.yml

@@ -0,0 +1,246 @@
+# This is a GitHub workflow defining a set of jobs with a set of steps.
+# ref: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions
+#
+name: Test
+
+# Trigger the workflow's on all PRs but only on pushed tags or commits to
+# main/master branch to avoid PRs developed in a GitHub fork's dedicated branch
+# to trigger.
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+
+defaults:
+  run:
+    # Declare bash be used by default in this workflow's "run" steps.
+    #
+    # NOTE: bash will by default run with:
+    #   --noprofile: Ignore ~/.profile etc.
+    #   --norc:      Ignore ~/.bashrc etc.
+    #   -e:          Exit directly on errors
+    #   -o pipefail: Don't mask errors from a command piped into another command
+    shell: bash
+
+env:
+  # UTF-8 content may be interpreted as ascii and causes errors without this.
+  LANG: C.UTF-8
+
+jobs:
+  # Run "pre-commit run --all-files"
+  pre-commit:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 2
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      # ref: https://github.com/pre-commit/action
+      - uses: pre-commit/action@v2.0.0
+      - name: Help message if pre-commit fail
+        if: ${{ failure() }}
+        run: |
+          echo "You can install pre-commit hooks to automatically run formatting"
+          echo "on each commit with:"
+          echo "    pre-commit install"
+          echo "or you can run by hand on staged files with"
+          echo "    pre-commit run"
+          echo "or after-the-fact on already committed files with"
+          echo "    pre-commit run --all-files"
+
+  # Run "pytest jupyterhub/tests" in various configurations
+  pytest:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+
+    strategy:
+      # Keep running even if one variation of the job fail
+      fail-fast: false
+      matrix:
+        # We run this job multiple times with different parameterization
+        # specified below, these parameters have no meaning on their own and
+        # gain meaning on how job steps use them.
+        #
+        # subdomain:
+        #   Tests everything when JupyterHub is configured to add routes for
+        #   users with dedicated subdomains like user1.jupyter.example.com
+        #   rather than jupyter.example.com/user/user1.
+        #
+        # db: [mysql/postgres]
+        #   Tests everything when JupyterHub works against a dedicated mysql or
+        #   postgresql server.
+        #
+        # jupyter_server:
+        #   Tests everything when the user instances are started with
+        #   jupyter_server instead of notebook.
+        #
+        # ssl:
+        #   Tests everything using internal SSL connections instead of
+        #   unencrypted HTTP
+        #
+        # main_dependencies:
+        #   Tests everything when the we use the latest available dependencies
+        #   from: ipytraitlets.
+        #
+        # NOTE: Since only the value of these parameters are presented in the
+        #       GitHub UI when the workflow run, we avoid using true/false as
+        #       values by instead duplicating the name to signal true.
+        include:
+          - python: "3.6"
+            oldest_dependencies: oldest_dependencies
+          - python: "3.6"
+            subdomain: subdomain
+          - python: "3.7"
+            db: mysql
+          - python: "3.7"
+            ssl: ssl
+          - python: "3.8"
+            db: postgres
+          - python: "3.8"
+            jupyter_server: jupyter_server
+          - python: "3.9"
+            main_dependencies: main_dependencies
+
+    steps:
+      # NOTE: In GitHub workflows, environment variables are set by writing
+      #       assignment statements to a file. They will be set in the following
+      #       steps as if would used `export MY_ENV=my-value`.
+      - name: Configure environment variables
+        run: |
+          if [ "${{ matrix.subdomain }}" != "" ]; then
+              echo "JUPYTERHUB_TEST_SUBDOMAIN_HOST=http://localhost.jovyan.org:8000" >> $GITHUB_ENV
+          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
+          fi
+          if [ "${{ matrix.ssl }}" == "ssl" ]; then
+              echo "SSL_ENABLED=1" >> $GITHUB_ENV
+          fi
+          if [ "${{ matrix.db }}" == "postgres" ]; then
+              echo "PGHOST=127.0.0.1" >> $GITHUB_ENV
+              echo "PGUSER=test_user" >> $GITHUB_ENV
+              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
+          fi
+      - uses: actions/checkout@v2
+      # NOTE: actions/setup-node@v1 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@v1
+        with:
+          node-version: "14"
+      - name: Install Node dependencies
+        run: |
+          npm install
+          npm install -g configurable-http-proxy
+          npm list
+
+      # NOTE: actions/setup-python@v2 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@v2
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Install Python dependencies
+        run: |
+          pip install --upgrade pip
+          pip install --upgrade . -r dev-requirements.txt
+
+          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
+          fi
+
+          if [ "${{ matrix.main_dependencies }}" != "" ]; then
+              pip install git+https://github.com/ipython/traitlets#egg=traitlets --force
+          fi
+          if [ "${{ matrix.jupyter_server }}" != "" ]; then
+              pip uninstall notebook --yes
+              pip install jupyter_server
+          fi
+          if [ "${{ matrix.db }}" == "mysql" ]; then
+              pip install mysql-connector-python
+          fi
+          if [ "${{ matrix.db }}" == "postgres" ]; then
+              pip install psycopg2-binary
+          fi
+
+          pip freeze
+
+      # NOTE: If you need to debug this DB setup step, consider the following.
+      #
+      # 1. mysql/postgressql are database servers we start as docker containers,
+      #    and we use clients named mysql/psql.
+      #
+      # 2. When we start a database server we need to pass environment variables
+      #    explicitly as part of the `docker run` command. These environment
+      #    variables are named differently from the similarly named environment
+      #    variables used by the clients.
+      #
+      #    - mysql    server ref: https://hub.docker.com/_/mysql/
+      #    - mysql    client ref: https://dev.mysql.com/doc/refman/5.7/en/environment-variables.html
+      #    - postgres server ref: https://hub.docker.com/_/postgres/
+      #    - psql     client ref: https://www.postgresql.org/docs/9.5/libpq-envars.html
+      #
+      # 3. When we connect, they should use 127.0.0.1 rather than the
+      #    default way of connecting which leads to errors like below both for
+      #    mysql and postgresql unless we set MYSQL_HOST/PGHOST to 127.0.0.1.
+      #
+      #    - ERROR 2002 (HY000): Can't connect to local MySQL server through socket '/var/run/mysqld/mysqld.sock' (2)
+      #
+      - name: Start a database server (${{ matrix.db }})
+        if: ${{ matrix.db }}
+        run: |
+          if [ "${{ matrix.db }}" == "mysql" ]; then
+              sudo apt-get update
+              sudo apt-get install -y mysql-client
+              DB=mysql bash ci/docker-db.sh
+              DB=mysql bash ci/init-db.sh
+          fi
+          if [ "${{ matrix.db }}" == "postgres" ]; then
+              sudo apt-get update
+              sudo apt-get install -y postgresql-client
+              DB=postgres bash ci/docker-db.sh
+              DB=postgres bash ci/init-db.sh
+          fi
+
+      - name: Run pytest
+        # FIXME: --color=yes explicitly set because:
+        #        https://github.com/actions/runner/issues/241
+        run: |
+          pytest -v --maxfail=2 --color=yes --cov=jupyterhub jupyterhub/tests
+      - name: Submit codecov report
+        run: |
+          codecov
+
+  docker-build:
+    runs-on: ubuntu-20.04
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: build images
+        run: |
+          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
+        run: |
+          docker run --rm -t jupyterhub/jupyterhub jupyterhub --help
+
+      - name: verify static files
+        run: |
+          docker run --rm -t -v $PWD/dockerfiles:/io jupyterhub/jupyterhub python3 /io/test.py

.gitignore

@@ -24,5 +24,8 @@ MANIFEST
 .coverage.*
 htmlcov
 .idea/
+.vscode/
 .pytest_cache
 pip-wheel-metadata
+docs/source/reference/metrics.rst
+oldest-requirements.txt

.pre-commit-config.yaml

@@ -1,20 +1,24 @@
 repos:
-- repo: https://github.com/asottile/reorder_python_imports
-  rev: v1.8.0
-  hooks:
-  - id: reorder-python-imports
-    language_version: python3.6
-- repo: https://github.com/ambv/black
-  rev: 19.10b0
-  hooks:
-  - id: black
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v2.4.0
-  hooks:
-  - id: end-of-file-fixer
-  - id: check-json
-  - id: check-yaml
-  - id: check-case-conflict
-  - id: check-executables-have-shebangs
-  - id: requirements-txt-fixer
-  - id: flake8
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v1.9.0
+    hooks:
+      - id: reorder-python-imports
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.2.1
+    hooks:
+      - id: prettier
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: "3.8.4"
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer

.prettierignore

@@ -0,0 +1 @@
+share/jupyterhub/templates/

.travis.yml

@@ -1,94 +0,0 @@
-dist: bionic
-language: python
-cache:
-  - pip
-env:
-  global:
-    - MYSQL_HOST=127.0.0.1
-    - MYSQL_TCP_PORT=13306
-
-# request additional services for the jobs to access
-services:
-  - postgresql
-  - docker
-
-# install dependencies for running pytest (but not linting)
-before_install:
-  - set -e
-  - nvm install 6; nvm use 6
-  - npm install
-  - npm install -g configurable-http-proxy
-  - |
-    # setup database
-    if [[ $JUPYTERHUB_TEST_DB_URL == mysql* ]]; then
-      unset MYSQL_UNIX_PORT
-      DB=mysql bash ci/docker-db.sh
-      DB=mysql bash ci/init-db.sh
-      # FIXME: mysql-connector-python 8.0.16 incorrectly decodes bytes to str
-      # ref: https://bugs.mysql.com/bug.php?id=94944
-      pip install 'mysql-connector-python==8.0.11'
-    elif [[ $JUPYTERHUB_TEST_DB_URL == postgresql* ]]; then
-      psql -c "CREATE USER $PGUSER WITH PASSWORD '$PGPASSWORD';" -U postgres
-      DB=postgres bash ci/init-db.sh
-      pip install psycopg2-binary
-    fi
-
-# install general dependencies
-install:
-  - pip install --upgrade pip
-  - pip install --upgrade --pre -r dev-requirements.txt .
-  - pip freeze
-
-# run tests
-script:
-  - pytest -v --maxfail=2 --cov=jupyterhub jupyterhub/tests
-
-# collect test coverage information
-after_success:
-  - codecov
-
-# list the jobs
-jobs:
-  include:
-    - name: autoformatting check
-      python: 3.6
-      # NOTE: It does not suffice to override to: null, [], or [""]. Travis will
-      #       fall back to the default if we do.
-      before_install: echo "Do nothing before install."
-      script:
-        - pre-commit run --all-files
-      after_success: echo "Do nothing after success."
-      after_failure:
-        - |
-          echo "You can install pre-commit hooks to automatically run formatting"
-          echo "on each commit with:"
-          echo "    pre-commit install"
-          echo "or you can run by hand on staged files with"
-          echo "    pre-commit run"
-          echo "or after-the-fact on already committed files with"
-          echo "    pre-commit run --all-files"
-    # When we run pytest, we want to run it with python>=3.5 as well as with
-    # various configurations. We increment the python version at the same time
-    # as we test new configurations in order to reduce the number of test jobs.
-    - name: python:3.5 + dist:xenial
-      python: 3.5
-      dist: xenial
-    - name: python:3.6 + subdomain
-      python: 3.6
-      env: JUPYTERHUB_TEST_SUBDOMAIN_HOST=http://localhost.jovyan.org:8000
-    - name: python:3.7 + mysql
-      python: 3.7
-      env:
-        - JUPYTERHUB_TEST_DB_URL=mysql+mysqlconnector://root@127.0.0.1:$MYSQL_TCP_PORT/jupyterhub
-    - name: python:3.8 + postgresql
-      python: 3.8
-      env:
-        - PGUSER=jupyterhub
-        - PGPASSWORD=hub[test/:?
-        # The password in url below is url-encoded with: urllib.parse.quote($PGPASSWORD, safe='')
-        - JUPYTERHUB_TEST_DB_URL=postgresql://jupyterhub:hub%5Btest%2F%3A%3F@127.0.0.1/jupyterhub
-    - name: python:nightly
-      python: nightly
-  allow_failures:
-    - name: python:nightly
-  fast_finish: true

CHECKLIST-Release.md

@@ -2,24 +2,24 @@
 
 - [ ] Upgrade Docs prior to Release
 
-    - [ ] Change log
-    - [ ] New features documented
-    - [ ] Update the contributor list - thank you page
+  - [ ] Change log
+  - [ ] New features documented
+  - [ ] Update the contributor list - thank you page
 
 - [ ] Upgrade and test Reference Deployments
 
 - [ ] Release software
 
-    - [ ] Make sure 0 issues in milestone
-    - [ ] Follow release process steps
-    - [ ] Send builds to PyPI (Warehouse) and Conda Forge
+  - [ ] Make sure 0 issues in milestone
+  - [ ] Follow release process steps
+  - [ ] Send builds to PyPI (Warehouse) and Conda Forge
 
 - [ ] Blog post and/or release note
 
 - [ ] Notify users of release
 
-    - [ ] Email Jupyter and Jupyter In Education mailing lists
-    - [ ] Tweet (optional)
+  - [ ] Email Jupyter and Jupyter In Education mailing lists
+  - [ ] Tweet (optional)
 
 - [ ] Increment the version number for the next release
 

CONTRIBUTING.md

@@ -1,50 +1,58 @@
 # Contributing to JupyterHub
 
 Welcome! As a [Jupyter](https://jupyter.org) project,
-you can follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html).
+you can follow the [Jupyter contributor guide](https://jupyter.readthedocs.io/en/latest/contributing/content-contributor.html).
 
 Make sure to also follow [Project Jupyter's Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md)
 for a friendly and welcoming collaborative environment.
 
 ## Setting up a development environment
 
+<!--
+https://jupyterhub.readthedocs.io/en/stable/contributing/setup.html
+contains a lot of the same information. Should we merge the docs and
+just have this page link to that one?
+-->
+
 JupyterHub requires Python >= 3.5 and nodejs.
 
 As a Python project, a development install of JupyterHub follows standard practices for the basics (steps 1-2).
 
-
 1. clone the repo
-    ```bash
-    git clone https://github.com/jupyterhub/jupyterhub
-    ```
+   ```bash
+   git clone https://github.com/jupyterhub/jupyterhub
+   ```
 2. do a development install with pip
 
-    ```bash
-    cd jupyterhub
-    python3 -m pip install --editable .
-    ```
+   ```bash
+   cd jupyterhub
+   python3 -m pip install --editable .
+   ```
+
 3. install the development requirements,
    which include things like testing tools
 
-    ```bash
-    python3 -m pip install -r dev-requirements.txt
-    ```
+   ```bash
+   python3 -m pip install -r dev-requirements.txt
+   ```
+
 4. install configurable-http-proxy with npm:
 
-    ```bash
-    npm install -g configurable-http-proxy
-    ```
+   ```bash
+   npm install -g configurable-http-proxy
+   ```
+
 5. set up pre-commit hooks for automatic code formatting, etc.
 
-    ```bash
-    pre-commit install
-    ```
+   ```bash
+   pre-commit install
+   ```
 
-    You can also invoke the pre-commit hook manually at any time with
+   You can also invoke the pre-commit hook manually at any time with
 
-    ```bash
-    pre-commit run
-    ```
+   ```bash
+   pre-commit run
+   ```
 
 ## Contributing
 
@@ -60,12 +68,12 @@ pre-commit run
 
 which should run any autoformatting on your code
 and tell you about any errors it couldn't fix automatically.
-You may also install [black integration](https://github.com/ambv/black#editor-integration)
+You may also install [black integration](https://github.com/psf/black#editor-integration)
 into your text editor to format code automatically.
 
 If you have already committed files before setting up the pre-commit
 hook with `pre-commit install`, you can fix everything up using
-`pre-commit run --all-files`.  You need to make the fixing commit
+`pre-commit run --all-files`. You need to make the fixing commit
 yourself after that.
 
 ## Testing
@@ -128,4 +136,4 @@ To read more about fixtures check out the
 [pytest docs](https://docs.pytest.org/en/latest/fixture.html)
 for how to use the existing fixtures, and how to create new ones.
 
-When in doubt, feel free to ask.
+When in doubt, feel free to [ask](https://gitter.im/jupyterhub/jupyterhub).

COPYING.md

@@ -24,7 +24,7 @@ software without specific prior written permission.
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
@@ -46,8 +46,8 @@ Jupyter uses a shared copyright model. Each contributor maintains copyright
 over their contributions to Jupyter. But, it is important to note that these
 contributions are typically only changes to the repositories. Thus, the Jupyter
 source code, in its entirety is not the copyright of any single person or
-institution.  Instead, it is the collective copyright of the entire Jupyter
-Development Team.  If individual contributors want to maintain a record of what
+institution. Instead, it is the collective copyright of the entire Jupyter
+Development Team. If individual contributors want to maintain a record of what
 changes/contributions they have specific copyright on, they should indicate
 their copyright in the commit message of the change, when they commit the
 change to one of the Jupyter repositories.

Dockerfile

@@ -21,8 +21,7 @@
 # your jupyterhub_config.py will be added automatically
 # from your docker directory.
 
-# https://github.com/tianon/docker-brew-ubuntu-core/commit/d4313e13366d24a97bd178db4450f63e221803f1
-ARG BASE_IMAGE=ubuntu:bionic-20191029@sha256:6e9f67fa63b0323e9a1e587fd71c561ba48a034504fb804fd26fd8800039835d
+ARG BASE_IMAGE=ubuntu:focal-20200729
 FROM $BASE_IMAGE AS builder
 
 USER root
@@ -41,19 +40,18 @@ RUN apt-get update \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/*
 
-# copy only what we need to avoid unnecessary rebuilds
-COPY package.json \
-     pyproject.toml \
-     README.md \
-     requirements.txt \
-     setup.py \
-     /src/jupyterhub/
-COPY jupyterhub/ /src/jupyterhub/jupyterhub
-COPY share/ /src/jupyterhub/share
-
-WORKDIR /src/jupyterhub
 RUN python3 -m pip install --upgrade setuptools pip wheel
-RUN python3 -m pip wheel -v --wheel-dir wheelhouse .
+
+# 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
+
+# Build client component packages (they will be copied into ./share and
+# packaged with the built wheel.)
+RUN python3 setup.py bdist_wheel
+RUN python3 -m pip wheel --wheel-dir wheelhouse dist/*.whl
 
 
 FROM $BASE_IMAGE
@@ -90,7 +88,6 @@ RUN npm install -g configurable-http-proxy@^4.2.0 \
 
 # install the wheels we built in the first stage
 COPY --from=builder /src/jupyterhub/wheelhouse /tmp/wheelhouse
-COPY --from=builder /src/jupyterhub/share /src/jupyterhub/share
 RUN python3 -m pip install --no-cache /tmp/wheelhouse/*
 
 RUN mkdir -p /srv/jupyterhub/

README.md

@@ -6,14 +6,12 @@
 **[License](#license)** |
 **[Help and Resources](#help-and-resources)**
 
-
 # [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://www.npmjs.com/package/jupyterhub)
 [![Documentation build status](https://img.shields.io/readthedocs/jupyterhub?logo=read-the-docs)](https://jupyterhub.readthedocs.org/en/latest/)
-[![TravisCI build status](https://img.shields.io/travis/jupyterhub/jupyterhub/master?logo=travis)](https://travis-ci.org/jupyterhub/jupyterhub)
+[![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)
 [![CircleCI build status](https://img.shields.io/circleci/build/github/jupyterhub/jupyterhub?logo=circleci)](https://circleci.com/gh/jupyterhub/jupyterhub)<!-- CircleCI Token: b5b65862eb2617b9a8d39e79340b0a6b816da8cc -->
 [![Test coverage of code](https://codecov.io/gh/jupyterhub/jupyterhub/branch/master/graph/badge.svg)](https://codecov.io/gh/jupyterhub/jupyterhub)
@@ -53,17 +51,16 @@ for administration of the Hub and its users.
 
 ## Installation
 
-
 ### Check prerequisites
 
 - A Linux/Unix based system
 - [Python](https://www.python.org/downloads/) 3.5 or greater
 - [nodejs/npm](https://www.npmjs.com/)
 
-  * If you are using **`conda`**, the nodejs and npm dependencies will be installed for
+  - If you are using **`conda`**, the nodejs and npm dependencies will be installed for
     you by conda.
 
-  * If you are using **`pip`**, install a recent version of
+  - If you are using **`pip`**, install a recent version of
     [nodejs/npm](https://docs.npmjs.com/getting-started/installing-node).
     For example, install it on Linux (Debian/Ubuntu) using:
 
@@ -74,6 +71,7 @@ for administration of the Hub and its users.
     The `nodejs-legacy` package installs the `node` executable and is currently
     required for npm to work on Debian/Ubuntu.
 
+- If using the default PAM Authenticator, a [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module).
 - TLS certificate and key for HTTPS communication
 - Domain name
 
@@ -101,7 +99,7 @@ JupyterHub can be installed with `pip`, and the proxy with `npm`:
 
 ```bash
 npm install -g configurable-http-proxy
-python3 -m pip install jupyterhub    
+python3 -m pip install jupyterhub
 ```
 
 If you plan to run notebook servers locally, you will need to install the
@@ -119,10 +117,10 @@ To start the Hub server, run the command:
 Visit `https://localhost:8000` in your browser, and sign in with your unix
 PAM credentials.
 
-*Note*: To allow multiple users to sign into the server, you will need to
-run the `jupyterhub` command as a *privileged user*, such as root.
+_Note_: To allow multiple users to sign into the server, you will need to
+run the `jupyterhub` command as a _privileged user_, such as root.
 The [wiki](https://github.com/jupyterhub/jupyterhub/wiki/Using-sudo-to-run-JupyterHub-without-root-privileges)
-describes how to run the server as a *less privileged user*, which requires
+describes how to run the server as a _less privileged user_, which requires
 more configuration of the system.
 
 ## Configuration
@@ -141,7 +139,7 @@ To generate a default config file with settings and descriptions:
 
 ### Start the Hub
 
-To start the Hub on a specific url and port ``10.0.1.2:443`` with **https**:
+To start the Hub on a specific url and port `10.0.1.2:443` with **https**:
 
     jupyterhub --ip 10.0.1.2 --port 443 --ssl-key my_ssl.key --ssl-cert my_ssl.cert
 

ci/docker-db.sh

@@ -1,59 +1,60 @@
 #!/usr/bin/env bash
-# source this file to setup postgres and mysql
-# for local testing (as similar as possible to docker)
+# The goal of this script is to start a database server as a docker container.
+#
+# Required environment variables:
+# - DB: The database server to start, either "postgres" or "mysql".
+#
+# - PGUSER/PGPASSWORD: For the creation of a postgresql user with associated
+#   password.
 
 set -eu
 
-export MYSQL_HOST=127.0.0.1
-export MYSQL_TCP_PORT=${MYSQL_TCP_PORT:-13306}
-export PGHOST=127.0.0.1
-NAME="hub-test-$DB"
-DOCKER_RUN="docker run -d --name $NAME"
+# Stop and remove any existing database container
+DOCKER_CONTAINER="hub-test-$DB"
+docker rm -f "$DOCKER_CONTAINER" 2>/dev/null || true
 
-docker rm -f "$NAME" 2>/dev/null || true
+# Prepare environment variables to startup and await readiness of either a mysql
+# or postgresql server.
+if [[ "$DB" == "mysql" ]]; then
+    # Environment variables can influence both the mysql server in the docker
+    # container and the mysql client.
+    #
+    # ref server: https://hub.docker.com/_/mysql/
+    # ref client: https://dev.mysql.com/doc/refman/5.7/en/setting-environment-variables.html
+    #
+    DOCKER_RUN_ARGS="-p 3306:3306 --env MYSQL_ALLOW_EMPTY_PASSWORD=1 mysql:5.7"
+    READINESS_CHECK="mysql --user root --execute \q"
+elif [[ "$DB" == "postgres" ]]; then
+    # Environment variables can influence both the postgresql server in the
+    # docker container and the postgresql client (psql).
+    #
+    # ref server: https://hub.docker.com/_/postgres/
+    # ref client: https://www.postgresql.org/docs/9.5/libpq-envars.html
+    #
+    # POSTGRES_USER / POSTGRES_PASSWORD will create a user on startup of the
+    # postgres server, but PGUSER and PGPASSWORD are the environment variables
+    # used by the postgresql client psql, so we configure the user based on how
+    # we want to connect.
+    #
+    DOCKER_RUN_ARGS="-p 5432:5432 --env "POSTGRES_USER=${PGUSER}" --env "POSTGRES_PASSWORD=${PGPASSWORD}" postgres:9.5"
+    READINESS_CHECK="psql --command \q"
+else
+    echo '$DB must be mysql or postgres'
+    exit 1
+fi
 
-case "$DB" in
-"mysql")
-  RUN_ARGS="-e MYSQL_ALLOW_EMPTY_PASSWORD=1 -p $MYSQL_TCP_PORT:3306 mysql:5.7"
-  CHECK="mysql --host $MYSQL_HOST --port $MYSQL_TCP_PORT --user root -e \q"
-  ;;
-"postgres")
-  RUN_ARGS="-p 5432:5432 postgres:9.5"
-  CHECK="psql --user postgres -c \q"
-  ;;
-*)
-  echo '$DB must be mysql or postgres'
-  exit 1
-esac
-
-$DOCKER_RUN $RUN_ARGS
+# Start the database server
+docker run --detach --name "$DOCKER_CONTAINER" $DOCKER_RUN_ARGS
 
+# Wait for the database server to start
 echo -n "waiting for $DB "
 for i in {1..60}; do
-  if $CHECK; then
-    echo 'done'
-    break
-  else
-    echo -n '.'
-    sleep 1
-  fi
+    if $READINESS_CHECK; then
+        echo 'done'
+        break
+    else
+        echo -n '.'
+        sleep 1
+    fi
 done
-$CHECK
-
-case "$DB" in
-"mysql")
-  ;;
-"postgres")
-  # create the user
-  psql --user postgres -c "CREATE USER $PGUSER WITH PASSWORD '$PGPASSWORD';"
-  ;;
-*)
-esac
-
-echo -e "
-Set these environment variables:
-
-    export MYSQL_HOST=127.0.0.1
-    export MYSQL_TCP_PORT=$MYSQL_TCP_PORT
-    export PGHOST=127.0.0.1
-"
+$READINESS_CHECK

ci/init-db.sh

@@ -1,27 +1,26 @@
 #!/usr/bin/env bash
-# initialize jupyterhub databases for testing
+# The goal of this script is to initialize a running database server with clean
+# databases for use during tests.
+#
+# Required environment variables:
+# - DB: The database server to start, either "postgres" or "mysql".
 
 set -eu
 
-MYSQL="mysql --user root --host $MYSQL_HOST --port $MYSQL_TCP_PORT -e "
-PSQL="psql --user postgres -c "
-
-case "$DB" in
-"mysql")
-  EXTRA_CREATE='CHARACTER SET utf8 COLLATE utf8_general_ci'
-  SQL="$MYSQL"
-  ;;
-"postgres")
-  SQL="$PSQL"
-  ;;
-*)
-  echo '$DB must be mysql or postgres'
-  exit 1
-esac
+# Prepare env vars SQL_CLIENT and EXTRA_CREATE_DATABASE_ARGS
+if [[ "$DB" == "mysql" ]]; then
+    SQL_CLIENT="mysql --user root --execute "
+    EXTRA_CREATE_DATABASE_ARGS='CHARACTER SET utf8 COLLATE utf8_general_ci'
+elif [[ "$DB" == "postgres" ]]; then
+    SQL_CLIENT="psql --command "
+else
+    echo '$DB must be mysql or postgres'
+    exit 1
+fi
 
+# Configure a set of databases in the database server for upgrade tests
 set -x
-
 for SUFFIX in '' _upgrade_072 _upgrade_081 _upgrade_094; do
-    $SQL "DROP DATABASE jupyterhub${SUFFIX};" 2>/dev/null || true
-    $SQL "CREATE DATABASE jupyterhub${SUFFIX} ${EXTRA_CREATE:-};"
+    $SQL_CLIENT "DROP DATABASE jupyterhub${SUFFIX};" 2>/dev/null || true
+    $SQL_CLIENT "CREATE DATABASE jupyterhub${SUFFIX} ${EXTRA_CREATE_DATABASE_ARGS:-};"
 done

demo-image/Dockerfile

@@ -0,0 +1,16 @@
+# Demo JupyterHub Docker image
+#
+# 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
+FROM ${BASE_IMAGE}
+
+# Install the notebook package
+RUN python3 -m pip install notebook
+
+# Create a demo user
+RUN useradd --create-home demo
+RUN chown demo .
+
+USER demo

demo-image/README.md

@@ -0,0 +1,26 @@
+## Demo Dockerfile
+
+This is a demo JupyterHub Docker image to help you get a quick overview of what
+JupyterHub is and how it works.
+
+It uses the SimpleLocalProcessSpawner to spawn new user servers and
+DummyAuthenticator for authentication.
+The DummyAuthenticator allows you to log in with any username & password and the
+SimpleLocalProcessSpawner allows starting servers without having to create a
+local user for each JupyterHub user.
+
+### Important!
+
+This should only be used for demo or testing purposes!
+It shouldn't be used as a base image to build on.
+
+### Try it
+
+1. `cd` to the root of your jupyterhub repo.
+
+2. Build the demo image with `docker build -t jupyterhub-demo demo-image`.
+
+3. Run the demo image with `docker run -d -p 8000:8000 jupyterhub-demo`.
+
+4. Visit http://localhost:8000 and login with any username and password
+5. Happy demo-ing :tada:!

demo-image/jupyterhub_config.py

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

dev-requirements.txt

@@ -10,9 +10,9 @@ html5lib  # needed for beautifulsoup
 mock
 notebook
 pre-commit
+pytest>=3.3
 pytest-asyncio
 pytest-cov
-pytest>=3.3
 requests-mock
 # blacklist urllib3 releases affected by https://github.com/urllib3/urllib3/issues/1683
 # I *think* this should only affect testing, not production

dockerfiles/Dockerfile.alpine

@@ -1,9 +1,14 @@
-FROM python:3.6.3-alpine3.6
-
-ARG JUPYTERHUB_VERSION=0.8.1
-
-RUN pip3 install --no-cache jupyterhub==${JUPYTERHUB_VERSION}
+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,20 +1,20 @@
 ## What is Dockerfile.alpine
-Dockerfile.alpine  contains base image for jupyterhub. It does not work independently, but only as part of a full jupyterhub cluster
+
+Dockerfile.alpine contains base image for jupyterhub. It does not work independently, but only as part of a full jupyterhub cluster
 
 ## How to use it?
 
-1. A running configurable-http-proxy, whose API is accessible. 
+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 dummy authenticator for ease of testing. Update following in jupyterhub_config file
-    - c.JupyterHub.authenticator_class = 'dummyauthenticator.DummyAuthenticator'
-    - c.DummyAuthenticator.password = "your strong password"
+- 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 dummy authenticator for ease of testing. Update following in jupyterhub_config file
+  - c.JupyterHub.authenticator_class = 'dummyauthenticator.DummyAuthenticator'
+  - c.DummyAuthenticator.password = "your strong password"

dockerfiles/test.py

@@ -0,0 +1,9 @@
+import os
+
+from jupyterhub._data import DATA_FILES_PATH
+
+print(f"DATA_FILES_PATH={DATA_FILES_PATH}")
+
+for sub_path in ("templates", "static/components", "static/css/style.min.css"):
+    path = os.path.join(DATA_FILES_PATH, sub_path)
+    assert os.path.exists(path), path

docs/Makefile

@@ -48,6 +48,7 @@ help:
 	@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"
 
 clean:
 	rm -rf $(BUILDDIR)/*
@@ -60,7 +61,12 @@ rest-api: source/_static/rest-api/index.html
 source/_static/rest-api/index.html: rest-api.yml node_modules
 	npm run rest-api
 
-html: rest-api
+metrics: source/reference/metrics.rst
+
+source/reference/metrics.rst: generate-metrics.py
+	python3 generate-metrics.py
+
+html: rest-api metrics
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/environment.yml

@@ -1,20 +0,0 @@
-# ReadTheDocs uses the `environment.yaml` so make sure to update that as well
-# if you change the dependencies of JupyterHub in the various `requirements.txt`
-name: jhub_docs
-channels:
-  - conda-forge
-dependencies:
-- pip
-- nodejs
-- python=3.6
-- alembic
-- jinja2
-- pamela
-- recommonmark==0.6.0
-- requests
-- sqlalchemy>=1
-- tornado>=5.0
-- traitlets>=4.1
-- sphinx>=1.7
-- pip:
-  - -r requirements.txt

docs/generate-metrics.py

@@ -0,0 +1,57 @@
+import os
+from os.path import join
+
+from pytablewriter import RstSimpleTableWriter
+from pytablewriter.style import Style
+
+import jupyterhub.metrics
+
+HERE = os.path.abspath(os.path.dirname(__file__))
+
+
+class Generator:
+    @classmethod
+    def create_writer(cls, table_name, headers, values):
+        writer = RstSimpleTableWriter()
+        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):
+        table_rows = []
+        for name in dir(jupyterhub.metrics):
+            obj = getattr(jupyterhub.metrics, name)
+            if obj.__class__.__module__.startswith('prometheus_client.'):
+                for metric in obj.describe():
+                    table_rows.append([metric.type, metric.name, metric.documentation])
+        return table_rows
+
+    def prometheus_metrics(self):
+        generated_directory = f"{HERE}/source/reference"
+        if not os.path.exists(generated_directory):
+            os.makedirs(generated_directory)
+
+        filename = f"{generated_directory}/metrics.rst"
+        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}.")
+
+
+def main():
+    doc_generator = Generator()
+    doc_generator.prometheus_metrics()
+
+
+if __name__ == "__main__":
+    main()

docs/requirements.txt

@@ -1,10 +1,12 @@
-# ReadTheDocs uses the `environment.yaml` so make sure to update that as well
-# if you change this file
 -r ../requirements.txt
+
 alabaster_jupyterhub
-autodoc-traits
-git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
-recommonmark==0.5.0
+# Temporary fix of #3021. Revert back to released autodoc-traits when
+# 0.1.0 released.
+https://github.com/jupyterhub/autodoc-traits/archive/75885ee24636efbfebfceed1043459715049cd84.zip
+pydata-sphinx-theme
+pytablewriter>=0.56
+recommonmark>=0.6
+sphinx>=1.7
 sphinx-copybutton
 sphinx-jsonschema
-sphinx>=1.7

docs/rest-api.yml

@@ -1,13 +1,12 @@
 # see me at: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#/default
-swagger: '2.0'
+swagger: "2.0"
 info:
   title: JupyterHub
   description: The REST API for JupyterHub
-  version: 0.9.0dev
+  version: 1.4.0
   license:
     name: BSD-3-Clause
-schemes:
-  [http, https]
+schemes: [http, https]
 securityDefinitions:
   token:
     type: apiKey
@@ -28,7 +27,7 @@ paths:
         This endpoint is not authenticated for the purpose of clients and user
         to identify the JupyterHub version before setting up authentication.
       responses:
-        '200':
+        "200":
           description: The JupyterHub version
           schema:
             type: object
@@ -44,7 +43,7 @@ paths:
         JupyterHub's version and executable path,
         and which Authenticator and Spawner are active.
       responses:
-        '200':
+        "200":
           description: Detailed JupyterHub info
           schema:
             type: object
@@ -79,13 +78,28 @@ paths:
   /users:
     get:
       summary: List users
+      parameters:
+        - name: state
+          in: query
+          required: false
+          type: string
+          enum: ["inactive", "active", "ready"]
+          description: |
+            Return only users who have servers in the given state.
+            If unspecified, return all users.
+
+            active: all users with any active servers (ready OR pending)
+            ready: all users who have any ready servers (running, not pending)
+            inactive: all users who have *no* active servers (complement of active)
+
+            Added in JupyterHub 1.3
       responses:
-        '200':
+        "200":
           description: The Hub's user list
           schema:
             type: array
             items:
-              $ref: '#/definitions/User'
+              $ref: "#/definitions/User"
     post:
       summary: Create multiple users
       parameters:
@@ -104,13 +118,13 @@ paths:
                 description: whether the created users should be admins
                 type: boolean
       responses:
-        '201':
+        "201":
           description: The users have been created
           schema:
             type: array
             description: The created users
             items:
-              $ref: '#/definitions/User'
+              $ref: "#/definitions/User"
   /users/{name}:
     get:
       summary: Get a user by name
@@ -121,10 +135,10 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: The User model
           schema:
-            $ref: '#/definitions/User'
+            $ref: "#/definitions/User"
     post:
       summary: Create a single user
       parameters:
@@ -134,10 +148,10 @@ paths:
           required: true
           type: string
       responses:
-        '201':
+        "201":
           description: The user has been created
           schema:
-            $ref: '#/definitions/User'
+            $ref: "#/definitions/User"
     patch:
       summary: Modify a user
       description: Change a user's name or admin status
@@ -161,10 +175,10 @@ paths:
                 type: boolean
                 description: update admin (optional, if another key is updated i.e. name)
       responses:
-        '200':
+        "200":
           description: The updated user info
           schema:
-            $ref: '#/definitions/User'
+            $ref: "#/definitions/User"
     delete:
       summary: Delete a user
       parameters:
@@ -174,14 +188,12 @@ paths:
           required: true
           type: string
       responses:
-        '204':
+        "204":
           description: The user has been deleted
   /users/{name}/activity:
     post:
-      summary:
-        Notify Hub of activity for a given user.
-      description:
-        Notify the Hub of activity by the user,
+      summary: Notify Hub of activity for a given user.
+      description: Notify the Hub of activity by the user,
         e.g. accessing a service or (more likely)
         actively using a server.
       parameters:
@@ -209,7 +221,7 @@ paths:
                   The default server has an empty name ('').
                 type: object
                 properties:
-                  '<server name>':
+                  "<server name>":
                     description: |
                       Activity for a single server.
                     type: object
@@ -222,16 +234,16 @@ paths:
                         description: |
                           Timestamp of last-seen activity on this server.
             example:
-              last_activity: '2019-02-06T12:54:14Z'
+              last_activity: "2019-02-06T12:54:14Z"
               servers:
-                '':
-                  last_activity: '2019-02-06T12:54:14Z'
+                "":
+                  last_activity: "2019-02-06T12:54:14Z"
                 gpu:
-                  last_activity: '2019-02-06T12:54:14Z'
+                  last_activity: "2019-02-06T12:54:14Z"
       responses:
-        '401':
-          $ref: '#/responses/Unauthorized'
-        '404':
+        "401":
+          $ref: "#/responses/Unauthorized"
+        "404":
           description: No such user
   /users/{name}/server:
     post:
@@ -248,14 +260,17 @@ paths:
             when spawning via the API instead of spawn form.
             The structure of the options
             will depend on the Spawner's configuration.
+            The body itself will be available as `user_options` for the
+            Spawner.
           in: body
           required: false
           schema:
             type: object
+
       responses:
-        '201':
+        "201":
           description: The user's notebook server has started
-        '202':
+        "202":
           description: The user's notebook server has not yet started, but has been requested
     delete:
       summary: Stop a user's server
@@ -266,9 +281,9 @@ paths:
           required: true
           type: string
       responses:
-        '204':
+        "204":
           description: The user's notebook server has stopped
-        '202':
+        "202":
           description: The user's notebook server has not yet stopped as it is taking a while to stop
   /users/{name}/servers/{server_name}:
     post:
@@ -280,7 +295,10 @@ paths:
           required: true
           type: string
         - name: server_name
-          description: name given to a named-server
+          description: |
+            name given to a named-server. 
+
+            Note that depending on your JupyterHub infrastructure there are chracterter size limitation to `server_name`. Default spawner with K8s pod will not allow Jupyter Notebooks to be spawned with a name that contains more than 253 characters (keep in mind that the pod will be spawned with extra characters to identify the user and hub).
           in: path
           required: true
           type: string
@@ -295,9 +313,9 @@ paths:
           schema:
             type: object
       responses:
-        '201':
+        "201":
           description: The user's notebook named-server has started
-        '202':
+        "202":
           description: The user's notebook named-server has not yet started, but has been requested
     delete:
       summary: Stop a user's named-server
@@ -312,18 +330,22 @@ paths:
           in: path
           required: true
           type: string
-        - name: remove
-          description: |
-            Whether to fully remove the server, rather than just stop it.
-            Removing a server deletes things like the state of the stopped server.
+        - name: body
           in: body
           required: false
           schema:
-            type: boolean
+            type: object
+            properties:
+              remove:
+                type: boolean
+                description: |
+                  Whether to fully remove the server, rather than just stop it.
+                  Removing a server deletes things like the state of the stopped server.
+                  Default: false.
       responses:
-        '204':
+        "204":
           description: The user's notebook named-server has stopped
-        '202':
+        "202":
           description: The user's notebook named-server has not yet stopped as it is taking a while to stop
   /users/{name}/tokens:
     parameters:
@@ -335,15 +357,15 @@ paths:
     get:
       summary: List tokens for the user
       responses:
-        '200':
+        "200":
           description: The list of tokens
           schema:
             type: array
             items:
-              $ref: '#/definitions/Token'
-        '401':
-          $ref: '#/responses/Unauthorized'
-        '404':
+              $ref: "#/definitions/Token"
+        "401":
+          $ref: "#/responses/Unauthorized"
+        "404":
           description: No such user
     post:
       summary: Create a new token for the user
@@ -361,11 +383,11 @@ paths:
                 type: string
                 description: A note attached to the token for future bookkeeping
       responses:
-        '201':
+        "201":
           description: The newly created token
           schema:
-            $ref: '#/definitions/Token'
-        '400':
+            $ref: "#/definitions/Token"
+        "400":
           description: Body must be a JSON dict or empty
   /users/{name}/tokens/{token_id}:
     parameters:
@@ -381,33 +403,33 @@ paths:
     get:
       summary: Get the model for a token by id
       responses:
-        '200':
+        "200":
           description: The info for the new token
           schema:
-            $ref: '#/definitions/Token'
+            $ref: "#/definitions/Token"
     delete:
       summary: Delete (revoke) a token by id
       responses:
-        '204':
+        "204":
           description: The token has been deleted
   /user:
     get:
       summary: Return authenticated user's model
       responses:
-        '200':
+        "200":
           description: The authenticated user's model is returned.
           schema:
-            $ref: '#/definitions/User'
+            $ref: "#/definitions/User"
   /groups:
     get:
       summary: List groups
       responses:
-        '200':
+        "200":
           description: The list of groups
           schema:
             type: array
             items:
-              $ref: '#/definitions/Group'
+              $ref: "#/definitions/Group"
   /groups/{name}:
     get:
       summary: Get a group by name
@@ -418,10 +440,10 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: The group model
           schema:
-            $ref: '#/definitions/Group'
+            $ref: "#/definitions/Group"
     post:
       summary: Create a group
       parameters:
@@ -431,10 +453,10 @@ paths:
           required: true
           type: string
       responses:
-        '201':
+        "201":
           description: The group has been created
           schema:
-            $ref: '#/definitions/Group'
+            $ref: "#/definitions/Group"
     delete:
       summary: Delete a group
       parameters:
@@ -444,7 +466,7 @@ paths:
           required: true
           type: string
       responses:
-        '204':
+        "204":
           description: The group has been deleted
   /groups/{name}/users:
     post:
@@ -468,10 +490,10 @@ paths:
                 items:
                   type: string
       responses:
-        '200':
+        "200":
           description: The users have been added to the group
           schema:
-            $ref: '#/definitions/Group'
+            $ref: "#/definitions/Group"
     delete:
       summary: Remove users from a group
       parameters:
@@ -493,18 +515,18 @@ paths:
                 items:
                   type: string
       responses:
-        '200':
+        "200":
           description: The users have been removed from the group
   /services:
     get:
       summary: List services
       responses:
-        '200':
+        "200":
           description: The service list
           schema:
             type: array
             items:
-              $ref: '#/definitions/Service'
+              $ref: "#/definitions/Service"
   /services/{name}:
     get:
       summary: Get a service by name
@@ -515,16 +537,16 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: The Service model
           schema:
-            $ref: '#/definitions/Service'
+            $ref: "#/definitions/Service"
   /proxy:
     get:
       summary: Get the proxy's routing table
       description: A convenience alias for getting the routing table directly from the proxy
       responses:
-        '200':
+        "200":
           description: Routing table
           schema:
             type: object
@@ -532,7 +554,7 @@ paths:
     post:
       summary: Force the Hub to sync with the proxy
       responses:
-        '200':
+        "200":
           description: Success
     patch:
       summary: Notify the Hub about a new proxy
@@ -558,7 +580,7 @@ paths:
                 type: string
                 description: CONFIGPROXY_AUTH_TOKEN for the new proxy
       responses:
-        '200':
+        "200":
           description: Success
   /authorizations/token:
     post:
@@ -580,7 +602,7 @@ paths:
               password:
                 type: string
       responses:
-        '200':
+        "200":
           description: The new API token
           schema:
             type: object
@@ -588,7 +610,7 @@ paths:
               token:
                 type: string
                 description: The new API token.
-        '403':
+        "403":
           description: The user can not be authenticated.
   /authorizations/token/{token}:
     get:
@@ -599,9 +621,9 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: The user or service identified by the API token
-        '404':
+        "404":
           description: A user or service is not found.
   /authorizations/cookie/{cookie_name}/{cookie_value}:
     get:
@@ -617,15 +639,15 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: The user identified by the cookie
           schema:
-            $ref: '#/definitions/User'
-        '404':
+            $ref: "#/definitions/User"
+        "404":
           description: A user is not found.
   /oauth2/authorize:
     get:
-      summary: 'OAuth 2.0 authorize endpoint'
+      summary: "OAuth 2.0 authorize endpoint"
       description: |
         Redirect users to this URL to begin the OAuth process.
         It is not an API endpoint.
@@ -651,9 +673,9 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: Success
-        '400':
+        "400":
           description: OAuth2Error
   /oauth2/token:
     post:
@@ -690,7 +712,7 @@ paths:
           required: true
           type: string
       responses:
-        '200':
+        "200":
           description: JSON response including the token
           schema:
             type: object
@@ -717,9 +739,9 @@ paths:
                 type: boolean
                 description: Whether users' notebook servers should be shutdown as well (default from Hub config)
       responses:
-        '202':
+        "202":
           description: Shutdown successful
-        '400':
+        "400":
           description: Unexpeced value for proxy or servers
 # Descriptions of common responses
 responses:
@@ -757,7 +779,7 @@ definitions:
         type: array
         description: The active servers for this user.
         items:
-          $ref: '#/definitions/Server'
+          $ref: "#/definitions/Server"
   Server:
     type: object
     properties:
@@ -795,6 +817,9 @@ definitions:
       state:
         type: object
         description: Arbitrary internal state from this server's spawner.  Only available on the hub's users list or get-user-by-name method, and only if a hub admin.  None otherwise.
+      user_options:
+        type: object
+        description: User specified options for the user's spawned instance of a single-user server.
   Group:
     type: object
     properties:

docs/source/_static/custom.css

@@ -1,106 +1,4 @@
-div#helm-chart-schema h2,
-div#helm-chart-schema h3,
-div#helm-chart-schema h4,
-div#helm-chart-schema h5,
-div#helm-chart-schema h6 {
-    font-family: courier new;
-}
-
-h3, h3 ~ * {
-  margin-left: 3% !important;
-}
-
-h4, h4 ~ * {
-  margin-left: 6% !important;
-}
-
-h5, h5 ~ * {
-  margin-left: 9% !important;
-}
-
-h6, h6 ~ * {
-  margin-left: 12% !important;
-}
-
-h7, h7 ~ * {
-  margin-left: 15% !important;
-}
-
-img.logo {
-  width:100%
-}
-
-.right-next {
-    float: right;
-    max-width: 45%;
-    overflow: auto;
-    text-overflow: ellipsis;
-    white-space: nowrap;
-}
-
-.right-next::after{
-    content: ' »';
-}
-
-.left-prev {
-    float: left;
-    max-width: 45%;
-    overflow: auto;
-    text-overflow: ellipsis;
-    white-space: nowrap;
-}
-
-.left-prev::before{
-    content: '« ';
-}
-
-.prev-next-bottom {
-  margin-top: 3em;
-}
-
-.prev-next-top {
-  margin-bottom: 1em;
-}
-
-/* Sidebar TOC and headers */
-
-div.sphinxsidebarwrapper div {
-    margin-bottom: .8em;
-}
-div.sphinxsidebar h3 {
-    font-size: 1.3em;
-    padding-top: 0px;
-    font-weight: 800;
-    margin-left: 0px !important;
-}
-
-div.sphinxsidebar p.caption {
-    font-size: 1.2em;
-    margin-bottom: 0px;
-    margin-left: 0px !important;
-    font-weight: 900;
-    color: #767676;
-}
-
-div.sphinxsidebar ul {
-    font-size: .8em;
-    margin-top: 0px;
-    padding-left: 3%;
-    margin-left: 0px !important;
-}
-
-div.relations ul {
-    font-size: 1em;
-    margin-left: 0px !important;
-}
-
-div#searchbox form {
-    margin-left: 0px !important;
-}
-
-/* body elements */
-.toctree-wrapper span.caption-text {
-    color: #767676;
-    font-style: italic;
-    font-weight: 300;
-}
+/* Added to avoid logo being too squeezed */
+.navbar-brand {
+  height: 4rem !important;
+}

docs/source/_templates/navigation.html

@@ -1,16 +0,0 @@
-{# Custom template for navigation.html
-
-   alabaster theme does not provide blocks for titles to
-   be overridden so this custom theme handles title and
-   toctree for sidebar
-#}
-<h3>{{ _('Table of Contents') }}</h3>
-{{ toctree(includehidden=theme_sidebar_includehidden, collapse=theme_sidebar_collapse) }}
-{% if theme_extra_nav_links %}
-<hr />
-<ul>
-    {% for text, uri in theme_extra_nav_links.items() %}
-    <li class="toctree-l1"><a href="{{ uri }}">{{ text }}</a></li>
-    {% endfor %}
-</ul>
-{% endif %}

docs/source/_templates/relations.html

@@ -1,17 +0,0 @@
-{# Custom template for relations.html
-
-   alabaster theme does not provide previous/next page by default
-#}
-<div class="relations">
-<h3>Navigation</h3>
-<ul>
-  <li><a href="{{ pathto(master_doc) }}">Documentation Home</a><ul>
-  {%- if prev %}
-  <li><a href="{{ prev.link|e }}" title="Previous">Previous topic</a></li>
-  {%- endif %}
-  {%- if next %}
-  <li><a href="{{ next.link|e }}" title="Next">Next topic</a></li>
-  {%- endif %}
-  </ul>
-</ul>
-</div>

docs/source/conf.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 #
 import os
-import shlex
 import sys
 
 # Set paths
@@ -20,10 +19,9 @@ extensions = [
     'autodoc_traits',
     'sphinx_copybutton',
     'sphinx-jsonschema',
+    'recommonmark',
 ]
 
-templates_path = ['_templates']
-
 # The master toctree document.
 master_doc = 'index'
 
@@ -59,22 +57,74 @@ default_role = 'literal'
 import recommonmark
 from recommonmark.transform import AutoStructify
 
+# -- Config -------------------------------------------------------------
+from jupyterhub.app import JupyterHub
+from docutils import nodes
+from sphinx.directives.other import SphinxDirective
+from contextlib import redirect_stdout
+from io import StringIO
+
+# create a temp instance of JupyterHub just to get the output of the generate-config
+# and help --all commands.
+jupyterhub_app = JupyterHub()
+
+
+class ConfigDirective(SphinxDirective):
+    """Generate the configuration file output for use in the documentation."""
+
+    has_content = False
+    required_arguments = 0
+    optional_arguments = 0
+    final_argument_whitespace = False
+    option_spec = {}
+
+    def run(self):
+        # The generated configuration file for this version
+        generated_config = jupyterhub_app.generate_config_file()
+        # post-process output
+        home_dir = os.environ['HOME']
+        generated_config = generated_config.replace(home_dir, '$HOME', 1)
+        par = nodes.literal_block(text=generated_config)
+        return [par]
+
+
+class HelpAllDirective(SphinxDirective):
+    """Print the output of jupyterhub help --all for use in the documentation."""
+
+    has_content = False
+    required_arguments = 0
+    optional_arguments = 0
+    final_argument_whitespace = False
+    option_spec = {}
+
+    def run(self):
+        # The output of the help command for this version
+        buffer = StringIO()
+        with redirect_stdout(buffer):
+            jupyterhub_app.print_help('--help-all')
+        all_help = buffer.getvalue()
+        # post-process output
+        home_dir = os.environ['HOME']
+        all_help = all_help.replace(home_dir, '$HOME', 1)
+        par = nodes.literal_block(text=all_help)
+        return [par]
+
 
 def setup(app):
     app.add_config_value('recommonmark_config', {'enable_eval_rst': True}, True)
-    app.add_stylesheet('custom.css')
+    app.add_css_file('custom.css')
     app.add_transform(AutoStructify)
+    app.add_directive('jupyterhub-generate-config', ConfigDirective)
+    app.add_directive('jupyterhub-help-all', HelpAllDirective)
 
 
-source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}
-
 source_suffix = ['.rst', '.md']
 # source_encoding = 'utf-8-sig'
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.
-html_theme = 'pandas_sphinx_theme'
+html_theme = 'pydata_sphinx_theme'
 
 html_logo = '_static/images/logo/logo.png'
 html_favicon = '_static/images/logo/favicon.ico'
@@ -166,10 +216,10 @@ intersphinx_mapping = {'https://docs.python.org/3/': None}
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 if on_rtd:
     # readthedocs.org uses their theme by default, so no need to specify it
-    # build rest-api, since RTD doesn't run make
+    # build both metrics and rest-api, since RTD doesn't run make
     from subprocess import check_call as sh
 
-    sh(['make', 'rest-api'], cwd=docs)
+    sh(['make', 'metrics', 'rest-api'], cwd=docs)
 
 # -- Spell checking -------------------------------------------------------
 

docs/source/contributing/roadmap.md

@@ -6,8 +6,8 @@ the community of users, contributors, and maintainers.
 The goal is to communicate priorities and upcoming release plans.
 It is not a aimed at limiting contributions to what is listed here.
 
-
 ## Using the roadmap
+
 ### Sharing Feedback on the Roadmap
 
 All of the community is encouraged to provide feedback as well as share new
@@ -22,17 +22,17 @@ maintainers will help identify what a good next step is for the issue.
 When submitting an issue, think about what "next step" category best describes
 your issue:
 
-* **now**, concrete/actionable step that is ready for someone to start work on.
-These might be items that have a link to an issue or more abstract like
-"decrease typos and dead links in the documentation"
-* **soon**, less concrete/actionable step that is going to happen soon,
-discussions around the topic are coming close to an end at which point it can
-move into the "now" category
-* **later**, abstract ideas or tasks, need a lot of discussion or
-experimentation to shape the idea so that it can be executed. Can also
-contain concrete/actionable steps that have been postponed on purpose
-(these are steps that could be in "now" but the decision was taken to work on
-them later)
+- **now**, concrete/actionable step that is ready for someone to start work on.
+  These might be items that have a link to an issue or more abstract like
+  "decrease typos and dead links in the documentation"
+- **soon**, less concrete/actionable step that is going to happen soon,
+  discussions around the topic are coming close to an end at which point it can
+  move into the "now" category
+- **later**, abstract ideas or tasks, need a lot of discussion or
+  experimentation to shape the idea so that it can be executed. Can also
+  contain concrete/actionable steps that have been postponed on purpose
+  (these are steps that could be in "now" but the decision was taken to work on
+  them later)
 
 ### Reviewing and Updating the Roadmap
 
@@ -47,8 +47,8 @@ For those please create a
 The roadmap should give the reader an idea of what is happening next, what needs
 input and discussion before it can happen and what has been postponed.
 
-
 ## The roadmap proper
+
 ### Project vision
 
 JupyterHub is a dependable tool used by humans that reduces the complexity of
@@ -58,20 +58,19 @@ creating the environment in which a piece of software can be executed.
 
 These "Now" items are considered active areas of focus for the project:
 
-* HubShare - a sharing service for use with JupyterHub.
-    * Users should be able to:
-        - Push a project to other users.
-        - Get a checkout of a project from other users.
-        - Push updates to a published project.
-        - Pull updates from a published project.
-        - Manage conflicts/merges by simply picking a version (our/theirs)
-        - Get a checkout of a project from the internet. These steps are completely different from saving notebooks/files.
-        - Have directories that are managed by git completely separately from our stuff.
-        - Look at pushed content that they have access to without an explicit pull.
-        - Define and manage teams of users.
-            - Adding/removing a user to/from a team gives/removes them access to all projects that team has access to.
-        - Build other services, such as static HTML publishing and dashboarding on top of these things.
-
+- HubShare - a sharing service for use with JupyterHub.
+  - Users should be able to:
+    - Push a project to other users.
+    - Get a checkout of a project from other users.
+    - Push updates to a published project.
+    - Pull updates from a published project.
+    - Manage conflicts/merges by simply picking a version (our/theirs)
+    - Get a checkout of a project from the internet. These steps are completely different from saving notebooks/files.
+    - Have directories that are managed by git completely separately from our stuff.
+    - Look at pushed content that they have access to without an explicit pull.
+    - Define and manage teams of users.
+      - Adding/removing a user to/from a team gives/removes them access to all projects that team has access to.
+    - Build other services, such as static HTML publishing and dashboarding on top of these things.
 
 ### Soon
 
@@ -79,12 +78,10 @@ These "Soon" items are under discussion. Once an item reaches the point of an
 actionable plan, the item will be moved to the "Now" section. Typically,
 these will be moved at a future review of the roadmap.
 
-* resource monitoring and management:
-    - (prometheus?) API for resource monitoring
-    - tracking activity on single-user servers instead of the proxy
-    - notes and activity tracking per API token
-    - UI for managing named servers
-
+- resource monitoring and management:
+  - (prometheus?) API for resource monitoring
+  - tracking activity on single-user servers instead of the proxy
+  - notes and activity tracking per API token
 
 ### Later
 
@@ -93,6 +90,6 @@ time there is no active plan for an item. The project would like to find the
 resources and time to discuss these ideas.
 
 - real-time collaboration
-    - Enter into real-time collaboration mode for a project that starts a shared execution context.
-    - Once the single-user notebook package supports realtime collaboration,
-      implement sharing mechanism integrated into the Hub.
+  - Enter into real-time collaboration mode for a project that starts a shared execution context.
+  - Once the single-user notebook package supports realtime collaboration,
+    implement sharing mechanism integrated into the Hub.

docs/source/contributing/setup.rst

@@ -8,7 +8,7 @@ System requirements
 ===================
 
 JupyterHub can only run on MacOS or Linux operating systems. If you are
-using Windows, we recommend using `VirtualBox <https://virtualbox.org>`_ 
+using Windows, we recommend using `VirtualBox <https://virtualbox.org>`_
 or a similar system to run `Ubuntu Linux <https://ubuntu.com>`_ for
 development.
 
@@ -18,7 +18,7 @@ Install Python
 JupyterHub is written in the `Python <https://python.org>`_ programming language, and
 requires you have at least version 3.5 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, 
+`miniconda <https://conda.io/miniconda.html>`_. Remember to get the ‘Python 3’ version,
 and **not** the ‘Python 2’ version!
 
 Install nodejs
@@ -45,7 +45,13 @@ When developing JupyterHub, you need to make changes to the code & see
 their effects quickly. You need to do a developer install to make that
 happen.
 
-1. Clone the `JupyterHub git repository <https://github.com/jupyterhub/jupyterhub>`_ 
+.. note:: This guide does not attempt to dictate *how* development
+   environements 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
@@ -93,7 +99,14 @@ happen.
       python3 -m pip install -r dev-requirements.txt
       python3 -m pip install -r requirements.txt
 
-5. Install the development version of JupyterHub. This lets you edit
+5. Setup 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. Install the development version of JupyterHub. This lets you edit
    JupyterHub code in a text editor & restart the JupyterHub process to
    see your code changes immediately.
 
@@ -101,13 +114,13 @@ happen.
 
       python3 -m pip install --editable .
 
-6. You are now ready to start JupyterHub!
+7. You are now ready to start JupyterHub!
 
    .. code:: bash
 
       jupyterhub
 
-7. You can access JupyterHub from your browser at
+8. You can access JupyterHub from your browser at
    ``http://localhost:8000`` now.
 
 Happy developing!

docs/source/contributing/tests.rst

@@ -64,5 +64,5 @@ Troubleshooting Test Failures
 All the tests are failing
 -------------------------
 
-Make sure you have completed all the steps in :ref:`contributing/setup` sucessfully, and
+Make sure you have completed all the steps in :ref:`contributing/setup` successfully, and
 can launch ``jupyterhub`` from the terminal.

docs/source/events/index.rst

@@ -1,10 +1,7 @@
 Eventlogging 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 below_
-
- emitted as JSON data, defined and validated by the JSON schemas listed below.
-
+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
@@ -38,13 +35,12 @@ Here's a basic example:
 The output is a file, ``"event.log"``, with events recorded as JSON data.
 
 
-
-.. _below:
+.. _page:
 
 Event schemas
 -------------
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   server-actions.rst
+    server-actions.rst

docs/source/gallery-jhub-deployments.md

@@ -8,23 +8,25 @@ high performance computing.
 
 Please submit pull requests to update information or to add new institutions or uses.
 
-
 ## Academic Institutions, Research Labs, and Supercomputer Centers
 
 ### University of California Berkeley
 
 - [BIDS - Berkeley Institute for Data Science](https://bids.berkeley.edu/)
-    - [Teaching with Jupyter notebooks and JupyterHub](https://bids.berkeley.edu/resources/videos/teaching-ipythonjupyter-notebooks-and-jupyterhub)
+
+  - [Teaching with Jupyter notebooks and JupyterHub](https://bids.berkeley.edu/resources/videos/teaching-ipythonjupyter-notebooks-and-jupyterhub)
 
 - [Data 8](http://data8.org/)
-    - [GitHub organization](https://github.com/data-8)
+
+  - [GitHub organization](https://github.com/data-8)
 
 - [NERSC](http://www.nersc.gov/)
-    - [Press release on Jupyter and Cori](http://www.nersc.gov/news-publications/nersc-news/nersc-center-news/2016/jupyter-notebooks-will-open-up-new-possibilities-on-nerscs-cori-supercomputer/)
-    - [Moving and sharing data](https://www.nersc.gov/assets/Uploads/03-MovingAndSharingData-Cholia.pdf)
+
+  - [Press release on Jupyter and Cori](http://www.nersc.gov/news-publications/nersc-news/nersc-center-news/2016/jupyter-notebooks-will-open-up-new-possibilities-on-nerscs-cori-supercomputer/)
+  - [Moving and sharing data](https://www.nersc.gov/assets/Uploads/03-MovingAndSharingData-Cholia.pdf)
 
 - [Research IT](http://research-it.berkeley.edu)
-    - [JupyterHub server supports campus research computation](http://research-it.berkeley.edu/blog/17/01/24/free-fully-loaded-jupyterhub-server-supports-campus-research-computation)
+  - [JupyterHub server supports campus research computation](http://research-it.berkeley.edu/blog/17/01/24/free-fully-loaded-jupyterhub-server-supports-campus-research-computation)
 
 ### University of California Davis
 
@@ -62,20 +64,21 @@ easy to do with RStudio too.
 ### Clemson University
 
 - Advanced Computing
-    - [Palmetto cluster and JupyterHub](http://citi.sites.clemson.edu/2016/08/18/JupyterHub-for-Palmetto-Cluster.html)
+  - [Palmetto cluster and JupyterHub](http://citi.sites.clemson.edu/2016/08/18/JupyterHub-for-Palmetto-Cluster.html)
 
 ### University of Colorado Boulder
 
 - (CU Research Computing) CURC
-    - [JupyterHub User Guide](https://www.rc.colorado.edu/support/user-guide/jupyterhub.html)
-        - Slurm job dispatched on Crestone compute cluster
-        - log troubleshooting
-        - Profiles in IPython Clusters tab
-    - [Parallel Processing with JupyterHub tutorial](https://www.rc.colorado.edu/support/examples-and-tutorials/parallel-processing-with-jupyterhub.html)
-    - [Parallel Programming with JupyterHub document](https://www.rc.colorado.edu/book/export/html/833)
+
+  - [JupyterHub User Guide](https://www.rc.colorado.edu/support/user-guide/jupyterhub.html)
+    - Slurm job dispatched on Crestone compute cluster
+    - log troubleshooting
+    - Profiles in IPython Clusters tab
+  - [Parallel Processing with JupyterHub tutorial](https://www.rc.colorado.edu/support/examples-and-tutorials/parallel-processing-with-jupyterhub.html)
+  - [Parallel Programming with JupyterHub document](https://www.rc.colorado.edu/book/export/html/833)
 
 - Earth Lab at CU
-    - [Tutorial on Parallel R on JupyterHub](https://earthdatascience.org/tutorials/parallel-r-on-jupyterhub/)
+  - [Tutorial on Parallel R on JupyterHub](https://earthdatascience.org/tutorials/parallel-r-on-jupyterhub/)
 
 ### George Washington University
 
@@ -112,7 +115,7 @@ easy to do with RStudio too.
 ### Paderborn University
 
 - [Data Science (DICE) group](https://dice.cs.uni-paderborn.de/)
-    - [nbgraderutils](https://github.com/dice-group/nbgraderutils): Use JupyterHub + nbgrader + iJava kernel for online Java exercises. Used in lecture Statistical Natural Language Processing.
+  - [nbgraderutils](https://github.com/dice-group/nbgraderutils): Use JupyterHub + nbgrader + iJava kernel for online Java exercises. Used in lecture Statistical Natural Language Processing.
 
 ### Penn State University
 
@@ -125,27 +128,28 @@ easy to do with RStudio too.
 ### University of California San Diego
 
 - San Diego Supercomputer Center - Andrea Zonca
-    - [Deploy JupyterHub on a Supercomputer with SSH](https://zonca.github.io/2017/05/jupyterhub-hpc-batchspawner-ssh.html)
-    - [Run Jupyterhub on a Supercomputer](https://zonca.github.io/2015/04/jupyterhub-hpc.html)
-    - [Deploy JupyterHub on a VM for a Workshop](https://zonca.github.io/2016/04/jupyterhub-sdsc-cloud.html)
-    - [Customize your Python environment in Jupyterhub](https://zonca.github.io/2017/02/customize-python-environment-jupyterhub.html)
-    - [Jupyterhub deployment on multiple nodes with Docker Swarm](https://zonca.github.io/2016/05/jupyterhub-docker-swarm.html)
-    - [Sample deployment of Jupyterhub in HPC on SDSC Comet](https://zonca.github.io/2017/02/sample-deployment-jupyterhub-hpc.html)
+
+  - [Deploy JupyterHub on a Supercomputer with SSH](https://zonca.github.io/2017/05/jupyterhub-hpc-batchspawner-ssh.html)
+  - [Run Jupyterhub on a Supercomputer](https://zonca.github.io/2015/04/jupyterhub-hpc.html)
+  - [Deploy JupyterHub on a VM for a Workshop](https://zonca.github.io/2016/04/jupyterhub-sdsc-cloud.html)
+  - [Customize your Python environment in Jupyterhub](https://zonca.github.io/2017/02/customize-python-environment-jupyterhub.html)
+  - [Jupyterhub deployment on multiple nodes with Docker Swarm](https://zonca.github.io/2016/05/jupyterhub-docker-swarm.html)
+  - [Sample deployment of Jupyterhub in HPC on SDSC Comet](https://zonca.github.io/2017/02/sample-deployment-jupyterhub-hpc.html)
 
 - Educational Technology Services - Paul Jamason
-    - [jupyterhub.ucsd.edu](https://jupyterhub.ucsd.edu)
+  - [jupyterhub.ucsd.edu](https://jupyterhub.ucsd.edu)
 
 ### TACC University of Texas
 
 ### Texas A&M
 
 - Kristen Thyng - Oceanography
-    - [Teaching with JupyterHub and nbgrader](http://kristenthyng.com/blog/2016/09/07/jupyterhub+nbgrader/)
+  - [Teaching with JupyterHub and nbgrader](http://kristenthyng.com/blog/2016/09/07/jupyterhub+nbgrader/)
 
 ### Elucidata
-  - What's new in Jupyter Notebooks @[Elucidata](https://elucidata.io/):
-      - Using Jupyter Notebooks with Jupyterhub on GCP, managed by GKE
-            - https://medium.com/elucidata/why-you-should-be-using-a-jupyter-notebook-8385a4ccd93d
+
+- What's new in Jupyter Notebooks @[Elucidata](https://elucidata.io/):
+  - Using Jupyter Notebooks with Jupyterhub on GCP, managed by GKE - https://medium.com/elucidata/why-you-should-be-using-a-jupyter-notebook-8385a4ccd93d
 
 ## Service Providers
 
@@ -175,7 +179,6 @@ easy to do with RStudio too.
 
 - [Deploying JupyterHub on Hadoop](https://jupyterhub-on-hadoop.readthedocs.io)
 
-
 ## Miscellaneous
 
 - https://medium.com/@ybarraud/setting-up-jupyterhub-with-sudospawner-and-anaconda-844628c0dbee#.rm3yt87e1

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

@@ -4,23 +4,22 @@ The default Authenticator uses [PAM][] 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 whitelist of users
-
-You can restrict which users are allowed to login with a whitelist,
-`Authenticator.whitelist`:
+## Create a set of allowed users
 
+You can restrict which users are allowed to login with a set,
+`Authenticator.allowed_users`:
 
 ```python
-c.Authenticator.whitelist = {'mal', 'zoe', 'inara', 'kaylee'}
+c.Authenticator.allowed_users = {'mal', 'zoe', 'inara', 'kaylee'}
 ```
 
-Users in the whitelist are added to the Hub database when the Hub is
+Users in the `allowed_users` set are added to the Hub database when the Hub is
 started.
 
 ## Configure admins (`admin_users`)
 
 Admin users of JupyterHub, `admin_users`, can add and remove users from
-the user `whitelist`. `admin_users` can take actions on other users'
+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 configured be as follows:
@@ -28,7 +27,8 @@ A set of initial admin users, `admin_users` can configured be as follows:
 ```python
 c.Authenticator.admin_users = {'mal', 'zoe'}
 ```
-Users in the admin list are automatically added to the user `whitelist`,
+
+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
@@ -44,8 +44,8 @@ c.PAMAuthenticator.admin_groups = {'wheel'}
 
 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
+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.**
 
@@ -53,12 +53,12 @@ sure your users know if admin_access is enabled.**
 
 Users can be added to and removed from the Hub via either the admin
 panel or the REST API. When a user is **added**, the user will be
-automatically added to the whitelist and database. Restarting the Hub
-will not require manually updating the whitelist in your config file,
+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 whitelist in your config file. You must also remove the 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.
@@ -91,6 +91,7 @@ JupyterHub's [OAuthenticator][] currently supports the following
 popular services:
 
 - Auth0
+- Azure AD
 - Bitbucket
 - CILogon
 - GitHub
@@ -115,5 +116,5 @@ To set a global password, add this to the config file:
 c.DummyAuthenticator.password = "some_password"
 ```
 
-[PAM]: https://en.wikipedia.org/wiki/Pluggable_authentication_module
-[OAuthenticator]: https://github.com/jupyterhub/oauthenticator
+[pam]: https://en.wikipedia.org/wiki/Pluggable_authentication_module
+[oauthenticator]: https://github.com/jupyterhub/oauthenticator

docs/source/getting-started/config-basics.md

@@ -56,7 +56,7 @@ To display all command line options that are available for configuration:
 ```
 
 Configuration using the command line options is done when launching JupyterHub.
-For example, to start JupyterHub on ``10.0.1.2:443`` with https, you
+For example, to start JupyterHub on `10.0.1.2:443` with https, you
 would enter:
 
 ```bash
@@ -88,13 +88,13 @@ meant as illustration, are:
 
 ## Run the proxy separately
 
-This is *not* strictly necessary, but useful in many cases.  If you
+This is _not_ strictly necessary, but useful in many cases. If you
 use a custom proxy (e.g. Traefik), this also not needed.
 
-Connections to user servers go through the proxy, and *not* the hub
-itself.  If the proxy stays running when the hub restarts (for
+Connections to user servers go through the proxy, and _not_ the hub
+itself. If the proxy stays running when the hub restarts (for
 maintenance, re-configuration, etc.), then use connections are not
-interrupted.  For simplicity, by default the hub starts the proxy
+interrupted. For simplicity, by default the hub starts the proxy
 automatically, so if the hub restarts, the proxy restarts, and user
-connections are interrupted.  It is easy to run the proxy separately,
+connections are interrupted. It is easy to run the proxy separately,
 for information see [the separate proxy page](../reference/separate-proxy).

docs/source/getting-started/faq.md

@@ -0,0 +1,35 @@
+# 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/...` and after the visitor logs in,
+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

@@ -15,4 +15,5 @@ own JupyterHub.
    authenticators-users-basics
    spawners-basics
    services-basics
+   faq
    institutional-faq

docs/source/getting-started/institutional-faq.md

@@ -18,14 +18,14 @@ to the use-cases of large organizations.
 
 Here is a quick breakdown of these three tools:
 
-* **The Jupyter Notebook** is a document specification (the `.ipynb`) file that interweaves
+- **The Jupyter Notebook** is a document specification (the `.ipynb`) file that interweaves
   narrative text with code cells and their outputs. It is also a graphical interface
   that allows users to edit these documents. There are also several other graphical interfaces
-  that allow users to edit the `.ipynb` format (nteract, Jupyer Lab, Google Colab, Kaggle, etc).
-* **JupyterLab** is a flexible and extendible user interface for interactive computing. It
+  that allow users to edit the `.ipynb` format (nteract, Jupyter Lab, Google Colab, Kaggle, etc).
+- **JupyterLab** is a flexible and extendible user interface for interactive computing. It
   has several extensions that are tailored for using Jupyter Notebooks, as well as extensions
   for other parts of the data science stack.
-* **JupyterHub** is an application that manages interactive computing sessions for **multiple users**.
+- **JupyterHub** is an application that manages interactive computing sessions for **multiple users**.
   It also connects them with infrastructure those users wish to access. It can provide
   remote access to Jupyter Notebooks and Jupyter Lab for many people.
 
@@ -50,20 +50,20 @@ scalable infrastructure, large datasets, and high-performance computing.
 JupyterHub is used at a variety of institutions in academia,
 industry, and government research labs. It is most-commonly used by two kinds of groups:
 
-* Small teams (e.g., data science teams, research labs, or collaborative projects) to provide a
+- Small teams (e.g., data science teams, research labs, or collaborative projects) to provide a
   shared resource for interactive computing, collaboration, and analytics.
-* Large teams (e.g., a department, a large class, or a large group of remote users) to provide
+- Large teams (e.g., a department, a large class, or a large group of remote users) to provide
   access to organizational hardware, data, and analytics environments at scale.
 
 Here are a sample of organizations that use JupyterHub:
 
-* **Universities and colleges**: UC Berkeley, UC San Diego, Cal Poly SLO, Harvard University, University of Chicago,
+- **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,
+- **Research laboratories**: NASA, NCAR, NOAA, the Large Synoptic Survey Telescope, Brookhaven National Lab,
   Minnesota Supercomputing Institute, ALCF, CERN, Lawrence Livermore National Laboratory
-* **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
+- **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
 a more complete list of JupyterHub deployments at institutions.
@@ -95,14 +95,13 @@ The most common way to set up a JupyterHub is to use a JupyterHub distribution,
 and opinionated ways to set up a JupyterHub on particular kinds of infrastructure. The two distributions
 that we currently suggest are:
 
-* [Zero to JupyterHub for Kubernetes](https://z2jh.jupyter.org) is a scalable JupyterHub deployment and
+- [Zero to JupyterHub for Kubernetes](https://z2jh.jupyter.org) is a scalable JupyterHub deployment and
   guide that runs on Kubernetes. Better for larger or dynamic user groups (50-10,000) or more complex
   compute/data needs.
-* [The Littlest JupyterHub](https://tljh.jupyter.org) is a lightweight JupyterHub that runs on a single
+- [The Littlest JupyterHub](https://tljh.jupyter.org) is a lightweight JupyterHub that runs on a single
   single machine (in the cloud or under your desk). Better for smaller usergroups (4-80) or more
   lightweight computational resources.
 
-
 ### Does JupyterHub run well in the cloud?
 
 Yes - most deployments of JupyterHub are run via cloud infrastructure and on a variety of cloud providers.
@@ -123,9 +122,9 @@ The short answer: yes. JupyterHub as a standalone application has been battle-te
 level for several years, and makes a number of "default" security decisions that are reasonable for most
 users.
 
-* For security considerations in the base JupyterHub application,
+- For security considerations in the base JupyterHub application,
   [see the JupyterHub security page](https://jupyterhub.readthedocs.io/en/stable/reference/websecurity.html)
-* For security considerations when deploying JupyterHub on Kubernetes, see the
+- 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).
 
 The longer answer: it depends on your deployment. Because JupyterHub is very flexible, it can be used
@@ -137,15 +136,13 @@ If you are worried about security, don't hesitate to reach out to the JupyterHub
 [Jupyter Community Forum](https://discourse.jupyter.org/c/jupyterhub). This community of practice has many
 individuals with experience running secure JupyterHub deployments.
 
-
 ### Does JupyterHub provide computing or data infrastructure?
 
-No - JupyterHub manages user sessions and can *control* computing infrastructure, but it does not provide these
+No - JupyterHub manages user sessions and can _control_ computing infrastructure, but it does not provide these
 things itself. You are expected to run JupyterHub on your own infrastructure (local or in the cloud). Moreover,
 JupyterHub has no internal concept of "data", but is designed to be able to communicate with data repositories
 (again, either locally or remotely) for use within interactive computing sessions.
 
-
 ### How do I manage users?
 
 JupyterHub offers a few options for managing your users. Upon setting up a JupyterHub, you can choose what
@@ -154,7 +151,7 @@ email address, or choose a username / password when they first log-in, or offloa
 another service such as an organization's OAuth.
 
 The users of a JupyterHub are stored locally, and can be modified manually by an administrator of the JupyterHub.
-Moreover, the *active* users on a JupyterHub can be found on the administrator's page. This page
+Moreover, the _active_ users on a JupyterHub can be found on the administrator's page. This page
 gives you the abiltiy to stop or restart kernels, inspect user filesystems, and even take over user
 sessions to assist them with debugging.
 
@@ -182,7 +179,6 @@ connect with other infrastructure tools (like Dask or Spark). This allows users
 scalable or high-performance resources from within their JupyterHub sessions. The logic of
 how those resources are controlled is taken care of by the non-JupyterHub application.
 
-
 ### Can JupyterHub be used with my high-performance computing resources?
 
 Yes - JupyterHub can provide access to many kinds of computing infrastructure.
@@ -218,7 +214,6 @@ the technologies your JupyterHub will use (e.g., dev-ops knowledge with cloud co
 In general, the base JupyterHub deployment is not the bottleneck for setup, it is connecting
 your JupyterHub with the various services and tools that you wish to provide to your users.
 
-
 ### How well does JupyterHub scale? What are JupyterHub's limitations?
 
 JupyterHub works well at both a small scale (e.g., a single VM or machine) as well as a
@@ -227,7 +222,6 @@ for user bases as large as 10,000. The scalability of JupyterHub largely depends
 infrastructure on which it is deployed. JupyterHub has been designed to be lightweight and
 flexible, so you can tailor your JupyterHub deployment to your needs.
 
-
 ### Is JupyterHub resilient? What happens when a machine goes down?
 
 For JupyterHubs that are deployed in a containerized environment (e.g., Kubernetes), it is

docs/source/getting-started/networking-basics.md

@@ -11,7 +11,7 @@ This section will help you with basic proxy and network configuration to:
 
 The Proxy's main IP address setting determines where JupyterHub is available to users.
 By default, JupyterHub is configured to be available on all network interfaces
-(`''`) on port 8000. *Note*: Use of `'*'` is discouraged for IP configuration;
+(`''`) on port 8000. _Note_: Use of `'*'` is discouraged for IP configuration;
 instead, use of `'0.0.0.0'` is preferred.
 
 Changing the Proxy's main IP address and port can be done with the following
@@ -74,7 +74,7 @@ The Hub service listens only on `localhost` (port 8081) by default.
 The Hub needs to be accessible from both the proxy and all Spawners.
 When spawning local servers, an IP address setting of `localhost` is fine.
 
-If *either* the Proxy *or* (more likely) the Spawners will be remote or
+If _either_ the Proxy _or_ (more likely) the Spawners will be remote or
 isolated in containers, the Hub must listen on an IP that is accessible.
 
 ```python
@@ -93,9 +93,9 @@ c.JupyterHub.hub_connect_ip = '10.0.1.4'  # ip as seen on the docker network. Ca
 
 ## Adjusting the hub's URL
 
-The hub will most commonly be running on a hostname of its own.  If it
+The hub will most commonly be running on a hostname of its own. If it
 is not – for example, if the hub is being reverse-proxied and being
 exposed at a URL such as `https://proxy.example.org/jupyter/` – then
-you will need to tell JupyterHub the base URL of the service.  In such
+you will need to tell JupyterHub the base URL of the service. In such
 a case, it is both necessary and sufficient to set
 `c.JupyterHub.base_url = '/jupyter/'` in the configuration.

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

@@ -80,6 +80,49 @@ To achieve this, simply omit the configuration settings
 ``c.JupyterHub.ssl_key`` and ``c.JupyterHub.ssl_cert``
 (setting them to ``None`` does not have the same effect, and is 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 don't set the Proxy authentication token, the Hub will generate a random
+key itself, which 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
@@ -146,41 +189,73 @@ itself, ``jupyterhub_config.py``, as a binary string:
    If the cookie secret value changes for the Hub, all single-user notebook
    servers must also be restarted.
 
+.. _cookies:
 
-.. _authentication-token:
+Cookies used by JupyterHub authentication
+-----------------------------------------
 
-Proxy authentication token
---------------------------
+The following cookies are used by the Hub for handling user authentication.
 
-The Hub authenticates its requests to the Proxy using a secret token that
-the Hub and Proxy agree upon. The value of this string should be a random
-string (for example, generated by ``openssl rand -hex 32``).
+This section was created based on this post_ from Discourse.
 
-Generating and storing token in the configuration file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. _post: https://discourse.jupyter.org/t/how-to-force-re-login-for-users/1998/6
 
-Or you can set the value in the configuration file, ``jupyterhub_config.py``:
+jupyterhub-hub-login
+~~~~~~~~~~~~~~~~~~~~
 
-.. code-block:: python
+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.
 
-    c.JupyterHub.proxy_auth_token = '0bc02bede919e99a26de1e2a7a5aadfaf6228de836ec39a05a6c6942831d8fe5'
+Resetting the Hub cookie secret effectively revokes this cookie.
 
-Generating and storing as an environment variable
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This cookie is restricted to the path ``/hub/``.
 
-You can pass this value of the proxy authentication token to the Hub and Proxy
-using the ``CONFIGPROXY_AUTH_TOKEN`` environment variable:
+jupyterhub-user-<username>
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. code-block:: bash
+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.
 
-    export CONFIGPROXY_AUTH_TOKEN=$(openssl rand -hex 32)
+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.
 
-This environment variable needs to be visible to the Hub and Proxy.
+Each OAuth access token is associated with a session id (see ``jupyterhub-session-id`` section
+below).
 
-Default if token is not set
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To avoid hitting the Hub on every request, the authentication response
+is cached. And to avoid a stale cache the cache key is comprised of both
+the token and session id.
 
-If you don't set the Proxy authentication token, the Hub will generate a random
-key itself, which 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).
+Resetting the Hub cookie secret effectively revokes this cookie.
+
+This cookie is restricted to the path ``/user/<username>``, so 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 logout of the multiple OAuth cookies.
+
+This cookie is set to ``/`` so all endpoints can receive it, or 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 your 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/getting-started/services-basics.md

@@ -5,7 +5,7 @@ that interacts with the Hub's REST API. A Service may perform a specific
 or action or task. For example, shutting down individuals' single user
 notebook servers that have been idle for some time is a good example of
 a task that could be automated by a Service. Let's look at how the
-[cull_idle_servers][] script can be used as a Service.
+[jupyterhub_idle_culler][] script can be used as a Service.
 
 ## Real-world example to cull idle servers
 
@@ -15,11 +15,11 @@ document will:
 - explain some basic information about API tokens
 - clarify that API tokens can be used to authenticate to
   single-user servers as of [version 0.8.0](../changelog)
-- show how the [cull_idle_servers][] script can be:
-    - used in a Hub-managed service
-    - run as a standalone script
+- show how the [jupyterhub_idle_culler][] script can be:
+  - used in a Hub-managed service
+  - run as a standalone script
 
-Both examples for `cull_idle_servers` will communicate tasks to the
+Both examples for `jupyterhub_idle_culler` will communicate tasks to the
 Hub via the REST API.
 
 ## API Token basics
@@ -78,17 +78,23 @@ single-user servers, and only cookies can be used for authentication.
 0.8 supports using JupyterHub API tokens to authenticate to single-user
 servers.
 
-## Configure `cull-idle` to run as a Hub-Managed Service
+## Configure the idle culler to run as a Hub-Managed Service
+
+Install the idle culler:
+
+```
+pip install jupyterhub-idle-culler
+```
 
 In `jupyterhub_config.py`, add the following dictionary for the
-`cull-idle` Service to the `c.JupyterHub.services` list:
+`idle-culler` Service to the `c.JupyterHub.services` list:
 
 ```python
 c.JupyterHub.services = [
     {
-        'name': 'cull-idle',
+        'name': 'idle-culler',
         'admin': True,
-        'command': [sys.executable, 'cull_idle_servers.py', '--timeout=3600'],
+        'command': [sys.executable, '-m', 'jupyterhub_idle_culler', '--timeout=3600'],
     }
 ]
 ```
@@ -101,21 +107,21 @@ where:
 
 ## Run `cull-idle` manually as a standalone script
 
-Now you can run your script, i.e. `cull_idle_servers`, by providing it
+Now you can run your script by providing it
 the API token and it will authenticate through the REST API to
 interact with it.
 
-This will run `cull-idle` manually. `cull-idle` can be run as a standalone
+This will run the idle culler service manually. It can be run as a standalone
 script anywhere with access to the Hub, and will periodically check for idle
 servers and shut them down via the Hub's REST API. In order to shutdown the
 servers, the token given to cull-idle must have admin privileges.
 
 Generate an API token and store it in the `JUPYTERHUB_API_TOKEN` environment
-variable. Run `cull_idle_servers.py` manually.
+variable. Run `jupyterhub_idle_culler` manually.
 
 ```bash
     export JUPYTERHUB_API_TOKEN='token'
-    python3 cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]
+    python -m jupyterhub_idle_culler [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]
 ```
 
-[cull_idle_servers]: https://github.com/jupyterhub/jupyterhub/blob/master/examples/cull-idle/cull_idle_servers.py
+[jupyterhub_idle_culler]: https://github.com/jupyterhub/jupyterhub-idle-culler

docs/source/index.rst

@@ -3,11 +3,11 @@ JupyterHub
 ==========
 
 `JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users.
-It can be used in a classes of students, a corporate data science group or scientific
+It can be used in a class of students, a corporate data science group or scientific
 research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
 instances of the single-user `Jupyter notebook`_ server.
 
-To make life easier, JupyterHub have distributions. Be sure to
+To make life easier, JupyterHub has distributions. Be sure to
 take a look at them before continuing with the configuration of the broad
 original system of `JupyterHub`_. Today, you can find two main cases:
 

docs/source/installation-guide-hard.md

@@ -1,338 +0,0 @@
-# Install JupyterHub and JupyterLab from the ground up
-
-The combination of [JupyterHub](https://jupyterhub.readthedocs.io) and [JupyterLab](https://jupyterlab.readthedocs.io)
-is a great way to make shared computing resources available to a group.
-
-These instructions are a guide for a manual, 'bare metal' install of [JupyterHub](https://jupyterhub.readthedocs.io) 
-and [JupyterLab](https://jupyterlab.readthedocs.io). This is ideal for running on a single server: build a beast
-of a machine and share it within your lab, or use a virtual machine from any VPS or cloud provider.
-
-This guide has similar goals to [The Littlest JupyterHub](https://the-littlest-jupyterhub.readthedocs.io) setup
-script. However, instead of bundling all these step for you into one installer, we will perform every step manually.
-This makes it easy to customize any part (e.g. if you want to run other services on the same system and need to make them
-work together), as well as giving you full control and understanding of your setup.
-
-
-## Prerequisites
-
-Your own server with administrator (root) access. This could be a local machine, a remotely hosted one, or a cloud instance
-or VPS. Each user who will access JupyterHub should have a standard user account on the machine. The install will be done
-through the command line - useful if you log into your machine remotely using SSH.
-
-This tutorial was tested on **Ubuntu 18.04**. No other Linux distributions have been tested, but the instructions 
-should be reasonably straightforward to adapt.
-
-
-## Goals
-
-JupyterLab enables access to a multiple 'kernels', each one being a given environment for a given language. The most
-common is a Python environment, for scientific computing usually one managed by the `conda` package manager.
-
-This guide will set up JupyterHub and JupyterLab seperately from the Python environment. In other words, we treat
-JupyterHub+JupyterLab as a 'app' or webservice, which will connect to the kernels available on the system. Specifically:
-
-- We will create an installation of JupyterHub and JupyterLab using a virtualenv under `/opt` using the system Python.
-
-- We will install conda globally.
-
-- We will create a shared conda environment which can be used (but not modified) by all users.
-
-- We will show how users can create their own private conda environments, where they can install whatever they like.
-
-
-The default JupyterHub Authenticator uses PAM to authenticate system users with their username and password. One can
-[choose the authenticator](https://jupyterhub.readthedocs.io/en/stable/reference/authenticators.html#authenticators) 
-that best suits their needs. In this guide we will use the default Authenticator because it makes it easy for everyone to manage data 
-in their home folder and to mix and match different services and access methods (e.g. SSH) which all work using the 
-Linux system user accounts. Therefore, each user of JupyterHub will need a standard system user account.
-
-Another goal of this guide is to use system provided packages wherever possible. This has the advantage that these packages
-get automatic patches and security updates (be sure to turn on automatic updates in Ubuntu). This means less maintenance
-work and a more reliable system.
-
-## Part 1: JupyterHub and JupyterLab
-
-### Setup the JupyterHub and JupyterLab in a virtual environment
-
-First we create a virtual environment under '/opt/jupyterhub'. The '/opt' folder is where apps not belonging to the operating
-system are [commonly installed](https://unix.stackexchange.com/questions/11544/what-is-the-difference-between-opt-and-usr-local).
-Both jupyterlab and jupyterhub will be installed into this virtualenv. Create it with the command:
-
-```sh
-sudo python3 -m venv /opt/jupyterhub/
-```
-
-Now we use pip to install the required Python packages into the new virtual environment. Be sure to install 
-`wheel` first. Since we are separating the user interface from the computing kernels, we don't install 
-any Python scientific packages here. The only exception is `ipywidgets` because this is needed to allow connection 
-between interactive tools running in the kernel and the user interface. 
-
-Note that we use `/opt/jupyterhub/bin/python3 -m pip install` each time - this [makes sure](https://snarky.ca/why-you-should-use-python-m-pip/)
-that the packages are installed to the correct virtual environment.
-
-Perform the install using the following commands:
-
-```sh
-sudo /opt/jupyterhub/bin/python3 -m pip install wheel
-sudo /opt/jupyterhub/bin/python3 -m pip install jupyterhub jupyterlab
-sudo /opt/jupyterhub/bin/python3 -m pip install ipywidgets
-```
-
-JupyterHub also currently defaults to requiring `configurable-http-proxy`, which needs `nodejs` and `npm`. The versions
-of these available in Ubuntu therefore need to be installed first (they are a bit old but this is ok for our needs):
-
-```sh
-sudo apt install nodejs npm
-```
-
-Then install `configurable-http-proxy`:
-
-```sh
-npm install -g configurable-http-proxy
-```
-
-### Create the configuration for JupyterHub
-
-Now we start creating configuration files. To keep everything together, we put all the configuration into the folder
-created for the virtualenv, under `/opt/jupyterhub/etc/`. For each thing needing configuration, we will create a further
-subfolder and necessary files. 
-
-First create the folder for the JupyterHub configuration and navigate to it:
-
-```sh
-sudo mkdir -p /opt/jupyterhub/etc/jupyterhub/
-cd /opt/jupyterhub/etc/jupyterhub/
-```
-Then generate the default configuration file
-
-```sh
-sudo /opt/jupyterhub/bin/jupyterhub --generate-config
-```
-This will produce the default configuration file `/opt/jupyterhub/etc/jupyterhub/jupyterhub_config.py`
-
-You will need to edit the configuration file to make the JupyterLab interface by the default. 
-Set the following configuration option in your `jupyterhub_config.py` file:
-
-```python
-c.Spawner.default_url = '/lab' 
-```
-
-Further configuration options may be found in the documentation.
-
-### Setup Systemd service
-
-We will setup JupyterHub to run as a system service using Systemd (which is responsible for managing all services and 
-servers that run on startup in Ubuntu). We will create a service file in a suitable location in the virtualenv folder 
-and then link it to the system services. First create the folder for the service file:
-
-```sh
-sudo mkdir -p /opt/jupyterhub/etc/systemd
-```
-
-Then create the following text file using your [favourite editor](https://micro-editor.github.io/) at
-```sh
-/opt/jupyterhub/etc/systemd/jupyterhub.service
-```
-
-Paste the following service unit definition into the file:
-
-```
-[Unit]
-Description=JupyterHub
-After=syslog.target network.target
-
-[Service]
-User=root
-Environment="PATH=/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/opt/jupyterhub/bin"
-ExecStart=/opt/jupyterhub/bin/jupyterhub -f /opt/jupyterhub/etc/jupyterhub/jupyterhub_config.py
-
-[Install]
-WantedBy=multi-user.target
-```
-
-This sets up the environment to use the virtual environment we created, tells Systemd how to start jupyterhub using
-the configuration file we created, specifies that jupyterhub will be started as the `root` user (needed so that it can
-start jupyter on behalf of other logged in users), and specifies that jupyterhub should start on boot after the network
-is enabled.
-
-Finally, we need to make systemd aware of our service file. First we symlink our file into systemd's directory:
-
-```sh
-sudo ln -s /opt/jupyterhub/etc/systemd/jupyterhub.service /etc/systemd/system/jupyterhub.service
-```
-
-Then tell systemd to reload its configuration files
-
-```sh
-sudo systemctl daemon-reload
-```
-
-And finally enable the service 
-
-```sh
-sudo systemctl enable jupyterhub.service
-```
-
-The service will start on reboot, but we can start it straight away using:
-
-```sh
-sudo systemctl start jupyterhub.service
-```
-
-...and check that it's running using:
-
-```sh
-sudo systemctl status jupyterhub.service
-```
-
-You should now be already be able to access jupyterhub using `<your servers ip>:8000` (assuming you haven't already set
-up a firewall or something). However, when you log in the jupyter notebooks will be trying to use the Python virtualenv
-that was created to install JupyterHub, this is not what we want. So on to part 2   
-
-## Part 2: Conda environments
-
-### Install conda for the whole system
-
-We will use `conda` to manage Python environments. We will install the officially maintained `conda` packages for Ubuntu,
-this means they will get automatic updates with the rest of the system. Setup repo for the official Conda debian packages,
-instructions are copied from [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/rpm-debian.html):
-
-Install Anacononda public gpg key to trusted store
-```sh
-curl https://repo.anaconda.com/pkgs/misc/gpgkeys/anaconda.asc | gpg --dearmor > conda.gpg 
-sudo install -o root -g root -m 644 conda.gpg /etc/apt/trusted.gpg.d/
-```
-
-Add Debian repo
-
-```sh
-sudo echo "deb [arch=amd64] https://repo.anaconda.com/pkgs/misc/debrepo/conda stable main" > /etc/apt/sources.list.d/conda.list
-```
-
-Install conda
-
-```sh
-sudo apt update
-sudo apt install conda
-```
-
-This will install conda into the folder `/opt/conda/`, with the conda command available at `/opt/conda/bin/conda`.
-
-Finally, we can make conda more easily available to users by symlinking the conda shell setup script to the profile
-'drop in' folder so that it gets run on login
-
-```sh
-sudo ln -s /opt/conda/etc/profile.d/conda.sh /etc/profile.d/conda.sh
-```
-
-### Install a default conda environment for all users
-
-First create a folder for conda envs (might exist already):
-```sh
-sudo mkdir /opt/conda/envs/
-```
-
-Then create a conda environment to your liking within that folder. Here we have called it 'python' because it will
-be the obvious default - call it whatever you like. You can install whatever you like into this environment, but you MUST at least install `ipykernel`.
-
-```sh
-sudo /opt/conda/bin/conda create --prefix /opt/conda/envs/python python=3.7 ipykernel
-```
-
-Once your env is set up as desired, make it visible to Jupyter by installing the kernel spec. There are two options here: 
-
-1 ) Install into the JupyterHub virtualenv - this ensures it overrides the default python version. It will only be visible
-to the JupyterHub installation we have just created. This is useful to avoid conda environments appearing where they are not expected.
-
-```sh
-sudo /opt/conda/envs/python/bin/python -m ipykernel install --prefix=/opt/jupyterhub/ --name 'python' --display-name "Python (default)"
-```
-
-2 ) Install it system-wide by putting it into `/usr/local`. It will be visible to any parallel install of JupyterHub or
-JupyterLab, and will persist even if you later delete or modify the JupyterHub installation. This is useful if the kernels
-might be used by other services, or if you want to modify the JupyterHub installation independently from the conda environments.
-
-```sh
-sudo /opt/conda/envs/python/bin/python -m ipykernel install --prefix /usr/local/ --name 'python' --display-name "Python (default)"
-````
-
-### Setting up users' own conda environments
-
-There is relatively little for the administrator to do here, as users will have to set up their own environments using the shell. 
-On login they should run `conda init` or  `/opt/conda/bin/conda`. The can then use conda to set up their environment,
-although they must also install `ipykernel`. Once done, they can enable their kernel using:
-
-```sh
-/path/to/kernel/env/bin/python -m ipykernel install --name 'python-my-env' --display-name "Python My Env"
-```
-
-This will place the kernel spec into their home folder, where Jupyter will look for it on startup.
-
-
-## Setting up a reverse proxy 
-
-The guide so far results in JupyterHub running on port 8000. It is not generally advisable to run open web services in 
-this way - instead, use a reverse proxy running on standard HTTP/HTTPS ports.
-
-> **Important**: Be aware of the security implications especially if you are running a server that is accessible from the open internet 
-> i.e. not protected within an institutional intranet or private home/office network. You should set up a firewall and 
-> HTTPS encryption, which is outside of the scope of this guide. For HTTPS consider using [LetsEncrypt](https://letsencrypt.org/) 
-> or setting up a [self-signed certificate](https://www.digitalocean.com/community/tutorials/how-to-create-a-self-signed-ssl-certificate-for-nginx-in-ubuntu-18-04).
-> Firewalls may be set up using `ufs` or `firewalld` and combined with `fail2ban`.
-
-### Using Nginx
-Nginx is a mature and established web server and reverse proxy and is easy to install using `sudo apt install nginx`.
-Details on using Nginx as a reverse proxy can be found elsewhere. Here, we will only outline the additional steps needed 
-to setup JupyterHub with Nginx and host it at a given URL e.g. `<your-server-ip-or-url>/jupyter`. 
-This could be useful for example if you are running several services or web pages on the same server.
-
-To achieve this needs a few tweaks to both the JupyterHub configuration and the Nginx config. First, edit the
-configuration file `/opt/jupyterhub/etc/jupyterhub/jupyterhub_config.py` and add the line:
-
-```python
-c.JupyterHub.bind_url = 'http://:8000/jupyter'
-```
-
-where `/jupyter` will be the relative URL of the JupyterHub.
-
-Now Nginx must be configured with a to pass all traffic from `/jupyter` to the the local address `127.0.0.1:8000`.
-Add the following snippet to your nginx configuration file (e.g. `/etc/nginx/sites-available/default`).
-
-```
-  location /jupyter/ {    
-    # NOTE important to also set base url of jupyterhub to /jupyter in its config
-    proxy_pass http://127.0.0.1:8000;
-
-    proxy_redirect   off;
-    proxy_set_header X-Real-IP $remote_addr;
-    proxy_set_header Host $host;
-    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_set_header X-Forwarded-Proto $scheme;
-
-    # websocket headers
-    proxy_set_header Upgrade $http_upgrade;
-    proxy_set_header Connection $connection_upgrade;
-
-  }
-```
-
-Nginx will not run if there are errors in the configuration, check your configuration using:
-
-```sh
-nginx -t
-```
-
-If there are no errors, you can restart the Nginx service for the new configuration to take effect.
-
-```sh
-sudo systemctl restart nginx.service
-```
-
-
-## Getting started using your new JupyterHub
-
-Once you have setup JupyterHub and Nginx proxy as described, you can browse to your JupyterHub IP or URL 
-(e.g. if your server IP address is `123.456.789.1` and you decided to host JupyterHub at the `/jupyter` URL, browse
-to `123.456.789.1/jupyter`). You will find a login page where you enter your Linux username and password. On login
-you will be presented with the JupyterLab interface, with the file browser pane showing the contents of your users'
-home directory on the server.

docs/source/installation-guide-hard.rst

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

docs/source/installation-guide.rst

@@ -11,4 +11,3 @@ running on your own infrastructure.
    quickstart
    quickstart-docker
    installation-basics
-   installation-guide-hard

docs/source/quickstart.md

@@ -12,20 +12,24 @@ Before installing JupyterHub, you will need:
 - [nodejs/npm](https://www.npmjs.com/). [Install nodejs/npm](https://docs.npmjs.com/getting-started/installing-node),
   using your operating system's package manager.
 
-  * If you are using **`conda`**, the nodejs and npm dependencies will be installed for
+  - If you are using **`conda`**, the nodejs and npm dependencies will be installed for
     you by conda.
 
-  * If you are using **`pip`**, install a recent version of
+  - If you are using **`pip`**, install a recent version of
     [nodejs/npm](https://docs.npmjs.com/getting-started/installing-node).
     For example, install it on Linux (Debian/Ubuntu) using:
 
     ```
     sudo apt-get install npm nodejs-legacy
     ```
-          
+
     The `nodejs-legacy` package installs the `node` executable and is currently
     required for npm to work on Debian/Ubuntu.
 
+- A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module)
+  to use the [default Authenticator](./getting-started/authenticators-users-basics.md).
+  PAM is often available by default on most distributions, if this is not the case it can be installed by
+  using the operating system's package manager.
 - TLS certificate and key for HTTPS communication
 - Domain name
 
@@ -74,12 +78,12 @@ Visit `https://localhost:8000` in your browser, and sign in with your unix
 credentials.
 
 To **allow multiple users to sign in** to the Hub server, you must start
-`jupyterhub` as a *privileged user*, such as root:
+`jupyterhub` as a _privileged user_, such as root:
 
 ```bash
 sudo jupyterhub
 ```
 
 The [wiki](https://github.com/jupyterhub/jupyterhub/wiki/Using-sudo-to-run-JupyterHub-without-root-privileges)
-describes how to run the server as a *less privileged user*. This requires
+describes how to run the server as a _less privileged user_. This requires
 additional configuration of the system.

docs/source/reference/authenticators.md

@@ -89,7 +89,6 @@ class DictionaryAuthenticator(Authenticator):
             return data['username']
 ```
 
-
 #### Normalize usernames
 
 Since the Authenticator and Spawner both use the same username,
@@ -111,11 +110,10 @@ When using `PAMAuthenticator`, you can set
 normalize usernames using PAM (basically round-tripping them: username
 to uid to username), which is useful in case you use some external
 service that allows multiple usernames mapping to the same user (such
-as ActiveDirectory, yes, this really happens).  When
-`pam_normalize_username` is on, usernames are *not* normalized to
+as ActiveDirectory, yes, this really happens). When
+`pam_normalize_username` is on, usernames are _not_ normalized to
 lowercase.
 
-
 #### Validate usernames
 
 In most cases, there is a very limited set of acceptable usernames.
@@ -132,7 +130,6 @@ To only allow usernames that start with 'w':
 c.Authenticator.username_pattern = r'w.*'
 ```
 
-
 ### How to write a custom authenticator
 
 You can use custom Authenticator subclasses to enable authentication
@@ -145,7 +142,6 @@ and [post_spawn_stop(user, spawner)][], are hooks that can be used to do
 auth-related startup (e.g. opening PAM sessions) and cleanup
 (e.g. closing PAM sessions).
 
-
 See a list of custom Authenticators [on the wiki](https://github.com/jupyterhub/jupyterhub/wiki/Authenticators).
 
 If you are interested in writing a custom authenticator, you can read
@@ -186,7 +182,6 @@ Additionally, configurable attributes for your authenticator will
 appear in jupyterhub help output and auto-generated configuration files
 via `jupyterhub --generate-config`.
 
-
 ### Authentication state
 
 JupyterHub 0.8 adds the ability to persist state related to authentication,
@@ -220,12 +215,10 @@ To store auth_state, two conditions must be met:
    export JUPYTERHUB_CRYPT_KEY=$(openssl rand -hex 32)
    ```
 
-
 JupyterHub uses [Fernet](https://cryptography.io/en/latest/fernet/) to encrypt auth_state.
 To facilitate key-rotation, `JUPYTERHUB_CRYPT_KEY` may be a semicolon-separated list of encryption keys.
 If there are multiple keys present, the **first** key is always used to persist any new auth_state.
 
-
 #### Using auth_state
 
 Typically, if `auth_state` is persisted it is desirable to affect the Spawner environment in some way.
@@ -235,10 +228,9 @@ to Spawner environment:
 
 ```python
 class MyAuthenticator(Authenticator):
-    @gen.coroutine
-    def authenticate(self, handler, data=None):
-        username = yield identify_user(handler, data)
-        upstream_token = yield token_for_user(username)
+    async def authenticate(self, handler, data=None):
+        username = await identify_user(handler, data)
+        upstream_token = await token_for_user(username)
         return {
             'name': username,
             'auth_state': {
@@ -246,10 +238,9 @@ class MyAuthenticator(Authenticator):
             },
         }
 
-    @gen.coroutine
-    def pre_spawn_start(self, user, spawner):
+    async def pre_spawn_start(self, user, spawner):
         """Pass upstream_token to spawner via environment variable"""
-        auth_state = yield user.get_auth_state()
+        auth_state = await user.get_auth_state()
         if not auth_state:
             # auth_state not enabled
             return
@@ -268,11 +259,10 @@ PAM session.
 
 Beginning with version 0.8, JupyterHub is an OAuth provider.
 
-
-[Authenticator]: https://github.com/jupyterhub/jupyterhub/blob/master/jupyterhub/auth.py
-[PAM]: https://en.wikipedia.org/wiki/Pluggable_authentication_module
-[OAuth]: https://en.wikipedia.org/wiki/OAuth
-[GitHub OAuth]: https://developer.github.com/v3/oauth/
-[OAuthenticator]: https://github.com/jupyterhub/oauthenticator
+[authenticator]: https://github.com/jupyterhub/jupyterhub/blob/master/jupyterhub/auth.py
+[pam]: https://en.wikipedia.org/wiki/Pluggable_authentication_module
+[oauth]: https://en.wikipedia.org/wiki/OAuth
+[github oauth]: https://developer.github.com/v3/oauth/
+[oauthenticator]: https://github.com/jupyterhub/oauthenticator
 [pre_spawn_start(user, spawner)]: https://jupyterhub.readthedocs.io/en/latest/api/auth.html#jupyterhub.auth.Authenticator.pre_spawn_start
 [post_spawn_stop(user, spawner)]: https://jupyterhub.readthedocs.io/en/latest/api/auth.html#jupyterhub.auth.Authenticator.post_spawn_stop

docs/source/reference/config-ghoauth.md

@@ -3,18 +3,17 @@
 In this example, we show a configuration file for a fairly standard JupyterHub
 deployment with the following assumptions:
 
-* Running JupyterHub on a single cloud server
-* Using SSL on the standard HTTPS port 443
-* Using GitHub OAuth (using oauthenticator) for login
-* Using the default spawner (to configure other spawners, uncomment and edit
+- Running JupyterHub on a single cloud server
+- Using SSL on the standard HTTPS port 443
+- Using GitHub OAuth (using oauthenticator) for login
+- Using the default spawner (to configure other spawners, uncomment and edit
   `spawner_class` as well as follow the instructions for your desired spawner)
-* Users exist locally on the server
-* Users' notebooks to be served from `~/assignments` to allow users to browse
+- Users exist locally on the server
+- Users' notebooks to be served from `~/assignments` to allow users to browse
   for notebooks within other users' home directories
-* You want the landing page for each user to be a `Welcome.ipynb` notebook in
+- You want the landing page for each user to be a `Welcome.ipynb` notebook in
   their assignments directory.
-* All runtime files are put into `/srv/jupyterhub` and log files in `/var/log`.
-
+- All runtime files are put into `/srv/jupyterhub` and log files in `/var/log`.
 
 The `jupyterhub_config.py` file would have these settings:
 
@@ -52,7 +51,7 @@ c.GitHubOAuthenticator.oauth_callback_url = os.environ['OAUTH_CALLBACK_URL']
 c.LocalAuthenticator.create_system_users = True
 
 # specify users and admin
-c.Authenticator.whitelist = {'rgbkrk', 'minrk', 'jhamrick'}
+c.Authenticator.allowed_users = {'rgbkrk', 'minrk', 'jhamrick'}
 c.Authenticator.admin_users = {'jhamrick', 'rgbkrk'}
 
 # uses the default spawner

docs/source/reference/config-proxy.md

@@ -6,12 +6,12 @@ SSL port `443`. This could be useful if the JupyterHub server machine is also
 hosting other domains or content on `443`. The goal in this example is to
 satisfy the following:
 
-* JupyterHub is running on a server, accessed *only* via `HUB.DOMAIN.TLD:443`
-* On the same machine, `NO_HUB.DOMAIN.TLD` strictly serves different content,
+- JupyterHub is running on a server, accessed _only_ via `HUB.DOMAIN.TLD:443`
+- On the same machine, `NO_HUB.DOMAIN.TLD` strictly serves different content,
   also on port `443`
-* `nginx` or `apache` is used as the public access point (which means that
-  only nginx/apache will bind  to `443`)
-* After testing, the server in question should be able to score at least an A on the
+- `nginx` or `apache` is used as the public access point (which means that
+  only nginx/apache will bind to `443`)
+- After testing, the server in question should be able to score at least an A on the
   Qualys SSL Labs [SSL Server Test](https://www.ssllabs.com/ssltest/)
 
 Let's start out with needed JupyterHub configuration in `jupyterhub_config.py`:
@@ -83,8 +83,12 @@ server {
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 
         # websocket headers
+        proxy_http_version 1.1;
         proxy_set_header Upgrade $http_upgrade;
         proxy_set_header Connection $connection_upgrade;
+        proxy_set_header X-Scheme $scheme;
+
+        proxy_buffering off;
     }
 
     # Managing requests to verify letsencrypt host
@@ -139,6 +143,21 @@ Now restart `nginx`, restart the JupyterHub, and enjoy accessing
 `https://HUB.DOMAIN.TLD` while serving other content securely on
 `https://NO_HUB.DOMAIN.TLD`.
 
+### SELinux permissions for nginx
+
+On distributions with SELinux enabled (e.g. Fedora), one may encounter permission errors
+when the nginx service is started.
+
+We need to allow nginx to perform network relay and connect to the jupyterhub port. The
+following commands do that:
+
+```bash
+semanage port -a -t http_port_t -p tcp 8000
+setsebool -P httpd_can_network_relay 1
+setsebool -P httpd_can_network_connect 1
+```
+
+Replace 8000 with the port the jupyterhub server is running from.
 
 ## Apache
 
@@ -193,22 +212,24 @@ Listen 443
 </VirtualHost>
 ```
 
- 
 In case of the need to run the jupyterhub under /jhub/ or other location please use the below configurations:
+
 - JupyterHub running locally at http://127.0.0.1:8000/jhub/ or other location
 
 httpd.conf amendments:
+
 ```bash
- RewriteRule /jhub/(.*) ws://127.0.0.1:8000/jhub/$1 [P,L]
- RewriteRule /jhub/(.*) http://127.0.0.1:8000/jhub/$1 [P,L]
- 
+ RewriteRule /jhub/(.*) ws://127.0.0.1:8000/jhub/$1 [NE.P,L]
+ RewriteRule /jhub/(.*) http://127.0.0.1:8000/jhub/$1 [NE,P,L]
+
  ProxyPass /jhub/ http://127.0.0.1:8000/jhub/
  ProxyPassReverse /jhub/  http://127.0.0.1:8000/jhub/
- ```
- 
+```
+
 jupyterhub_config.py amendments:
- ```bash
-  --The public facing URL of the whole JupyterHub application.
-  --This is the address on which the proxy will bind. Sets protocol, ip, base_url
-  c.JupyterHub.bind_url = 'http://127.0.0.1:8000/jhub/'
-  ```
+
+```bash
+ --The public facing URL of the whole JupyterHub application.
+ --This is the address on which the proxy will bind. Sets protocol, ip, base_url
+ c.JupyterHub.bind_url = 'http://127.0.0.1:8000/jhub/'
+```

docs/source/reference/config-reference.rst

@@ -0,0 +1,30 @@
+==============================
+Configuration Reference
+==============================
+
+.. important::
+
+    Make sure the version of JupyterHub for this documentation matches your
+    installation version, as the output of this command may change between versions.
+
+JupyterHub configuration
+------------------------
+
+As explained in the `Configuration Basics <../getting-started/config-basics.html#generate-a-default-config-file>`_
+section, the ``jupyterhub_config.py`` can be automatically generated via
+
+    .. code-block:: bash
+
+        jupyterhub --generate-config
+
+
+The following contains the output of that command for reference.
+
+.. jupyterhub-generate-config::
+
+JupyterHub help command output
+------------------------------
+
+This section contains the output of the command ``jupyterhub --help-all``.
+
+.. jupyterhub-help-all::

docs/source/reference/config-sudo.md

@@ -9,7 +9,7 @@ Only do this if you are very sure you must.
 There are many Authenticators and Spawners available for JupyterHub. Some, such
 as DockerSpawner or 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 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
@@ -50,14 +50,13 @@ To do this we add to `/etc/sudoers` (use `visudo` for safe editing of sudoers):
 
 - specify the list of users `JUPYTER_USERS` for whom `rhea` can spawn servers
 - set the command `JUPYTER_CMD` that `rhea` can execute on behalf of users
-- give `rhea` permission to run `JUPYTER_CMD` on behalf of `JUPYTER_USERS` 
+- give `rhea` permission to run `JUPYTER_CMD` on behalf of `JUPYTER_USERS`
   without entering a password
 
-
 For example:
 
 ```bash
-# comma-separated whitelist of users that can spawn single-user servers
+# comma-separated list of users that can spawn single-user servers
 # this should include all of your Hub users
 Runas_Alias JUPYTER_USERS = rhea, zoe, wash
 
@@ -91,16 +90,16 @@ $ adduser -G jupyterhub newuser
 Test that the new user doesn't need to enter a password to run the sudospawner
 command.
 
-This should prompt for your password to switch to rhea, but *not* prompt for
+This should prompt for your password to switch to rhea, but _not_ prompt for
 any password for the second switch. It should show some help output about
 logging options:
 
 ```bash
 $ sudo -u rhea sudo -n -u $USER /usr/local/bin/sudospawner --help
 Usage: /usr/local/bin/sudospawner [OPTIONS]
-    
+
 Options:
-    
+
 --help          show this help information
 ...
 ```
@@ -120,6 +119,11 @@ the shadow password database.
 
 ### Shadow group (Linux)
 
+**Note:** On Fedora based distributions there is no clear way to configure
+the PAM database to allow sufficient access for authenticating with the target user's password
+from JupyterHub. As a workaround we recommend use an
+[alternative authentication method](https://github.com/jupyterhub/jupyterhub/wiki/Authenticators).
+
 ```bash
 $ ls -l /etc/shadow
 -rw-r-----  1 root shadow   2197 Jul 21 13:41 shadow
@@ -146,12 +150,13 @@ We want our new user to be able to read the shadow passwords, so add it to the s
     $ sudo usermod -a -G shadow rhea
 ```
 
-If you want jupyterhub to serve pages on a restricted port (such as port 80 for http), 
+If you want jupyterhub to serve pages on a restricted port (such as port 80 for http),
 then you will need to give `node` permission to do so:
 
 ```bash
 sudo setcap 'cap_net_bind_service=+ep' /usr/bin/node
 ```
+
 However, you may want to further understand the consequences of this.
 
 You may also be interested in limiting the amount of CPU any process can use
@@ -160,7 +165,6 @@ 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).
 
-
 ### Shadow group (FreeBSD)
 
 **NOTE:** This has not been tested and may not work as expected.
@@ -181,7 +185,7 @@ $ sudo chgrp shadow /etc/master.passwd
 $ sudo chmod g+r /etc/master.passwd
 ```
 
-We want our new user to be able to read the shadow passwords, so add it to the 
+We want our new user to be able to read the shadow passwords, so add it to the
 shadow group:
 
 ```bash
@@ -215,7 +219,7 @@ Finally, start the server as our newly configured user, `rhea`:
 ```bash
 $ cd /etc/jupyterhub
 $ sudo -u rhea jupyterhub --JupyterHub.spawner_class=sudospawner.SudoSpawner
-```                                                                             
+```
 
 And try logging in.
 
@@ -223,7 +227,7 @@ And try logging in.
 
 If you still get a generic `Permission denied` `PermissionError`, it's possible SELinux is blocking you.  
 Here's how you can make a module to allow this.
-First, put this in a file  named `sudo_exec_selinux.te`:
+First, put this in a file named `sudo_exec_selinux.te`:
 
 ```bash
 module sudo_exec_selinux 1.1;

docs/source/reference/config-user-env.md

@@ -22,20 +22,18 @@ This section will focus on user environments, including:
 - Installing kernelspecs
 - Using containers vs. multi-user hosts
 
-
 ## Installing packages
 
 To make packages available to users, you generally will install packages
 system-wide or in a shared environment.
 
 This installation location should always be in the same environment that
-`jupyterhub-singleuser` itself is installed in, and must be *readable and
-executable* by your users. If you want users to be able to install additional
-packages, it must also be *writable* by your users.
+`jupyterhub-singleuser` itself is installed in, and must be _readable and
+executable_ by your users. If you want users to be able to install additional
+packages, it must also be _writable_ by your users.
 
 If you are using a standard system Python install, you would use:
 
-
 ```bash
 sudo python3 -m pip install numpy
 ```
@@ -47,7 +45,6 @@ You may also use conda to install packages. If you do, you should make sure
 that the conda environment has appropriate permissions for users to be able to
 run Python code in the env.
 
-
 ## Configuring Jupyter and IPython
 
 [Jupyter](https://jupyter-notebook.readthedocs.io/en/stable/config_overview.html)
@@ -64,6 +61,7 @@ users. It's generally more efficient to configure user environments "system-wide
 and it's a good idea to avoid creating files in users' home directories.
 
 The typical locations for these config files are:
+
 - **system-wide** in `/etc/{jupyter|ipython}`
 - **env-wide** (environment wide) in `{sys.prefix}/etc/{jupyter|ipython}`.
 
@@ -91,7 +89,6 @@ c.MappingKernelManager.cull_idle_timeout = 20 * 60
 c.MappingKernelManager.cull_interval = 2 * 60
 ```
 
-
 ## Installing kernelspecs
 
 You may have multiple Jupyter kernels installed and want to make sure that
@@ -119,7 +116,6 @@ sure are available, I can install their specs system-wide (in /usr/local) with:
 /path/to/python2 -m IPython kernel install --prefix=/usr/local
 ```
 
-
 ## Multi-user hosts vs. Containers
 
 There are two broad categories of user environments that depend on what
@@ -141,8 +137,8 @@ When JupyterHub uses **container-based** Spawners (e.g. KubeSpawner or
 DockerSpawner), the 'system-wide' environment is really the container image
 which you are using for users.
 
-In both cases, you want to *avoid putting configuration in user home
-directories* because users can change those configuration settings. Also,
+In both cases, you want to _avoid putting configuration in user home
+directories_ because users can change those configuration settings. Also,
 home directories typically persist once they are created, so they are
 difficult for admins to update later.
 
@@ -179,3 +175,13 @@ The number of named servers per user can be limited by setting
 ```python
 c.JupyterHub.named_server_limit_per_user = 5
 ```
+
+## Switching to Jupyter Server
+
+[Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/) is a new Tornado Server backend for Jupyter web applications (e.g. JupyterLab 3.0 uses this package as its default backend).
+
+By default, the single-user notebook server uses the (old) `NotebookApp` from the [notebook](https://github.com/jupyter/notebook) package. You can switch to using Jupyter Server's `ServerApp` backend (this will likely become the default in future releases) by setting the `JUPYTERHUB_SINGLEUSER_APP` environment variable to:
+
+```bash
+export JUPYTERHUB_SINGLEUSER_APP='jupyter_server.serverapp.ServerApp'
+```

docs/source/reference/database.md

@@ -46,8 +46,8 @@ additional configuration required for MySQL that is not needed for PostgreSQL.
 
 - You should use the `pymysql` sqlalchemy provider (the other one, MySQLdb,
   isn't available for py3).
-- You also need to set `pool_recycle` to some value (typically 60 - 300) 
-  which depends on your  MySQL setup. This is necessary since MySQL kills
+- You also need to set `pool_recycle` to some value (typically 60 - 300)
+  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

docs/source/reference/index.rst

@@ -16,6 +16,7 @@ what happens under-the-hood when you deploy and configure your JupyterHub.
    proxy
    separate-proxy
    rest
+   monitoring
    database
    templates
    ../events/index
@@ -24,3 +25,4 @@ what happens under-the-hood when you deploy and configure your JupyterHub.
    config-ghoauth
    config-proxy
    config-sudo
+   config-reference

docs/source/reference/monitoring.rst

@@ -0,0 +1,20 @@
+Monitoring
+==========
+
+This section covers details on monitoring the state of your JupyterHub installation.
+
+JupyterHub expose the ``/metrics`` endpoint that returns text describing its current
+operational state formatted in a way `Prometheus <https://prometheus.io/docs/introduction/overview/>`_ understands.
+
+Prometheus is a separate open source tool that can be configured to repeatedly poll
+JupyterHub's ``/metrics`` endpoint to parse and save its current state.
+
+By doing so, Prometheus can describe JupyterHub's evolving state over time.
+This evolving state can then be accessed through Prometheus that expose its underlying
+storage to those allowed to access it, and be presented with dashboards by a
+tool like `Grafana <https://grafana.com/docs/grafana/latest/getting-started/what-is-grafana/>`_.
+
+.. toctree::
+   :maxdepth: 2
+
+   metrics

docs/source/reference/proxy.md

@@ -54,7 +54,7 @@ class MyProxy(Proxy):
         """Stop the proxy"""
 ```
 
-These methods **may** be  coroutines.
+These methods **may** be coroutines.
 
 `c.Proxy.should_start` is a configurable flag that determines whether the
 Hub should call these methods when the Hub itself starts and stops.
@@ -103,7 +103,7 @@ route to be proxied, such as `/user/name/`. A routespec will:
 
 When adding a route, JupyterHub may pass a JSON-serializable dict as a `data`
 argument that should be attached to the proxy route. When that route is
-retrieved, the `data` argument should be returned as well. If your  proxy
+retrieved, the `data` argument should be returned as well. If your proxy
 implementation doesn't support storing data attached to routes, then your
 Python wrapper may have to handle storing the `data` piece itself, e.g in a
 simple file or database.
@@ -136,7 +136,7 @@ async def delete_route(self, routespec):
 
 ### Retrieving routes
 
-For retrieval, you only *need* to implement a single method that retrieves all
+For retrieval, you only _need_ to implement a single method that retrieves all
 routes. The return value for this function should be a dictionary, keyed by
 `routespect`, of dicts whose keys are the same three arguments passed to
 `add_route` (`routespec`, `target`, `data`)

docs/source/reference/rest.md

@@ -57,6 +57,9 @@ generating an API token is available from the JupyterHub user interface:
 
 ## Add API tokens to the config file
 
+**This is deprecated. We are in no rush to remove this feature,
+but please consider if service tokens are right for you.**
+
 You may also add a dictionary of API tokens and usernames to the hub's
 configuration file, `jupyterhub_config.py` (note that
 the **key** is the 'secret-token' while the **value** is the 'username'):
@@ -67,6 +70,41 @@ c.JupyterHub.api_tokens = {
 }
 ```
 
+### Updating to admin services
+
+The `api_tokens` configuration has been softly deprecated since the introduction of services.
+We have no plans to remove it,
+but users are encouraged to use service configuration instead.
+
+If you have been using `api_tokens` to create an admin user
+and a token for that user to perform some automations,
+the services mechanism may be a better fit.
+If you have the following configuration:
+
+```python
+c.JupyterHub.admin_users = {"service-admin",}
+c.JupyterHub.api_tokens = {
+    "secret-token": "service-admin",
+}
+```
+
+This can be updated to create an admin service, with the following configuration:
+
+```python
+c.JupyterHub.services = [
+    {
+        "name": "service-token",
+        "admin": True,
+        "api_token": "secret-token",
+    },
+]
+```
+
+The token will have the same admin permissions,
+but there will no longer be a user account created to house it.
+The main noticeable difference is that there will be no notebook server associated with the account
+and the service will not show up in the various user list pages and APIs.
+
 ## Make an API request
 
 To authenticate your requests, pass the API token in the request's
@@ -131,7 +169,7 @@ curl -X POST -H "Authorization: token <token>" "http://127.0.0.1:8081/hub/api/us
 ```
 
 With the named-server functionality, it's now possible to launch more than one
-specifically named servers against a given user.  This could be used, for instance,
+specifically named servers against a given user. This could be used, for instance,
 to launch each server based on a different image.
 
 First you must enable named-servers by including the following setting in the `jupyterhub_config.py` file.
@@ -149,6 +187,7 @@ hub:
 ```
 
 With that setting in place, a new named-server is activated like this:
+
 ```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>"
@@ -163,7 +202,6 @@ will need to be able to handle the case of multiple servers per user and ensure
 uniqueness of names, particularly if servers are spawned via docker containers
 or kubernetes pods.
 
-
 ## Learn more about the API
 
 You can see the full [JupyterHub REST API][] for details. This REST API Spec can
@@ -172,6 +210,6 @@ Both resources contain the same information and differ only in its display.
 Note: The Swagger specification is being renamed the [OpenAPI Initiative][].
 
 [interactive style on swagger's petstore]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#!/default
-[OpenAPI Initiative]: https://www.openapis.org/
-[JupyterHub REST API]: ./rest-api
-[Jupyter Notebook REST API]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml
+[openapi initiative]: https://www.openapis.org/
+[jupyterhub rest api]: ./rest-api
+[jupyter notebook rest api]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml

docs/source/reference/separate-proxy.md

@@ -1,28 +1,26 @@
 # Running proxy separately from the hub
 
-
 ## Background
 
 The thing which users directly connect to is the proxy, by default
-`configurable-http-proxy`.  The proxy either redirects users to the
+`configurable-http-proxy`. The proxy either redirects users to the
 hub (for login and managing servers), or to their own single-user
-servers.  Thus, as long as the proxy stays running, access to existing
+servers. Thus, as long as the proxy stays running, access to existing
 servers continues, even if the hub itself restarts or goes down.
 
 When you first configure the hub, you may not even realize this
-because the proxy is automatically managed by the hub.  This is great
+because the proxy is automatically managed by the hub. This is great
 for getting started and even most use, but everytime you restart the
-hub, all user connections also get restarted.  But it's also simple to
+hub, all user connections also get restarted. But it's also simple to
 run the proxy as a service separate from the hub, so that you are free
 to reconfigure the hub while only interrupting users who are currently
 actively starting the hub.
 
 The default JupyterHub proxy is
 [configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy),
-and that page has some docs.  If you are using a different proxy, such
+and that page has some docs. If you are using a different proxy, such
 as Traefik, these instructions are probably not relevant to you.
 
-
 ## Configuration options
 
 `c.JupyterHub.cleanup_servers = False` should be set, which tells the
@@ -37,24 +35,20 @@ it yourself).
 token for authenticating communication with the proxy.
 
 `c.ConfigurableHTTPProxy.api_url = 'http://localhost:8001'` should be
-set to the URL which the hub uses to connect *to the proxy's API*.
-
+set to the URL which the hub uses to connect _to the proxy's API_.
 
 ## Proxy configuration
 
-You need to configure a service to start the proxy.  An example
-command line for this is `configurable-http-proxy --ip=127.0.0.1
---port=8000 --api-ip=127.0.0.1 --api-port=8001
---default-target=http://localhost:8081
---error-target=http://localhost:8081/hub/error`.  (Details for how to
+You need to configure a service to start the proxy. An example
+command line for this is `configurable-http-proxy --ip=127.0.0.1 --port=8000 --api-ip=127.0.0.1 --api-port=8001 --default-target=http://localhost:8081 --error-target=http://localhost:8081/hub/error`. (Details for how to
 do this is out of scope for this tutorial - for example it might be a
-systemd service on within another docker cotainer).  The proxy has no
+systemd service on within another docker cotainer). The proxy has no
 configuration files, all configuration is via the command line and
 environment variables.
 
 `--api-ip` and `--api-port` (which tells the proxy where to listen) should match the hub's `ConfigurableHTTPProxy.api_url`.
 
-`--ip`, `-port`, and other options configure the *user* connections to the proxy.
+`--ip`, `-port`, and other options configure the _user_ connections to the proxy.
 
 `--default-target` and `--error-target` should point to the hub, and used when users navigate to the proxy originally.
 
@@ -63,18 +57,16 @@ match the token given to `c.ConfigurableHTTPProxy.auth_token`.
 
 You should check the [configurable-http-proxy
 options](https://github.com/jupyterhub/configurable-http-proxy) to see
-what other options are needed, for example SSL options.  Note that
+what other options are needed, for example SSL options. Note that
 these are configured in the hub if the hub is starting the proxy - you
 need to move the options to here.
 
-
 ## Docker image
 
 You can use [jupyterhub configurable-http-proxy docker
 image](https://hub.docker.com/r/jupyterhub/configurable-http-proxy/)
 to run the proxy.
 
-
 ## See also
 
-* [jupyterhub configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy)
+- [jupyterhub configurable-http-proxy](https://github.com/jupyterhub/configurable-http-proxy)

docs/source/reference/services.md

@@ -45,17 +45,14 @@ A Service may have the following properties:
 - `url: str (default - None)` - The URL where the service is/should be. If a
   url is specified for where the Service runs its own web server,
   the service will be added to the proxy at `/services/:name`
-- `api_token: str (default - None)` - For Externally-Managed Services you need to specify 
+- `api_token: str (default - None)` - For Externally-Managed Services you need to specify
   an API token to perform API requests to the Hub
 
 If a service is also to be managed by the Hub, it has a few extra options:
 
-- `command: (str/Popen list`) - Command for JupyterHub to spawn the service.
-      - Only use this if the service should be a subprocess.
-      - If command is not specified, the Service is assumed to be managed
-        externally.
-      - If a command is specified for launching the Service, the Service will
-        be started and managed by the Hub.
+- `command: (str/Popen list)` - Command for JupyterHub to spawn the service. - Only use this if the service should be a subprocess. - If command is not specified, the Service is assumed to be managed
+  externally. - If a command is specified for launching the Service, the Service will
+  be started and managed by the Hub.
 - `environment: dict` - additional environment variables for the Service.
 - `user: str` - the name of a system user to manage the Service. If
   unspecified, run as the same user as the Hub.
@@ -91,9 +88,9 @@ This example would be configured as follows in `jupyterhub_config.py`:
 ```python
 c.JupyterHub.services = [
     {
-        'name': 'cull-idle',
+        'name': 'idle-culler',
         'admin': True,
-        'command': [sys.executable, '/path/to/cull-idle.py', '--timeout']
+        'command': [sys.executable, '-m', 'jupyterhub_idle_culler', '--timeout=3600']
     }
 ]
 ```
@@ -103,9 +100,9 @@ parameters, which describe the environment needed to start the Service process:
 
 - `environment: dict` - additional environment variables for the Service.
 - `user: str` - name of the user to run the server if different from the Hub.
-   Requires Hub to be root.
+  Requires Hub to be root.
 - `cwd: path` directory in which to run the Service, if different from the
-   Hub directory.
+  Hub directory.
 
 The Hub will pass the following environment variables to launch the Service:
 
@@ -123,15 +120,14 @@ For the previous 'cull idle' Service example, these environment variables
 would be passed to the Service when the Hub starts the 'cull idle' Service:
 
 ```bash
-JUPYTERHUB_SERVICE_NAME: 'cull-idle'
+JUPYTERHUB_SERVICE_NAME: 'idle-culler'
 JUPYTERHUB_API_TOKEN: API token assigned to the service
 JUPYTERHUB_API_URL: http://127.0.0.1:8080/hub/api
 JUPYTERHUB_BASE_URL: https://mydomain[:port]
-JUPYTERHUB_SERVICE_PREFIX: /services/cull-idle/
+JUPYTERHUB_SERVICE_PREFIX: /services/idle-culler/
 ```
 
-See the JupyterHub GitHub repo for additional information about the
-[`cull-idle` example](https://github.com/jupyterhub/jupyterhub/tree/master/examples/cull-idle).
+See the GitHub repo for additional information about the [jupyterhub_idle_culler][].
 
 ## Externally-Managed Services
 
@@ -151,6 +147,8 @@ c.JupyterHub.services = [
     {
         'name': 'my-web-service',
         'url': 'https://10.0.1.1:1984',
+        # any secret >8 characters, you'll use api_token to
+        # authenticate api requests to the hub from your service
         'api_token': 'super-secret',
     }
 ]
@@ -198,16 +196,16 @@ can be used by services. You may go beyond this reference implementation and
 create custom hub-authenticating clients and services. We describe the process
 below.
 
-The reference, or base, implementation is the [`HubAuth`][HubAuth] class,
+The reference, or base, implementation is the [`HubAuth`][hubauth] class,
 which implements the requests to the Hub.
 
 To use HubAuth, you must set the `.api_token`, either programmatically when constructing the class,
 or via the `JUPYTERHUB_API_TOKEN` environment variable.
 
-Most of the logic for authentication implementation is found in the 
-[`HubAuth.user_for_cookie`][HubAuth.user_for_cookie] 
-and in the 
-[`HubAuth.user_for_token`][HubAuth.user_for_token]
+Most of the logic for authentication implementation is found in the
+[`HubAuth.user_for_cookie`][hubauth.user_for_cookie]
+and in the
+[`HubAuth.user_for_token`][hubauth.user_for_token]
 methods, which makes a request of the Hub, and returns:
 
 - None, if no user could be identified, or
@@ -284,11 +282,10 @@ def whoami(user):
         )
 ```
 
-
 ### Authenticating tornado services with JupyterHub
 
 Since most Jupyter services are written with tornado,
-we include a mixin class, [`HubAuthenticated`][HubAuthenticated],
+we include a mixin class, [`HubAuthenticated`][hubauthenticated],
 for quickly authenticating your own tornado services with JupyterHub.
 
 Tornado's `@web.authenticated` method calls a Handler's `.get_current_user`
@@ -309,66 +306,65 @@ class MyHandler(HubAuthenticated, web.RequestHandler):
         ...
 ```
 
-
 The HubAuth will automatically load the desired configuration from the Service
 environment variables.
 
-If you want to limit user access, you can whitelist users through either the
+If you want to limit user access, you can specify allowed users through either the
 `.hub_users` attribute or `.hub_groups`. These are sets that check against the
 username and user group list, respectively. If a user matches neither the user
 list nor the group list, they will not be allowed access. If both are left
 undefined, then any user will be allowed.
 
-
 ### Implementing your own Authentication with JupyterHub
 
 If you don't want to use the reference implementation
 (e.g. you find the implementation a poor fit for your Flask app),
 you can implement authentication via the Hub yourself.
-We recommend looking at the [`HubAuth`][HubAuth] class implementation for reference,
+We recommend looking at the [`HubAuth`][hubauth] class implementation for reference,
 and taking note of the following process:
 
 1. retrieve the cookie `jupyterhub-services` from the request.
 2. Make an API request `GET /hub/api/authorizations/cookie/jupyterhub-services/cookie-value`,
-    where cookie-value is the url-encoded value of the `jupyterhub-services` cookie.
-    This request must be authenticated with a Hub API token in the `Authorization` header.
-    For example, with [requests][]:
+   where cookie-value is the url-encoded value of the `jupyterhub-services` cookie.
+   This request must be authenticated with a Hub API token in the `Authorization` header,
+   for example using the `api_token` from your [external service's configuration](#externally-managed-services).
 
-    ```python
-    r = requests.get(
-        '/'.join((["http://127.0.0.1:8081/hub/api",
-                   "authorizations/cookie/jupyterhub-services",
-                   quote(encrypted_cookie, safe=''),
-        ]),
-        headers = {
-            'Authorization' : 'token %s' % api_token,
-        },
-    )
-    r.raise_for_status()
-    user = r.json()
-    ```
+   For example, with [requests][]:
+
+   ```python
+   r = requests.get(
+       '/'.join(["http://127.0.0.1:8081/hub/api",
+                  "authorizations/cookie/jupyterhub-services",
+                  quote(encrypted_cookie, safe=''),
+       ]),
+       headers = {
+           'Authorization' : 'token %s' % api_token,
+       },
+   )
+   r.raise_for_status()
+   user = r.json()
+   ```
 
 3. On success, the reply will be a JSON model describing the user:
 
    ```json
    {
      "name": "inara",
-     "groups": ["serenity", "guild"],
-
+     "groups": ["serenity", "guild"]
    }
    ```
 
 An example of using an Externally-Managed Service and authentication is
 in [nbviewer README][nbviewer example] section on securing the notebook viewer,
-and an example of its configuration is found [here](https://github.com/jupyter/nbviewer/blob/master/nbviewer/providers/base.py#L94).
+and an example of its configuration is found [here](https://github.com/jupyter/nbviewer/blob/ed942b10a52b6259099e2dd687930871dc8aac22/nbviewer/providers/base.py#L95).
 nbviewer can also be run as a Hub-Managed Service as described [nbviewer README][nbviewer example]
 section on securing the notebook viewer.
 
-
 [requests]: http://docs.python-requests.org/en/master/
 [services_auth]: ../api/services.auth.html
-[HubAuth]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth
-[HubAuth.user_for_cookie]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth.user_for_cookie
-[HubAuth.user_for_token]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth.user_for_token
-[HubAuthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated
+[hubauth]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth
+[hubauth.user_for_cookie]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth.user_for_cookie
+[hubauth.user_for_token]: ../api/services.auth.html#jupyterhub.services.auth.HubAuth.user_for_token
+[hubauthenticated]: ../api/services.auth.html#jupyterhub.services.auth.HubAuthenticated
 [nbviewer example]: https://github.com/jupyter/nbviewer#securing-the-notebook-viewer
+[jupyterhub_idle_culler]: https://github.com/jupyterhub/jupyterhub-idle-culler

docs/source/reference/spawners.md

@@ -8,18 +8,17 @@ and a custom Spawner needs to be able to take three actions:
 - poll whether the process is still running
 - stop the process
 
-
 ## Examples
 
 Custom Spawners for JupyterHub can be found on the [JupyterHub wiki](https://github.com/jupyterhub/jupyterhub/wiki/Spawners).
 Some examples include:
 
 - [DockerSpawner](https://github.com/jupyterhub/dockerspawner) for spawning user servers in Docker containers
-  * `dockerspawner.DockerSpawner` for spawning identical Docker containers for
+  - `dockerspawner.DockerSpawner` for spawning identical Docker containers for
     each users
-  * `dockerspawner.SystemUserSpawner` for spawning Docker containers with an
+  - `dockerspawner.SystemUserSpawner` for spawning Docker containers with an
     environment and home directory for each users
-  * both `DockerSpawner` and `SystemUserSpawner` also work with Docker Swarm for
+  - both `DockerSpawner` and `SystemUserSpawner` also work with Docker Swarm for
     launching containers on remote machines
 - [SudoSpawner](https://github.com/jupyterhub/sudospawner) enables JupyterHub to
   run without being root, by spawning an intermediate process via `sudo`
@@ -27,9 +26,8 @@ Some examples include:
   servers using batch systems
 - [YarnSpawner](https://github.com/jupyterhub/yarnspawner) for spawning notebook
   servers in YARN containers on a Hadoop cluster
-- [RemoteSpawner](https://github.com/zonca/remotespawner) to spawn notebooks
-  and a remote server and tunnel the port via SSH
-
+- [SSHSpawner](https://github.com/NERSC/sshspawner) to spawn notebooks
+  on a remote server using SSH
 
 ## Spawner control methods
 
@@ -41,7 +39,7 @@ an object encapsulating the user's name, authentication, and server info.
 
 The return value of `Spawner.start` should be the (ip, port) of the running server.
 
-**NOTE:** When writing coroutines, *never* `yield` in between a database change and a commit.
+**NOTE:** When writing coroutines, _never_ `yield` in between a database change and a commit.
 
 Most `Spawner.start` functions will look similar to this example:
 
@@ -80,7 +78,6 @@ to check if the local process is still running. On Windows, it uses `psutil.pid_
 
 `Spawner.stop` should stop the process. It must be a tornado coroutine, which should return when the process has finished exiting.
 
-
 ## Spawner state
 
 JupyterHub should be able to stop and restart without tearing down
@@ -112,7 +109,6 @@ def clear_state(self):
     self.pid = 0
 ```
 
-
 ## Spawner options form
 
 (new in 0.4)
@@ -170,8 +166,7 @@ which would return:
 
 When `Spawner.start` is called, this dictionary is accessible as `self.user_options`.
 
-
-[Spawner]: https://github.com/jupyterhub/jupyterhub/blob/master/jupyterhub/spawner.py
+[spawner]: https://github.com/jupyterhub/jupyterhub/blob/master/jupyterhub/spawner.py
 
 ## Writing a custom spawner
 
@@ -212,7 +207,6 @@ Additionally, configurable attributes for your spawner will
 appear in jupyterhub help output and auto-generated configuration files
 via `jupyterhub --generate-config`.
 
-
 ## Spawners, resource limits, and guarantees (Optional)
 
 Some spawners of the single-user notebook servers allow setting limits or
@@ -224,10 +218,9 @@ support for them**. For example, LocalProcessSpawner, the default
 spawner, does not support limits and guarantees. One of the spawners
 that supports limits and guarantees is the `systemdspawner`.
 
-
 ### Memory Limits & Guarantees
 
-`c.Spawner.mem_limit`: A **limit** specifies the *maximum amount of memory*
+`c.Spawner.mem_limit`: A **limit** specifies the _maximum amount of memory_
 that may be allocated, though there is no promise that the maximum amount will
 be available. In supported spawners, you can set `c.Spawner.mem_limit` to
 limit the total amount of memory that a single-user notebook server can
@@ -235,8 +228,8 @@ allocate. Attempting to use more memory than this limit will cause errors. The
 single-user notebook server can discover its own memory limit by looking at
 the environment variable `MEM_LIMIT`, which is specified in absolute bytes.
 
-`c.Spawner.mem_guarantee`: Sometimes, a **guarantee** of a *minimum amount of
-memory* is desirable. In this case, you can set `c.Spawner.mem_guarantee` to
+`c.Spawner.mem_guarantee`: Sometimes, a **guarantee** of a _minimum amount of
+memory_ is desirable. In this case, you can set `c.Spawner.mem_guarantee` to
 to provide a guarantee that at minimum this much memory will always be
 available for the single-user notebook server to use. The environment variable
 `MEM_GUARANTEE` will also be set in the single-user notebook server.
@@ -271,7 +264,7 @@ utilize these certs, there are two methods of interest on the base `Spawner`
 class: `.create_certs` and `.move_certs`.
 
 The first method, `.create_certs` will sign a key-cert pair using an internally
-trusted authority for notebooks.  During this process, `.create_certs` can
+trusted authority for notebooks. During this process, `.create_certs` can
 apply `ip` and `dns` name information to the cert via an `alt_names` `kwarg`.
 This is used for certificate authentication (verification). Without proper
 verification, the `Notebook` will be unable to communicate with the `Hub` and

docs/source/reference/templates.md

@@ -1,8 +1,8 @@
 # Working with templates and UI
 
 The pages of the JupyterHub application are generated from
-[Jinja](http://jinja.pocoo.org/) templates.  These allow the header, for
-example, to be defined once and incorporated into all pages.  By providing
+[Jinja](http://jinja.pocoo.org/) templates. These allow the header, for
+example, to be defined once and incorporated into all pages. By providing
 your own templates, you can have complete control over JupyterHub's
 appearance.
 
@@ -20,7 +20,7 @@ or as few templates as you desire.
 
 Jinja provides a mechanism to [extend templates](http://jinja.pocoo.org/docs/2.10/templates/#template-inheritance).
 A base template can define a `block`, and child templates can replace or
-supplement the material in the block.  The 
+supplement the material in the block. The
 [JupyterHub templates](https://github.com/jupyterhub/jupyterhub/tree/master/share/jupyterhub/templates)
 make extensive use of blocks, which allows you to customize parts of the
 interface easily.
@@ -32,8 +32,8 @@ In general, a child template can extend a base template, `page.html`, by beginni
 ```
 
 This works, unless you are trying to extend the default template for the same
-file name.  Starting in version 0.9, you may refer to the base file with a
-`templates/` prefix.  Thus, if you are writing a custom `page.html`, start the
+file name. Starting in version 0.9, you may refer to the base file with a
+`templates/` prefix. Thus, if you are writing a custom `page.html`, start the
 file with this block:
 
 ```html
@@ -41,7 +41,7 @@ file with this block:
 ```
 
 By defining `block`s with same name as in the base template, child templates
-can replace those sections with custom content.  The content from the base
+can replace those sections with custom content. The content from the base
 template can be included with the `{{ super() }}` directive.
 
 ### Example
@@ -52,10 +52,7 @@ text about the server starting up, place this content in a file named
 `JupyterHub.template_paths` configuration option.
 
 ```html
-{% extends "templates/spawn_pending.html" %}
-
-{% block message %}
-{{ super() }}
+{% extends "templates/spawn_pending.html" %} {% block message %} {{ super() }}
 <p>Patience is a virtue.</p>
 {% endblock %}
 ```
@@ -69,9 +66,8 @@ To add announcements to be displayed on a page, you have two options:
 
 ### Announcement Configuration Variables
 
-If you set the configuration variable `JupyterHub.template_vars =
-{'announcement': 'some_text'}`, the given `some_text` will be placed on
-the top of all pages.  The more specific variables
+If you set the configuration variable `JupyterHub.template_vars = {'announcement': 'some_text'}`, the given `some_text` will be placed on
+the top of all pages. The more specific variables
 `announcement_login`, `announcement_spawn`, `announcement_home`, and
 `announcement_logout` are more specific and only show on their
 respective pages (overriding the global `announcement` variable).
@@ -79,13 +75,12 @@ Note that changing these variables require a restart, unlike direct
 template extension.
 
 You can get the same effect by extending templates, which allows you
-to update the messages without restarting.  Set
+to update the messages without restarting. Set
 `c.JupyterHub.template_paths` as mentioned above, and then create a
 template (for example, `login.html`) with:
 
 ```html
-{% extends "templates/login.html" %}
-{% set announcement = 'some message' %}
+{% extends "templates/login.html" %} {% set announcement = 'some message' %}
 ```
 
 Extending `page.html` puts the message on all pages, but note that

docs/source/reference/urls.md

@@ -11,8 +11,6 @@ All authenticated handlers redirect to `/hub/login` to login users
 prior to being redirected back to the originating page.
 The returned request should preserve all query parameters.
 
-
-
 ## `/`
 
 The top-level request is always a simple redirect to `/hub/`,
@@ -61,7 +59,7 @@ for starting and stopping the user's server.
 If named servers are enabled, there will be some additional
 tools for management of named servers.
 
-*Version added: 1.0* named server UI is new in 1.0.
+_Version added: 1.0_ named server UI is new in 1.0.
 
 ## `/hub/login`
 
@@ -111,7 +109,7 @@ not the Hub.
 The username is the first part and, if using named servers,
 the server name is the second part.
 
-If the user's server is *not* running, this will be redirected to `/hub/user/:username/...`
+If the user's server is _not_ running, this will be redirected to `/hub/user/:username/...`
 
 ## `/hub/user/:username[/:servername]`
 
@@ -123,8 +121,8 @@ Handling this URL is the most complicated condition in JupyterHub,
 because there can be many states:
 
 1. server is not active
-  a. user matches
-  b. user doesn't match
+   a. user matches
+   b. user doesn't match
 2. server is ready
 3. server is pending, but not ready
 
@@ -146,7 +144,7 @@ without additional user action (i.e. clicking the link on the page)
 
 ![Visiting a URL for a server that's not running](../images/not-running.png)
 
-*Version changed: 1.0*
+_Version changed: 1.0_
 
 Prior to 1.0, this URL itself was responsible for spawning servers,
 and served the progress page if it was pending,
@@ -165,7 +163,7 @@ indicating how to spawn the server.
 This is meant to help applications such as JupyterLab
 that are connected to a server that has stopped.
 
-*Version changed: 1.0*
+_Version changed: 1.0_
 
 JupyterHub 0.9 failed these API requests with status 404,
 but 1.0 uses 503.
@@ -207,12 +205,12 @@ and a POST request will trigger the actual spawn and redirect.
 
 ![The spawn form](../images/spawn-form.png)
 
-*Version added: 1.0*
+_Version added: 1.0_
 
 1.0 adds the ability to specify username and servername.
 Prior to 1.0, only `/hub/spawn` was recognized for the default server.
 
-*Version changed: 1.0*
+_Version changed: 1.0_
 
 Prior to 1.0, this page redirected back to `/hub/user/:username`,
 which was responsible for triggering spawn and rendering progress, etc.
@@ -221,7 +219,7 @@ which was responsible for triggering spawn and rendering progress, etc.
 
 ![The spawn pending page](../images/spawn-pending.png)
 
-*Version added: 1.0* this URL is new in JupyterHub 1.0.
+_Version added: 1.0_ this URL is new in JupyterHub 1.0.
 
 This page renders the progress view for the given spawn request.
 Once the server is ready,

docs/source/reference/websecurity.md

@@ -12,17 +12,17 @@ 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
+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 is not necessarily unsuitable for serving **untrusted** users.
 
 Using JupyterHub with **untrusted** users does mean more work by the
 administrator. Much care is required to secure a Hub, with extra caution on
 protecting users from each other as the Hub is serving untrusted users.
 
-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
+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
@@ -40,7 +40,7 @@ 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,
+- A user **does not have permission** to modify their single-user notebook server,
   including:
   - A user **may not** install new packages in the Python environment that runs
     their single-user server.
@@ -49,11 +49,11 @@ ensure that:
     directory that precedes the directory containing `jupyterhub-singleuser`.
   - A user may not modify environment variables (e.g. PATH, PYTHONPATH) for
     their single-user server.
-* A user **may not** modify the configuration of the notebook server
+- A user **may not** modify the configuration of the notebook server
   (the `~/.jupyter` or `JUPYTER_CONFIG_DIR` directory).
 
 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*
+**must never** display user-authored HTML that is neither _sanitized_ nor _sandboxed_
 (e.g. IFramed) to any user that lacks authentication as the author of a file.
 
 ## Mitigate security issues
@@ -85,7 +85,7 @@ admin must enforce.
 ### Prevent spawners from evaluating shell configuration files
 
 For most Spawners, `PATH` is not something users can influence, but care should
-be taken to ensure that the Spawner does *not* evaluate shell configuration
+be taken to ensure that the Spawner does _not_ evaluate shell configuration
 files prior to launching the server.
 
 ### Isolate packages using virtualenv
@@ -125,7 +125,6 @@ versions 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

docs/source/troubleshooting.md

@@ -4,17 +4,20 @@ When troubleshooting, you may see unexpected behaviors or receive an error
 message. This section provide links for identifying the cause of the
 problem and how to resolve it.
 
-[*Behavior*](#behavior)
+[_Behavior_](#behavior)
+
 - JupyterHub proxy fails to start
 - sudospawner fails to run
-- What is the default behavior when none of the lists (admin, whitelist,
-  group whitelist) are set?
+- What is the default behavior when none of the lists (admin, allowed,
+  allowed groups) are set?
 - JupyterHub Docker container not accessible at localhost
 
-[*Errors*](#errors)
+[_Errors_](#errors)
+
 - 500 error after spawning my single-user server
 
-[*How do I...?*](#how-do-i)
+[_How do I...?_](#how-do-i)
+
 - Use a chained SSL certificate
 - Install JupyterHub without a network connection
 - I want access to the whole filesystem, but still default users to their home directory
@@ -25,7 +28,7 @@ problem and how to resolve it.
 - Toree integration with HDFS rack awareness script
 - Where do I find Docker images and Dockerfiles related to JupyterHub?
 
-[*Troubleshooting commands*](#troubleshooting-commands)
+[_Troubleshooting commands_](#troubleshooting-commands)
 
 ## Behavior
 
@@ -34,8 +37,8 @@ problem and how to resolve it.
 If you have tried to start the JupyterHub proxy and it fails to start:
 
 - check if the JupyterHub IP configuration setting is
-  ``c.JupyterHub.ip = '*'``; if it is, try ``c.JupyterHub.ip = ''``
-- Try starting with ``jupyterhub --ip=0.0.0.0``
+  `c.JupyterHub.ip = '*'`; if it is, try `c.JupyterHub.ip = ''`
+- Try starting with `jupyterhub --ip=0.0.0.0`
 
 **Note**: If this occurs on Ubuntu/Debian, check that the you are using a
 recent version of node. Some versions of Ubuntu/Debian come with a version
@@ -55,26 +58,70 @@ or add:
 
 to the config file, `jupyterhub_config.py`.
 
-### What is the default behavior when none of the lists (admin, whitelist, group whitelist) are set?
+### What is the default behavior when none of the lists (admin, allowed, allowed groups) are set?
 
 When nothing is given for these lists, there will be no admins, and all users
 who can authenticate on the system (i.e. all the unix users on the server with
-a password) will be allowed to start a server. The whitelist lets you limit
-this to a particular set of users, and the admin_users lets you specify who
+a password) will be allowed to start a server. The allowed username set lets you limit
+this to a particular set of users, and admin_users lets you specify who
 among them may use the admin interface (not necessary, unless you need to do
-things like inspect other users' servers, or modify the userlist at runtime).
+things like inspect other users' servers, or modify the user list at runtime).
 
 ### JupyterHub Docker container 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`), 
-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: 
+Even though the command to start your Docker container exposes port 8000
+(`docker run -p 8000:8000 -d --name jupyterhub 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`
 
+### How can I kill ports from JupyterHub managed services that have been orphaned?
+
+I started JupyterHub + nbgrader on the same host without containers. When I try to restart JupyterHub + nbgrader with this configuration, errors appear that the service accounts cannot start because the ports are being used.
+
+How can I kill the processes that are using these ports?
+
+Run the following command:
+
+    sudo kill -9 $(sudo lsof -t -i:<service_port>)
+
+Where `<service_port>` is the port used by the nbgrader course service. This configuration is specified in `jupyterhub_config.py`.
+
+### Why am I getting a Spawn failed error message?
+
+After successfully logging in to JupyterHub with a compatible authenticators, I get a 'Spawn failed' error message in the browser. The JupyterHub logs have `jupyterhub KeyError: "getpwnam(): name not found: <my_user_name>`.
+
+This issue occurs when the authenticator requires a local system user to exist. In these cases, you need to use a spawner
+that does not require an existing system user account, such as `DockerSpawner` or `KubeSpawner`.
+
+### How can I run JupyterHub with sudo but use my current env vars and virtualenv location?
+
+When launching JupyterHub with `sudo jupyterhub` I get import errors and my environment variables don't work.
+
+When launching services with `sudo ...` the shell won't have the same environment variables or `PATH`s in place. The most direct way to solve this issue is to use the full path to your python environment and add environment variables. For example:
+
+```bash
+sudo MY_ENV=abc123 \
+  /home/foo/venv/bin/python3 \
+  /srv/jupyterhub/jupyterhub
+```
+
+### How can I view the logs for JupyterHub or the user's Notebook servers when using the DockerSpawner?
+
+Use `docker logs <container>` where `<container>` is the container name defined within `docker-compose.yml`. For example, to view the logs of the JupyterHub container use:
+
+    docker logs hub
+
+By default, the user's notebook server is named `jupyter-<username>` where `username` is the user's username within JupyterHub's db. So if you wanted to see the logs for user `foo` you would use:
+
+    docker logs jupyter-foo
+
+You can also tail logs to view them in real time using the `-f` option:
+
+    docker logs -f hub
 
 ## Errors
 
@@ -88,11 +135,11 @@ There are two likely reasons for this:
 
 1. The single-user server cannot connect to the Hub's API (networking
    configuration problems)
-2. The single-user server cannot *authenticate* its requests (invalid token)
+2. The single-user server cannot _authenticate_ its requests (invalid token)
 
 #### Symptoms
 
-The main symptom is a failure to load *any* page served by the single-user
+The main symptom is a failure to load _any_ page served by the single-user
 server, met with a 500 error. This is typically the first page at `/user/<your_name>`
 after logging in or clicking "Start my server". When a single-user notebook server
 receives a request, the notebook server makes an API request to the Hub to
@@ -108,7 +155,7 @@ You should see a similar 200 message, as above, in the Hub log when you first
 visit your single-user notebook server. If you don't see this message in the log, it
 may mean that your single-user notebook server isn't connecting to your Hub.
 
-If you see 403 (forbidden) like this, it's a token problem:
+If you see 403 (forbidden) like this, it's likely a token problem:
 
 ```
 403 GET /hub/api/authorizations/cookie/jupyterhub-token-name/[secret] (@10.0.1.4) 4.14ms
@@ -152,6 +199,42 @@ After this, when you start your server via JupyterHub, it will build a
 new container. If this was the underlying cause of the issue, you should see
 your server again.
 
+##### Proxy settings (403 GET)
+
+When your whole JupyterHub sits behind a organization proxy (_not_ a reverse proxy like NGINX as part of your setup and _not_ the configurable-http-proxy) the environment variables `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy` and `https_proxy` might be set. This confuses the jupyterhub-singleuser servers: When connecting to the Hub for authorization they connect via the proxy instead of directly connecting to the Hub on localhost. The proxy might deny the request (403 GET). This results in the singleuser server thinking it has a wrong auth token. To circumvent this you should add `<hub_url>,<hub_ip>,localhost,127.0.0.1` to the environment variables `NO_PROXY` and `no_proxy`.
+
+### 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:
+
+- **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 grading assignments.
+- **Private Dashboards**: share dashboards with certain group members.
+
+If possible, try to run the Jupyter Notebook as an externally managed service with one of the provided [jupyter/docker-stacks](https://github.com/jupyter/docker-stacks).
+
+Standard JupyterHub installations include a [jupyterhub-singleuser](https://github.com/jupyterhub/jupyterhub/blob/9fdab027daa32c9017845572ad9d5ba1722dbc53/setup.py#L116) command which is built from the `jupyterhub.singleuser:main` method. The `jupyterhub-singleuser` command is the default command when JupyterHub launches single-user Jupyter Notebooks. One of the goals of this command is to make sure the version of JupyterHub installed within the Jupyter Notebook coincides with the version of the JupyterHub server itself.
+
+If you launch a Jupyter Notebook with the `jupyterhub-singleuser` command directly from the command line the Jupyter Notebook won't have access to the `JUPYTERHUB_API_TOKEN` and will return:
+
+```
+    JUPYTERHUB_API_TOKEN env is required to run jupyterhub-singleuser.
+    Did you launch it manually?
+```
+
+If you plan on testing `jupyterhub-singleuser` independently from JupyterHub, then you can set the api token environment variable. For example, if were to run the single-user Jupyter Notebook on the host, then:
+
+    export JUPYTERHUB_API_TOKEN=my_secret_token
+    jupyterhub-singleuser
+
+With a docker container, pass in the environment variable with the run command:
+
+    docker run -d \
+      -p 8888:8888 \
+      -e JUPYTERHUB_API_TOKEN=my_secret_token \
+      jupyter/datascience-notebook:latest
+
+[This example](https://github.com/jupyterhub/jupyterhub/tree/master/examples/service-notebook/external) demonstrates how to combine the use of the `jupyterhub-singleuser` environment variables when launching a Notebook as an externally managed service.
 
 ## How do I...?
 
@@ -170,7 +253,6 @@ You would then set in your `jupyterhub_config.py` file the `ssl_key` and
     c.JupyterHub.ssl_cert = your_host-chained.crt
     c.JupyterHub.ssl_key = your_host.key
 
-
 #### Example
 
 Your certificate provider gives you the following files: `example_host.crt`,
@@ -193,7 +275,7 @@ where `ssl_cert` is example-chained.crt and ssl_key to your private key.
 
 Then restart JupyterHub.
 
-See also [JupyterHub SSL encryption](getting-started.md#ssl-encryption).
+See also [JupyterHub SSL encryption](./getting-started/security-basics.html#ssl-encryption).
 
 ### Install JupyterHub without a network connection
 
@@ -252,8 +334,7 @@ notebook servers to default to JupyterLab:
 ### How do I set up JupyterHub for a workshop (when users are not known ahead of time)?
 
 1. Set up JupyterHub using OAuthenticator for GitHub authentication
-2. Configure whitelist to be an empty list in` jupyterhub_config.py`
-3. Configure admin list to have workshop leaders be listed with administrator privileges.
+2. Configure admin list to have workshop leaders be listed with administrator privileges.
 
 Users will need a GitHub account to login and be authenticated by the Hub.
 
@@ -281,7 +362,6 @@ Or use syslog:
 
     jupyterhub | logger -t jupyterhub
 
-
 ## Troubleshooting commands
 
 The following commands provide additional detail about installed packages,
@@ -324,8 +404,8 @@ SyntaxError: Missing parentheses in call to 'print'
 In order to resolve this issue, there are two potential options.
 
 1. Update HDFS core-site.xml, so the parameter "net.topology.script.file.name" points to a custom
-script (e.g. /etc/hadoop/conf/custom_topology_script.py). Copy the original script and change the first line point
-to a python two installation (e.g. /usr/bin/python).
+   script (e.g. /etc/hadoop/conf/custom_topology_script.py). Copy the original script and change the first line point
+   to a python two installation (e.g. /usr/bin/python).
 2. In spark-env.sh add a Python 2 installation to your path (e.g. export PATH=/opt/anaconda2/bin:$PATH).
 
 ### Where do I find Docker images and Dockerfiles related to JupyterHub?

examples/bootstrap-script/README.md

@@ -1,34 +1,34 @@
 # Bootstrapping your users
 
-Before spawning a notebook to the user, it could be useful to 
+Before spawning a notebook to the user, it could be useful to
 do some preparation work in a bootstrapping process.
 
 Common use cases are:
 
-*Providing writeable storage for LDAP users*
+_Providing writeable storage for LDAP users_
 
 Your Jupyterhub is configured to use the LDAPAuthenticator and DockerSpawer.
 
-* The user has no file directory on the host since your are using LDAP.
-* When a user has no directory and DockerSpawner wants to mount a volume,
-the spawner will use docker to create a directory.
-Since the docker daemon is running as root, the generated directory for the volume 
-mount will not be writeable by the `jovyan` user inside of the container. 
-For the directory to be useful to the user, the permissions on the directory 
-need to be modified for the user to have write access.
+- The user has no file directory on the host since your are using LDAP.
+- When a user has no directory and DockerSpawner wants to mount a volume,
+  the spawner will use docker to create a directory.
+  Since the docker daemon is running as root, the generated directory for the volume
+  mount will not be writeable by the `jovyan` user inside of the container.
+  For the directory to be useful to the user, the permissions on the directory
+  need to be modified for the user to have write access.
 
-*Prepopulating Content*
+_Prepopulating Content_
 
 Another use would be to copy initial content, such as tutorial files or reference
- material, into the user's space when a notebook server is newly spawned.
+material, into the user's space when a notebook server is newly spawned.
 
 You can define your own bootstrap process by implementing a `pre_spawn_hook` on any spawner.
-The Spawner itself is passed as parameter to your hook and you can easily get the contextual information out of the spawning process. 
+The Spawner itself is passed as parameter to your hook and you can easily get the contextual information out of the spawning process.
 
 Similarly, there may be cases where you would like to clean up after a spawner stops.
 You may implement a `post_stop_hook` that is always executed after the spawner stops.
 
-If you implement a hook, make sure that it is *idempotent*. It will be executed every time
+If you implement a hook, make sure that it is _idempotent_. It will be executed every time
 a notebook server is spawned to the user. That means you should somehow
 ensure that things which should run only once are not running again and again.
 For example, before you create a directory, check if it exists.
@@ -41,13 +41,13 @@ Create a directory for the user, if none exists
 
 ```python
 
-# in jupyterhub_config.py  
+# in jupyterhub_config.py
 import os
 def create_dir_hook(spawner):
     username = spawner.user.name # get the username
     volume_path = os.path.join('/volumes/jupyterhub', username)
     if not os.path.exists(volume_path):
-        # create a directory with umask 0755 
+        # create a directory with umask 0755
         # hub and container user must have the same UID to be writeable
         # still readable by other users on the system
         os.mkdir(volume_path, 0o755)
@@ -83,17 +83,17 @@ in a new file in `/etc/sudoers.d`, or simply in `/etc/sudoers`.
 
 All new home directories will be created from `/etc/skel`, so make sure to place any custom homedir-contents in there.
 
-### Example #3 - Run a shell script 
+### Example #3 - Run a shell script
 
-You can specify a plain ole' shell script (or any other executable) to be run 
+You can specify a plain ole' shell script (or any other executable) to be run
 by the bootstrap process.
 
-For example, you can execute a shell script and as first parameter pass the name 
+For example, you can execute a shell script and as first parameter pass the name
 of the user:
 
 ```python
 
-# in jupyterhub_config.py    
+# in jupyterhub_config.py
 from subprocess import check_call
 import os
 def my_script_hook(spawner):
@@ -106,7 +106,7 @@ c.Spawner.pre_spawn_hook = my_script_hook
 
 ```
 
-Here's an example on what you could do in your shell script. See also 
+Here's an example on what you could do in your shell script. See also
 `/examples/bootstrap-script/`
 
 ```bash
@@ -126,7 +126,7 @@ fi
 
 # This example script will do the following:
 # - create one directory for the user $USER in a BASE_DIRECTORY (see below)
-# - create a "tutorials" directory within and download and unzip 
+# - create a "tutorials" directory within and download and unzip
 #   the PythonDataScienceHandbook from GitHub
 
 # Start the Bootstrap Process

examples/cull-idle/README.md

@@ -1,41 +1,4 @@
-# `cull-idle` Example
+# idle-culler example
 
-The `cull_idle_servers.py` file provides a script to cull and shut down idle
-single-user notebook servers. This script is used when `cull-idle` is run as
-a Service or when it is run manually as a standalone script.
-
-
-## Configure `cull-idle` to run as a Hub-Managed Service
-
-In `jupyterhub_config.py`, add the following dictionary for the `cull-idle`
-Service to the `c.JupyterHub.services` list:
-
-```python
-c.JupyterHub.services = [
-    {
-        'name': 'cull-idle',
-        'admin': True,
-        'command': [sys.executable, 'cull_idle_servers.py', '--timeout=3600'],
-    }
-]
-```
-
-where:
-
-- `'admin': True` indicates that the Service has 'admin' permissions, and
-- `'command'` indicates that the Service will be managed by the Hub.
-
-## Run `cull-idle` manually as a standalone script
-
-This will run `cull-idle` manually. `cull-idle` can be run as a standalone
-script anywhere with access to the Hub, and will periodically check for idle
-servers and shut them down via the Hub's REST API. In order to shutdown the
-servers, the token given to cull-idle must have admin privileges.
-
-Generate an API token and store it in the `JUPYTERHUB_API_TOKEN` environment
-variable. Run `cull_idle_servers.py` manually. 
-
-```bash
-    export JUPYTERHUB_API_TOKEN=$(jupyterhub token)
-    python3 cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]
-```
+The idle culler has been moved to its own repository at
+[jupyterhub/jupyterhub-idle-culler](https://github.com/jupyterhub/jupyterhub-idle-culler).

examples/cull-idle/cull_idle_servers.py

@@ -1,401 +0,0 @@
-#!/usr/bin/env python3
-"""script to monitor and cull idle single-user servers
-
-Caveats:
-
-last_activity is not updated with high frequency,
-so cull timeout should be greater than the sum of:
-
-- single-user websocket ping interval (default: 30s)
-- JupyterHub.last_activity_interval (default: 5 minutes)
-
-You can run this as a service managed by JupyterHub with this in your config::
-
-
-    c.JupyterHub.services = [
-        {
-            'name': 'cull-idle',
-            'admin': True,
-            'command': [sys.executable, 'cull_idle_servers.py', '--timeout=3600'],
-        }
-    ]
-
-Or run it manually by generating an API token and storing it in `JUPYTERHUB_API_TOKEN`:
-
-    export JUPYTERHUB_API_TOKEN=$(jupyterhub token)
-    python3 cull_idle_servers.py [--timeout=900] [--url=http://127.0.0.1:8081/hub/api]
-
-This script uses the same ``--timeout`` and ``--max-age`` values for
-culling users and users' servers.  If you want a different value for
-users and servers, you should add this script to the services list
-twice, just with different ``name``s, different values, and one with
-the ``--cull-users`` option.
-"""
-import json
-import os
-from datetime import datetime
-from datetime import timezone
-from functools import partial
-
-try:
-    from urllib.parse import quote
-except ImportError:
-    from urllib import quote
-
-import dateutil.parser
-
-from tornado.gen import coroutine, multi
-from tornado.locks import Semaphore
-from tornado.log import app_log
-from tornado.httpclient import AsyncHTTPClient, HTTPRequest
-from tornado.ioloop import IOLoop, PeriodicCallback
-from tornado.options import define, options, parse_command_line
-
-
-def parse_date(date_string):
-    """Parse a timestamp
-
-    If it doesn't have a timezone, assume utc
-
-    Returned datetime object will always be timezone-aware
-    """
-    dt = dateutil.parser.parse(date_string)
-    if not dt.tzinfo:
-        # assume naïve timestamps are UTC
-        dt = dt.replace(tzinfo=timezone.utc)
-    return dt
-
-
-def format_td(td):
-    """
-    Nicely format a timedelta object
-
-    as HH:MM:SS
-    """
-    if td is None:
-        return "unknown"
-    if isinstance(td, str):
-        return td
-    seconds = int(td.total_seconds())
-    h = seconds // 3600
-    seconds = seconds % 3600
-    m = seconds // 60
-    seconds = seconds % 60
-    return "{h:02}:{m:02}:{seconds:02}".format(h=h, m=m, seconds=seconds)
-
-
-@coroutine
-def cull_idle(
-    url, api_token, inactive_limit, cull_users=False, max_age=0, concurrency=10
-):
-    """Shutdown idle single-user servers
-
-    If cull_users, inactive *users* will be deleted as well.
-    """
-    auth_header = {'Authorization': 'token %s' % api_token}
-    req = HTTPRequest(url=url + '/users', headers=auth_header)
-    now = datetime.now(timezone.utc)
-    client = AsyncHTTPClient()
-
-    if concurrency:
-        semaphore = Semaphore(concurrency)
-
-        @coroutine
-        def fetch(req):
-            """client.fetch wrapped in a semaphore to limit concurrency"""
-            yield semaphore.acquire()
-            try:
-                return (yield client.fetch(req))
-            finally:
-                yield semaphore.release()
-
-    else:
-        fetch = client.fetch
-
-    resp = yield fetch(req)
-    users = json.loads(resp.body.decode('utf8', 'replace'))
-    futures = []
-
-    @coroutine
-    def handle_server(user, server_name, server, max_age, inactive_limit):
-        """Handle (maybe) culling a single server
-
-        "server" is the entire server model from the API.
-
-        Returns True if server is now stopped (user removable),
-        False otherwise.
-        """
-        log_name = user['name']
-        if server_name:
-            log_name = '%s/%s' % (user['name'], server_name)
-        if server.get('pending'):
-            app_log.warning(
-                "Not culling server %s with pending %s", log_name, server['pending']
-            )
-            return False
-
-        # jupyterhub < 0.9 defined 'server.url' once the server was ready
-        # as an *implicit* signal that the server was ready.
-        # 0.9 adds a dedicated, explicit 'ready' field.
-        # By current (0.9) definitions, servers that have no pending
-        # events and are not ready shouldn't be in the model,
-        # but let's check just to be safe.
-
-        if not server.get('ready', bool(server['url'])):
-            app_log.warning(
-                "Not culling not-ready not-pending server %s: %s", log_name, server
-            )
-            return False
-
-        if server.get('started'):
-            age = now - parse_date(server['started'])
-        else:
-            # started may be undefined on jupyterhub < 0.9
-            age = None
-
-        # check last activity
-        # last_activity can be None in 0.9
-        if server['last_activity']:
-            inactive = now - parse_date(server['last_activity'])
-        else:
-            # no activity yet, use start date
-            # last_activity may be None with jupyterhub 0.9,
-            # which introduces the 'started' field which is never None
-            # for running servers
-            inactive = age
-
-        # CUSTOM CULLING TEST CODE HERE
-        # Add in additional server tests here.  Return False to mean "don't
-        # cull", True means "cull immediately", or, for example, update some
-        # other variables like inactive_limit.
-        #
-        # Here, server['state'] is the result of the get_state method
-        # on the spawner.  This does *not* contain the below by
-        # default, you may have to modify your spawner to make this
-        # work.  The `user` variable is the user model from the API.
-        #
-        # if server['state']['profile_name'] == 'unlimited'
-        #     return False
-        # inactive_limit = server['state']['culltime']
-
-        should_cull = (
-            inactive is not None and inactive.total_seconds() >= inactive_limit
-        )
-        if should_cull:
-            app_log.info(
-                "Culling server %s (inactive for %s)", log_name, format_td(inactive)
-            )
-
-        if max_age and not should_cull:
-            # only check started if max_age is specified
-            # so that we can still be compatible with jupyterhub 0.8
-            # which doesn't define the 'started' field
-            if age is not None and age.total_seconds() >= max_age:
-                app_log.info(
-                    "Culling server %s (age: %s, inactive for %s)",
-                    log_name,
-                    format_td(age),
-                    format_td(inactive),
-                )
-                should_cull = True
-
-        if not should_cull:
-            app_log.debug(
-                "Not culling server %s (age: %s, inactive for %s)",
-                log_name,
-                format_td(age),
-                format_td(inactive),
-            )
-            return False
-
-        if server_name:
-            # culling a named server
-            delete_url = url + "/users/%s/servers/%s" % (
-                quote(user['name']),
-                quote(server['name']),
-            )
-        else:
-            delete_url = url + '/users/%s/server' % quote(user['name'])
-
-        req = HTTPRequest(url=delete_url, method='DELETE', headers=auth_header)
-        resp = yield fetch(req)
-        if resp.code == 202:
-            app_log.warning("Server %s is slow to stop", log_name)
-            # return False to prevent culling user with pending shutdowns
-            return False
-        return True
-
-    @coroutine
-    def handle_user(user):
-        """Handle one user.
-
-        Create a list of their servers, and async exec them.  Wait for
-        that to be done, and if all servers are stopped, possibly cull
-        the user.
-        """
-        # shutdown servers first.
-        # Hub doesn't allow deleting users with running servers.
-        # jupyterhub 0.9 always provides a 'servers' model.
-        # 0.8 only does this when named servers are enabled.
-        if 'servers' in user:
-            servers = user['servers']
-        else:
-            # jupyterhub < 0.9 without named servers enabled.
-            # create servers dict with one entry for the default server
-            # from the user model.
-            # only if the server is running.
-            servers = {}
-            if user['server']:
-                servers[''] = {
-                    'last_activity': user['last_activity'],
-                    'pending': user['pending'],
-                    'url': user['server'],
-                }
-        server_futures = [
-            handle_server(user, server_name, server, max_age, inactive_limit)
-            for server_name, server in servers.items()
-        ]
-        results = yield multi(server_futures)
-        if not cull_users:
-            return
-        # some servers are still running, cannot cull users
-        still_alive = len(results) - sum(results)
-        if still_alive:
-            app_log.debug(
-                "Not culling user %s with %i servers still alive",
-                user['name'],
-                still_alive,
-            )
-            return False
-
-        should_cull = False
-        if user.get('created'):
-            age = now - parse_date(user['created'])
-        else:
-            # created may be undefined on jupyterhub < 0.9
-            age = None
-
-        # check last activity
-        # last_activity can be None in 0.9
-        if user['last_activity']:
-            inactive = now - parse_date(user['last_activity'])
-        else:
-            # no activity yet, use start date
-            # last_activity may be None with jupyterhub 0.9,
-            # which introduces the 'created' field which is never None
-            inactive = age
-
-        should_cull = (
-            inactive is not None and inactive.total_seconds() >= inactive_limit
-        )
-        if should_cull:
-            app_log.info("Culling user %s (inactive for %s)", user['name'], inactive)
-
-        if max_age and not should_cull:
-            # only check created if max_age is specified
-            # so that we can still be compatible with jupyterhub 0.8
-            # which doesn't define the 'started' field
-            if age is not None and age.total_seconds() >= max_age:
-                app_log.info(
-                    "Culling user %s (age: %s, inactive for %s)",
-                    user['name'],
-                    format_td(age),
-                    format_td(inactive),
-                )
-                should_cull = True
-
-        if not should_cull:
-            app_log.debug(
-                "Not culling user %s (created: %s, last active: %s)",
-                user['name'],
-                format_td(age),
-                format_td(inactive),
-            )
-            return False
-
-        req = HTTPRequest(
-            url=url + '/users/%s' % user['name'], method='DELETE', headers=auth_header
-        )
-        yield fetch(req)
-        return True
-
-    for user in users:
-        futures.append((user['name'], handle_user(user)))
-
-    for (name, f) in futures:
-        try:
-            result = yield f
-        except Exception:
-            app_log.exception("Error processing %s", name)
-        else:
-            if result:
-                app_log.debug("Finished culling %s", name)
-
-
-if __name__ == '__main__':
-    define(
-        'url',
-        default=os.environ.get('JUPYTERHUB_API_URL'),
-        help="The JupyterHub API URL",
-    )
-    define('timeout', default=600, help="The idle timeout (in seconds)")
-    define(
-        'cull_every',
-        default=0,
-        help="The interval (in seconds) for checking for idle servers to cull",
-    )
-    define(
-        'max_age',
-        default=0,
-        help="The maximum age (in seconds) of servers that should be culled even if they are active",
-    )
-    define(
-        'cull_users',
-        default=False,
-        help="""Cull users in addition to servers.
-                This is for use in temporary-user cases such as tmpnb.""",
-    )
-    define(
-        'concurrency',
-        default=10,
-        help="""Limit the number of concurrent requests made to the Hub.
-
-                Deleting a lot of users at the same time can slow down the Hub,
-                so limit the number of API requests we have outstanding at any given time.
-                """,
-    )
-
-    parse_command_line()
-    if not options.cull_every:
-        options.cull_every = options.timeout // 2
-    api_token = os.environ['JUPYTERHUB_API_TOKEN']
-
-    try:
-        AsyncHTTPClient.configure("tornado.curl_httpclient.CurlAsyncHTTPClient")
-    except ImportError as e:
-        app_log.warning(
-            "Could not load pycurl: %s\n"
-            "pycurl is recommended if you have a large number of users.",
-            e,
-        )
-
-    loop = IOLoop.current()
-    cull = partial(
-        cull_idle,
-        url=options.url,
-        api_token=api_token,
-        inactive_limit=options.timeout,
-        cull_users=options.cull_users,
-        max_age=options.max_age,
-        concurrency=options.concurrency,
-    )
-    # schedule first cull immediately
-    # because PeriodicCallback doesn't start until the end of the first interval
-    loop.add_callback(cull)
-    # schedule periodic cull
-    pc = PeriodicCallback(cull, 1e3 * options.cull_every)
-    pc.start()
-    try:
-        loop.start()
-    except KeyboardInterrupt:
-        pass

examples/cull-idle/jupyterhub_config.py

@@ -1,11 +0,0 @@
-import sys
-
-# run cull-idle as a service
-
-c.JupyterHub.services = [
-    {
-        'name': 'cull-idle',
-        'admin': True,
-        'command': [sys.executable, 'cull_idle_servers.py', '--timeout=3600'],
-    }
-]

examples/external-oauth/README.md

@@ -16,63 +16,62 @@ implementations in other web servers or languages.
 
 ## Run the example
 
-1. generate an API token:
+1.  generate an API token:
 
         export JUPYTERHUB_API_TOKEN=$(openssl rand -hex 32)
 
-2. launch a version of the the whoami service.
-   For `whoami-oauth`:
+2.  launch a version of the the whoami service.
+    For `whoami-oauth`:
 
-        bash launch-service.sh &
+         bash launch-service.sh &
 
     or for `whoami-oauth-basic`:
 
-        bash launch-service-basic.sh &
+         bash launch-service-basic.sh &
 
-3. Launch JupyterHub:
+3.  Launch JupyterHub:
 
         jupyterhub
 
-4. Visit http://127.0.0.1:5555/
+4.  Visit http://127.0.0.1:5555/
 
 After logging in with your local-system credentials, you should see a JSON dump of your user info:
 
 ```json
 {
- "admin": false,
- "last_activity": "2016-05-27T14:05:18.016372",
- "name": "queequeg",
- "pending": null,
- "server": "/user/queequeg"
+  "admin": false,
+  "last_activity": "2016-05-27T14:05:18.016372",
+  "name": "queequeg",
+  "pending": null,
+  "server": "/user/queequeg"
 }
 ```
 
-
 The essential pieces for using JupyterHub as an OAuth provider are:
 
 1. registering your service with jupyterhub:
 
-    ```python
-    c.JupyterHub.services = [
-        {
-            # the name of your service
-            # should be simple and unique.
-            # mostly used to identify your service in logging
-            "name": "my-service",
-            # the oauth client id of your service
-            # must be unique but isn't private
-            # can be randomly generated or hand-written
-            "oauth_client_id": "abc123",
-            # the API token and client secret of the service
-            # should be generated securely,
-            # e.g. via `openssl rand -hex 32`
-            "api_token": "abc123...",
-            # the redirect target for jupyterhub to send users
-            # after successful authentication
-            "oauth_redirect_uri": "https://service-host/oauth_callback"
-        }
-    ]
-    ```
+   ```python
+   c.JupyterHub.services = [
+       {
+           # the name of your service
+           # should be simple and unique.
+           # mostly used to identify your service in logging
+           "name": "my-service",
+           # the oauth client id of your service
+           # must be unique but isn't private
+           # can be randomly generated or hand-written
+           "oauth_client_id": "abc123",
+           # the API token and client secret of the service
+           # should be generated securely,
+           # e.g. via `openssl rand -hex 32`
+           "api_token": "abc123...",
+           # the redirect target for jupyterhub to send users
+           # after successful authentication
+           "oauth_redirect_uri": "https://service-host/oauth_callback"
+       }
+   ]
+   ```
 
 2. Telling your service how to authenticate with JupyterHub.
 

examples/external-oauth/whoami-oauth-basic.py

@@ -5,13 +5,11 @@ so all URLs and requests necessary for OAuth with JupyterHub should be in one pl
 """
 import json
 import os
-import sys
 from urllib.parse import urlencode
 from urllib.parse import urlparse
 
 from tornado import log
 from tornado import web
-from tornado.auth import OAuth2Mixin
 from tornado.httpclient import AsyncHTTPClient
 from tornado.httpclient import HTTPRequest
 from tornado.httputil import url_concat

examples/postgres/README.md

@@ -4,14 +4,14 @@ This example shows how you can connect Jupyterhub to a Postgres database
 instead of the default SQLite backend.
 
 ### Running Postgres with Jupyterhub on the host.
+
 0. Uncomment and replace `ENV JPY_PSQL_PASSWORD arglebargle` with your own
    password in the Dockerfile for `examples/postgres/db`. (Alternatively, pass
    -e `JPY_PSQL_PASSWORD=<password>` when you start the db container.)
 
 1. `cd` to the root of your jupyterhub repo.
 
-2. Build the postgres image with `docker build -t jupyterhub-postgres-db
-   examples/postgres/db`.  This may take a minute or two the first time it's
+2. Build the postgres image with `docker build -t jupyterhub-postgres-db examples/postgres/db`. This may take a minute or two the first time it's
    run.
 
 3. Run the db image with `docker run -d -p 5433:5432 jupyterhub-postgres-db`.
@@ -24,24 +24,22 @@ instead of the default SQLite backend.
 5. Log in as the user running jupyterhub on your host machine.
 
 ### Running Postgres with Containerized Jupyterhub.
+
 0. Do steps 0-2 in from the above section, ensuring that the values set/passed
    for `JPY_PSQL_PASSWORD` match for the hub and db containers.
 
-1. Build the hub image with `docker build -t jupyterhub-postgres-hub
-   examples/postgres/hub`.  This may take a minute or two the first time it's
+1. Build the hub image with `docker build -t jupyterhub-postgres-hub examples/postgres/hub`. This may take a minute or two the first time it's
    run.
 
-2. Run the db image with `docker run -d --name=jpy-db
-   jupyterhub-postgres`. Note that, unlike when connecting to a host machine
+2. Run the db image with `docker run -d --name=jpy-db jupyterhub-postgres`. Note that, unlike when connecting to a host machine
    jupyterhub, we don't specify a port-forwarding scheme here, but we do need
    to specify a name for the container.
 
-3. Run the containerized hub with `docker run -it --link jpy-db:postgres
-   jupyterhub-postgres-hub`.  This instructs docker to run the hub container
+3. Run the containerized hub with `docker run -it --link jpy-db:postgres jupyterhub-postgres-hub`. This instructs docker to run the hub container
    with a link to the already-running db container, which will forward
    environment and connection information from the DB to the hub.
 
 4. Log in as one of the users defined in the `examples/postgres/hub/`
-   Dockerfile.  By default `rhea` is the server's admin user, `io` and
+   Dockerfile. By default `rhea` is the server's admin user, `io` and
    `ganymede` are non-admin users, and all users' passwords are their
    usernames.

examples/service-announcement/README.md

@@ -1,4 +1,3 @@
-
 # Simple Announcement Service Example
 
 This is a simple service that allows administrators to manage announcements
@@ -16,10 +15,10 @@ configuration file something like:
     ]
 
 This starts the announcements service up at `/services/announcement` when
-JupyterHub launches.  By default the announcement text is empty.
+JupyterHub launches. By default the announcement text is empty.
 
 The `announcement` module has a configurable port (default 8888) and an API
-prefix setting.  By default the API prefix is `JUPYTERHUB_SERVICE_PREFIX` if
+prefix setting. By default the API prefix is `JUPYTERHUB_SERVICE_PREFIX` if
 that environment variable is set or `/` if it is not.
 
 ## Managing the Announcement
@@ -27,7 +26,7 @@ that environment variable is set or `/` if it is not.
 Admin users can set the announcement text with an API token:
 
     $ curl -X POST -H "Authorization: token <token>"                        \
-        -d "{'announcement':'JupyterHub will be upgraded on August 14!'}"   \
+        -d '{"announcement":"JupyterHub will be upgraded on August 14!"}'   \
         https://.../services/announcement
 
 Anyone can read the announcement:
@@ -42,7 +41,7 @@ Anyone can read the announcement:
 The time the announcement was posted is recorded in the `timestamp` field and
 the user who posted the announcement is recorded in the `user` field.
 
-To clear the announcement text, just DELETE.  Only admin users can do this.
+To clear the announcement text, just DELETE. Only admin users can do this.
 
     $ curl -X POST -H "Authorization: token <token>"                        \
         https://.../services/announcement
@@ -50,11 +49,11 @@ To clear the announcement text, just DELETE.  Only admin users can do this.
 ## Seeing the Announcement in JupyterHub
 
 To be able to render the announcement, include the provide `page.html` template
-that extends the base `page.html` template.  Set `c.JupyterHub.template_paths`
+that extends the base `page.html` template. Set `c.JupyterHub.template_paths`
 in JupyterHub's configuration to include the path to the extending template.
 The template changes the `announcement` element and does a JQuery `$.get()` call
 to retrieve the announcement text.
 
 JupyterHub's configurable announcement template variables can be set for various
-pages like login, logout, spawn, and home.  Including the template provided in
+pages like login, logout, spawn, and home. Including the template provided in
 this example overrides all of those.

examples/service-announcement/announcement.py

@@ -4,7 +4,6 @@ import json
 import os
 
 from tornado import escape
-from tornado import gen
 from tornado import ioloop
 from tornado import web
 

examples/service-announcement/templates/page.html

@@ -1,14 +1,9 @@
-{% extends "templates/page.html" %}
-{% block announcement %}
-<div class="container text-center announcement">
-</div>
-{% endblock %}
-
-{% block script %}
-{{ super() }}
+{% extends "templates/page.html" %} {% block announcement %}
+<div class="container text-center announcement"></div>
+{% endblock %} {% block script %} {{ super() }}
 <script>
-$.get("/services/announcement/", function(data) {
+  $.get("/services/announcement/", function (data) {
     $(".announcement").html(data["announcement"]);
-});
+  });
 </script>
 {% endblock %}

examples/service-fastapi/Dockerfile

@@ -0,0 +1,13 @@
+FROM jupyterhub/jupyterhub
+
+# Create test user (PAM auth) and install single-user Jupyter 
+RUN useradd testuser --create-home --shell /bin/bash
+RUN echo 'testuser:passwd' | chpasswd
+RUN pip install jupyter 
+
+COPY app ./app
+COPY jupyterhub_config.py .
+COPY requirements.txt /tmp/requirements.txt
+RUN pip install -r /tmp/requirements.txt
+
+CMD ["jupyterhub", "--ip", "0.0.0.0"]

examples/service-fastapi/README.md

@@ -0,0 +1,107 @@
+# Fastapi
+
+[FastAPI](https://fastapi.tiangolo.com/) is a popular new web framework attractive for its type hinting, async support, automatic doc generation (Swagger), and more. Their [Feature highlights](https://fastapi.tiangolo.com/features/) sum it up nicely.
+
+# Swagger UI with OAuth demo
+
+![Fastapi Service Example](./fastapi_example.gif)
+
+# Try it out locally
+
+1. Install `fastapi` and other dependencies, then launch Jupyterhub
+
+```
+pip install -r requirements.txt
+jupyterhub --ip=127.0.0.1
+```
+
+2. Visit http://127.0.0.1:8000/services/fastapi or http://127.0.0.1:8000/services/fastapi/docs
+
+3. Try interacting programmatically. If you create a new token in your control panel or pull out the `JUPYTERHUB_API_TOKEN` in the single user environment, you can skip the third step here.
+
+```
+$ curl -X GET http://127.0.0.1:8000/services/fastapi/
+{"Hello":"World"}
+
+$ curl -X GET http://127.0.0.1:8000/services/fastapi/me
+{"detail":"Must login with token parameter, cookie, or header"}
+
+$ curl -X POST http://127.0.0.1:8000/hub/api/authorizations/token \
+       -d '{"username": "myname", "password": "mypasswd!"}' \
+       | jq '.token'
+"3fee13ce6d2845da9bd5f2c2170d3428"
+
+$ curl -X GET http://127.0.0.1:8000/services/fastapi/me \
+       -H "Authorization: Bearer 3fee13ce6d2845da9bd5f2c2170d3428" \
+       | jq .
+{
+  "name": "myname",
+  "admin": false,
+  "groups": [],
+  "server": null,
+  "pending": null,
+  "last_activity": "2021-04-07T18:05:11.587638+00:00",
+  "servers": null
+}
+```
+
+# Try it out in Docker
+
+1. Build and run the Docker image locally
+
+```bash
+sudo docker build . -t service-fastapi
+sudo docker run -it -p 8000:8000 service-fastapi
+```
+
+2. Visit http://127.0.0.1:8000/services/fastapi/docs. When going through the OAuth flow or getting a token from the control panel, you can log in with `testuser` / `passwd`.
+
+# PUBLIC_HOST
+
+If you are running your service behind a proxy, or on a Docker / Kubernetes infrastructure, you might run into an error during OAuth that says `Mismatching redirect URI`. In the Jupterhub logs, there will be a warning along the lines of: `[W 2021-04-06 23:40:06.707 JupyterHub provider:498] Redirect uri https://jupyterhub.my.cloud/services/fastapi/oauth_callback != /services/fastapi/oauth_callback`. This happens because Swagger UI adds the request host, as seen in the browser, to the Authorization URL.
+
+To solve that problem, the `oauth_redirect_uri` value in the service initialization needs to match what Swagger will auto-generate and what the service will use when POST'ing to `/oauth2/token`. In this example, setting the `PUBLIC_HOST` environment variable to your public-facing Hub domain (e.g. `https://jupyterhub.my.cloud`) should make it work.
+
+# Notes on security.py
+
+FastAPI has a concept of a [dependency injection](https://fastapi.tiangolo.com/tutorial/dependencies) using a `Depends` object (and a subclass `Security`) that is automatically instantiated/executed when it is a parameter for your endpoint routes. You can utilize a `Depends` object for re-useable common parameters or authentication mechanisms like the [`get_user`](https://fastapi.tiangolo.com/tutorial/security/get-current-user) pattern.
+
+JupyterHub OAuth has three ways to authenticate: a `token` url parameter; a `Authorization: Bearer <token>` header; and a (deprecated) `jupyterhub-services` cookie. FastAPI has helper functions that let us create `Security` (dependency injection) objects for each of those. When you need to allow multiple / optional authentication dependencies (`Security` objects), then you can use the argument `auto_error=False` and it will return `None` instead of raising an `HTTPException`.
+
+Endpoints that need authentication (`/me` and `/debug` in this example) can leverage the `get_user` pattern and effectively pull the user model from the Hub API when a request has authenticated with cookie / token / header all using the simple syntax,
+
+```python
+from .security import get_current_user
+from .models import User
+
+@router.get("/new_endpoint")
+async def new_endpoint(user: User = Depends(get_current_user)):
+    "Function that needs to work with an authenticated user"
+    return {"Hello": user.name}
+```
+
+# Notes on client.py
+
+FastAPI is designed to be an asynchronous web server, so the interactions with the Hub API should be made asynchronously as well. Instead of using `requests` to get user information from a token/cookie, this example uses [`httpx`](https://www.python-httpx.org/). `client.py` defines a small function that creates a `Client` (equivalent of `requests.Session`) with the Hub API url as it's `base_url` and adding the `JUPYTERHUB_API_TOKEN` to every header.
+
+Consider this a very minimal alternative to using `jupyterhub.services.auth.HubOAuth`
+
+```python
+# client.py
+import os
+
+def get_client():
+    base_url = os.environ["JUPYTERHUB_API_URL"]
+    token = os.environ["JUPYTERHUB_API_TOKEN"]
+    headers = {"Authorization": "Bearer %s" % token}
+    return httpx.AsyncClient(base_url=base_url, headers=headers)
+```
+
+```python
+# other modules
+from .client import get_client
+
+async with get_client() as client:
+    resp = await client.get('/endpoint')
+    ...
+```

examples/service-fastapi/app/__init__.py

@@ -0,0 +1 @@
+from .app import app

examples/service-fastapi/app/app.py

@@ -0,0 +1,25 @@
+import os
+
+from fastapi import FastAPI
+
+from .service import router
+
+### When managed by Jupyterhub, the actual endpoints
+### will be served out prefixed by /services/:name.
+### One way to handle this with FastAPI is to use an APIRouter.
+### All routes are defined in service.py
+
+app = FastAPI(
+    title="Example FastAPI Service",
+    version="0.1",
+    ### Serve out Swagger from the service prefix (<hub>/services/:name/docs)
+    openapi_url=router.prefix + "/openapi.json",
+    docs_url=router.prefix + "/docs",
+    redoc_url=router.prefix + "/redoc",
+    ### Add our service client id to the /docs Authorize form automatically
+    swagger_ui_init_oauth={"clientId": os.environ["JUPYTERHUB_CLIENT_ID"]},
+    ### Default /docs/oauth2 redirect will cause Hub
+    ### to raise oauth2 redirect uri mismatch errors
+    swagger_ui_oauth2_redirect_url=os.environ["JUPYTERHUB_OAUTH_CALLBACK_URL"],
+)
+app.include_router(router)

examples/service-fastapi/app/client.py

@@ -0,0 +1,11 @@
+import os
+
+import httpx
+
+
+# a minimal alternative to using HubOAuth class
+def get_client():
+    base_url = os.environ["JUPYTERHUB_API_URL"]
+    token = os.environ["JUPYTERHUB_API_TOKEN"]
+    headers = {"Authorization": "Bearer %s" % token}
+    return httpx.AsyncClient(base_url=base_url, headers=headers)

examples/service-fastapi/app/models.py

@@ -0,0 +1,46 @@
+from datetime import datetime
+from typing import Any
+from typing import List
+from typing import Optional
+
+from pydantic import BaseModel
+
+
+# https://jupyterhub.readthedocs.io/en/stable/_static/rest-api/index.html
+class Server(BaseModel):
+    name: str
+    ready: bool
+    pending: Optional[str]
+    url: str
+    progress_url: str
+    started: datetime
+    last_activity: datetime
+    state: Optional[Any]
+    user_options: Optional[Any]
+
+
+class User(BaseModel):
+    name: str
+    admin: bool
+    groups: List[str]
+    server: Optional[str]
+    pending: Optional[str]
+    last_activity: datetime
+    servers: Optional[List[Server]]
+
+
+# https://stackoverflow.com/questions/64501193/fastapi-how-to-use-httpexception-in-responses
+class AuthorizationError(BaseModel):
+    detail: str
+
+
+class HubResponse(BaseModel):
+    msg: str
+    request_url: str
+    token: str
+    response_code: int
+    hub_response: dict
+
+
+class HubApiError(BaseModel):
+    detail: HubResponse

examples/service-fastapi/app/security.py

@@ -0,0 +1,61 @@
+import os
+
+from fastapi import HTTPException
+from fastapi import Security
+from fastapi import status
+from fastapi.security import OAuth2AuthorizationCodeBearer
+from fastapi.security.api_key import APIKeyQuery
+
+from .client import get_client
+from .models import User
+
+### Endpoints can require authentication using Depends(get_current_user)
+### get_current_user will look for a token in url params or
+### Authorization: bearer token (header).
+### Hub technically supports cookie auth too, but it is deprecated so
+### not being included here.
+auth_by_param = APIKeyQuery(name="token", auto_error=False)
+
+auth_url = os.environ["PUBLIC_HOST"] + "/hub/api/oauth2/authorize"
+auth_by_header = OAuth2AuthorizationCodeBearer(
+    authorizationUrl=auth_url, tokenUrl="get_token", auto_error=False
+)
+### ^^ The flow for OAuth2 in Swagger is that the "authorize" button
+### will redirect user (browser) to "auth_url", which is the Hub login page.
+### After logging in, the browser will POST to our internal /get_token endpoint
+### with the auth code.  That endpoint POST's to Hub /oauth2/token with
+### our client_secret (JUPYTERHUB_API_TOKEN) and that code to get an
+### access_token, which it returns to browser, which places in Authorization header.
+
+### For consideration: optimize performance with a cache instead of
+### always hitting the Hub api?
+async def get_current_user(
+    auth_by_param: str = Security(auth_by_param),
+    auth_by_header: str = Security(auth_by_header),
+):
+    token = auth_by_param or auth_by_header
+    if token is None:
+        raise HTTPException(
+            status.HTTP_401_UNAUTHORIZED,
+            detail="Must login with token parameter or Authorization bearer header",
+        )
+
+    async with get_client() as client:
+        endpoint = "/user"
+        # normally we auth to Hub API with service api token,
+        # but this time auth as the user token to get user model
+        headers = {"Authorization": f"Bearer {token}"}
+        resp = await client.get(endpoint, headers=headers)
+        if resp.is_error:
+            raise HTTPException(
+                status.HTTP_400_BAD_REQUEST,
+                detail={
+                    "msg": "Error getting user info from token",
+                    "request_url": str(resp.request.url),
+                    "token": token,
+                    "response_code": resp.status_code,
+                    "hub_response": resp.json(),
+                },
+            )
+    user = User(**resp.json())
+    return user

examples/service-fastapi/app/service.py

@@ -0,0 +1,70 @@
+import os
+
+from fastapi import APIRouter
+from fastapi import Depends
+from fastapi import Form
+from fastapi import Request
+
+from .client import get_client
+from .models import AuthorizationError
+from .models import HubApiError
+from .models import User
+from .security import get_current_user
+
+# APIRouter prefix cannot end in /
+service_prefix = os.getenv("JUPYTERHUB_SERVICE_PREFIX", "").rstrip("/")
+router = APIRouter(prefix=service_prefix)
+
+
+@router.post("/get_token", include_in_schema=False)
+async def get_token(code: str = Form(...)):
+    "Callback function for OAuth2AuthorizationCodeBearer scheme"
+    # The only thing we need in this form post is the code
+    # Everything else we can hardcode / pull from env
+    async with get_client() as client:
+        redirect_uri = (
+            os.environ["PUBLIC_HOST"] + os.environ["JUPYTERHUB_OAUTH_CALLBACK_URL"],
+        )
+        data = {
+            "client_id": os.environ["JUPYTERHUB_CLIENT_ID"],
+            "client_secret": os.environ["JUPYTERHUB_API_TOKEN"],
+            "grant_type": "authorization_code",
+            "code": code,
+            "redirect_uri": redirect_uri,
+        }
+        resp = await client.post("/oauth2/token", data=data)
+    ### resp.json() is {'access_token': <token>, 'token_type': 'Bearer'}
+    return resp.json()
+
+
+@router.get("/")
+async def index():
+    "Non-authenticated function that returns {'Hello': 'World'}"
+    return {"Hello": "World"}
+
+
+# response_model and responses dict translate to OpenAPI (Swagger) hints
+# compare and contrast what the /me endpoint looks like in Swagger vs /debug
+@router.get(
+    "/me",
+    response_model=User,
+    responses={401: {'model': AuthorizationError}, 400: {'model': HubApiError}},
+)
+async def me(user: User = Depends(get_current_user)):
+    "Authenticated function that returns the User model"
+    return user
+
+
+@router.get("/debug")
+async def index(request: Request, user: User = Depends(get_current_user)):
+    """
+    Authenticated function that returns a few pieces of debug
+     * Environ of the service process
+     * Request headers
+     * User model
+    """
+    return {
+        "env": dict(os.environ),
+        "headers": dict(request.headers),
+        "user": user,
+    }

examples/service-fastapi/jupyterhub_config.py

@@ -0,0 +1,31 @@
+import os
+import warnings
+
+# When Swagger performs OAuth2 in the browser, it will set
+# the request host + relative path as the redirect uri, causing a
+# uri mismatch if the oauth_redirect_uri is just the relative path
+# is set in the c.JupyterHub.services entry (as per default).
+# Therefore need to know the request host ahead of time.
+if "PUBLIC_HOST" not in os.environ:
+    msg = (
+        "env PUBLIC_HOST is not set, defaulting to http://127.0.0.1:8000.  "
+        "This can cause problems with OAuth.  "
+        "Set PUBLIC_HOST to your public (browser accessible) host."
+    )
+    warnings.warn(msg)
+    public_host = "http://127.0.0.1:8000"
+else:
+    public_host = os.environ["PUBLIC_HOST"].rstrip('/')
+service_name = "fastapi"
+oauth_redirect_uri = f"{public_host}/services/{service_name}/oauth_callback"
+
+c.JupyterHub.services = [
+    {
+        "name": service_name,
+        "url": "http://127.0.0.1:10202",
+        "command": ["uvicorn", "app:app", "--port", "10202"],
+        "admin": True,
+        "oauth_redirect_uri": oauth_redirect_uri,
+        "environment": {"PUBLIC_HOST": public_host},
+    }
+]

examples/service-fastapi/requirements.txt

@@ -0,0 +1,4 @@
+fastapi
+httpx
+python-multipart
+uvicorn

examples/service-notebook/README.md

@@ -17,8 +17,8 @@ and the name of the shared-notebook service.
 
 In the external example, some extra steps are required to set up supervisor:
 
-1. select a system user to run the service. This is  a user on the system, and does not need to be a Hub user. Add this to the user field in `shared-notebook.conf`, replacing `someuser`.
+1. select a system user to run the service. This is a user on the system, and does not need to be a Hub user. Add this to the user field in `shared-notebook.conf`, replacing `someuser`.
 2. generate a secret token for authentication, and replace the `super-secret` fields in `shared-notebook-service` and `jupyterhub_config.py`
 3. install `shared-notebook-service` somewhere on your system, and update `/path/to/shared-notebook-service` to the absolute path of this destination
-3. copy `shared-notebook.conf` to `/etc/supervisor/conf.d/`
-4. `supervisorctl reload`
+4. copy `shared-notebook.conf` to `/etc/supervisor/conf.d/`
+5. `supervisorctl reload`

examples/service-whoami-flask/README.md

@@ -4,21 +4,21 @@ Uses `jupyterhub.services.HubAuth` to authenticate requests with the Hub in a [f
 
 ## Run
 
-1. Launch JupyterHub and the `whoami service` with
+1.  Launch JupyterHub and the `whoami service` with
 
         jupyterhub --ip=127.0.0.1
 
-2. Visit http://127.0.0.1:8000/services/whoami/ or http://127.0.0.1:8000/services/whoami-oauth/
+2.  Visit http://127.0.0.1:8000/services/whoami/ or http://127.0.0.1:8000/services/whoami-oauth/
 
 After logging in with your local-system credentials, you should see a JSON dump of your user info:
 
 ```json
 {
- "admin": false,
- "last_activity": "2016-05-27T14:05:18.016372",
- "name": "queequeg",
- "pending": null,
- "server": "/user/queequeg"
+  "admin": false,
+  "last_activity": "2016-05-27T14:05:18.016372",
+  "name": "queequeg",
+  "pending": null,
+  "server": "/user/queequeg"
 }
 ```
 
@@ -29,5 +29,4 @@ A similar service could be run externally, by setting the JupyterHub service env
     JUPYTERHUB_API_TOKEN
     JUPYTERHUB_SERVICE_PREFIX
 
-
 [flask]: http://flask.pocoo.org

examples/service-whoami-flask/jupyterhub_config.py

@@ -1,6 +1,3 @@
-import os
-import sys
-
 c.JupyterHub.services = [
     {
         'name': 'whoami',

examples/service-whoami/README.md

@@ -6,21 +6,21 @@ There is an implementation each of cookie-based `HubAuthenticated` and OAuth-bas
 
 ## Run
 
-1. Launch JupyterHub and the `whoami service` with
+1.  Launch JupyterHub and the `whoami service` with
 
         jupyterhub --ip=127.0.0.1
 
-2. Visit http://127.0.0.1:8000/services/whoami or http://127.0.0.1:8000/services/whoami-oauth
+2.  Visit http://127.0.0.1:8000/services/whoami or http://127.0.0.1:8000/services/whoami-oauth
 
 After logging in with your local-system credentials, you should see a JSON dump of your user info:
 
 ```json
 {
- "admin": false,
- "last_activity": "2016-05-27T14:05:18.016372",
- "name": "queequeg",
- "pending": null,
- "server": "/user/queequeg"
+  "admin": false,
+  "last_activity": "2016-05-27T14:05:18.016372",
+  "name": "queequeg",
+  "pending": null,
+  "server": "/user/queequeg"
 }
 ```
 

examples/service-whoami/jupyterhub_config.py

@@ -1,4 +1,3 @@
-import os
 import sys
 
 c.JupyterHub.services = [

examples/service-whoami/whoami-oauth.py

@@ -6,7 +6,6 @@ showing the user their own info.
 """
 import json
 import os
-from getpass import getuser
 from urllib.parse import urlparse
 
 from tornado.httpserver import HTTPServer
@@ -25,6 +24,7 @@ class WhoAmIHandler(HubOAuthenticated, RequestHandler):
     # `getuser()` here would mean only the user who started the service
     # can access the service:
 
+    # from getpass import getuser
     # hub_users = {getuser()}
 
     @authenticated

examples/service-whoami/whoami.py

@@ -4,7 +4,6 @@ This serves `/services/whoami/`, authenticated with the Hub, showing the user th
 """
 import json
 import os
-from getpass import getuser
 from urllib.parse import urlparse
 
 from tornado.httpserver import HTTPServer
@@ -21,6 +20,7 @@ class WhoAmIHandler(HubAuthenticated, RequestHandler):
     # `getuser()` here would mean only the user who started the service
     # can access the service:
 
+    # from getpass import getuser
     # hub_users = {getuser()}
 
     @authenticated

hooks/README.md

@@ -1,3 +0,0 @@
-# Docker Cloud build hooks
-
-These are the hooks

hooks/post_build

@@ -1,4 +0,0 @@
-#!/bin/bash
-set -exuo pipefail
-
-docker build --build-arg BASE_IMAGE=$DOCKER_REPO:$DOCKER_TAG -t ${DOCKER_REPO}-onbuild:$DOCKER_TAG onbuild

hooks/post_push

@@ -1,44 +0,0 @@
-#!/bin/bash
-set -exuo pipefail
-
-export ONBUILD=${DOCKER_REPO}-onbuild
-# push ONBUILD image
-docker push $ONBUILD:$DOCKER_TAG
-
-function get_hub_version() {
-  rm -f hub_version
-  docker run --rm -v $PWD:/version -u $(id -u) -i $DOCKER_REPO:$DOCKER_TAG sh -c 'jupyterhub --version > /version/hub_version'
-  hub_xyz=$(cat hub_version)
-  split=( ${hub_xyz//./ } )
-  hub_xy="${split[0]}.${split[1]}"
-  # add .dev on hub_xy so it's 1.0.dev
-  if [[ ! -z "${split[3]:-}" ]]; then
-    hub_xy="${hub_xy}.${split[3]}"
-    latest=0
-  else
-    latest=1
-  fi
-}
-
-
-get_hub_version
-
-# when building master, push 0.9.0.dev as well
-docker tag $DOCKER_REPO:$DOCKER_TAG $DOCKER_REPO:$hub_xyz
-docker push $DOCKER_REPO:$hub_xyz
-docker tag $ONBUILD:$DOCKER_TAG $ONBUILD:$hub_xyz
-docker push $ONBUILD:$hub_xyz
-
-# when building 0.9.x, push 0.9 as well
-docker tag $DOCKER_REPO:$DOCKER_TAG $DOCKER_REPO:$hub_xy
-docker push $DOCKER_REPO:$hub_xy
-docker tag $ONBUILD:$DOCKER_TAG $ONBUILD:$hub_xy
-docker push $ONBUILD:$hub_xyz
-
-# if building a stable release, tag latest as well
-if [[ "$latest" == "1" ]]; then
-  docker tag $DOCKER_REPO:$DOCKER_TAG $DOCKER_REPO:latest
-  docker push $DOCKER_REPO:latest
-  docker tag $ONBUILD:$DOCKER_TAG $ONBUILD:latest
-  docker push $ONBUILD:latest
-fi