diff --git a/docs/source/getting-started/config-basics.md b/docs/source/getting-started/config-basics.md index 71fca2c0..19094aff 100644 --- a/docs/source/getting-started/config-basics.md +++ b/docs/source/getting-started/config-basics.md @@ -85,3 +85,16 @@ meant as illustration, are: - Using GitHub OAuth instead of PAM with [OAuthenticator](https://github.com/jupyterhub/oauthenticator) - Spawning single-user servers with Docker, using the [DockerSpawner](https://github.com/jupyterhub/dockerspawner) + +## Run the proxy separately + +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 +maintnance, re-configuration, etc), then use connections are not +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, +for information see [the separate proxy page](../reference/separate-proxy.html). \ No newline at end of file diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 81eaf4d5..7e119a66 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -10,6 +10,7 @@ Technical Reference spawners services proxy + separate-proxy rest database templates