mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-15 22:13:00 +00:00
Some suggestions from reading through the docs
Thanks to @willingc, @minrk and @manics for the review so far. This commit is the PR so far rebased onto master and squashed.
This commit is contained in:
@@ -101,6 +101,9 @@ popular services:
|
||||
- Okpy
|
||||
- OpenShift
|
||||
|
||||
NOTE: Open issue asking for more details on this generic implementation.
|
||||
It's not clear if this is a different implementation or if the JupyterHub OAuth
|
||||
_is_ the generic implementation.
|
||||
A generic implementation, which you can use for OAuth authentication
|
||||
with any provider, is also available.
|
||||
|
||||
|
@@ -93,7 +93,7 @@ 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
|
||||
maintenance, re-configuration, etc.), then use connections are not
|
||||
maintenance, re-configuration, etc.), then user 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,
|
||||
|
@@ -12,7 +12,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;
|
||||
instead, use of `'0.0.0.0'` is preferred.
|
||||
instead, use of `'0.0.0.0'` is preferred.
|
||||
|
||||
Changing the Proxy's main IP address and port can be done with the following
|
||||
JupyterHub **command line options**:
|
||||
@@ -41,9 +41,9 @@ port.
|
||||
|
||||
## Set the Proxy's REST API communication URL (optional)
|
||||
|
||||
By default, this REST API listens on port 8081 of `localhost` only.
|
||||
The Hub service talks to the proxy via a REST API on a secondary port. The
|
||||
API URL can be configured separately and override the default settings.
|
||||
By default, the proxy's REST API listens on port 8081 of `localhost` only.
|
||||
The Hub service talks to the proxy via a REST API on a secondary port.
|
||||
The REST API URL (hostname and port) can be configured separately and override the default settings.
|
||||
|
||||
### Set api_url
|
||||
|
||||
|
@@ -76,9 +76,9 @@ In certain cases, for example if the hub is running behind a reverse proxy, and
|
||||
`SSL termination is being provided by NGINX <https://www.nginx.com/resources/admin-guide/nginx-ssl-termination/>`_,
|
||||
it is reasonable to run the hub without SSL.
|
||||
|
||||
To achieve this, 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).
|
||||
To achieve this, remove ``c.JupyterHub.ssl_key`` and ``c.JupyterHub.ssl_cert``
|
||||
from your configuration (setting them to ``None`` or an empty string does not
|
||||
have the same effect, and will result in an error).
|
||||
|
||||
.. _cookie-secret:
|
||||
|
||||
|
@@ -67,7 +67,7 @@ c.JupyterHub.services = [
|
||||
Upon restarting JupyterHub, you should see a message like below in the
|
||||
logs:
|
||||
|
||||
```
|
||||
```none
|
||||
Adding API token for <username>
|
||||
```
|
||||
|
||||
|
Reference in New Issue
Block a user